#include "llvm/IR/GlobalObject.h"

Inheritance diagram for llvm::GlobalObject:

[legend]

Collaboration diagram for llvm::GlobalObject:

[legend]

Public Member Functions
	GlobalObject (const GlobalObject &)=delete

unsigned	getAlignment () const

void	setAlignment (unsigned 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 Comdat *	getComdat () const

Comdat *	getComdat ()

void	setComdat (Comdat *C)

bool	hasMetadata () const
	Check if this has any metadata. More...

bool	hasMetadata (unsigned KindID) const
	Check if this has any metadata of the given kind. More...

bool	hasMetadata (StringRef Kind) const

void	getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode *>> &MDs) const
	Appends all attachments for the global to `MDs`, sorting by attachment ID. More...

bool	eraseMetadata (unsigned KindID)
	Erase all metadata attachments with the given kind. More...

void	copyMetadata (const GlobalObject *Src, unsigned Offset)
	Copy metadata from Src, adjusting offsets by Offset. More...

void	addTypeMetadata (unsigned Offset, Metadata *TypeID)

void	clearMetadata ()


MDNode *	getMetadata (unsigned KindID) const
	Get the current metadata attachments for the given kind, if any. More...

MDNode *	getMetadata (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


void	setMetadata (unsigned KindID, MDNode *MD)
	Set a particular kind of metadata attachment. More...

void	setMetadata (StringRef Kind, MDNode *MD)


void	addMetadata (unsigned KindID, MDNode &MD)
	Add a metadata attachment. More...

void	addMetadata (StringRef Kind, MDNode &MD)

Public Member Functions inherited from llvm::GlobalValue
	GlobalValue (const GlobalValue &)=delete

unsigned	getAlignment () const

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 Comdat *	getComdat () const

Comdat *	getComdat ()

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

PointerType *	getType () const
	Global values are always pointers. More...

Type *	getValueType () const

void	setDSOLocal (bool Local)

bool	isDSOLocal () const

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. More...

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

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...

bool	canIncreaseAlignment () const

const GlobalObject *	getBaseObject () const

GlobalObject *	getBaseObject ()

bool	isAbsoluteSymbolRef () const
	Returns whether this is a reference to an absolute symbol. More...

Optional< ConstantRange >	getAbsoluteSymbolRange () 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...

Module *	getParent ()
	Get the module that this global value is contained inside of... More...

const Module *	getParent () 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	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. 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 vector constant with all finite and non-zero elements. More...

bool	isNormalFP () const
	Return true if this is a normal (as opposed to denormal) 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	containsUndefElement () const
	Return true if this is a vector constant that includes any undefined elements. 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. More...

Constant *	getAggregateElement (unsigned Elt) const
	For aggregates (struct/array/vector) return the constant that corresponds to the specified element if possible, or null if not. More...

Constant *	getAggregateElement (Constant *Elt) const

Constant *	getSplatValue () const
	If this is a splat vector constant, meaning that all of the elements have the same value, return that value. More...

const APInt &	getUniqueInteger () 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...

const Constant *	stripPointerCasts () const

Constant *	stripPointerCasts ()

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, bool)
	Placement delete - required by std, called if the ctor throws. More...

const Use *	getOperandList () const

Use *	getOperandList ()

Value *	getOperand (unsigned i) const

void	setOperand (unsigned i, Value *Val)

const Use &	getOperandUse (unsigned i) const

Use &	getOperandUse (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...

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_iterator >	operand_values ()

const_value_op_iterator	value_op_begin () const

const_value_op_iterator	value_op_end () const

iterator_range< const_value_op_iterator >	operand_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

Value &	operator= (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...

Type *	getType () const
	All values are typed, get the type of this value. More...

LLVMContext &	getContext () const
	All values hold a context through their type. More...

bool	hasName () const

ValueName *	getValueName () 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...

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	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_iterator >	materialized_uses ()

iterator_range< const_use_iterator >	materialized_uses () const

iterator_range< use_iterator >	uses ()

iterator_range< const_use_iterator >	uses () 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

User *	user_back ()

const User *	user_back () const

iterator_range< user_iterator >	materialized_users ()

iterator_range< const_user_iterator >	materialized_users () const

iterator_range< user_iterator >	users ()

iterator_range< const_user_iterator >	users () const

bool	hasOneUse () const
	Return true if there is exactly one user of this value. More...

bool	hasNUses (unsigned N) const
	Return true if this Value has exactly N users. More...

bool	hasNUsesOrMore (unsigned N) const
	Return true if this value has N users or more. 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	isSwiftError () const
	Return true if this value is a swifterror value. More...

const Value *	stripPointerCasts () const
	Strip off pointer casts, all-zero GEPs, and aliases. More...

Value *	stripPointerCasts ()

const Value *	stripPointerCastsAndInvariantGroups () const
	Strip off pointer casts, all-zero GEPs, aliases and invariant group info. More...

Value *	stripPointerCastsAndInvariantGroups ()

const Value *	stripPointerCastsNoFollowAliases () const
	Strip off pointer casts and all-zero GEPs. More...

Value *	stripPointerCastsNoFollowAliases ()

const Value *	stripInBoundsConstantOffsets () const
	Strip off pointer casts and all-constant inbounds GEPs. More...

Value *	stripInBoundsConstantOffsets ()

const Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
	Accumulate offsets from stripInBoundsConstantOffsets(). More...

Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)

const Value *	stripInBoundsOffsets () const
	Strip off pointer casts and inbounds GEPs. More...

Value *	stripInBoundsOffsets ()

uint64_t	getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const
	Returns the number of bytes known to be dereferenceable for the pointer value. More...

unsigned	getPointerAlignment (const DataLayout &DL) const
	Returns an alignment of the pointer value. More...

const Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB) const
	Translate PHI node to its predecessor from the given basic block. More...

Value *	DoPHITranslation (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	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 Constant *	getNullValue (Type *Ty)
	Constructor to create a '0' constant of arbitrary type. More...

static Constant *	getAllOnesValue (Type *Ty)

static Constant *	getIntegerValue (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 Public Member Functions inherited from llvm::User
static bool	classof (const Value *V)

Protected Types
enum	{ LastAlignmentBit = 4, HasMetadataHashEntryBit, HasSectionHashEntryBit, GlobalObjectBits }

Protected Types inherited from llvm::Value
enum	: unsigned { NumUserOperandsBits = 28 }
	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)

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>
Use &	Op ()

template<int Idx>
const Use &	Op () 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...

unsigned short	getSubclassDataFromValue () const

void	setValueSubclassData (unsigned short D)

Protected Attributes
Comdat *	ObjComdat

Protected Attributes inherited from llvm::GlobalValue
Type *	ValueType

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...

Intrinsic::ID	IntID
	The intrinsic ID for this subclass (which must be a Function). More...

Module *	Parent

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	HasHungOffUses: 1

unsigned	HasDescriptor: 1

Static Protected Attributes
static const unsigned	GlobalObjectSubClassDataBits

Static Protected Attributes inherited from llvm::GlobalValue
static const unsigned	GlobalValueSubClassDataBits = 17

Additional Inherited Members
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 >

Static Public Attributes inherited from llvm::Value
static const unsigned	MaxAlignmentExponent = 29
	The maximum alignment for instructions. More...

static const unsigned	MaximumAlignment = 1u << MaxAlignmentExponent

Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static Use &	OpFrom (const U *that)

Detailed Description

Definition at line 30 of file GlobalObject.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerator
LastAlignmentBit
HasMetadataHashEntryBit
HasSectionHashEntryBit
GlobalObjectBits

Definition at line 41 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 32 of file GlobalObject.h.

References llvm::GlobalValue::setGlobalValueSubClassData().

◆ GlobalObject() [2/2]

llvm::GlobalObject::GlobalObject ( const GlobalObject & )

delete

Member Function Documentation

◆ addMetadata() [1/2]

void GlobalObject::addMetadata	(	unsigned	KindID,
		MDNode &	MD
	)

Add a metadata attachment.

Definition at line 1394 of file Metadata.cpp.

References llvm::MDNode::getContext(), llvm::LLVMContextImpl::GlobalObjectMetadata, and llvm::LLVMContext::pImpl.

Referenced by llvm::CloneFunctionInto(), llvm::CloneModule(), llvm::createDeadArgHackingPass(), hasMetadata(), parseOptionalLinkageAux(), and wrapConstantAsMetadata().

◆ addMetadata() [2/2]

void GlobalObject::addMetadata	(	StringRef	Kind,
		MDNode &	MD
	)

Definition at line 1401 of file Metadata.cpp.

References llvm::MDNode::getContext().

◆ addTypeMetadata()

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

Definition at line 1495 of file Metadata.cpp.

References llvm::ConstantInt::get(), llvm::ConstantAsMetadata::get(), llvm::MDTuple::get(), llvm::MDNode::getContext(), llvm::Type::getInt64Ty(), and llvm::LLVMContext::MD_type.

Referenced by hasMetadata().

◆ classof()

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

inlinestatic

Definition at line 168 of file GlobalObject.h.

References llvm::tgtok::Bit, clearMetadata(), llvm::GlobalValue::getGlobalValueSubClassData(), llvm::Value::getValueID(), HasMetadataHashEntryBit, llvm::BitmaskEnumDetail::Mask(), and llvm::GlobalValue::setGlobalValueSubClassData().

◆ clearMetadata()

void GlobalObject::clearMetadata ( )

Definition at line 1427 of file Metadata.cpp.

References llvm::MDNode::getContext(), llvm::LLVMContextImpl::GlobalObjectMetadata, and llvm::LLVMContext::pImpl.

Referenced by classof(), llvm::GlobalVariable::dropAllReferences(), and wrapConstantAsMetadata().

◆ copyAttributesFrom()

void GlobalObject::copyAttributesFrom ( const GlobalObject * Src )

protected

Definition at line 126 of file Globals.cpp.

References llvm::GlobalValue::copyAttributesFrom(), getAlignment(), and getSection().

Referenced by llvm::GlobalVariable::copyAttributesFrom(), llvm::Function::copyAttributesFrom(), and hasMetadata().

◆ copyMetadata()

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

Copy metadata from Src, adjusting offsets by Offset.

Definition at line 1454 of file Metadata.cpp.

References llvm::ArrayRef< T >::begin(), llvm::copy(), llvm::dyn_cast(), E, llvm::ConstantInt::get(), llvm::ConstantAsMetadata::get(), llvm::MDNode::get(), getAllMetadata(), llvm::MDNode::getContext(), llvm::LLVMContext::MD_dbg, llvm::LLVMContext::MD_type, and llvm::ArrayRef< T >::size().

Referenced by hasMetadata().

◆ eraseMetadata()

bool GlobalObject::eraseMetadata ( unsigned KindID )

Erase all metadata attachments with the given kind.

Returns: true if any metadata was removed.

Definition at line 1405 of file Metadata.cpp.

References llvm::MDNode::getContext(), llvm::LLVMContextImpl::GlobalObjectMetadata, llvm::LLVMContext::pImpl, and llvm::SPII::Store.

Referenced by hasMetadata().

◆ getAlignment()

unsigned llvm::GlobalObject::getAlignment ( ) const

inline

Definition at line 59 of file GlobalObject.h.

References llvm::AMDGPU::HSAMD::Kernel::Arg::Key::Align, llvm::Data, llvm::GlobalValue::getGlobalValueSubClassData(), and setAlignment().

Referenced by canCreateAliasFor(), copyAttributesFrom(), llvm::NVPTXAsmPrinter::doFinalization(), forceRenaming(), getAlignment(), getArrayElements(), llvm::DataLayout::getPreferredAlignment(), INITIALIZE_PASS(), instrumentMaskedLoadOrStore(), maybePrintComdat(), replace(), SRAGlobal(), and llvm::ObjectSizeOffsetVisitor::visitGlobalVariable().

◆ getAllMetadata()

void GlobalObject::getAllMetadata ( SmallVectorImpl< std::pair< unsigned, MDNode *>> & MDs ) const

Appends all attachments for the global to MDs, sorting by attachment ID.

Attachments with the same ID appear in insertion order.

Definition at line 1417 of file Metadata.cpp.

References llvm::MDNode::getContext(), llvm::LLVMContextImpl::GlobalObjectMetadata, and llvm::LLVMContext::pImpl.

Referenced by llvm::CloneFunctionInto(), copyMetadata(), getRetComponentType(), hasMetadata(), hasMetadataOtherThanDebugLoc(), llvm::SlotTracker::initializeIndexIfNeeded(), maybePrintComdat(), and wrapConstantAsMetadata().

◆ getComdat() [1/2]

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

inline

Definition at line 101 of file GlobalObject.h.

References ObjComdat.

Referenced by canRenameComdat(), copyComdat(), llvm::AsmPrinter::emitXRayTable(), llvm::GetOrCreateFunctionComdat(), getRetComponentType(), llvm::TargetLoweringObjectFileELF::getSectionForJumpTable(), llvm::TargetLoweringObjectFileCOFF::getSectionForJumpTable(), hasComdat(), INITIALIZE_PASS(), instrumentMaskedLoadOrStore(), LLVMGetComdat(), maybePrintComdat(), optimizeGlobalsInModule(), rewriteComdat(), and llvm::WholeProgramDevirtPass::run().

◆ getComdat() [2/2]

Comdat* llvm::GlobalObject::getComdat ( )

inline

Definition at line 102 of file GlobalObject.h.

References ObjComdat.

◆ getGlobalObjectSubClassData()

unsigned llvm::GlobalObject::getGlobalObjectSubClassData ( ) const

inline

Definition at line 66 of file GlobalObject.h.

References llvm::GlobalValue::getGlobalValueSubClassData(), and GlobalObjectBits.

Referenced by setGlobalObjectSubClassData().

◆ getMetadata() [1/4]

MDNode * GlobalObject::getMetadata ( unsigned KindID ) const

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

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

Definition at line 1444 of file Metadata.cpp.

References llvm::MDNode::getContext(), llvm::LLVMContextImpl::GlobalObjectMetadata, and llvm::LLVMContext::pImpl.

Referenced by llvm::WebAssemblyAsmPrinter::EmitFunctionBodyStart(), llvm::AMDGPU::HSAMD::MetadataStreamerV2::emitKernel(), forEachUser(), getAssociatedSymbol(), llvm::getPGOFuncNameMetadata(), hasMetadata(), llvm::GlobalValue::isAbsoluteSymbolRef(), llvm::ImportedFunctionsInliningStatistics::setModuleInfo(), and splitGlobal().

◆ getMetadata() [2/4]

MDNode * GlobalObject::getMetadata ( StringRef Kind ) const

Definition at line 1450 of file Metadata.cpp.

References llvm::MDNode::getContext().

◆ getMetadata() [3/4]

void GlobalObject::getMetadata	(	unsigned	KindID,
		SmallVectorImpl< MDNode *> &	MDs
	)		const

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

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

Definition at line 1382 of file Metadata.cpp.

References llvm::MDNode::getContext(), llvm::LLVMContextImpl::GlobalObjectMetadata, and llvm::LLVMContext::pImpl.

◆ getMetadata() [4/4]

void GlobalObject::getMetadata	(	StringRef	Kind,
		SmallVectorImpl< MDNode *> &	MDs
	)		const

Definition at line 1388 of file Metadata.cpp.

References llvm::MDNode::getContext().

◆ getSection()

StringRef llvm::GlobalObject::getSection ( ) const

inline

Get the custom section of this global if it has one.

If this global does not have a custom section, this will be empty and the default object file section (.text, .data, etc) will be used.

Definition at line 90 of file GlobalObject.h.

References hasSection(), and setSection().

Referenced by callsShareTOCBase(), llvm::FunctionComparator::compareSignature(), copyAttributesFrom(), llvm::NVPTXAsmPrinter::doFinalization(), llvm::AsmPrinter::EmitSpecialLLVMGlobal(), getArrayElements(), llvm::HexagonTargetObjectFile::getExplicitSectionGlobal(), llvm::XCoreTargetObjectFile::getExplicitSectionGlobal(), llvm::AMDGPUTargetObjectFile::getExplicitSectionGlobal(), llvm::TargetLoweringObjectFileELF::getExplicitSectionGlobal(), llvm::TargetLoweringObjectFileMachO::getExplicitSectionGlobal(), llvm::TargetLoweringObjectFileCOFF::getExplicitSectionGlobal(), llvm::TargetLoweringObjectFileWasm::getExplicitSectionGlobal(), instrumentMaskedLoadOrStore(), llvm::MipsTargetObjectFile::IsGlobalInSmallSection(), maybePrintComdat(), llvm::WholeProgramDevirtPass::run(), llvm::HexagonTargetObjectFile::SelectSectionForGlobal(), and llvm::HexagonTargetObjectFile::shouldPutJumpTableInFunctionSection().

◆ hasComdat()

bool llvm::GlobalObject::hasComdat ( ) const

inline

Definition at line 100 of file GlobalObject.h.

References getComdat().

Referenced by callsShareTOCBase(), llvm::canRenameComdatFunc(), computeVariableSummary(), llvm::AsmPrinter::emitXRayTable(), forEachUser(), llvm::TargetLoweringObjectFileCOFF::getExplicitSectionGlobal(), instrumentMaskedLoadOrStore(), llvm::needsComdatForCounter(), llvm::LegacyInlinerBase::removeDeadFunctions(), llvm::AlwaysInlinerPass::run(), llvm::TargetLoweringObjectFileELF::SelectSectionForGlobal(), llvm::TargetLoweringObjectFileCOFF::SelectSectionForGlobal(), llvm::TargetLoweringObjectFileWasm::SelectSectionForGlobal(), and shouldRecordFunctionAddr().

◆ hasMetadata() [1/3]

bool llvm::GlobalObject::hasMetadata ( ) const

inline

Check if this has any metadata.

Definition at line 106 of file GlobalObject.h.

Referenced by emitSignedInt64(), and llvm::stripDebugInfo().

◆ hasMetadata() [2/3]

bool llvm::GlobalObject::hasMetadata ( unsigned KindID ) const

inline

Check if this has any metadata of the given kind.

Definition at line 109 of file GlobalObject.h.

References getMetadata().

◆ hasMetadata() [3/3]

bool llvm::GlobalObject::hasMetadata ( StringRef Kind ) const

inline

Definition at line 112 of file GlobalObject.h.

References addMetadata(), addTypeMetadata(), copyAttributesFrom(), copyMetadata(), eraseMetadata(), getAllMetadata(), getMetadata(), Kind, and setMetadata().

◆ hasSection()

bool llvm::GlobalObject::hasSection ( ) const

inline

Check if this global has a custom object file section.

This is more efficient than calling getSection() and checking for an empty string.

Definition at line 82 of file GlobalObject.h.

References llvm::GlobalValue::getGlobalValueSubClassData(), and HasSectionHashEntryBit.

Referenced by llvm::FunctionComparator::compareSignature(), llvm::NVPTXAsmPrinter::doFinalization(), llvm::HexagonTargetObjectFile::getExplicitSectionGlobal(), llvm::HexagonTargetObjectFile::getLutUsedFunction(), llvm::DataLayout::getPreferredAlignment(), getSection(), instrumentMaskedLoadOrStore(), llvm::AArch64InstrInfo::isFunctionSafeToOutlineFrom(), llvm::MipsTargetObjectFile::IsGlobalInSmallSection(), isKnownTypeIdMember(), isSuitableForBSS(), maybePrintComdat(), mergeConstants(), llvm::TargetLoweringObjectFile::SectionForGlobal(), llvm::AVRTargetObjectFile::SelectSectionForGlobal(), and llvm::HexagonTargetObjectFile::shouldPutJumpTableInFunctionSection().

◆ setAlignment()

void GlobalObject::setAlignment ( unsigned Align )

Definition at line 116 of file Globals.cpp.

References assert(), llvm::GlobalValue::getAlignment(), llvm::GlobalValue::getGlobalValueSubClassData(), llvm::Log2_32(), llvm::Value::MaximumAlignment, and llvm::GlobalValue::setGlobalValueSubClassData().

Referenced by canCreateAliasFor(), despeculateCountZeros(), forceRenaming(), FunctionNumber(), getAlignment(), INITIALIZE_PASS(), instrumentMaskedLoadOrStore(), maybeSetDSOLocal(), replace(), selectJumpTableArmEncoding(), and SRAGlobal().

◆ setComdat()

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

inline

Definition at line 103 of file GlobalObject.h.

References C.

Referenced by canRenameComdat(), copyComdat(), llvm::createDeadArgHackingPass(), llvm::createX86RetpolineThunksPass(), FunctionNumber(), llvm::GetOrCreateFunctionComdat(), getOrInsertGlobal(), getRetComponentType(), INITIALIZE_PASS(), instrumentMaskedLoadOrStore(), LLVMSetComdat(), maybeSetDSOLocal(), and rewriteComdat().

◆ setGlobalObjectSubClassData()

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

inline

Definition at line 71 of file GlobalObject.h.

References assert(), getGlobalObjectSubClassData(), llvm::GlobalValue::getGlobalValueSubClassData(), and llvm::GlobalValue::setGlobalValueSubClassData().

◆ setMetadata() [1/2]

void GlobalObject::setMetadata	(	unsigned	KindID,
		MDNode *	MD
	)

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 1434 of file Metadata.cpp.

Referenced by llvm::createPGOFuncNameMetadata(), hasMetadata(), instrumentMaskedLoadOrStore(), and selectJumpTableArmEncoding().

◆ setMetadata() [2/2]

void GlobalObject::setMetadata	(	StringRef	Kind,
		MDNode *	MD
	)

Definition at line 1440 of file Metadata.cpp.

References llvm::MDNode::getContext(), and setMetadata().

◆ 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 189 of file Globals.cpp.

References llvm::StringRef::empty(), llvm::Value::getContext(), llvm::LLVMContextImpl::GlobalObjectSections, llvm::GlobalValue::hasSection(), llvm::StringSet< AllocatorTy >::insert(), llvm::LLVMContext::pImpl, and llvm::LLVMContextImpl::SectionStrings.

Referenced by assureFPCallStub(), createFPFnStub(), FunctionNumber(), getSection(), instrumentMaskedLoadOrStore(), maybeSetDSOLocal(), needsRuntimeRegistrationOfSectionRange(), llvm::WholeProgramDevirtPass::run(), and setUsedInitializer().

Member Data Documentation

◆ GlobalObjectSubClassDataBits

const unsigned llvm::GlobalObject::GlobalObjectSubClassDataBits

staticprotected

Initial value:

=

GlobalValueSubClassDataBits - GlobalObjectBits

Definition at line 48 of file GlobalObject.h.

◆ ObjComdat

Comdat* llvm::GlobalObject::ObjComdat

protected

Definition at line 40 of file GlobalObject.h.

Referenced by getComdat().

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

include/llvm/IR/GlobalObject.h
lib/IR/Globals.cpp
lib/IR/Metadata.cpp

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ GlobalObject() [1/2]

◆ GlobalObject() [2/2]

Member Function Documentation

◆ addMetadata() [1/2]

◆ addMetadata() [2/2]

◆ addTypeMetadata()

◆ classof()

◆ clearMetadata()

◆ copyAttributesFrom()

◆ copyMetadata()

◆ eraseMetadata()

◆ getAlignment()

◆ getAllMetadata()

◆ getComdat() [1/2]

◆ getComdat() [2/2]

◆ getGlobalObjectSubClassData()

◆ getMetadata() [1/4]

◆ getMetadata() [2/4]

◆ getMetadata() [3/4]

◆ getMetadata() [4/4]

◆ getSection()

◆ hasComdat()

◆ hasMetadata() [1/3]

◆ hasMetadata() [2/3]

◆ hasMetadata() [3/3]

◆ hasSection()

◆ setAlignment()

◆ setComdat()

◆ setGlobalObjectSubClassData()

◆ setMetadata() [1/2]

◆ setMetadata() [2/2]

◆ setSection()

Member Data Documentation

◆ GlobalObjectSubClassDataBits

◆ ObjComdat