LLVM API Documentation

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
llvm::GlobalValue Class Reference

#include <GlobalValue.h>

Inheritance diagram for llvm::GlobalValue:
Inheritance graph
Collaboration diagram for llvm::GlobalValue:
Collaboration graph

List of all members.

Public Types

enum  LinkageTypes {
  ExternalLinkage = 0, AvailableExternallyLinkage, LinkOnceAnyLinkage, LinkOnceODRLinkage,
  WeakAnyLinkage, WeakODRLinkage, AppendingLinkage, InternalLinkage,
  PrivateLinkage, ExternalWeakLinkage, CommonLinkage
 An enumeration for the kinds of linkage for global values. More...
enum  VisibilityTypes { DefaultVisibility = 0, HiddenVisibility, ProtectedVisibility }
 An enumeration for the kinds of visibility of global values. More...
enum  DLLStorageClassTypes { DefaultStorageClass = 0, DLLImportStorageClass = 1, DLLExportStorageClass = 2 }
 Storage classes of global values for PE targets. More...
enum  ThreadLocalMode {
  NotThreadLocal = 0, GeneralDynamicTLSModel, LocalDynamicTLSModel, InitialExecTLSModel,

Public Member Functions

 ~GlobalValue ()
unsigned getAlignment () const
bool hasUnnamedAddr () const
void setUnnamedAddr (bool Val)
bool hasComdat () const
ComdatgetComdat ()
const ComdatgetComdat () const
VisibilityTypes getVisibility () const
bool hasDefaultVisibility () const
bool hasHiddenVisibility () const
bool hasProtectedVisibility () const
void setVisibility (VisibilityTypes V)
bool isThreadLocal () const
 If the value is "Thread Local", its value isn't shared by the threads.
void setThreadLocal (bool Val)
void setThreadLocalMode (ThreadLocalMode Val)
ThreadLocalMode getThreadLocalMode () const
DLLStorageClassTypes getDLLStorageClass () const
bool hasDLLImportStorageClass () const
bool hasDLLExportStorageClass () const
void setDLLStorageClass (DLLStorageClassTypes C)
bool hasSection () const
const char * getSection () const
PointerTypegetType () const
 Global values are always pointers.
bool hasExternalLinkage () const
bool hasAvailableExternallyLinkage () const
bool hasLinkOnceLinkage () const
bool hasLinkOnceODRLinkage () const
bool hasWeakLinkage () const
bool hasWeakAnyLinkage () const
bool hasWeakODRLinkage () const
bool hasAppendingLinkage () const
bool hasInternalLinkage () const
bool hasPrivateLinkage () const
bool hasLocalLinkage () const
bool hasExternalWeakLinkage () const
bool hasCommonLinkage () const
void setLinkage (LinkageTypes LT)
LinkageTypes getLinkage () const
bool isDiscardableIfUnused () const
bool mayBeOverridden () const
bool isWeakForLinker () const
virtual void copyAttributesFrom (const GlobalValue *Src)
void destroyConstant () override
 Override from Constant class.
bool isDeclaration () const
bool isDeclarationForLinker () const
virtual void removeFromParent ()=0
virtual void eraseFromParent ()=0
 This method unlinks 'this' from the containing module and deletes it.
ModulegetParent ()
 Get the module that this global value is contained inside of...
const ModulegetParent () const
const DataLayoutgetDataLayout () const

Materialization is used to construct functions only as they're needed. This is useful to reduce memory usage in LLVM or parsing work done by the BitcodeReader to load the Module.

bool isMaterializable () const
bool isDematerializable () const
std::error_code materialize ()
void Dematerialize ()

Static Public Member Functions

static LinkageTypes getLinkOnceLinkage (bool ODR)
static LinkageTypes getWeakLinkage (bool ODR)
static bool isExternalLinkage (LinkageTypes Linkage)
static bool isAvailableExternallyLinkage (LinkageTypes Linkage)
static bool isLinkOnceODRLinkage (LinkageTypes Linkage)
static bool isLinkOnceLinkage (LinkageTypes Linkage)
static bool isWeakAnyLinkage (LinkageTypes Linkage)
static bool isWeakODRLinkage (LinkageTypes Linkage)
static bool isWeakLinkage (LinkageTypes Linkage)
static bool isAppendingLinkage (LinkageTypes Linkage)
static bool isInternalLinkage (LinkageTypes Linkage)
static bool isPrivateLinkage (LinkageTypes Linkage)
static bool isLocalLinkage (LinkageTypes Linkage)
static bool isExternalWeakLinkage (LinkageTypes Linkage)
static bool isCommonLinkage (LinkageTypes Linkage)
static bool isDiscardableIfUnused (LinkageTypes Linkage)
static bool mayBeOverridden (LinkageTypes Linkage)
static bool isWeakForLinker (LinkageTypes Linkage)
static StringRef getRealLinkageName (StringRef Name)
static bool classof (const Value *V)

Protected Member Functions

 GlobalValue (Type *Ty, ValueTy VTy, Use *Ops, unsigned NumOps, LinkageTypes Linkage, const Twine &Name)
unsigned getGlobalValueSubClassData () const
void setGlobalValueSubClassData (unsigned V)

Protected Attributes

LinkageTypes Linkage: 5
unsigned Visibility: 2
unsigned UnnamedAddr: 1
unsigned DllStorageClass: 2
unsigned ThreadLocal: 3

Static Protected Attributes

static const unsigned GlobalValueSubClassDataBits = 19

Detailed Description

Definition at line 31 of file GlobalValue.h.

Member Enumeration Documentation

Storage classes of global values for PE targets.


Function to be imported from DLL.


Function to be accessible from DLL.

Definition at line 57 of file GlobalValue.h.

An enumeration for the kinds of linkage for global values.


Externally visible function.


Available for inspection, not emission.


Keep one copy of function when linking (inline)


Same, but only replaced by something equivalent.


Keep one copy of named function when linking (weak)


Same, but only replaced by something equivalent.


Special purpose, only applies to global arrays.


Rename collisions when linking (static functions).


Like Internal, but omit from symbol table.


ExternalWeak linkage description.


Tentative definitions.

Definition at line 35 of file GlobalValue.h.


Definition at line 99 of file GlobalValue.h.

An enumeration for the kinds of visibility of global values.


The GV is visible.


The GV is hidden.


The GV is protected.

Definition at line 50 of file GlobalValue.h.

Constructor & Destructor Documentation

llvm::GlobalValue::GlobalValue ( Type Ty,
ValueTy  VTy,
Use Ops,
unsigned  NumOps,
LinkageTypes  Linkage,
const Twine Name 
) [inline, protected]

Definition at line 64 of file GlobalValue.h.

References llvm::Value::setName().

Definition at line 107 of file GlobalValue.h.

References llvm::Constant::removeDeadConstantUsers().

Member Function Documentation

static bool llvm::GlobalValue::classof ( const Value V) [inline, static]

Copy all additional attributes (those not needed to create a GlobalValue) from the GlobalValue Src to this one.

copyAttributesFrom - copy all additional attributes (those not needed to create a GlobalValue) from the GlobalValue Src to this one.

Reimplemented in llvm::Function, llvm::GlobalVariable, and llvm::GlobalObject.

Definition at line 57 of file Globals.cpp.

References getDLLStorageClass(), getVisibility(), hasUnnamedAddr(), setDLLStorageClass(), setUnnamedAddr(), and setVisibility().

Referenced by llvm::CloneModule(), llvm::CloneSubModule(), and copyGVAttributes().

If this GlobalValue is read in, and if the GVMaterializer supports it, release the memory for the function, and set it up to be materialized lazily. If !isDematerializable(), this method is a noop.

Definition at line 41 of file Globals.cpp.

References llvm::Module::Dematerialize(), and getParent().

void GlobalValue::destroyConstant ( ) [override, virtual]

Override from Constant class.

Override destroyConstant to make sure it doesn't get called on GlobalValue's because they shouldn't be treated like other constants.

Reimplemented from llvm::Constant.

Definition at line 51 of file Globals.cpp.

References llvm_unreachable.

virtual void llvm::GlobalValue::eraseFromParent ( ) [pure virtual]

This method unlinks 'this' from the containing module and deletes it.

Implemented in llvm::Function, llvm::GlobalVariable, and llvm::GlobalAlias.

Reimplemented in llvm::GlobalObject.

Definition at line 118 of file GlobalValue.h.

References getComdat().

static LinkageTypes llvm::GlobalValue::getLinkOnceLinkage ( bool  ODR) [inline, static]

Definition at line 172 of file GlobalValue.h.

References LinkOnceAnyLinkage, and LinkOnceODRLinkage.

Get the module that this global value is contained inside of...

Definition at line 346 of file GlobalValue.h.

References Parent.

Referenced by callIntrinsic(), changeToUnreachable(), CloneDebugInfoMetadata(), llvm::GlobalAlias::create(), llvm::IRBuilderBase::CreateAssumption(), llvm::IRBuilderBase::CreateGCRelocate(), llvm::IRBuilderBase::CreateGCResult(), llvm::IRBuilderBase::CreateGCStatepoint(), llvm::IRBuilderBase::CreateGlobalString(), llvm::IRBuilderBase::CreateLifetimeEnd(), llvm::IRBuilderBase::CreateLifetimeStart(), llvm::IRBuilderBase::CreateMemCpy(), llvm::IRBuilderBase::CreateMemMove(), llvm::IRBuilderBase::CreateMemSet(), Dematerialize(), llvm::EmitBinaryFloatFnCall(), llvm::EmitFPutC(), llvm::EmitFPutS(), llvm::AsmPrinter::EmitFunctionHeader(), llvm::EmitFWrite(), llvm::AsmPrinter::EmitGlobalVariable(), llvm::AArch64TargetLowering::emitLoadLinked(), llvm::ARMTargetLowering::emitLoadLinked(), llvm::EmitMemChr(), llvm::EmitMemCmp(), llvm::EmitMemCpyChk(), llvm::EmitPutChar(), llvm::EmitPutS(), llvm::AArch64TargetLowering::emitStoreConditional(), llvm::ARMTargetLowering::emitStoreConditional(), llvm::EmitStrChr(), llvm::EmitStrCpy(), llvm::EmitStrLen(), llvm::EmitStrNCmp(), llvm::EmitStrNCpy(), llvm::EmitStrNLen(), llvm::EmitUnaryFloatFnCall(), llvm::GlobalAlias::eraseFromParent(), llvm::GlobalVariable::eraseFromParent(), llvm::Function::eraseFromParent(), llvm::CodeExtractor::extractCodeRegion(), llvm::findAllNVVMAnnotation(), llvm::findOneNVVMAnnotation(), forceRenaming(), generateUnsignedDivisionCode(), llvm::CallSiteBase< Function, Value, User, Instruction, CallInst, InvokeInst, User::op_iterator >::getCaller(), getComdatGVForCOFF(), getDataLayout(), llvm::RegionBase< Tr >::getDepth(), getExpression(), llvm::Trace::getModule(), getModuleFromVal(), llvm::CallGraph::getOrInsertFunction(), getParent(), llvm::MCJIT::getPointerToFunction(), llvm::SparcTargetLowering::getSRetArgSize(), llvm::GlobalVariable::GlobalVariable(), hasDebugInfo(), hasReturnsTwiceAttr(), INITIALIZE_PASS(), llvm::InlineFunction(), insertSinCosCall(), isDematerializable(), llvm::isImageReadOnly(), llvm::isImageReadWrite(), llvm::isImageWriteOnly(), llvm::isSampler(), llvm::lintFunction(), LLVMGetNextFunction(), LLVMGetNextGlobal(), LLVMGetPreviousFunction(), LLVMGetPreviousGlobal(), llvm::AsmPrinter::lowerConstant(), llvm::LowerDbgDeclare(), llvm::IntrinsicLowering::LowerToByteSwap(), llvm::ARMTargetLowering::makeDMB(), materialize(), OptimizeGlobalAddressOfMalloc(), parentFunctionOfValue(), PerformHeapAllocSRoA(), llvm::FileInfo::print(), llvm::AssemblyWriter::printFunction(), llvm::AssemblyWriter::printGlobal(), PrintOps(), ProcessUAddIdiom(), ProcessUGT_ADDCST_ADD(), ProcessUMulZExtIdiom(), promoteSingleBlockAlloca(), llvm::GlobalAlias::removeFromParent(), llvm::GlobalVariable::removeFromParent(), llvm::Function::removeFromParent(), ReplaceCallWith(), rewriteSingleStoreAlloca(), llvm::InstCombinePass::run(), llvm::TargetLibraryAnalysis::run(), llvm::NVPTXLowerAggrCopies::runOnFunction(), llvm::StackProtector::runOnFunction(), setUsedInitializer(), SRAGlobal(), SwitchToLookupTable(), TryToShrinkGlobalToBoolean(), UpgradeAVX512CmpIntrinsic(), upgradeGlobalArray(), llvm::UpgradeIntrinsicCall(), UpgradeIntrinsicFunction1(), UpgradeSSE41Function(), UpgradeX86IntrinsicsWith8BitMask(), usedInOneFunc(), llvm::InstCombiner::visitCallInst(), and llvm::InstCombiner::visitFPTrunc().

Definition at line 347 of file GlobalValue.h.

References Parent.

static StringRef llvm::GlobalValue::getRealLinkageName ( StringRef  Name) [inline, static]

If special LLVM prefix that is used to inform the asm printer to not emit usual symbol prefix before the symbol name is used then return linkage name after skipping this special LLVM prefix.

Definition at line 290 of file GlobalValue.h.

References llvm::StringRef::empty(), Name, and llvm::StringRef::substr().

Referenced by llvm::DwarfUnit::applySubprogramDefinitionAttributes(), and llvm::DwarfCompileUnit::getOrCreateGlobalVariableDIE().

const char * GlobalValue::getSection ( ) const
static LinkageTypes llvm::GlobalValue::getWeakLinkage ( bool  ODR) [inline, static]

Definition at line 175 of file GlobalValue.h.

References WeakAnyLinkage, and WeakODRLinkage.

bool llvm::GlobalValue::hasComdat ( ) const [inline]

Definition at line 123 of file GlobalValue.h.

References DefaultVisibility, and Visibility.

Referenced by bindsLocally(), and llvm::AArch64Subtarget::ClassifyGlobalReference().

Definition at line 150 of file GlobalValue.h.

References DLLImportStorageClass, and DllStorageClass.

Referenced by isSimpleEnoughValueToCommitHelper().

Definition at line 251 of file GlobalValue.h.

References isLinkOnceODRLinkage(), and Linkage.

Referenced by llvm::canBeOmittedFromSymbolTable().

Definition at line 125 of file GlobalValue.h.

References ProtectedVisibility, and Visibility.

bool llvm::GlobalValue::hasSection ( ) const [inline]

Definition at line 255 of file GlobalValue.h.

References isWeakAnyLinkage(), and Linkage.

Definition at line 258 of file GlobalValue.h.

References isWeakODRLinkage(), and Linkage.

static bool llvm::GlobalValue::isAppendingLinkage ( LinkageTypes  Linkage) [inline, static]

Definition at line 200 of file GlobalValue.h.

References AppendingLinkage.

Referenced by hasAppendingLinkage().

Definition at line 182 of file GlobalValue.h.

References AvailableExternallyLinkage.

Referenced by hasAvailableExternallyLinkage().

static bool llvm::GlobalValue::isCommonLinkage ( LinkageTypes  Linkage) [inline, static]

Definition at line 215 of file GlobalValue.h.

References CommonLinkage.

Referenced by hasCommonLinkage().

Returns true if this function was loaded from a GVMaterializer that's still attached to its Module and that knows how to dematerialize the function.

Definition at line 35 of file Globals.cpp.

References getParent(), and llvm::Module::isDematerializable().

static bool llvm::GlobalValue::isDiscardableIfUnused ( LinkageTypes  Linkage) [inline, static]

Whether the definition of this global may be discarded if it is not used in its compilation unit.

Definition at line 221 of file GlobalValue.h.

References isLinkOnceLinkage(), and isLocalLinkage().

Referenced by makeVisible().

Definition at line 275 of file GlobalValue.h.

References Linkage.

static bool llvm::GlobalValue::isExternalLinkage ( LinkageTypes  Linkage) [inline, static]

Definition at line 179 of file GlobalValue.h.

References ExternalLinkage.

Referenced by hasExternalLinkage(), and llvm::GlobalAlias::isValidLinkage().

static bool llvm::GlobalValue::isExternalWeakLinkage ( LinkageTypes  Linkage) [inline, static]

Definition at line 212 of file GlobalValue.h.

References ExternalWeakLinkage.

Referenced by hasExternalWeakLinkage().

static bool llvm::GlobalValue::isInternalLinkage ( LinkageTypes  Linkage) [inline, static]

Definition at line 203 of file GlobalValue.h.

References InternalLinkage.

Referenced by hasInternalLinkage(), and isLocalLinkage().

static bool llvm::GlobalValue::isLinkOnceLinkage ( LinkageTypes  Linkage) [inline, static]
static bool llvm::GlobalValue::isLinkOnceODRLinkage ( LinkageTypes  Linkage) [inline, static]

Definition at line 185 of file GlobalValue.h.

References LinkOnceODRLinkage.

Referenced by hasLinkOnceODRLinkage().

static bool llvm::GlobalValue::isLocalLinkage ( LinkageTypes  Linkage) [inline, static]

If this function's Module is being lazily streamed in functions from disk or some other source, this method can be used to check to see if the function has been read in yet or not.

Reimplemented in llvm::Function.

Definition at line 30 of file Globals.cpp.

References F().

Referenced by llvm::AssemblyWriter::printAlias(), and llvm::AssemblyWriter::printGlobal().

static bool llvm::GlobalValue::isPrivateLinkage ( LinkageTypes  Linkage) [inline, static]

Definition at line 206 of file GlobalValue.h.

References PrivateLinkage.

Referenced by hasPrivateLinkage(), and isLocalLinkage().

static bool llvm::GlobalValue::isWeakAnyLinkage ( LinkageTypes  Linkage) [inline, static]

Definition at line 191 of file GlobalValue.h.

References WeakAnyLinkage.

Referenced by hasWeakAnyLinkage(), and isWeakLinkage().

static bool llvm::GlobalValue::isWeakForLinker ( LinkageTypes  Linkage) [inline, static]

Whether the definition of this global may be replaced at link time. NB: Using this method outside of the code generators is almost always a mistake: when working at the IR level use mayBeOverridden instead as it knows about ODR semantics.

Definition at line 237 of file GlobalValue.h.

References AvailableExternallyLinkage, CommonLinkage, ExternalWeakLinkage, LinkOnceAnyLinkage, LinkOnceODRLinkage, WeakAnyLinkage, and WeakODRLinkage.

Referenced by llvm::AArch64Subtarget::ClassifyGlobalReference(), llvm::AsmPrinter::EmitJumpTableInfo(), getSelectionForCOFF(), llvm::ARMSubtarget::GVIsIndirectSymbol(), llvm::TargetLowering::isOffsetFoldingLegal(), PrepareCall(), and llvm::TargetLoweringObjectFileMachO::SelectSectionForGlobal().

Definition at line 281 of file GlobalValue.h.

References isWeakForLinker(), and Linkage.

Referenced by llvm::GlobalVariable::hasUniqueInitializer(), and isWeakForLinker().

static bool llvm::GlobalValue::isWeakLinkage ( LinkageTypes  Linkage) [inline, static]

Definition at line 197 of file GlobalValue.h.

References isWeakAnyLinkage(), and isWeakODRLinkage().

Referenced by hasWeakLinkage(), and llvm::GlobalAlias::isValidLinkage().

static bool llvm::GlobalValue::isWeakODRLinkage ( LinkageTypes  Linkage) [inline, static]

Definition at line 194 of file GlobalValue.h.

References WeakODRLinkage.

Referenced by hasWeakODRLinkage(), and isWeakLinkage().

std::error_code GlobalValue::materialize ( )

Make sure this GlobalValue is fully read. If the module is corrupt, this returns true and fills in the optional string with information about the problem. If successful, this returns false.

Definition at line 38 of file Globals.cpp.

References getParent(), and llvm::Module::materialize().

Referenced by llvm::legacy::FunctionPassManager::run().

static bool llvm::GlobalValue::mayBeOverridden ( LinkageTypes  Linkage) [inline, static]

Whether the definition of this global may be replaced by something non-equivalent at link time. For example, if a function has weak linkage then the code defining it may be replaced by different code.

Definition at line 228 of file GlobalValue.h.

References CommonLinkage, ExternalWeakLinkage, LinkOnceAnyLinkage, and WeakAnyLinkage.

Referenced by llvm::InlineCostAnalysis::getInlineCost(), and llvm::ObjectSizeOffsetVisitor::visitGlobalAlias().

Definition at line 279 of file GlobalValue.h.

References Linkage, and mayBeOverridden().

Referenced by llvm::GlobalVariable::hasDefinitiveInitializer(), and mayBeOverridden().

virtual void llvm::GlobalValue::removeFromParent ( ) [pure virtual]

This method unlinks 'this' from the containing module, but does not delete it.

Implemented in llvm::Function, llvm::GlobalVariable, and llvm::GlobalAlias.

Definition at line 156 of file GlobalValue.h.

References llvm::CallingConv::C, and DllStorageClass.

Referenced by copyAttributesFrom(), and UpgradeDLLImportExportLinkage().

void llvm::GlobalValue::setThreadLocal ( bool  Val) [inline]

Definition at line 136 of file GlobalValue.h.

References GeneralDynamicTLSModel, NotThreadLocal, and setThreadLocalMode().

void llvm::GlobalValue::setUnnamedAddr ( bool  Val) [inline]

Member Data Documentation

Definition at line 88 of file GlobalValue.h.

Definition at line 97 of file GlobalValue.h.

Referenced by getParent().

Definition at line 80 of file GlobalValue.h.

Referenced by getThreadLocalMode().

Definition at line 77 of file GlobalValue.h.

Referenced by hasUnnamedAddr(), and setUnnamedAddr().

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