LLVM 19.0.0git
MCSymbolMachO.h
Go to the documentation of this file.
1//===- MCSymbolMachO.h - ---------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8#ifndef LLVM_MC_MCSYMBOLMACHO_H
9#define LLVM_MC_MCSYMBOLMACHO_H
10
11#include "llvm/ADT/Twine.h"
12#include "llvm/MC/MCSymbol.h"
13
14namespace llvm {
15class MCSymbolMachO : public MCSymbol {
16 /// We store the value for the 'desc' symbol field in the
17 /// lowest 16 bits of the implementation defined flags.
18 enum MachOSymbolFlags : uint16_t { // See <mach-o/nlist.h>.
19 SF_DescFlagsMask = 0xFFFF,
20
21 // Reference type flags.
22 SF_ReferenceTypeMask = 0x0007,
23 SF_ReferenceTypeUndefinedNonLazy = 0x0000,
24 SF_ReferenceTypeUndefinedLazy = 0x0001,
25 SF_ReferenceTypeDefined = 0x0002,
26 SF_ReferenceTypePrivateDefined = 0x0003,
27 SF_ReferenceTypePrivateUndefinedNonLazy = 0x0004,
28 SF_ReferenceTypePrivateUndefinedLazy = 0x0005,
29
30 // Other 'desc' flags.
31 SF_ThumbFunc = 0x0008,
32 SF_NoDeadStrip = 0x0020,
33 SF_WeakReference = 0x0040,
34 SF_WeakDefinition = 0x0080,
35 SF_SymbolResolver = 0x0100,
36 SF_AltEntry = 0x0200,
37 SF_Cold = 0x0400,
38
39 // Common alignment
40 SF_CommonAlignmentMask = 0xF0FF,
41 SF_CommonAlignmentShift = 8
42 };
43
44public:
47
48 // Reference type methods.
49
50 void clearReferenceType() const {
51 modifyFlags(0, SF_ReferenceTypeMask);
52 }
53
55 modifyFlags(Value ? SF_ReferenceTypeUndefinedLazy : 0,
56 SF_ReferenceTypeUndefinedLazy);
57 }
58
59 // Other 'desc' methods.
60
61 void setThumbFunc() const {
62 modifyFlags(SF_ThumbFunc, SF_ThumbFunc);
63 }
64
65 bool isNoDeadStrip() const {
66 return getFlags() & SF_NoDeadStrip;
67 }
68 void setNoDeadStrip() const {
69 modifyFlags(SF_NoDeadStrip, SF_NoDeadStrip);
70 }
71
72 bool isWeakReference() const {
73 return getFlags() & SF_WeakReference;
74 }
75 void setWeakReference() const {
76 modifyFlags(SF_WeakReference, SF_WeakReference);
77 }
78
79 bool isWeakDefinition() const {
80 return getFlags() & SF_WeakDefinition;
81 }
82 void setWeakDefinition() const {
83 modifyFlags(SF_WeakDefinition, SF_WeakDefinition);
84 }
85
86 bool isSymbolResolver() const {
87 return getFlags() & SF_SymbolResolver;
88 }
89 void setSymbolResolver() const {
90 modifyFlags(SF_SymbolResolver, SF_SymbolResolver);
91 }
92
93 void setAltEntry() const {
94 modifyFlags(SF_AltEntry, SF_AltEntry);
95 }
96
97 bool isAltEntry() const {
98 return getFlags() & SF_AltEntry;
99 }
100
101 void setCold() const { modifyFlags(SF_Cold, SF_Cold); }
102
103 bool isCold() const { return getFlags() & SF_Cold; }
104
105 void setDesc(unsigned Value) const {
106 assert(Value == (Value & SF_DescFlagsMask) &&
107 "Invalid .desc value!");
108 setFlags(Value & SF_DescFlagsMask);
109 }
110
111 /// Get the encoded value of the flags as they will be emitted in to
112 /// the MachO binary
113 uint16_t getEncodedFlags(bool EncodeAsAltEntry) const {
115
116 // Common alignment is packed into the 'desc' bits.
117 if (isCommon()) {
118 if (MaybeAlign MaybeAlignment = getCommonAlignment()) {
119 Align Alignment = *MaybeAlignment;
120 unsigned Log2Size = Log2(Alignment);
121 if (Log2Size > 15)
122 report_fatal_error("invalid 'common' alignment '" +
123 Twine(Alignment.value()) + "' for '" +
124 getName() + "'",
125 false);
126 Flags = (Flags & SF_CommonAlignmentMask) |
127 (Log2Size << SF_CommonAlignmentShift);
128 }
129 }
130
131 if (EncodeAsAltEntry)
132 Flags |= SF_AltEntry;
133
134 return Flags;
135 }
136
137 static bool classof(const MCSymbol *S) { return S->isMachO(); }
138};
139}
140
141#endif
std::string Name
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
MCSymbolMachO(const StringMapEntry< bool > *Name, bool isTemporary)
Definition: MCSymbolMachO.h:45
void setWeakReference() const
Definition: MCSymbolMachO.h:75
bool isNoDeadStrip() const
Definition: MCSymbolMachO.h:65
uint16_t getEncodedFlags(bool EncodeAsAltEntry) const
Get the encoded value of the flags as they will be emitted in to the MachO binary.
void setWeakDefinition() const
Definition: MCSymbolMachO.h:82
void setSymbolResolver() const
Definition: MCSymbolMachO.h:89
void clearReferenceType() const
Definition: MCSymbolMachO.h:50
bool isCold() const
bool isWeakReference() const
Definition: MCSymbolMachO.h:72
void setReferenceTypeUndefinedLazy(bool Value) const
Definition: MCSymbolMachO.h:54
void setAltEntry() const
Definition: MCSymbolMachO.h:93
void setCold() const
void setDesc(unsigned Value) const
bool isAltEntry() const
Definition: MCSymbolMachO.h:97
static bool classof(const MCSymbol *S)
bool isSymbolResolver() const
Definition: MCSymbolMachO.h:86
void setNoDeadStrip() const
Definition: MCSymbolMachO.h:68
bool isWeakDefinition() const
Definition: MCSymbolMachO.h:79
void setThumbFunc() const
Definition: MCSymbolMachO.h:61
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:40
bool isMachO() const
Definition: MCSymbol.h:289
bool isCommon() const
Is this a 'common' symbol.
Definition: MCSymbol.h:387
void modifyFlags(uint32_t Value, uint32_t Mask) const
Modify the flags via a mask.
Definition: MCSymbol.h:431
StringRef getName() const
getName - Get the symbol name.
Definition: MCSymbol.h:205
uint32_t Flags
Definition: MCSymbol.h:134
void setFlags(uint32_t Value) const
Set the (implementation defined) symbol flags.
Definition: MCSymbol.h:425
uint32_t getFlags() const
Get the (implementation defined) symbol flags.
Definition: MCSymbol.h:422
MaybeAlign getCommonAlignment() const
Return the alignment of a 'common' symbol.
Definition: MCSymbol.h:364
bool isTemporary() const
isTemporary - Check if this is an assembler temporary symbol.
Definition: MCSymbol.h:222
StringMapEntry - This is used to represent one value that is inserted into a StringMap.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
LLVM Value Representation.
Definition: Value.h:74
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
void report_fatal_error(Error Err, bool gen_crash_diag=true)
Report a serious error, calling any installed error handler.
Definition: Error.cpp:156
unsigned Log2(Align A)
Returns the log2 of the alignment.
Definition: Alignment.h:208
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition: Alignment.h:39
uint64_t value() const
This is a hole in the type system and should not be abused.
Definition: Alignment.h:85
This struct is a compact representation of a valid (power of two) or undefined (0) alignment.
Definition: Alignment.h:117