LLVM 19.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::DIVariable Class Reference

Base class for variables. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIVariable:
Inheritance graph
[legend]

Public Member Functions

unsigned getLine () const
 
DIScopegetScope () const
 
StringRef getName () const
 
DIFilegetFile () const
 
DITypegetType () const
 
uint32_t getAlignInBits () const
 
uint32_t getAlignInBytes () const
 
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
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
 
TempMDNode clone () const
 Create a (temporary) clone of this.
 
LLVMContextgetContext () const
 
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
 
unsigned getNumTemporaryUses () const
 
void replaceAllUsesWith (Metadata *MD)
 RAUW a temporary.
 
void resolveCycles ()
 Resolve cycles.
 
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.
 
bool isTBAAVtableAccess () const
 Check whether MDNode is a vtable access.
 
void printTree (raw_ostream &OS, const Module *M=nullptr) const
 Print in tree shape.
 
void printTree (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const
 
void dumpTree () const
 User-friendly dump in tree shape.
 
void dumpTree (const Module *M) const
 

Static Public Member Functions

static bool classof (const Metadata *MD)
 
- Static Public Member Functions inherited from llvm::DINode
static DIFlags getFlag (StringRef Flag)
 
static StringRef getFlagString (DIFlags Flag)
 
static 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 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 MDNodeconcatenate (MDNode *A, MDNode *B)
 Methods for metadata merging.
 
static MDNodeintersect (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericTBAA (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericFPMath (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericRange (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericAliasScope (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericAlignmentOrDereferenceable (MDNode *A, MDNode *B)
 
static MDNodegetMergedProfMetadata (MDNode *A, MDNode *B, const Instruction *AInstr, const Instruction *BInstr)
 Merge !prof metadata from two instructions.
 

Protected Member Functions

 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=std::nullopt)
 
 ~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
 MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2=std::nullopt)
 
 ~MDNode ()=default
 
void * operator new (size_t Size, size_t NumOps, StorageType Storage)
 
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.
 
void dropAllReferences ()
 
MDOperandmutable_begin ()
 
MDOperandmutable_end ()
 
mutable_op_range mutable_operands ()
 
void setOperand (unsigned I, Metadata *New)
 Set an operand.
 
unsigned getNumUnresolved () const
 
void setNumUnresolved (unsigned N)
 
void storeDistinctInContext ()
 
void resize (size_t NumOps)
 Resize the node to hold NumOps operands.
 

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

Base class for variables.

Uses the SubclassData32 Metadata slot.

Definition at line 2661 of file DebugInfoMetadata.h.

Constructor & Destructor Documentation

◆ DIVariable()

DIVariable::DIVariable ( LLVMContext C,
unsigned  ID,
StorageType  Storage,
signed  Line,
ArrayRef< Metadata * >  Ops,
uint32_t  AlignInBits = 0 
)
protected

Definition at line 1321 of file DebugInfoMetadata.cpp.

References llvm::Metadata::SubclassData32.

◆ ~DIVariable()

llvm::DIVariable::~DIVariable ( )
protecteddefault

Member Function Documentation

◆ classof()

static bool llvm::DIVariable::classof ( const Metadata MD)
inlinestatic

Definition at line 2711 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ getAlignInBits()

uint32_t llvm::DIVariable::getAlignInBits ( ) const
inline

Definition at line 2675 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData32.

Referenced by getAlignInBytes().

◆ getAlignInBytes()

uint32_t llvm::DIVariable::getAlignInBytes ( ) const
inline

◆ getDirectory()

StringRef llvm::DIVariable::getDirectory ( ) const
inline

Definition at line 2694 of file DebugInfoMetadata.h.

References F, and getFile().

◆ getFile()

DIFile * llvm::DIVariable::getFile ( ) const
inline

Definition at line 2673 of file DebugInfoMetadata.h.

References getRawFile().

Referenced by getDirectory(), getFilename(), and getSource().

◆ getFilename()

StringRef llvm::DIVariable::getFilename ( ) const
inline

Definition at line 2688 of file DebugInfoMetadata.h.

References F, and getFile().

◆ getLine()

unsigned llvm::DIVariable::getLine ( ) const
inline

Definition at line 2670 of file DebugInfoMetadata.h.

Referenced by buildFrameDebugInfo().

◆ getName()

StringRef llvm::DIVariable::getName ( ) const
inline

◆ getRawFile()

Metadata * llvm::DIVariable::getRawFile ( ) const
inline

Definition at line 2708 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getFile().

◆ getRawName()

MDString * llvm::DIVariable::getRawName ( ) const
inline

Definition at line 2707 of file DebugInfoMetadata.h.

◆ getRawScope()

Metadata * llvm::DIVariable::getRawScope ( ) const
inline

Definition at line 2706 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getScope().

◆ getRawType()

Metadata * llvm::DIVariable::getRawType ( ) const
inline

Definition at line 2709 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getSizeInBits(), and getType().

◆ getScope()

DIScope * llvm::DIVariable::getScope ( ) const
inline

◆ getSignedness()

std::optional< DIBasicType::Signedness > llvm::DIVariable::getSignedness ( ) const
inline

Return the signedness of this variable's type, or std::nullopt if this type is neither signed nor unsigned.

Definition at line 2682 of file DebugInfoMetadata.h.

References getType().

Referenced by llvm::DIExpression::getActiveBits(), and llvm::replaceAllDbgUsesWith().

◆ getSizeInBits()

std::optional< uint64_t > DIVariable::getSizeInBits ( ) const

◆ getSource()

std::optional< StringRef > llvm::DIVariable::getSource ( ) const
inline

Definition at line 2700 of file DebugInfoMetadata.h.

References F, and getFile().

◆ getType()

DIType * llvm::DIVariable::getType ( ) const
inline

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