Generic tagged DWARF-like metadata node. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::GenericDINode:

[legend]

Public Member Functions
unsigned	getHash () const

	DEFINE_MDNODE_GET (GenericDINode,(unsigned Tag, StringRef Header, ArrayRef< Metadata * > DwarfOps),(Tag, Header, DwarfOps)) DEFINE_MDNODE_GET(GenericDINode

unsigned MDString ArrayRef< Metadata * > DwarfOps TempGenericDINode	clone () const
	Return a (temporary) clone of this.

dwarf::Tag	getTag () const

StringRef	getHeader () const

MDString *	getRawHeader () const

op_iterator	dwarf_op_begin () const

op_iterator	dwarf_op_end () const

op_range	dwarf_operands () const

unsigned	getNumDwarfOperands () const

const MDOperand &	getDwarfOperand (unsigned I) const

void	replaceDwarfOperandWith (unsigned I, Metadata *New)

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.

LLVMContext &	getContext () 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< MDOperand >	operands () const

const MDOperand &	getOperand (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

Public Member Functions inherited from llvm::Metadata
unsigned	getMetadataID () const

void	dump () const
	User-friendly dump.

void	dump (const Module *M) const

void	print (raw_ostream &OS, const Module *M=nullptr, bool IsForDebug=false) const
	Print.

void	print (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr, bool IsForDebug=false) const

void	printAsOperand (raw_ostream &OS, const Module *M=nullptr) const
	Print as operand.

void	printAsOperand (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) 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 MDTuple *	get (LLVMContext &Context, ArrayRef< Metadata * > MDs)

static MDTuple *	getIfExists (LLVMContext &Context, ArrayRef< Metadata * > MDs)

static MDTuple *	getDistinct (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 MDNode *	concatenate (MDNode A, MDNode B)
	Methods for metadata merging.

static MDNode *	intersect (MDNode A, MDNode B)

static MDNode *	getMostGenericTBAA (MDNode A, MDNode B)

static MDNode *	getMostGenericFPMath (MDNode A, MDNode B)

static MDNode *	getMostGenericRange (MDNode A, MDNode B)

static MDNode *	getMostGenericAliasScope (MDNode A, MDNode B)

static MDNode *	getMostGenericAlignmentOrDereferenceable (MDNode A, MDNode B)

static MDNode *	getMergedProfMetadata (MDNode A, MDNode B, const Instruction AInstr, const Instruction BInstr)
	Merge !prof metadata from two instructions.

Public Attributes
unsigned	Tag

unsigned MDString *	Header

unsigned MDString ArrayRef< Metadata * >	DwarfOps

unsigned MDString ArrayRef< Metadata * >	Tag

unsigned MDString ArrayRef< Metadata * >	Header

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 >

Public Types inherited from llvm::Metadata
enum	MetadataKind

Protected Types inherited from llvm::MDNode
using	mutable_op_range = iterator_range< MDOperand * >

Protected Types inherited from llvm::Metadata
enum	StorageType { Uniqued , Distinct , Temporary }
	Active type of storage. More...

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

MDOperand *	mutable_begin ()

MDOperand *	mutable_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.

Protected Member Functions inherited from llvm::Metadata
	Metadata (unsigned ID, StorageType Storage)

	~Metadata ()=default

void	handleChangedOperand (void , Metadata )
	Default handling of a changed operand, which asserts.

Static Protected Member Functions inherited from llvm::DINode
static MDString *	getCanonicalMDString (LLVMContext &Context, StringRef S)

Static Protected Member Functions inherited from llvm::MDNode
template<class T , class StoreT >
static T *	storeImpl (T *N, StorageType Storage, StoreT &Store)

template<class T >
static T *	storeImpl (T *N, StorageType Storage)

Protected Attributes inherited from llvm::Metadata
unsigned char	Storage: 7
	Storage flag for non-uniqued, otherwise unowned, metadata.

unsigned char	SubclassData1: 1

unsigned short	SubclassData16 = 0

unsigned	SubclassData32 = 0

Detailed Description

Generic tagged DWARF-like metadata node.

An un-specialized DWARF-like metadata node. The first operand is a (possibly empty) null-separated MDString header that contains arbitrary fields. The remaining operands are dwarf_operands(), and are pointers to other metadata.

Uses the SubclassData32 Metadata slot.

Definition at line 235 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

static bool llvm::GenericDINode::classof ( const Metadata * MD )

inlinestatic

Definition at line 299 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

unsigned MDString ArrayRef< Metadata * > DwarfOps TempGenericDINode llvm::GenericDINode::clone ( ) const

inline

Return a (temporary) clone of this.

Definition at line 279 of file DebugInfoMetadata.h.

◆ DEFINE_MDNODE_GET()

llvm::GenericDINode::DEFINE_MDNODE_GET	(	GenericDINode	,
		(unsigned Tag, StringRef Header, ArrayRef< Metadata * > DwarfOps)	,
		(Tag, Header, DwarfOps)
	)

◆ dwarf_op_begin()

op_iterator llvm::GenericDINode::dwarf_op_begin ( ) const

inline

Definition at line 285 of file DebugInfoMetadata.h.

References llvm::MDNode::op_begin().

Referenced by dwarf_operands().

◆ dwarf_op_end()

op_iterator llvm::GenericDINode::dwarf_op_end ( ) const

inline

Definition at line 286 of file DebugInfoMetadata.h.

References llvm::MDNode::op_end().

Referenced by dwarf_operands().

◆ dwarf_operands()

op_range llvm::GenericDINode::dwarf_operands ( ) const

inline

Definition at line 287 of file DebugInfoMetadata.h.

References dwarf_op_begin(), and dwarf_op_end().

◆ getDwarfOperand()

const MDOperand & llvm::GenericDINode::getDwarfOperand ( unsigned I ) const

inline

Definition at line 292 of file DebugInfoMetadata.h.

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

◆ getHash()

unsigned llvm::GenericDINode::getHash ( ) const

inline

Definition at line 267 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData32.

◆ getHeader()

StringRef llvm::GenericDINode::getHeader ( ) const

inline

Definition at line 282 of file DebugInfoMetadata.h.

References llvm::DINode::getStringOperand().

◆ getNumDwarfOperands()

unsigned llvm::GenericDINode::getNumDwarfOperands ( ) const

inline

Definition at line 291 of file DebugInfoMetadata.h.

References llvm::MDNode::getNumOperands().

◆ getRawHeader()

MDString * llvm::GenericDINode::getRawHeader ( ) const

inline

Definition at line 283 of file DebugInfoMetadata.h.

◆ getTag()

dwarf::Tag GenericDINode::getTag ( ) const

Definition at line 391 of file DebugInfoMetadata.cpp.

References llvm::Metadata::SubclassData16.

◆ replaceDwarfOperandWith()

void llvm::GenericDINode::replaceDwarfOperandWith	(	unsigned	I,
		Metadata *	New
	)

inline

Definition at line 295 of file DebugInfoMetadata.h.

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

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl

friend

Definition at line 236 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode

friend

Definition at line 237 of file DebugInfoMetadata.h.

Member Data Documentation

◆ DwarfOps

unsigned MDString ArrayRef<Metadata *> llvm::GenericDINode::DwarfOps

Definition at line 275 of file DebugInfoMetadata.h.

◆ Header [1/2]

unsigned MDString* llvm::GenericDINode::Header

Definition at line 274 of file DebugInfoMetadata.h.

◆ Header [2/2]

unsigned MDString ArrayRef<Metadata *> llvm::GenericDINode::Header

Definition at line 276 of file DebugInfoMetadata.h.

◆ Tag [1/2]

unsigned llvm::GenericDINode::Tag

Definition at line 274 of file DebugInfoMetadata.h.

◆ Tag [2/2]

unsigned MDString ArrayRef<Metadata *> llvm::GenericDINode::Tag

Definition at line 276 of file DebugInfoMetadata.h.

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

include/llvm/IR/DebugInfoMetadata.h
lib/IR/DebugInfoMetadata.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classof()

◆ clone()

◆ DEFINE_MDNODE_GET()

◆ dwarf_op_begin()

◆ dwarf_op_end()

◆ dwarf_operands()

◆ getDwarfOperand()

◆ getHash()

◆ getHeader()

◆ getNumDwarfOperands()

◆ getRawHeader()

◆ getTag()

◆ replaceDwarfOperandWith()

Friends And Related Function Documentation

◆ LLVMContextImpl

◆ MDNode

Member Data Documentation

◆ DwarfOps

◆ Header [1/2]

◆ Header [2/2]

◆ Tag [1/2]

◆ Tag [2/2]