LLVM 22.0.0git
llvm::DIGlobalVariable Class Reference

Global variables. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIGlobalVariable:
[legend]

Public Member Functions

 DEFINE_MDNODE_GET (DIGlobalVariable,(DIScope *Scope, StringRef Name, StringRef LinkageName, DIFile *File, unsigned Line, DIType *Type, bool IsLocalToUnit, bool IsDefinition, DIDerivedType *StaticDataMemberDeclaration, MDTuple *TemplateParams, uint32_t AlignInBits, DINodeArray Annotations),(Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition, StaticDataMemberDeclaration, TemplateParams, AlignInBits, Annotations)) DEFINE_MDNODE_GET(DIGlobalVariable
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata Annotations TempDIGlobalVariable clone () const
bool isLocalToUnit () const
bool isDefinition () const
StringRef getDisplayName () const
StringRef getLinkageName () const
DIDerivedTypegetStaticDataMemberDeclaration () const
DINodeArray getAnnotations () const
MDStringgetRawLinkageName () const
MetadatagetRawStaticDataMemberDeclaration () const
MetadatagetRawTemplateParams () const
MDTuplegetTemplateParams () const
MetadatagetRawAnnotations () const
Public Member Functions inherited from llvm::DIVariable
unsigned getLine () const
DIScopegetScope () const
StringRef getName () const
DIFilegetFile () const
DITypegetType () const
uint32_t getAlignInBits () const
uint32_t getAlignInBytes () const
LLVM_ABI std::optional< uint64_tgetSizeInBits () const
 Determines the size of the variable's type.
std::optional< DIBasicType::SignednessgetSignedness () const
 Return the signedness of this variable's type, or std::nullopt if this type is neither signed nor unsigned.
StringRef getFilename () const
StringRef getDirectory () const
std::optional< StringRefgetSource () const
MetadatagetRawScope () const
MDStringgetRawName () const
MetadatagetRawFile () const
MetadatagetRawType () const
Public Member Functions inherited from llvm::DINode
LLVM_ABI dwarf::Tag getTag () const
Public Member Functions inherited from llvm::MDNode
 MDNode (const MDNode &)=delete
void operator= (const MDNode &)=delete
void * operator new (size_t)=delete
LLVM_ABI TempMDNode clone () const
 Create a (temporary) clone of this.
LLVMContextgetContext () const
LLVM_ABI void replaceOperandWith (unsigned I, Metadata *New)
 Replace a specific operand.
bool isResolved () const
 Check if node is fully resolved.
bool isUniqued () const
bool isDistinct () const
bool isTemporary () const
bool isReplaceable () const
bool isAlwaysReplaceable () const
bool hasGeneralizedMDString ()
 Check if this is a valid generalized type metadata node.
unsigned getNumTemporaryUses () const
void replaceAllUsesWith (Metadata *MD)
 RAUW a temporary.
LLVM_ABI void resolveCycles ()
 Resolve cycles.
LLVM_ABI void resolve ()
 Resolve a unique, unresolved node.
op_iterator op_begin () const
op_iterator op_end () const
ArrayRef< MDOperandoperands () const
const MDOperandgetOperand (unsigned I) const
unsigned getNumOperands () const
 Return number of MDNode operands.
LLVM_ABI bool isTBAAVtableAccess () const
 Check whether MDNode is a vtable access.
LLVM_ABI void printTree (raw_ostream &OS, const Module *M=nullptr) const
 Print in tree shape.
LLVM_ABI void printTree (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const
LLVM_ABI void dumpTree () const
 User-friendly dump in tree shape.
LLVM_ABI void dumpTree (const Module *M) const

Static Public Member Functions

static bool classof (const Metadata *MD)
Static Public Member Functions inherited from llvm::DIVariable
static bool classof (const Metadata *MD)
Static Public Member Functions inherited from llvm::DINode
static LLVM_ABI DIFlags getFlag (StringRef Flag)
static LLVM_ABI StringRef getFlagString (DIFlags Flag)
static LLVM_ABI DIFlags splitFlags (DIFlags Flags, SmallVectorImpl< DIFlags > &SplitFlags)
 Split up a flags bitfield.
static bool classof (const Metadata *MD)
Static Public Member Functions inherited from llvm::MDNode
static MDTupleget (LLVMContext &Context, ArrayRef< Metadata * > MDs)
static MDTuplegetIfExists (LLVMContext &Context, ArrayRef< Metadata * > MDs)
static MDTuplegetDistinct (LLVMContext &Context, ArrayRef< Metadata * > MDs)
static TempMDTuple getTemporary (LLVMContext &Context, ArrayRef< Metadata * > MDs)
static LLVM_ABI void deleteTemporary (MDNode *N)
 Deallocate a node created by getTemporary.
template<class T>
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > replaceWithPermanent (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a permanent one.
template<class T>
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > replaceWithUniqued (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a uniqued one.
template<class T>
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > replaceWithDistinct (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a distinct one.
static bool classof (const Metadata *MD)
 Methods for support type inquiry through isa, cast, and dyn_cast:
static LLVM_ABI MDNodeconcatenate (MDNode *A, MDNode *B)
 Methods for metadata merging.
static LLVM_ABI MDNodeintersect (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericTBAA (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericFPMath (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericRange (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericNoaliasAddrspace (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericAliasScope (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericAlignmentOrDereferenceable (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMergedProfMetadata (MDNode *A, MDNode *B, const Instruction *AInstr, const Instruction *BInstr)
 Merge !prof metadata from two instructions.
static LLVM_ABI MDNodegetMergedMemProfMetadata (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMergedCallsiteMetadata (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMergedCalleeTypeMetadata (const MDNode *A, const MDNode *B)

Public Attributes

MetadataScope
Metadata MDStringName
Metadata MDString MDStringLinkageName
Metadata MDString MDString MetadataFile
Metadata MDString MDString Metadata unsigned Line
Metadata MDString MDString Metadata unsigned MetadataType
Metadata MDString MDString Metadata unsigned Metadata bool IsLocalToUnit
Metadata MDString MDString Metadata unsigned Metadata bool bool IsDefinition
Metadata MDString MDString Metadata unsigned Metadata bool bool MetadataStaticDataMemberDeclaration
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata MetadataTemplateParams
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t AlignInBits
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t MetadataAnnotations
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata Scope
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata Name
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata LinkageName
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata File
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata Line
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata Type
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata IsLocalToUnit
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata IsDefinition
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata StaticDataMemberDeclaration
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata TemplateParams
Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata AlignInBits

Friends

class LLVMContextImpl
class MDNode

Additional Inherited Members

Public Types inherited from llvm::DINode
enum  DIFlags : uint32_t { FlagAccessibility = FlagPrivate | FlagProtected | FlagPublic , FlagPtrToMemberRep }
 Debug info flags. More...
Public Types inherited from llvm::MDNode
using op_iterator = const MDOperand *
using op_range = iterator_range<op_iterator>
Protected Types inherited from llvm::MDNode
using mutable_op_range = iterator_range<MDOperand *>
 Active type of storage. More...
Protected Member Functions inherited from llvm::DIVariable
LLVM_ABI DIVariable (LLVMContext &C, unsigned ID, StorageType Storage, signed Line, ArrayRef< Metadata * > Ops, uint32_t AlignInBits=0)
 ~DIVariable ()=default
Protected Member Functions inherited from llvm::DINode
 DINode (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2={})
 ~DINode ()=default
template<class Ty>
Ty * getOperandAs (unsigned I) const
StringRef getStringOperand (unsigned I) const
void setTag (unsigned Tag)
 Allow subclasses to mutate the tag.
Protected Member Functions inherited from llvm::MDNode
LLVM_ABI MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2={})
 ~MDNode ()=default
LLVM_ABI void * operator new (size_t Size, size_t NumOps, StorageType Storage)
LLVM_ABI void operator delete (void *Mem)
void operator delete (void *, unsigned)
 Required by std, but never called.
void operator delete (void *, unsigned, bool)
 Required by std, but never called.
LLVM_ABI void dropAllReferences ()
MDOperandmutable_begin ()
MDOperandmutable_end ()
mutable_op_range mutable_operands ()
LLVM_ABI void setOperand (unsigned I, Metadata *New)
 Set an operand.
unsigned getNumUnresolved () const
void setNumUnresolved (unsigned N)
LLVM_ABI void storeDistinctInContext ()
void resize (size_t NumOps)
 Resize the node to hold NumOps operands.
Static Protected Member Functions inherited from llvm::DINode
static MDStringgetCanonicalMDString (LLVMContext &Context, StringRef S)
Static Protected Member Functions inherited from llvm::MDNode
template<class T, class StoreT>
static TstoreImpl (T *N, StorageType Storage, StoreT &Store)
template<class T>
static TstoreImpl (T *N, StorageType Storage)

Detailed Description

Global variables.

TODO: Remove DisplayName. It's always equal to Name.

Definition at line 3860 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

bool llvm::DIGlobalVariable::classof ( const Metadata * MD)
inlinestatic

Definition at line 3940 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata Annotations TempDIGlobalVariable llvm::DIGlobalVariable::clone ( ) const
inline

Definition at line 3921 of file DebugInfoMetadata.h.

References clone().

Referenced by clone().

◆ DEFINE_MDNODE_GET()

◆ getAnnotations()

DINodeArray llvm::DIGlobalVariable::getAnnotations ( ) const
inline

◆ getDisplayName()

StringRef llvm::DIGlobalVariable::getDisplayName ( ) const
inline

◆ getLinkageName()

StringRef llvm::DIGlobalVariable::getLinkageName ( ) const
inline

◆ getRawAnnotations()

Metadata * llvm::DIGlobalVariable::getRawAnnotations ( ) const
inline

Definition at line 3938 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getAnnotations().

◆ getRawLinkageName()

MDString * llvm::DIGlobalVariable::getRawLinkageName ( ) const
inline

Definition at line 3934 of file DebugInfoMetadata.h.

References llvm::DINode::getOperandAs().

◆ getRawStaticDataMemberDeclaration()

Metadata * llvm::DIGlobalVariable::getRawStaticDataMemberDeclaration ( ) const
inline

Definition at line 3935 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getStaticDataMemberDeclaration().

◆ getRawTemplateParams()

Metadata * llvm::DIGlobalVariable::getRawTemplateParams ( ) const
inline

Definition at line 3936 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

◆ getStaticDataMemberDeclaration()

DIDerivedType * llvm::DIGlobalVariable::getStaticDataMemberDeclaration ( ) const
inline

◆ getTemplateParams()

MDTuple * llvm::DIGlobalVariable::getTemplateParams ( ) const
inline

◆ isDefinition()

bool llvm::DIGlobalVariable::isDefinition ( ) const
inline

◆ isLocalToUnit()

bool llvm::DIGlobalVariable::isLocalToUnit ( ) const
inline

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 3861 of file DebugInfoMetadata.h.

References LLVMContextImpl.

Referenced by LLVMContextImpl.

◆ MDNode

Member Data Documentation

◆ AlignInBits [1/2]

Definition at line 3917 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ AlignInBits [2/2]

Definition at line 3919 of file DebugInfoMetadata.h.

◆ Annotations

Definition at line 3917 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET().

◆ File [1/2]

Metadata MDString MDString Metadata* llvm::DIGlobalVariable::File

Definition at line 3914 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET().

◆ File [2/2]

◆ IsDefinition [1/2]

Metadata MDString MDString Metadata unsigned Metadata bool bool llvm::DIGlobalVariable::IsDefinition

Definition at line 3915 of file DebugInfoMetadata.h.

◆ IsDefinition [2/2]

Definition at line 3918 of file DebugInfoMetadata.h.

◆ IsLocalToUnit [1/2]

Metadata MDString MDString Metadata unsigned Metadata bool llvm::DIGlobalVariable::IsLocalToUnit

Definition at line 3915 of file DebugInfoMetadata.h.

◆ IsLocalToUnit [2/2]

Definition at line 3918 of file DebugInfoMetadata.h.

◆ Line [1/2]

Metadata MDString MDString Metadata unsigned llvm::DIGlobalVariable::Line

Definition at line 3915 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ Line [2/2]

◆ LinkageName [1/2]

Metadata MDString MDString* llvm::DIGlobalVariable::LinkageName

Definition at line 3914 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET().

◆ LinkageName [2/2]

Definition at line 3918 of file DebugInfoMetadata.h.

◆ Name [1/2]

Metadata MDString* llvm::DIGlobalVariable::Name

Definition at line 3914 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET().

◆ Name [2/2]

◆ Scope [1/2]

Metadata* llvm::DIGlobalVariable::Scope

Definition at line 3914 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET().

◆ Scope [2/2]

◆ StaticDataMemberDeclaration [1/2]

Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata* llvm::DIGlobalVariable::StaticDataMemberDeclaration

Definition at line 3916 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET().

◆ StaticDataMemberDeclaration [2/2]

Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata uint32_t Metadata llvm::DIGlobalVariable::StaticDataMemberDeclaration

Definition at line 3919 of file DebugInfoMetadata.h.

◆ TemplateParams [1/2]

Metadata MDString MDString Metadata unsigned Metadata bool bool Metadata Metadata* llvm::DIGlobalVariable::TemplateParams

Definition at line 3916 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET().

◆ TemplateParams [2/2]

Definition at line 3919 of file DebugInfoMetadata.h.

◆ Type [1/2]

Metadata MDString MDString Metadata unsigned Metadata* llvm::DIGlobalVariable::Type

Definition at line 3915 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET().

◆ Type [2/2]


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