LLVM  14.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
llvm::GlobalObject Class Reference

#include "llvm/IR/GlobalObject.h"

Inheritance diagram for llvm::GlobalObject:
Inheritance graph
[legend]
Collaboration diagram for llvm::GlobalObject:
Collaboration graph
[legend]

Public Types

enum  VCallVisibility { VCallVisibilityPublic = 0, VCallVisibilityLinkageUnit = 1, VCallVisibilityTranslationUnit = 2 }
 
- Public Types inherited from llvm::GlobalValue
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,
  LocalExecTLSModel
}
 
enum  UnnamedAddr { UnnamedAddr::None, UnnamedAddr::Local, UnnamedAddr::Global }
 
using GUID = uint64_t
 Declare a type to represent a global unique identifier for a global value. More...
 
- Public Types inherited from llvm::User
using op_iterator = Use *
 
using const_op_iterator = const Use *
 
using op_range = iterator_range< op_iterator >
 
using const_op_range = iterator_range< const_op_iterator >
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
using use_iterator = use_iterator_impl< Use >
 
using const_use_iterator = use_iterator_impl< const Use >
 
using user_iterator = user_iterator_impl< User >
 
using const_user_iterator = user_iterator_impl< const User >
 

Public Member Functions

 GlobalObject (const GlobalObject &)=delete
 
uint64_t getAlignment () const
 FIXME: Remove this function once transition to Align is over. More...
 
MaybeAlign getAlign () const
 Returns the alignment of the given variable or function. More...
 
void setAlignment (MaybeAlign Align)
 
unsigned getGlobalObjectSubClassData () const
 
void setGlobalObjectSubClassData (unsigned Val)
 
bool hasSection () const
 Check if this global has a custom object file section. More...
 
StringRef getSection () const
 Get the custom section of this global if it has one. More...
 
void setSection (StringRef S)
 Change the section for this global. More...
 
bool hasComdat () const
 
const ComdatgetComdat () const
 
ComdatgetComdat ()
 
void setComdat (Comdat *C)
 
void copyMetadata (const GlobalObject *Src, unsigned Offset)
 Copy metadata from Src, adjusting offsets by Offset. More...
 
void addTypeMetadata (unsigned Offset, Metadata *TypeID)
 
void setVCallVisibilityMetadata (VCallVisibility Visibility)
 
VCallVisibility getVCallVisibility () const
 
bool canIncreaseAlignment () const
 Returns true if the alignment of the value can be unilaterally increased. More...
 
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment. More...
 
void addMetadata (StringRef Kind, MDNode &MD)
 
void clearMetadata ()
 Erase all metadata attached to this Value. More...
 
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind. More...
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * >> &MDs) const
 Appends all metadata attached to this value to MDs, sorting by KindID. More...
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any. More...
 
MDNodegetMetadata (StringRef Kind) const
 
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order. More...
 
void getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
 
bool hasMetadata () const
 Return true if this value has any metadata attached to it. More...
 
bool hasMetadata (unsigned KindID) const
 Return true if this value has the given type of metadata attached. More...
 
bool hasMetadata (StringRef Kind) const
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment. More...
 
void setMetadata (StringRef Kind, MDNode *Node)
 
- Public Member Functions inherited from llvm::GlobalValue
 GlobalValue (const GlobalValue &)=delete
 
unsigned getAddressSpace () const
 
bool hasGlobalUnnamedAddr () const
 
bool hasAtLeastLocalUnnamedAddr () const
 Returns true if this value's address is not significant in this module. More...
 
UnnamedAddr getUnnamedAddr () const
 
void setUnnamedAddr (UnnamedAddr Val)
 
bool hasComdat () const
 
const ComdatgetComdat () const
 
ComdatgetComdat ()
 
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. More...
 
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
 
StringRef getSection () const
 
PointerTypegetType () const
 Global values are always pointers. More...
 
TypegetValueType () const
 
bool isImplicitDSOLocal () const
 
void setDSOLocal (bool Local)
 
bool isDSOLocal () const
 
bool hasPartition () const
 
StringRef getPartition () const
 
void setPartition (StringRef Part)
 
bool isDefinitionExact () const
 Return true if the currently visible definition of this global (if any) is exactly the definition we will see at runtime. More...
 
bool hasExactDefinition () const
 Return true if this global has an exact defintion. More...
 
bool isInterposable () const
 Return true if this global's definition can be substituted with an arbitrary definition at link time or load time. More...
 
bool canBenefitFromLocalAlias () const
 
bool hasExternalLinkage () const
 
bool hasAvailableExternallyLinkage () const
 
bool hasLinkOnceLinkage () const
 
bool hasLinkOnceAnyLinkage () 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
 
bool hasValidDeclarationLinkage () const
 
void setLinkage (LinkageTypes LT)
 
LinkageTypes getLinkage () const
 
bool isDiscardableIfUnused () const
 
bool isWeakForLinker () const
 
std::string getGlobalIdentifier () const
 Return the modified name for this global value suitable to be used as the key for a global lookup (e.g. More...
 
GUID getGUID () const
 Return a 64-bit global unique ID constructed from global value name (i.e. More...
 
bool isDeclaration () const
 Return true if the primary definition of this global value is outside of the current translation unit. More...
 
bool isDeclarationForLinker () const
 
bool isStrongDefinitionForLinker () const
 Returns true if this global's definition will be the one chosen by the linker. More...
 
const GlobalObjectgetAliaseeObject () const
 
GlobalObjectgetAliaseeObject ()
 
bool isAbsoluteSymbolRef () const
 Returns whether this is a reference to an absolute symbol. More...
 
Optional< ConstantRangegetAbsoluteSymbolRange () const
 If this is an absolute symbol reference, returns the range of the symbol, otherwise returns None. More...
 
void removeFromParent ()
 This method unlinks 'this' from the containing module, but does not delete it. More...
 
void eraseFromParent ()
 This method unlinks 'this' from the containing module and deletes it. More...
 
ModulegetParent ()
 Get the module that this global value is contained inside of... More...
 
const ModulegetParent () const
 
bool canBeOmittedFromSymbolTable () const
 True if GV can be left out of the object symbol table. More...
 
bool isMaterializable () const
 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. More...
 
Error materialize ()
 Make sure this GlobalValue is fully read. More...
 
- Public Member Functions inherited from llvm::Constant
void operator= (const Constant &)=delete
 
 Constant (const Constant &)=delete
 
bool isNullValue () const
 Return true if this is the value that would be returned by getNullValue. More...
 
bool isOneValue () const
 Returns true if the value is one. More...
 
bool isNotOneValue () const
 Return true if the value is not the one value, or, for vectors, does not contain one value elements. More...
 
bool isAllOnesValue () const
 Return true if this is the value that would be returned by getAllOnesValue. More...
 
bool isNegativeZeroValue () const
 Return true if the value is what would be returned by getZeroValueForNegation. More...
 
bool isZeroValue () const
 Return true if the value is negative zero or null value. More...
 
bool isNotMinSignedValue () const
 Return true if the value is not the smallest signed value, or, for vectors, does not contain smallest signed value elements. More...
 
bool isMinSignedValue () const
 Return true if the value is the smallest signed value. More...
 
bool isFiniteNonZeroFP () const
 Return true if this is a finite and non-zero floating-point scalar constant or a fixed width vector constant with all finite and non-zero elements. More...
 
bool isNormalFP () const
 Return true if this is a normal (as opposed to denormal, infinity, nan, or zero) floating-point scalar constant or a vector constant with all normal elements. More...
 
bool hasExactInverseFP () const
 Return true if this scalar has an exact multiplicative inverse or this vector has an exact multiplicative inverse for each element in the vector. More...
 
bool isNaN () const
 Return true if this is a floating-point NaN constant or a vector floating-point constant with all NaN elements. More...
 
bool isElementWiseEqual (Value *Y) const
 Return true if this constant and a constant 'Y' are element-wise equal. More...
 
bool containsUndefOrPoisonElement () const
 Return true if this is a vector constant that includes any undef or poison elements. More...
 
bool containsPoisonElement () const
 Return true if this is a vector constant that includes any poison elements. More...
 
bool containsConstantExpression () const
 Return true if this is a fixed width vector constant that includes any constant expressions. More...
 
bool canTrap () const
 Return true if evaluation of this constant could trap. More...
 
bool isThreadDependent () const
 Return true if the value can vary between threads. More...
 
bool isDLLImportDependent () const
 Return true if the value is dependent on a dllimport variable. More...
 
bool isConstantUsed () const
 Return true if the constant has users other than constant expressions and other dangling things. More...
 
bool needsRelocation () const
 This method classifies the entry according to whether or not it may generate a relocation entry (either static or dynamic). More...
 
bool needsDynamicRelocation () const
 
ConstantgetAggregateElement (unsigned Elt) const
 For aggregates (struct/array/vector) return the constant that corresponds to the specified element if possible, or null if not. More...
 
ConstantgetAggregateElement (Constant *Elt) const
 
ConstantgetSplatValue (bool AllowUndefs=false) const
 If all elements of the vector constant have the same value, return that value. More...
 
const APIntgetUniqueInteger () const
 If C is a constant integer then return its value, otherwise C must be a vector of constant integers, all equal, and the common value is returned. More...
 
void destroyConstant ()
 Called if some element of this constant is no longer valid. More...
 
void handleOperandChange (Value *, Value *)
 This method is a special form of User::replaceUsesOfWith (which does not work on constants) that does work on constants. More...
 
void removeDeadConstantUsers () const
 If there are any dead constant users dangling off of this constant, remove them. More...
 
bool hasOneLiveUse () const
 Return true if the constant has exactly one live use. More...
 
const ConstantstripPointerCasts () const
 
ConstantstripPointerCasts ()
 
bool isManifestConstant () const
 Return true if a constant is ConstantData or a ConstantAggregate or ConstantExpr that contain only ConstantData. More...
 
- Public Member Functions inherited from llvm::User
 User (const User &)=delete
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects. More...
 
void operator delete (void *Usr, unsigned)
 Placement delete - required by std, called if the ctor throws. More...
 
void operator delete (void *Usr, unsigned, unsigned)
 Placement delete - required by std, called if the ctor throws. More...
 
const UsegetOperandList () const
 
UsegetOperandList ()
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
ArrayRef< const uint8_t > getDescriptor () const
 Returns the descriptor co-allocated with this User instance. More...
 
MutableArrayRef< uint8_t > getDescriptor ()
 Returns the descriptor co-allocated with this User instance. More...
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
bool isDroppable () const
 A droppable user is a user for which uses can be dropped without affecting correctness and should be dropped rather than preventing a transformation from happening. More...
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
iterator_range< value_op_iteratoroperand_values ()
 
const_value_op_iterator value_op_begin () const
 
const_value_op_iterator value_op_end () const
 
iterator_range< const_value_op_iteratoroperand_values () const
 
void dropAllReferences ()
 Drop all references to operands. More...
 
void replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another. More...
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value. More...
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
std::string getNameOrAsOperand () const
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value. More...
 
void replaceUsesWithIf (Value *New, llvm::function_ref< bool(Use &U)> ShouldReplace)
 Go through the uses list for this definition and make each use point to "V" if the callback ShouldReplace returns true for the given Use. More...
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
bool use_empty () const
 
bool materialized_use_empty () const
 
use_iterator materialized_use_begin ()
 
const_use_iterator materialized_use_begin () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () const
 
bool user_empty () const
 
user_iterator materialized_user_begin ()
 
const_user_iterator materialized_user_begin () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one use of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N uses. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N uses or more. More...
 
bool hasOneUser () const
 Return true if there is exactly one user of this value. More...
 
UsegetSingleUndroppableUse ()
 Return true if there is exactly one use of this value that cannot be dropped. More...
 
const UsegetSingleUndroppableUse () const
 
UsergetUniqueUndroppableUser ()
 Return true if there is exactly one unique user of this value that cannot be dropped (that user can have multiple uses of this value). More...
 
const UsergetUniqueUndroppableUser () const
 
bool hasNUndroppableUses (unsigned N) const
 Return true if there this value. More...
 
bool hasNUndroppableUsesOrMore (unsigned N) const
 Return true if this value has N uses or more. More...
 
void dropDroppableUses (llvm::function_ref< bool(const Use *)> ShouldDrop=[](const Use *) { return true;})
 Remove every uses that can safely be removed. More...
 
void dropDroppableUsesIn (User &Usr)
 Remove every use of this value in User that can safely be removed. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
bool isTransitiveUsedByMetadataOnly () const
 
bool isSwiftError () const
 Return true if this value is a swifterror value. More...
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs and address space casts. More...
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndAliases () const
 Strip off pointer casts, all-zero GEPs, address space casts, and aliases. More...
 
ValuestripPointerCastsAndAliases ()
 
const ValuestripPointerCastsSameRepresentation () const
 Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same. More...
 
ValuestripPointerCastsSameRepresentation ()
 
const ValuestripPointerCastsForAliasAnalysis () const
 Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info. More...
 
ValuestripPointerCastsForAliasAnalysis ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr) const
 Accumulate the constant offset this value has compared to a base pointer. More...
 
ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false)
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false. More...
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const
 Strip off pointer casts and inbounds GEPs. More...
 
ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {})
 
bool canBeFreed () const
 Return true if the memory object referred to by V can by freed in the scope for which the SSA value defining the allocation is statically defined. More...
 
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
 Returns the number of bytes known to be dereferenceable for the pointer value. More...
 
Align getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block. More...
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 

Static Public Member Functions

static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::GlobalValue
static UnnamedAddr getMinUnnamedAddr (UnnamedAddr A, UnnamedAddr B)
 
static LinkageTypes getLinkOnceLinkage (bool ODR)
 
static LinkageTypes getWeakLinkage (bool ODR)
 
static bool isExternalLinkage (LinkageTypes Linkage)
 
static bool isAvailableExternallyLinkage (LinkageTypes Linkage)
 
static bool isLinkOnceAnyLinkage (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 isValidDeclarationLinkage (LinkageTypes Linkage)
 
static bool isInterposableLinkage (LinkageTypes Linkage)
 Whether the definition of this global may be replaced by something non-equivalent at link time. More...
 
static bool isDiscardableIfUnused (LinkageTypes Linkage)
 Whether the definition of this global may be discarded if it is not used in its compilation unit. More...
 
static bool isWeakForLinker (LinkageTypes Linkage)
 Whether the definition of this global may be replaced at link time. More...
 
static StringRef dropLLVMManglingEscape (StringRef Name)
 If the given string begins with the GlobalValue name mangling escape character '\1', drop it. More...
 
static std::string getGlobalIdentifier (StringRef Name, GlobalValue::LinkageTypes Linkage, StringRef FileName)
 Return the modified name for a global value suitable to be used as the key for a global lookup (e.g. More...
 
static GUID getGUID (StringRef GlobalName)
 Return a 64-bit global unique ID constructed from global value name (i.e. More...
 
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::Constant
static bool classof (const Value *V)
 
static ConstantgetNullValue (Type *Ty)
 Constructor to create a '0' constant of arbitrary type. More...
 
static ConstantgetAllOnesValue (Type *Ty)
 
static ConstantgetIntegerValue (Type *Ty, const APInt &V)
 Return the value for an integer or pointer constant, or a vector thereof, with the given scalar value. More...
 
static ConstantreplaceUndefsWith (Constant *C, Constant *Replacement)
 Try to replace undefined constant C or undefined elements in C with Replacement. More...
 
static ConstantmergeUndefsWith (Constant *C, Constant *Other)
 Merges undefs of a Constant with another Constant, along with the undefs already present. More...
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::Value
static void dropDroppableUse (Use &U)
 Remove the droppable use U. More...
 

Protected Types

enum  { LastAlignmentBit = 5, HasSectionHashEntryBit, GlobalObjectBits }
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 27 }
 The number of operands in the subclass. More...
 

Protected Member Functions

 GlobalObject (Type *Ty, ValueTy VTy, Use *Ops, unsigned NumOps, LinkageTypes Linkage, const Twine &Name, unsigned AddressSpace=0)
 
void copyAttributesFrom (const GlobalObject *Src)
 
- Protected Member Functions inherited from llvm::GlobalValue
 GlobalValue (Type *Ty, ValueTy VTy, Use *Ops, unsigned NumOps, LinkageTypes Linkage, const Twine &Name, unsigned AddressSpace)
 
unsigned getGlobalValueSubClassData () const
 
void setGlobalValueSubClassData (unsigned V)
 
void setParent (Module *parent)
 
 ~GlobalValue ()
 
void copyAttributesFrom (const GlobalValue *Src)
 Copy all additional attributes (those not needed to create a GlobalValue) from the GlobalValue Src to this one. More...
 
- Protected Member Functions inherited from llvm::Constant
 Constant (Type *ty, ValueTy vty, Use *Ops, unsigned NumOps)
 
 ~Constant ()=default
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated. More...
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated. More...
 
void * operator new (size_t Size, unsigned Us, unsigned DescBytes)
 Allocate a User with the operands co-allocated. More...
 
 User (Type *ty, unsigned vty, Use *, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User. More...
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses. More...
 
 ~User ()=default
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~Value ()
 Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More...
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * >> &MDs) const
 Appends all metadata attached to this value to MDs, sorting by KindID. More...
 
bool hasMetadata () const
 Return true if this value has any metadata attached to it. More...
 
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind. More...
 
void clearMetadata ()
 Erase all metadata attached to this Value. More...
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any. More...
 
MDNodegetMetadata (StringRef Kind) const
 
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order. More...
 
void getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
 
bool hasMetadata (unsigned KindID) const
 Return true if this value has the given type of metadata attached. More...
 
bool hasMetadata (StringRef Kind) const
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment. More...
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment. More...
 
void addMetadata (StringRef Kind, MDNode &MD)
 

Protected Attributes

ComdatObjComdat
 
- Protected Attributes inherited from llvm::GlobalValue
TypeValueType
 
unsigned Linkage: 4
 
unsigned Visibility: 2
 
unsigned UnnamedAddrVal: 2
 
unsigned DllStorageClass: 2
 
unsigned ThreadLocal: 3
 
unsigned HasLLVMReservedName: 1
 True if the function's name starts with "llvm.". More...
 
unsigned IsDSOLocal: 1
 If true then there is a definition within the same linkage unit and that definition cannot be runtime preempted. More...
 
unsigned HasPartition: 1
 True if this symbol has a partition name assigned (see https://lld.llvm.org/Partitions.html). More...
 
Intrinsic::ID IntID
 The intrinsic ID for this subclass (which must be a Function). More...
 
ModuleParent
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasMetadata: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Static Protected Attributes

static const unsigned GlobalObjectSubClassDataBits
 
- Static Protected Attributes inherited from llvm::GlobalValue
static const unsigned GlobalValueSubClassDataBits = 16
 

Additional Inherited Members

- Static Public Attributes inherited from llvm::Value
static constexpr unsigned MaxAlignmentExponent = 32
 The maximum alignment for instructions. More...
 
static constexpr uint64_t MaximumAlignment = 1ULL << MaxAlignmentExponent
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 

Detailed Description

Definition at line 28 of file GlobalObject.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
LastAlignmentBit 
HasSectionHashEntryBit 
GlobalObjectBits 

Definition at line 53 of file GlobalObject.h.

◆ VCallVisibility

Enumerator
VCallVisibilityPublic 
VCallVisibilityLinkageUnit 
VCallVisibilityTranslationUnit 

Definition at line 33 of file GlobalObject.h.

Constructor & Destructor Documentation

◆ GlobalObject() [1/2]

llvm::GlobalObject::GlobalObject ( Type Ty,
ValueTy  VTy,
Use Ops,
unsigned  NumOps,
LinkageTypes  Linkage,
const Twine Name,
unsigned  AddressSpace = 0 
)
inlineprotected

Definition at line 44 of file GlobalObject.h.

References llvm::GlobalValue::setGlobalValueSubClassData().

◆ GlobalObject() [2/2]

llvm::GlobalObject::GlobalObject ( const GlobalObject )
delete

Member Function Documentation

◆ addMetadata() [1/2]

void Value::addMetadata

Definition at line 1275 of file Metadata.cpp.

◆ addMetadata() [2/2]

void Value::addMetadata

◆ addTypeMetadata()

void GlobalObject::addTypeMetadata ( unsigned  Offset,
Metadata TypeID 
)

◆ canIncreaseAlignment()

bool GlobalObject::canIncreaseAlignment ( ) const

Returns true if the alignment of the value can be unilaterally increased.

Note that for functions this is the alignment of the code, not the alignment of a function pointer.

Definition at line 242 of file Globals.cpp.

References getAlignment(), llvm::Module::getTargetTriple(), hasSection(), llvm::GlobalValue::isDSOLocal(), llvm::Triple::isOSBinFormatELF(), llvm::GlobalValue::isStrongDefinitionForLinker(), and llvm::GlobalValue::Parent.

◆ classof()

static bool llvm::GlobalObject::classof ( const Value V)
inlinestatic

Definition at line 154 of file GlobalObject.h.

References llvm::Value::getValueID().

◆ clearMetadata()

void Value::clearMetadata

Erase all metadata attached to this Value.

Definition at line 1291 of file Metadata.cpp.

◆ copyAttributesFrom()

void GlobalObject::copyAttributesFrom ( const GlobalObject Src)
protected

◆ copyMetadata()

void GlobalObject::copyMetadata ( const GlobalObject Src,
unsigned  Offset 
)

◆ eraseMetadata()

bool Value::eraseMetadata

Erase all metadata attachments with the given kind.

Returns
true if any metadata was removed.

Definition at line 1279 of file Metadata.cpp.

◆ getAlign()

MaybeAlign llvm::GlobalObject::getAlign ( ) const
inline

Returns the alignment of the given variable or function.

Note that for functions this is the alignment of the code, not the alignment of a function pointer.

Definition at line 80 of file GlobalObject.h.

References llvm::Data, llvm::decodeMaybeAlign(), and llvm::GlobalValue::getGlobalValueSubClassData().

Referenced by llvm::AMDGPUAsmPrinter::emitGlobalVariable(), getAlign(), getAlignment(), llvm::DataLayout::getPreferredAlign(), hasTocDataAttr(), replace(), llvm::AMDGPUMachineFunction::setDynLDSAlign(), and SRAGlobal().

◆ getAlignment()

uint64_t llvm::GlobalObject::getAlignment ( ) const
inline

FIXME: Remove this function once transition to Align is over.

Definition at line 71 of file GlobalObject.h.

References getAlign(), and llvm::Align::value().

Referenced by canIncreaseAlignment(), llvm::AsmPrinter::getGVAlignment(), setAlignment(), and llvm::ObjectSizeOffsetVisitor::visitGlobalVariable().

◆ getAllMetadata()

void Value::getAllMetadata

Appends all metadata attached to this value to MDs, sorting by KindID.

The first element of each pair returned is the KindID, the second element is the metadata value. Attachments with the same ID appear in insertion order.

Definition at line 1223 of file Metadata.cpp.

Referenced by hasMetadataOtherThanDebugLoc().

◆ getComdat() [1/2]

Comdat* llvm::GlobalObject::getComdat ( )
inline

Definition at line 124 of file GlobalObject.h.

References ObjComdat.

◆ getComdat() [2/2]

const Comdat* llvm::GlobalObject::getComdat ( ) const
inline

Definition at line 123 of file GlobalObject.h.

References ObjComdat.

Referenced by hasComdat(), maybePrintComdat(), and rewriteComdat().

◆ getGlobalObjectSubClassData()

unsigned llvm::GlobalObject::getGlobalObjectSubClassData ( ) const
inline

◆ getMetadata() [1/4]

MDNode * Value::getMetadata

Definition at line 1205 of file Metadata.cpp.

◆ getMetadata() [2/4]

void Value::getMetadata

Definition at line 1218 of file Metadata.cpp.

◆ getMetadata() [3/4]

MDNode * Value::getMetadata

Get the current metadata attachments for the given kind, if any.

These functions require that the value have at most a single attachment of the given kind, and return nullptr if such an attachment is missing.

Definition at line 1197 of file Metadata.cpp.

Referenced by calcUniqueIDUpdateFlagsAndSize(), computeVariableSummary(), getLinkedToSymbol(), hasInstrProfHashMismatch(), and splitGlobal().

◆ getMetadata() [4/4]

void Value::getMetadata

Appends all attachments with the given ID to MDs in insertion order.

If the Value has no attachments with the given ID, or if ID is invalid, leaves MDs unchanged.

Definition at line 1213 of file Metadata.cpp.

◆ getSection()

StringRef llvm::GlobalObject::getSection ( ) const
inline

◆ getVCallVisibility()

GlobalObject::VCallVisibility GlobalObject::getVCallVisibility ( ) const

Definition at line 1526 of file Metadata.cpp.

References assert(), and llvm::Value::getMetadata().

Referenced by computeVariableSummary(), and splitGlobal().

◆ hasComdat()

bool llvm::GlobalObject::hasComdat ( ) const
inline

◆ hasMetadata() [1/3]

bool llvm::Value::hasMetadata
inline

Return true if this value has any metadata attached to it.

Definition at line 588 of file Value.h.

Referenced by llvm::OpenMPIRBuilder::getOrCreateRuntimeFunction(), llvm::Attributor::internalizeFunctions(), and splitGlobal().

◆ hasMetadata() [2/3]

bool llvm::Value::hasMetadata
inline

Definition at line 595 of file Value.h.

◆ hasMetadata() [3/3]

bool llvm::Value::hasMetadata
inline

Return true if this value has the given type of metadata attached.

Definition at line 592 of file Value.h.

◆ hasSection()

bool llvm::GlobalObject::hasSection ( ) const
inline

◆ setAlignment()

void GlobalObject::setAlignment ( MaybeAlign  Align)

◆ setComdat()

void llvm::GlobalObject::setComdat ( Comdat C)
inline

Definition at line 125 of file GlobalObject.h.

References ObjComdat.

Referenced by createProfileFileNameVar(), llvm::createProfileFileNameVar(), and rewriteComdat().

◆ setGlobalObjectSubClassData()

void llvm::GlobalObject::setGlobalObjectSubClassData ( unsigned  Val)
inline

◆ setMetadata() [1/2]

void Value::setMetadata

Definition at line 1262 of file Metadata.cpp.

◆ setMetadata() [2/2]

void Value::setMetadata

Set a particular kind of metadata attachment.

Sets the given attachment to MD, erasing it if MD is nullptr or replacing it if it already exists.

Definition at line 1234 of file Metadata.cpp.

◆ setSection()

void GlobalObject::setSection ( StringRef  S)

Change the section for this global.

Setting the section to the empty string tells LLVM to choose an appropriate default object file section.

Definition at line 212 of file Globals.cpp.

References llvm::Value::getContext(), llvm::LLVMContextImpl::GlobalObjectSections, hasSection(), HasSectionHashEntryBit, llvm::LLVMContext::pImpl, S, llvm::UniqueStringSaver::save(), and llvm::LLVMContextImpl::Saver.

Referenced by appendToUsedList(), assureFPCallStub(), copyAttributesFrom(), createFPFnStub(), and llvm::EmbedBitcodeInModule().

◆ setVCallVisibilityMetadata()

void GlobalObject::setVCallVisibilityMetadata ( VCallVisibility  Visibility)

Member Data Documentation

◆ GlobalObjectSubClassDataBits

const unsigned llvm::GlobalObject::GlobalObjectSubClassDataBits
staticprotected
Initial value:

Definition at line 59 of file GlobalObject.h.

◆ ObjComdat

Comdat* llvm::GlobalObject::ObjComdat
protected

Definition at line 52 of file GlobalObject.h.

Referenced by getComdat(), and setComdat().


The documentation for this class was generated from the following files:
llvm::GlobalValue::GlobalValueSubClassDataBits
static const unsigned GlobalValueSubClassDataBits
Definition: GlobalValue.h:90
llvm::GlobalObject::GlobalObjectBits
@ GlobalObjectBits
Definition: GlobalObject.h:57