LLVM 17.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
llvm::DINode Class Reference

Tagged DWARF-like metadata node. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DINode:
Inheritance graph

Public Types

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 >

Public Member Functions

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

 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

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)


class LLVMContextImpl
class MDNode

Additional Inherited Members

- Protected Types inherited from llvm::MDNode
using mutable_op_range = iterator_range< MDOperand * >
 Active type of storage. More...

Detailed Description

Tagged DWARF-like metadata node.

A metadata node with a DWARF tag (i.e., a constant named DW_TAG_*, defined in llvm/BinaryFormat/Dwarf.h). Called DINode because it's potentially used for non-DWARF output.

Definition at line 130 of file DebugInfoMetadata.h.

Member Enumeration Documentation

◆ DIFlags

Debug info flags.

The three accessibility flags are mutually exclusive and rolled together in the first two bits.


Definition at line 169 of file DebugInfoMetadata.h.

Constructor & Destructor Documentation

◆ DINode()

llvm::DINode::DINode ( LLVMContext C,
unsigned  ID,
StorageType  Storage,
unsigned  Tag,
ArrayRef< Metadata * >  Ops1,
ArrayRef< Metadata * >  Ops2 = std::nullopt 

Definition at line 135 of file DebugInfoMetadata.h.

References assert(), and llvm::Metadata::SubclassData16.

◆ ~DINode()

llvm::DINode::~DINode ( )

Member Function Documentation

◆ classof()

static bool llvm::DINode::classof ( const Metadata MD)

Definition at line 189 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ getCanonicalMDString()

static MDString * llvm::DINode::getCanonicalMDString ( LLVMContext Context,
StringRef  S 

Definition at line 153 of file DebugInfoMetadata.h.

References Context, llvm::StringRef::empty(), and llvm::MDString::get().

◆ getFlag()

DINode::DIFlags DINode::getFlag ( StringRef  Flag)

◆ getFlagString()

StringRef DINode::getFlagString ( DIFlags  Flag)

Definition at line 288 of file DebugInfoMetadata.cpp.

◆ getOperandAs()

template<class Ty >
Ty * llvm::DINode::getOperandAs ( unsigned  I) const

Definition at line 143 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand(), and I.

◆ getStringOperand()

StringRef llvm::DINode::getStringOperand ( unsigned  I) const

◆ getTag()

dwarf::Tag DINode::getTag ( ) const

◆ setTag()

void llvm::DINode::setTag ( unsigned  Tag)

Allow subclasses to mutate the tag.

Definition at line 160 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData16.

Referenced by llvm::DIType::mutate().

◆ splitFlags()

DINode::DIFlags DINode::splitFlags ( DIFlags  Flags,
SmallVectorImpl< DIFlags > &  SplitFlags 

Split up a flags bitfield.

Split Flags into SplitFlags, a vector of its components. Returns any remaining (unrecognized) bits.

Definition at line 298 of file DebugInfoMetadata.cpp.

References A, FlagAccessibility, FlagPtrToMemberRep, Flags, and llvm::SmallVectorTemplateBase< T, bool >::push_back().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl

Definition at line 131 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode

Definition at line 132 of file DebugInfoMetadata.h.

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