llvm::MCSymbol Class Reference

MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created and uniqued by the MCContext class. More...

#include "llvm/MC/MCSymbol.h"

Inheritance diagram for llvm::MCSymbol:

Collaboration diagram for llvm::MCSymbol:

Public Member Functions
	MCSymbol (const MCSymbol &)=delete
MCSymbol &	operator= (const MCSymbol &)=delete
StringRef	getName () const
	getName - Get the symbol name.
bool	isRegistered () const
void	setIsRegistered (bool Value) const
void	setUsedInReloc () const
bool	isUsedInReloc () const
uint32_t	getIndex () const
	Get the (implementation defined) index.
void	setIndex (uint32_t Value) const
	Set the (implementation defined) index.
bool	isUnset () const
uint64_t	getOffset () const
void	setOffset (uint64_t Value)
uint64_t	getCommonSize () const
	Return the size of a 'common' symbol.
void	setCommon (uint64_t Size, Align Alignment, bool Target=false)
	Mark this symbol as being 'common'.
MaybeAlign	getCommonAlignment () const
	Return the alignment of a 'common' symbol.
bool	declareCommon (uint64_t Size, Align Alignment, bool Target=false)
	Declare this symbol as being 'common'.
bool	isCommon () const
	Is this a 'common' symbol.
bool	isTargetCommon () const
	Is this a target-specific common-like symbol.
MCFragment *	getFragment (bool SetUsed=true) const
bool	isExternal () const
void	setExternal (bool Value) const
bool	isPrivateExtern () const
void	setPrivateExtern (bool Value)
void	print (raw_ostream &OS, const MCAsmInfo *MAI) const
	print - Print the value to the stream OS.
void	dump () const
	dump - Print the value to stderr.
Accessors
bool	isTemporary () const
	isTemporary - Check if this is an assembler temporary symbol.
bool	isUsed () const
	isUsed - Check if this is used.
bool	isRedefinable () const
	Check if this symbol is redefinable.
void	setRedefinable (bool Value)
	Mark this symbol as redefinable.
void	redefineIfPossible ()
	Prepare this symbol to be redefined.
Associated Sections
bool	isDefined () const
	isDefined - Check if this symbol is defined (i.e., it has an address).
bool	isInSection () const
	isInSection - Check if this symbol is defined in some section (i.e., it is defined but not absolute).
bool	isUndefined (bool SetUsed=true) const
	isUndefined - Check if this symbol undefined (i.e., implicitly defined).
bool	isAbsolute () const
	isAbsolute - Check if this is an absolute symbol.
MCSection &	getSection () const
	Get the section associated with a defined, non-absolute symbol.
void	setFragment (MCFragment *F) const
	Mark the symbol as defined in the fragment F.
void	setUndefined ()
	Mark the symbol as undefined.
bool	isELF () const
bool	isCOFF () const
bool	isGOFF () const
bool	isMachO () const
bool	isWasm () const
bool	isXCOFF () const
Variable Symbols
bool	isVariable () const
	isVariable - Check if this is a variable symbol.
const MCExpr *	getVariableValue (bool SetUsed=true) const
	getVariableValue - Get the value for variable symbols.
void	setVariableValue (const MCExpr *Value)

Protected Types
enum	SymbolKind {   SymbolKindUnset , SymbolKindCOFF , SymbolKindELF , SymbolKindGOFF ,   SymbolKindMachO , SymbolKindWasm , SymbolKindXCOFF }
	The kind of the symbol. More...
enum	Contents : uint8_t {   SymContentsUnset , SymContentsOffset , SymContentsVariable , SymContentsCommon ,   SymContentsTargetCommon }
	A symbol can contain an Offset, or Value, or be Common, but never more than one of these. More...
enum	: unsigned { NumCommonAlignmentBits = 5 }
	The alignment of the symbol if it is 'common'. More...
enum	: unsigned { NumFlagsBits = 16 }
	The Flags field is used by object file implementations to store additional per symbol information which is not easily classified. More...
using	NameEntryStorageTy = union { const StringMapEntry< bool > *NameEntry
	The name for a symbol.

Protected Member Functions
	MCSymbol (SymbolKind Kind, const StringMapEntry< bool > *Name, bool isTemporary)
void *	operator new (size_t s, const StringMapEntry< bool > *Name, MCContext &Ctx)
uint32_t	getFlags () const
	Get the (implementation defined) symbol flags.
void	setFlags (uint32_t Value) const
	Set the (implementation defined) symbol flags.
void	modifyFlags (uint32_t Value, uint32_t Mask) const
	Modify the flags via a mask.

Protected Attributes
PointerIntPair< MCFragment *, 1 >	FragmentAndHasName
	If a symbol has a Fragment, the section is implied, so we only need one pointer.
unsigned	IsTemporary: 1
	IsTemporary - True if this is an assembler temporary label, which typically does not survive in the .o file's symbol table.
unsigned	IsRedefinable: 1
	True if this symbol can be redefined.
unsigned	IsUsed: 1
	IsUsed - True if this symbol has been used.
unsigned	IsRegistered: 1
unsigned	IsExternal: 1
	True if this symbol is visible outside this translation unit.
unsigned	IsPrivateExtern: 1
	This symbol is private extern.
unsigned	Kind: 3
	LLVM RTTI discriminator.
unsigned	IsUsedInReloc: 1
	True if we have created a relocation that uses this symbol.
unsigned	SymbolContents: 3
	This is actually a Contents enumerator, but is unsigned to avoid sign extension and achieve better bitpacking with MSVC.
unsigned	CommonAlignLog2: NumCommonAlignmentBits
uint32_t	Flags: NumFlagsBits
uint32_t	Index = 0
	Index field, for use by the object file implementation.
union {
uint64_t   Offset
	The offset to apply to the fragment address to form this symbol's value. More...
uint64_t   CommonSize
	The size of the symbol, if it is 'common'. More...
const MCExpr *   Value
	If non-null, the value for a variable symbol. More...
};
uint64_t	AlignmentPadding

Static Protected Attributes
static MCFragment *	AbsolutePseudoFragment = &SentinelFragment

Friends
class	MCExpr
class	MCContext

Detailed Description

MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created and uniqued by the MCContext class.

MCSymbols should only be constructed with valid names for the object file.

If the symbol is defined/emitted into the current translation unit, the Section member is set to indicate what section it lives in. Otherwise, if it is a reference to an external entity, it has a null section.

Definition at line 41 of file MCSymbol.h.

Member Typedef Documentation

NameEntryStorageTy

using llvm::MCSymbol::NameEntryStorageTy = union { const StringMapEntry<bool> *NameEntry

protected

The name for a symbol.

MCSymbol contains a uint64_t so is probably aligned to 8. On a 32-bit system, the name is a pointer so isn't going to satisfy the 8 byte alignment of uint64_t. Account for that here.

Definition at line 156 of file MCSymbol.h.

Member Enumeration Documentation

anonymous enum

anonymous enum : unsigned

protected

The alignment of the symbol if it is 'common'.

Internally, this is stored as log2(align) + 1. We reserve 5 bits to encode this value which allows the following values 0b00000 -> unset 0b00001 -> 1ULL << 0 = 1 0b00010 -> 1ULL << 1 = 2 0b00011 -> 1ULL << 2 = 4 ... 0b11111 -> 1ULL << 30 = 1 GiB

Enumerator
NumCommonAlignmentBits

Definition at line 126 of file MCSymbol.h.

anonymous enum

anonymous enum : unsigned

protected

The Flags field is used by object file implementations to store additional per symbol information which is not easily classified.

Enumerator
NumFlagsBits

Definition at line 131 of file MCSymbol.h.

Contents

enum llvm::MCSymbol::Contents : uint8_t

protected

A symbol can contain an Offset, or Value, or be Common, but never more than one of these.

Enumerator
SymContentsUnset
SymContentsOffset
SymContentsVariable
SymContentsCommon
SymContentsTargetCommon

Definition at line 57 of file MCSymbol.h.

SymbolKind

enum llvm::MCSymbol::SymbolKind

protected

The kind of the symbol.

If it is any value other than unset then this class is actually one of the appropriate subclasses of MCSymbol.

Enumerator
SymbolKindUnset
SymbolKindCOFF
SymbolKindELF
SymbolKindGOFF
SymbolKindMachO
SymbolKindWasm
SymbolKindXCOFF

Definition at line 45 of file MCSymbol.h.

Constructor & Destructor Documentation

MCSymbol() [1/2]

llvm::MCSymbol::MCSymbol ( SymbolKind  Kind, const StringMapEntry< bool > *  Name, bool  isTemporary  )

inlineprotected

Definition at line 161 of file MCSymbol.h.

References FragmentAndHasName, Name, and Offset.

MCSymbol() [2/2]

llvm::MCSymbol::MCSymbol ( const MCSymbol &  )

delete

Member Function Documentation

declareCommon()

bool llvm::MCSymbol::declareCommon ( uint64_t  Size, Align  Alignment, bool  Target = false  )

inline

Declare this symbol as being 'common'.

Parameters

Size	- The size of the symbol.
Alignment	- The alignment of the symbol.
Target	- Is the symbol a target-specific common-like symbol.

Returns

True if symbol was already declared as a different type

Definition at line 373 of file MCSymbol.h.

References assert(), CommonSize, getCommonAlignment(), getOffset(), isCommon(), isTargetCommon(), setCommon(), and Size.

Referenced by llvm::AMDGPUTargetELFStreamer::emitAMDGPULDS().

dump()

LLVM_DUMP_METHOD void MCSymbol::dump

(

)

const

dump - Print the value to stderr.

Definition at line 84 of file MCSymbol.cpp.

References llvm::dbgs().

getCommonAlignment()

MaybeAlign llvm::MCSymbol::getCommonAlignment ( ) const

inline

Return the alignment of a 'common' symbol.

Definition at line 362 of file MCSymbol.h.

References assert(), CommonAlignLog2, llvm::decodeMaybeAlign(), and isCommon().

Referenced by declareCommon(), and llvm::MCSymbolMachO::getEncodedFlags().

getCommonSize()

uint64_t llvm::MCSymbol::getCommonSize ( ) const

inline

Return the size of a 'common' symbol.

Definition at line 340 of file MCSymbol.h.

References assert(), CommonSize, and isCommon().

getFlags()

uint32_t llvm::MCSymbol::getFlags ( ) const

inlineprotected

Get the (implementation defined) symbol flags.

Definition at line 418 of file MCSymbol.h.

References Flags.

Referenced by llvm::MCSymbolCOFF::getClass(), llvm::MCSymbolMachO::getEncodedFlags(), llvm::MCSymbolMachO::isAltEntry(), llvm::MCSymbolELF::isBindingSet(), llvm::MCSymbolMachO::isCold(), llvm::MCSymbolWasm::isExported(), llvm::MCSymbolELF::isMemtag(), llvm::MCSymbolMachO::isNoDeadStrip(), llvm::MCSymbolWasm::isNoStrip(), llvm::MCSymbolCOFF::isSafeSEH(), llvm::MCSymbolELF::isSignature(), llvm::MCSymbolMachO::isSymbolResolver(), llvm::MCSymbolWasm::isTLS(), llvm::MCSymbolMachO::isWeakDefinition(), llvm::MCSymbolCOFF::isWeakExternal(), llvm::MCSymbolMachO::isWeakReference(), llvm::MCSymbolELF::isWeakrefUsedInReloc(), llvm::MCSymbolELF::setBinding(), llvm::MCSymbolELF::setIsSignature(), llvm::MCSymbolELF::setIsWeakrefUsedInReloc(), llvm::MCSymbolELF::setMemtag(), llvm::MCSymbolELF::setOther(), llvm::MCSymbolELF::setType(), and llvm::MCSymbolELF::setVisibility().

getFragment()

MCFragment * llvm::MCSymbol::getFragment ( bool  SetUsed = true ) const

inline

Definition at line 395 of file MCSymbol.h.

References llvm::MCExpr::findAssociatedFragment(), FragmentAndHasName, getVariableValue(), and isVariable().

Referenced by AttemptToFoldSymbolOffsetDifference(), llvm::MCExpr::findAssociatedFragment(), llvm::MCAssembler::getAtom(), getLabelOffset(), getOffsetAndDataFragment(), llvm::RISCVMCExpr::getPCRelHiFixup(), getSection(), llvm::MachObjectWriter::getSymbolAddress(), isAbsolute(), llvm::MCObjectWriter::isSymbolRefDifferenceFullyResolved(), llvm::MachObjectWriter::isSymbolRefDifferenceFullyResolvedImpl(), and isUndefined().

getIndex()

uint32_t llvm::MCSymbol::getIndex ( ) const

inline

Get the (implementation defined) index.

Definition at line 314 of file MCSymbol.h.

References Index.

Referenced by writeFragment(), and llvm::MachObjectWriter::writeObject().

getName()

StringRef llvm::MCSymbol::getName ( ) const

inline

getName - Get the symbol name.

Definition at line 203 of file MCSymbol.h.

References FragmentAndHasName.

Referenced by llvm::MipsTargetAsmStreamer::emitDirectiveCpsetup(), llvm::EHStreamer::emitExceptionTable(), llvm::WebAssemblyTargetAsmStreamer::emitExportName(), llvm::MipsAsmPrinter::emitFunctionBodyEnd(), llvm::AsmPrinter::emitFunctionEntryLabel(), llvm::ARMAsmPrinter::emitFunctionEntryLabel(), llvm::WebAssemblyTargetAsmStreamer::emitFunctionType(), llvm::WebAssemblyTargetAsmStreamer::emitGlobalType(), llvm::AsmPrinter::emitGlobalVariable(), llvm::AMDGPUAsmPrinter::emitGlobalVariable(), llvm::WebAssemblyTargetAsmStreamer::emitImportModule(), llvm::WebAssemblyTargetAsmStreamer::emitImportName(), llvm::TargetLoweringObjectFileELF::emitPersonalityValue(), llvm::WebAssemblyTargetAsmStreamer::emitTableType(), llvm::WebAssemblyTargetAsmStreamer::emitTagType(), EvaluateCRExpr(), llvm::RecordStreamer::flushSymverDirectives(), llvm::MCContext::getAssociativeCOFFSection(), llvm::MCAsmLayout::getBaseSymbol(), llvm::TargetLoweringObjectFileELF::getCFIPersonalitySymbol(), llvm::MCContext::getCOFFSection(), llvm::MCContext::getELFSection(), llvm::MCSymbolMachO::getEncodedFlags(), llvm::TargetLoweringObjectFileCOFF::getExplicitSectionGlobal(), llvm::MCSymbolWasm::getImportName(), llvm::TargetLoweringObjectFileMachO::getIndirectSymViaGOTPCRel(), getLabelOffset(), llvm::TargetLoweringObjectFileCOFF::getSectionForJumpTable(), llvm::TargetLoweringObjectFileELF::getSectionForMachineBasicBlock(), getStaticStructorSection(), llvm::MachObjectWriter::getSymbolAddress(), getSymbolOffsetImpl(), llvm::MCSymbolXCOFF::getUnqualifiedName(), llvm::MCContext::getWasmSection(), hasGOTReference(), llvm::DIELabel::print(), llvm::DIEDelta::print(), llvm::X86Operand::print(), print(), llvm::MCExpr::print(), llvm::MipsAsmPrinter::printOperand(), llvm::NVPTXInstPrinter::printProtoIdent(), llvm::MCSectionELF::printSwitchToSection(), llvm::MCSectionWasm::printSwitchToSection(), llvm::PPCInstPrinter::printTLSCall(), llvm::MCContext::registerInlineAsmLabel(), llvm::TargetLoweringObjectFileCOFF::SelectSectionForGlobal(), smallData(), llvm::stableHashValue(), and startsWithGlobalOffsetTable().

getOffset()

uint64_t llvm::MCSymbol::getOffset ( ) const

inline

Definition at line 325 of file MCSymbol.h.

References assert(), Offset, SymbolContents, SymContentsOffset, and SymContentsUnset.

Referenced by AttemptToFoldSymbolOffsetDifference(), declareCommon(), getLabelOffset(), getOffsetAndDataFragment(), llvm::RISCVMCExpr::getPCRelHiFixup(), and setCommon().

getSection()

MCSection & llvm::MCSymbol::getSection ( ) const

inline

Get the section associated with a defined, non-absolute symbol.

Definition at line 267 of file MCSymbol.h.

References assert(), getFragment(), llvm::MCFragment::getParent(), and isInSection().

Referenced by llvm::MCLineSection::addEndEntry(), llvm::BTFDebug::beginFunctionImpl(), emitRangeList(), llvm::CodeViewContext::encodeInlineLineTable(), llvm::MCSectionELF::getLinkedToSection(), llvm::DwarfDebug::insertSectionLabel(), llvm::MCObjectWriter::isSymbolRefDifferenceFullyResolvedImpl(), and llvm::MachObjectWriter::isSymbolRefDifferenceFullyResolvedImpl().

getVariableValue()

const MCExpr * llvm::MCSymbol::getVariableValue ( bool  SetUsed = true ) const

inline

getVariableValue - Get the value for variable symbols.

Definition at line 303 of file MCSymbol.h.

References assert(), IsUsed, isVariable(), and Value.

Referenced by canExpand(), llvm::MCExpr::evaluateAsRelocatableImpl(), llvm::MachObjectWriter::findAliasedSymbol(), getFragment(), llvm::MachObjectWriter::getSymbolAddress(), getSymbolOffsetImpl(), llvm::MCParserUtils::isSymbolUsedInExpression(), AMDGPUMCInstLower::lowerOperand(), and llvm::MCParserUtils::parseAssignmentExpression().

isAbsolute()

bool llvm::MCSymbol::isAbsolute ( ) const

inline

isAbsolute - Check if this is an absolute symbol.

Definition at line 262 of file MCSymbol.h.

References AbsolutePseudoFragment, and getFragment().

Referenced by isInSection().

isCOFF()

bool llvm::MCSymbol::isCOFF ( ) const

inline

Definition at line 283 of file MCSymbol.h.

References Kind, and SymbolKindCOFF.

Referenced by llvm::MCSymbolCOFF::classof().

isCommon()

bool llvm::MCSymbol::isCommon ( ) const

inline

Is this a 'common' symbol.

Definition at line 385 of file MCSymbol.h.

References SymbolContents, SymContentsCommon, and SymContentsTargetCommon.

Referenced by declareCommon(), llvm::MCAsmLayout::getBaseSymbol(), getCommonAlignment(), getCommonSize(), and llvm::MCSymbolMachO::getEncodedFlags().

isDefined()

bool llvm::MCSymbol::isDefined ( ) const

inline

isDefined - Check if this symbol is defined (i.e., it has an address).

Defined symbols are either absolute or in some section.

Definition at line 248 of file MCSymbol.h.

References isUndefined().

Referenced by llvm::DwarfCompileUnit::attachLowHighPC(), llvm::EHStreamer::computePadMap(), llvm::AsmPrinter::emitFunctionBody(), llvm::AsmPrinter::emitGlobalVariable(), llvm::AMDGPUAsmPrinter::emitGlobalVariable(), llvm::MCSymbolELF::getBinding(), getOffsetAndDataFragment(), isInSection(), isInSymtab(), and llvm::AddrLabelMap::UpdateForDeletedBlock().

isELF()

bool llvm::MCSymbol::isELF ( ) const

inline

Definition at line 281 of file MCSymbol.h.

References Kind, and SymbolKindELF.

Referenced by llvm::MCSymbolELF::classof(), and llvm::ARMAsmBackend::shouldForceRelocation().

isExternal()

bool llvm::MCSymbol::isExternal ( ) const

inline

Definition at line 404 of file MCSymbol.h.

References IsExternal.

Referenced by llvm::ARMAsmBackend::shouldForceRelocation().

isGOFF()

bool llvm::MCSymbol::isGOFF ( ) const

inline

Definition at line 285 of file MCSymbol.h.

References Kind, and SymbolKindGOFF.

Referenced by llvm::MCSymbolGOFF::classof().

isInSection()

bool llvm::MCSymbol::isInSection ( ) const

inline

isInSection - Check if this symbol is defined in some section (i.e., it is defined but not absolute).

Definition at line 252 of file MCSymbol.h.

References isAbsolute(), and isDefined().

Referenced by llvm::BTFDebug::beginFunctionImpl(), canExpand(), llvm::MCStreamer::endSection(), llvm::MCAssembler::getAtom(), getSection(), llvm::MCSection::hasEnded(), llvm::MachObjectWriter::isSymbolRefDifferenceFullyResolvedImpl(), and llvm::MCStreamer::switchSection().

isMachO()

bool llvm::MCSymbol::isMachO ( ) const

inline

Definition at line 287 of file MCSymbol.h.

References Kind, and SymbolKindMachO.

Referenced by llvm::MCSymbolMachO::classof().

isPrivateExtern()

bool llvm::MCSymbol::isPrivateExtern ( ) const

inline

Definition at line 407 of file MCSymbol.h.

References IsPrivateExtern.

isRedefinable()

bool llvm::MCSymbol::isRedefinable ( ) const

inline

Check if this symbol is redefinable.

Definition at line 226 of file MCSymbol.h.

References IsRedefinable.

isRegistered()

bool llvm::MCSymbol::isRegistered ( ) const

inline

Definition at line 210 of file MCSymbol.h.

References IsRegistered.

isTargetCommon()

bool llvm::MCSymbol::isTargetCommon ( ) const

inline

Is this a target-specific common-like symbol.

Definition at line 391 of file MCSymbol.h.

References SymbolContents, and SymContentsTargetCommon.

Referenced by declareCommon().

isTemporary()

bool llvm::MCSymbol::isTemporary ( ) const

inline

isTemporary - Check if this is an assembler temporary symbol.

Definition at line 220 of file MCSymbol.h.

References IsTemporary.

Referenced by llvm::MCWinCOFFStreamer::emitCGProfileEntry(), isInSymtab(), and llvm::MachObjectWriter::isSymbolRefDifferenceFullyResolvedImpl().

isUndefined()

bool llvm::MCSymbol::isUndefined ( bool  SetUsed = true ) const

inline

isUndefined - Check if this symbol undefined (i.e., implicitly defined).

Definition at line 257 of file MCSymbol.h.

References getFragment().

Referenced by AttemptToFoldSymbolOffsetDifference(), llvm::MachObjectWriter::doesSymbolRequireExternRelocation(), llvm::AsmPrinter::emitConstantPool(), llvm::RISCVAsmBackend::evaluateTargetFixup(), isDefined(), llvm::MCObjectWriter::isSymbolRefDifferenceFullyResolved(), llvm::MCParserUtils::parseAssignmentExpression(), and smallData().

isUnset()

bool llvm::MCSymbol::isUnset ( ) const

inline

Definition at line 323 of file MCSymbol.h.

References SymbolContents, and SymContentsUnset.

Referenced by AttemptToFoldSymbolOffsetDifference().

isUsed()

bool llvm::MCSymbol::isUsed ( ) const

inline

isUsed - Check if this is used.

Definition at line 223 of file MCSymbol.h.

References IsUsed.

Referenced by llvm::MCParserUtils::parseAssignmentExpression().

isUsedInReloc()

bool llvm::MCSymbol::isUsedInReloc ( ) const

inline

Definition at line 214 of file MCSymbol.h.

References IsUsedInReloc.

Referenced by llvm::MCSymbolELF::getBinding(), and isInSymtab().

isVariable()

bool llvm::MCSymbol::isVariable ( ) const

inline

isVariable - Check if this is a variable symbol.

Definition at line 298 of file MCSymbol.h.

References SymbolContents, and SymContentsVariable.

Referenced by AttemptToFoldSymbolOffsetDifference(), llvm::AsmPrinter::emitFunctionEntryLabel(), llvm::AsmPrinter::emitGlobalVariable(), llvm::AMDGPUAsmPrinter::emitGlobalVariable(), llvm::MCExpr::evaluateAsRelocatableImpl(), llvm::MachObjectWriter::findAliasedSymbol(), getFragment(), getOffsetAndDataFragment(), llvm::MachObjectWriter::getSymbolAddress(), getSymbolOffsetImpl(), getVariableValue(), llvm::MCParserUtils::isSymbolUsedInExpression(), llvm::MCParserUtils::parseAssignmentExpression(), and setFragment().

isWasm()

bool llvm::MCSymbol::isWasm ( ) const

inline

Definition at line 289 of file MCSymbol.h.

References Kind, and SymbolKindWasm.

Referenced by llvm::MCSymbolWasm::classof().

isXCOFF()

bool llvm::MCSymbol::isXCOFF ( ) const

inline

Definition at line 291 of file MCSymbol.h.

References Kind, and SymbolKindXCOFF.

Referenced by llvm::MCSymbolXCOFF::classof().

modifyFlags()

void llvm::MCSymbol::modifyFlags ( uint32_t  Value, uint32_t  Mask  ) const

inlineprotected

Modify the flags via a mask.

Definition at line 427 of file MCSymbol.h.

References assert(), Flags, and NumFlagsBits.

Referenced by llvm::MCSymbolMachO::clearReferenceType(), llvm::MCSymbolMachO::setAltEntry(), llvm::MCSymbolCOFF::setClass(), llvm::MCSymbolMachO::setCold(), llvm::MCSymbolWasm::setExported(), llvm::MCSymbolCOFF::setIsSafeSEH(), llvm::MCSymbolCOFF::setIsWeakExternal(), llvm::MCSymbolMachO::setNoDeadStrip(), llvm::MCSymbolWasm::setNoStrip(), llvm::MCSymbolMachO::setReferenceTypeUndefinedLazy(), llvm::MCSymbolMachO::setSymbolResolver(), llvm::MCSymbolMachO::setThumbFunc(), llvm::MCSymbolWasm::setTLS(), llvm::MCSymbolMachO::setWeakDefinition(), and llvm::MCSymbolMachO::setWeakReference().

operator new()

void * MCSymbol::operator new ( size_t  s, const StringMapEntry< bool > *  Name, MCContext &  Ctx  )

protected

Definition at line 30 of file MCSymbol.cpp.

References Name, and Size.

operator=()

MCSymbol & llvm::MCSymbol::operator= ( const MCSymbol &  )

delete

print()

void MCSymbol::print	(	raw_ostream &	OS,
		const MCAsmInfo *	MAI
	)		const

print - Print the value to the stream OS.

Definition at line 58 of file MCSymbol.cpp.

References llvm::CallingConv::C, getName(), llvm::MCAsmInfo::isValidUnquotedName(), Name, llvm::report_fatal_error(), and llvm::MCAsmInfo::supportsNameQuoting().

Referenced by EmitInlineAsmStr(), llvm::operator<<(), llvm::MCExpr::print(), llvm::CSKYAsmPrinter::PrintAsmOperand(), llvm::WebAssemblyAsmPrinter::PrintAsmOperand(), printExpr(), llvm::ARMAsmPrinter::printOperand(), llvm::MipsAsmPrinter::printOperand(), llvm::HexagonAsmPrinter::printOperand(), llvm::MCSectionCOFF::printSwitchToSection(), llvm::ARMAsmPrinter::PrintSymbolOperand(), and llvm::AsmPrinter::PrintSymbolOperand().

redefineIfPossible()

void llvm::MCSymbol::redefineIfPossible ( )

inline

Prepare this symbol to be redefined.

Definition at line 230 of file MCSymbol.h.

References IsRedefinable, setUndefined(), SymbolContents, SymContentsUnset, and SymContentsVariable.

Referenced by llvm::AsmPrinter::emitFunctionEntryLabel(), llvm::AsmPrinter::emitGlobalVariable(), and llvm::AMDGPUAsmPrinter::emitGlobalVariable().

setCommon()

void llvm::MCSymbol::setCommon ( uint64_t  Size, Align  Alignment, bool  Target = false  )

inline

Mark this symbol as being 'common'.

Parameters

Size	- The size of the symbol.
Alignment	- The alignment of the symbol.
Target	- Is the symbol a target-specific common-like symbol.

Definition at line 350 of file MCSymbol.h.

References assert(), CommonAlignLog2, CommonSize, llvm::encode(), getOffset(), NumCommonAlignmentBits, Size, SymbolContents, SymContentsCommon, and SymContentsTargetCommon.

Referenced by declareCommon().

setExternal()

void llvm::MCSymbol::setExternal ( bool  Value ) const

inline

Definition at line 405 of file MCSymbol.h.

References IsExternal, and Value.

Referenced by llvm::AMDGPUTargetELFStreamer::emitAMDGPULDS(), and AMDGPUMCInstLower::lowerOperand().

setFlags()

void llvm::MCSymbol::setFlags ( uint32_t  Value ) const

inlineprotected

Set the (implementation defined) symbol flags.

Definition at line 421 of file MCSymbol.h.

References assert(), Flags, NumFlagsBits, and Value.

Referenced by llvm::MCSymbolELF::setBinding(), llvm::MCSymbolMachO::setDesc(), llvm::MCSymbolELF::setIsSignature(), llvm::MCSymbolELF::setIsWeakrefUsedInReloc(), llvm::MCSymbolELF::setMemtag(), llvm::MCSymbolELF::setOther(), llvm::MCSymbolELF::setType(), and llvm::MCSymbolELF::setVisibility().

setFragment()

void llvm::MCSymbol::setFragment ( MCFragment *  F ) const

inline

Mark the symbol as defined in the fragment F.

Definition at line 273 of file MCSymbol.h.

References assert(), F, FragmentAndHasName, and isVariable().

Referenced by llvm::MCContext::getSPIRVSection(), llvm::MCContext::getWasmSection(), and llvm::MCContext::getXCOFFSection().

setIndex()

void llvm::MCSymbol::setIndex ( uint32_t  Value ) const

inline

Set the (implementation defined) index.

Definition at line 319 of file MCSymbol.h.

References Value.

Referenced by llvm::AMDGPUTargetELFStreamer::emitAMDGPULDS().

setIsRegistered()

void llvm::MCSymbol::setIsRegistered ( bool  Value ) const

inline

Definition at line 211 of file MCSymbol.h.

References IsRegistered, and Value.

setOffset()

void llvm::MCSymbol::setOffset ( uint64_t  Value )

inline

Definition at line 331 of file MCSymbol.h.

References assert(), Offset, SymbolContents, SymContentsOffset, SymContentsUnset, and Value.

setPrivateExtern()

void llvm::MCSymbol::setPrivateExtern ( bool  Value )

inline

Definition at line 408 of file MCSymbol.h.

References IsPrivateExtern, and Value.

setRedefinable()

void llvm::MCSymbol::setRedefinable ( bool  Value )

inline

Mark this symbol as redefinable.

Definition at line 228 of file MCSymbol.h.

References IsRedefinable, and Value.

Referenced by llvm::MCParserUtils::parseAssignmentExpression().

setUndefined()

void llvm::MCSymbol::setUndefined ( )

inline

Mark the symbol as undefined.

Definition at line 279 of file MCSymbol.h.

References FragmentAndHasName.

Referenced by llvm::WebAssembly::getOrCreateFunctionTableSymbol(), redefineIfPossible(), and setVariableValue().

setUsedInReloc()

void llvm::MCSymbol::setUsedInReloc ( ) const

inline

Definition at line 213 of file MCSymbol.h.

References IsUsedInReloc.

setVariableValue()

void MCSymbol::setVariableValue

(

const MCExpr *

Value

)

Definition at line 47 of file MCSymbol.cpp.

References assert(), IsUsed, setUndefined(), SymbolContents, SymContentsUnset, SymContentsVariable, and Value.

Referenced by llvm::MCELFStreamer::emitWeakReference(), llvm::MCWasmStreamer::emitWeakReference(), and llvm::SIInstrInfo::insertIndirectBranch().

Friends And Related Function Documentation

MCContext

friend class MCContext

friend

Definition at line 150 of file MCSymbol.h.

MCExpr

friend class MCExpr

friend

Definition at line 149 of file MCSymbol.h.

Member Data Documentation

union { ... } llvm::MCSymbol::@324

AbsolutePseudoFragment

MCFragment * MCSymbol::AbsolutePseudoFragment = &SentinelFragment

staticprotected

Definition at line 66 of file MCSymbol.h.

Referenced by llvm::MCExpr::findAssociatedFragment(), and isAbsolute().

AlignmentPadding

uint64_t llvm::MCSymbol::AlignmentPadding

protected

Definition at line 158 of file MCSymbol.h.

CommonAlignLog2

unsigned llvm::MCSymbol::CommonAlignLog2

protected

Definition at line 127 of file MCSymbol.h.

Referenced by getCommonAlignment(), and setCommon().

CommonSize

uint64_t llvm::MCSymbol::CommonSize

The size of the symbol, if it is 'common'.

Definition at line 142 of file MCSymbol.h.

Referenced by declareCommon(), getCommonSize(), and setCommon().

Flags

uint32_t llvm::MCSymbol::Flags

mutableprotected

Definition at line 132 of file MCSymbol.h.

Referenced by llvm::MCSymbolELF::getBinding(), llvm::MCSymbolMachO::getEncodedFlags(), getFlags(), llvm::MCSymbolELF::getOther(), llvm::MCSymbolELF::getType(), llvm::MCSymbolELF::getVisibility(), modifyFlags(), and setFlags().

FragmentAndHasName

PointerIntPair<MCFragment *, 1> llvm::MCSymbol::FragmentAndHasName

mutableprotected

If a symbol has a Fragment, the section is implied, so we only need one pointer.

The special AbsolutePseudoFragment value is for absolute symbols. If this is a variable symbol, this caches the variable value's fragment. FIXME: We might be able to simplify this by having the asm streamer create dummy fragments. If this is a section, then it gives the symbol is defined in. This is null for undefined symbols.

If this is a fragment, then it gives the fragment this symbol's value is relative to, if any.

For the 'HasName' integer, this is true if this symbol is named. A named symbol will have a pointer to the name allocated in the bytes immediately prior to the MCSymbol.

Definition at line 83 of file MCSymbol.h.

Referenced by getFragment(), getName(), MCSymbol(), setFragment(), and setUndefined().

Index

uint32_t llvm::MCSymbol::Index = 0

mutableprotected

Index field, for use by the object file implementation.

Definition at line 135 of file MCSymbol.h.

Referenced by getIndex().

IsExternal

unsigned llvm::MCSymbol::IsExternal

mutableprotected

True if this symbol is visible outside this translation unit.

Note: ELF uses binding instead of this bit.

Definition at line 100 of file MCSymbol.h.

Referenced by isExternal(), and setExternal().

IsPrivateExtern

unsigned llvm::MCSymbol::IsPrivateExtern

mutableprotected

This symbol is private extern.

Definition at line 103 of file MCSymbol.h.

Referenced by isPrivateExtern(), and setPrivateExtern().

IsRedefinable

unsigned llvm::MCSymbol::IsRedefinable

protected

True if this symbol can be redefined.

Definition at line 91 of file MCSymbol.h.

Referenced by isRedefinable(), redefineIfPossible(), and setRedefinable().

IsRegistered

unsigned llvm::MCSymbol::IsRegistered

mutableprotected

Definition at line 96 of file MCSymbol.h.

Referenced by isRegistered(), and setIsRegistered().

IsTemporary

unsigned llvm::MCSymbol::IsTemporary

protected

IsTemporary - True if this is an assembler temporary label, which typically does not survive in the .o file's symbol table.

Usually "Lfoo" or ".foo".

Definition at line 88 of file MCSymbol.h.

Referenced by isTemporary().

IsUsed

unsigned llvm::MCSymbol::IsUsed

mutableprotected

IsUsed - True if this symbol has been used.

Definition at line 94 of file MCSymbol.h.

Referenced by getVariableValue(), isUsed(), and setVariableValue().

IsUsedInReloc

unsigned llvm::MCSymbol::IsUsedInReloc

mutableprotected

True if we have created a relocation that uses this symbol.

Definition at line 110 of file MCSymbol.h.

Referenced by isUsedInReloc(), and setUsedInReloc().

Kind

unsigned llvm::MCSymbol::Kind

protected

LLVM RTTI discriminator.

This is actually a SymbolKind enumerator, but is unsigned to avoid sign extension and achieve better bitpacking with MSVC.

Definition at line 107 of file MCSymbol.h.

Referenced by isCOFF(), isELF(), isGOFF(), isMachO(), isWasm(), and isXCOFF().

Offset

uint64_t llvm::MCSymbol::Offset

The offset to apply to the fragment address to form this symbol's value.

Definition at line 139 of file MCSymbol.h.

Referenced by getOffset(), MCSymbol(), and setOffset().

SymbolContents

unsigned llvm::MCSymbol::SymbolContents

protected

This is actually a Contents enumerator, but is unsigned to avoid sign extension and achieve better bitpacking with MSVC.

Definition at line 114 of file MCSymbol.h.

Referenced by getOffset(), isCommon(), isTargetCommon(), isUnset(), isVariable(), redefineIfPossible(), setCommon(), setOffset(), and setVariableValue().

Value

const MCExpr* llvm::MCSymbol::Value

If non-null, the value for a variable symbol.

Definition at line 145 of file MCSymbol.h.

Referenced by getVariableValue(), setExternal(), setFlags(), setIndex(), setIsRegistered(), setOffset(), setPrivateExtern(), setRedefinable(), and setVariableValue().

---

The documentation for this class was generated from the following files:

• include/llvm/MC/MCSymbol.h
• lib/MC/MCSymbol.cpp