LLVM 20.0.0git
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::DILocalVariable Class Reference

Local variable. More...

#include "llvm/IR/DebugInfoMetadata.h"

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

Public Member Functions

 DEFINE_MDNODE_GET (DILocalVariable,(DILocalScope *Scope, StringRef Name, DIFile *File, unsigned Line, DIType *Type, unsigned Arg, DIFlags Flags, uint32_t AlignInBits, DINodeArray Annotations),(Scope, Name, File, Line, Type, Arg, Flags, AlignInBits, Annotations)) DEFINE_MDNODE_GET(DILocalVariable
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata Annotations TempDILocalVariable clone () const
 
DILocalScopegetScope () const
 Get the local scope for this variable.
 
bool isParameter () const
 
unsigned getArg () const
 
DIFlags getFlags () const
 
DINodeArray getAnnotations () const
 
MetadatagetRawAnnotations () const
 
bool isArtificial () const
 
bool isObjectPointer () const
 
bool isValidLocationForIntrinsic (const DILocation *DL) const
 Check that a location is valid for this variable.
 
- 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
 
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::DIVariable
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.
 

Public Attributes

MetadataScope
 
Metadata MDStringName
 
Metadata MDString MetadataFile
 
Metadata MDString Metadata unsigned Line
 
Metadata MDString Metadata unsigned MetadataType
 
Metadata MDString Metadata unsigned Metadata unsigned Arg
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags Flags
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t AlignInBits
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t MetadataAnnotations
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata Scope
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata Name
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata File
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata Line
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata Type
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata Arg
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata Flags
 
Metadata MDString Metadata unsigned Metadata unsigned DIFlags 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
 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.
 
- 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

Local variable.

TODO: Split up flags.

Definition at line 3423 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

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

Definition at line 3506 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata Annotations TempDILocalVariable llvm::DILocalVariable::clone ( ) const
inline

Definition at line 3476 of file DebugInfoMetadata.h.

◆ DEFINE_MDNODE_GET()

llvm::DILocalVariable::DEFINE_MDNODE_GET ( DILocalVariable  ,
(DILocalScope *Scope, StringRef Name, DIFile *File, unsigned Line, DIType *Type, unsigned Arg, DIFlags Flags, uint32_t AlignInBits, DINodeArray Annotations ,
(Scope, Name, File, Line, Type, Arg, Flags, AlignInBits, Annotations  
)

◆ getAnnotations()

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

Definition at line 3489 of file DebugInfoMetadata.h.

References getRawAnnotations().

◆ getArg()

unsigned llvm::DILocalVariable::getArg ( ) const
inline

Definition at line 3486 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfFile::addScopeVariable().

◆ getFlags()

DIFlags llvm::DILocalVariable::getFlags ( ) const
inline

Definition at line 3487 of file DebugInfoMetadata.h.

Referenced by isArtificial(), and isObjectPointer().

◆ getRawAnnotations()

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

Definition at line 3492 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getAnnotations().

◆ getScope()

DILocalScope * llvm::DILocalVariable::getScope ( ) const
inline

Get the local scope for this variable.

Variables must be defined in a local scope.

Definition at line 3481 of file DebugInfoMetadata.h.

References llvm::DIVariable::getScope().

Referenced by llvm::DebugHandlerBase::beginFunction(), buildFrameDebugInfo(), TransferTracker::emitMOLoc(), isValidLocationForIntrinsic(), and llvm::DebugInfoFinder::processVariable().

◆ isArtificial()

bool llvm::DILocalVariable::isArtificial ( ) const
inline

Definition at line 3494 of file DebugInfoMetadata.h.

References getFlags().

◆ isObjectPointer()

bool llvm::DILocalVariable::isObjectPointer ( ) const
inline

Definition at line 3495 of file DebugInfoMetadata.h.

References getFlags().

◆ isParameter()

bool llvm::DILocalVariable::isParameter ( ) const
inline

◆ isValidLocationForIntrinsic()

bool llvm::DILocalVariable::isValidLocationForIntrinsic ( const DILocation DL) const
inline

Check that a location is valid for this variable.

Check that DL exists, is in the same subprogram, and has the same inlined-at location as this. (Otherwise, it's not a valid attachment to a DbgInfoIntrinsic.)

Definition at line 3502 of file DebugInfoMetadata.h.

References DL, getScope(), and llvm::DILocalScope::getSubprogram().

Referenced by llvm::calculateDbgEntityHistory(), llvm::FastISel::lowerDbgDeclare(), llvm::SelectionDAGBuilder::resolveDanglingDebugInfo(), and llvm::FastISel::selectIntrinsicCall().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 3424 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode
friend

Definition at line 3425 of file DebugInfoMetadata.h.

Member Data Documentation

◆ AlignInBits [1/2]

Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t llvm::DILocalVariable::AlignInBits

Definition at line 3472 of file DebugInfoMetadata.h.

◆ AlignInBits [2/2]

Definition at line 3473 of file DebugInfoMetadata.h.

◆ Annotations

Definition at line 3472 of file DebugInfoMetadata.h.

◆ Arg [1/2]

Metadata MDString Metadata unsigned Metadata unsigned llvm::DILocalVariable::Arg

Definition at line 3471 of file DebugInfoMetadata.h.

◆ Arg [2/2]

Definition at line 3473 of file DebugInfoMetadata.h.

◆ File [1/2]

Metadata MDString Metadata* llvm::DILocalVariable::File

Definition at line 3470 of file DebugInfoMetadata.h.

◆ File [2/2]

Definition at line 3473 of file DebugInfoMetadata.h.

◆ Flags [1/2]

Metadata MDString Metadata unsigned Metadata unsigned DIFlags llvm::DILocalVariable::Flags

Definition at line 3471 of file DebugInfoMetadata.h.

◆ Flags [2/2]

Definition at line 3473 of file DebugInfoMetadata.h.

◆ Line [1/2]

Metadata MDString Metadata unsigned llvm::DILocalVariable::Line

Definition at line 3471 of file DebugInfoMetadata.h.

◆ Line [2/2]

Definition at line 3473 of file DebugInfoMetadata.h.

◆ Name [1/2]

Metadata MDString* llvm::DILocalVariable::Name

Definition at line 3470 of file DebugInfoMetadata.h.

◆ Name [2/2]

Definition at line 3473 of file DebugInfoMetadata.h.

◆ Scope [1/2]

Metadata* llvm::DILocalVariable::Scope

Definition at line 3470 of file DebugInfoMetadata.h.

◆ Scope [2/2]

Definition at line 3473 of file DebugInfoMetadata.h.

◆ Type [1/2]

Metadata MDString Metadata unsigned Metadata* llvm::DILocalVariable::Type

Definition at line 3471 of file DebugInfoMetadata.h.

◆ Type [2/2]

Definition at line 3473 of file DebugInfoMetadata.h.


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