Debug common block. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DICommonBlock:

Public Member Functions
	DEFINE_MDNODE_GET (DICommonBlock,(DIScope Scope, DIGlobalVariable Decl, StringRef Name, DIFile *File, unsigned LineNo),(Scope, Decl, Name, File, LineNo)) DEFINE_MDNODE_GET(DICommonBlock
Metadata Metadata MDString Metadata unsigned LineNo TempDICommonBlock	clone () const
DIScope *	getScope () const
DIGlobalVariable *	getDecl () const
StringRef	getName () const
DIFile *	getFile () const
unsigned	getLineNo () const
Metadata *	getRawScope () const
Metadata *	getRawDecl () const
MDString *	getRawName () const
Metadata *	getRawFile () const
Public Member Functions inherited from llvm::DIScope
DIFile *	getFile () const
StringRef	getFilename () const
StringRef	getDirectory () const
std::optional< StringRef >	getSource () const
LLVM_ABI StringRef	getName () const
LLVM_ABI DIScope *	getScope () const
Metadata *	getRawFile () const
	Return the raw underlying file.
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.
LLVMContext &	getContext () 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
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< MDOperand >	operands () const
const MDOperand &	getOperand (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
Public Member Functions inherited from llvm::Metadata
unsigned	getMetadataID () const
LLVM_ABI void	dump () const
	User-friendly dump.
LLVM_ABI void	dump (const Module *M) const
LLVM_ABI void	print (raw_ostream &OS, const Module *M=nullptr, bool IsForDebug=false) const
	Print.
LLVM_ABI void	print (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr, bool IsForDebug=false) const
LLVM_ABI void	printAsOperand (raw_ostream &OS, const Module *M=nullptr) const
	Print as operand.
LLVM_ABI 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::DIScope
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 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 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 MDNode *	concatenate (MDNode A, MDNode B)
	Methods for metadata merging.
static LLVM_ABI MDNode *	intersect (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericTBAA (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericFPMath (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericRange (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericNoaliasAddrspace (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericAliasScope (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericAlignmentOrDereferenceable (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericNoFPClass (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMergedProfMetadata (MDNode A, MDNode B, const Instruction AInstr, const Instruction BInstr)
	Merge !prof metadata from two instructions.
static LLVM_ABI MDNode *	getMergedMemProfMetadata (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMergedCallsiteMetadata (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMergedCalleeTypeMetadata (const MDNode A, const MDNode B)
static LLVM_ABI MDNode *	getMergedCalleesMetadata (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMergedAllocTokenMetadata (const MDNode A, const MDNode B)
static LLVM_ABI CaptureComponents	toCaptureComponents (const MDNode *MD)
	Convert !captures metadata to CaptureComponents. MD may be nullptr.
static LLVM_ABI MDNode *	fromCaptureComponents (LLVMContext &Ctx, CaptureComponents CC)
	Convert CaptureComponents to !captures metadata.

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
Static Public Attributes inherited from llvm::Metadata
static constexpr const unsigned	PoisonGeneratingIDs []
	Metadata IDs that may generate poison.
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::DIScope
	DIScope (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops)
	~DIScope ()=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 ()
MDOperand *	mutable_begin ()
MDOperand *	mutable_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.
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

Debug common block.

Uses the SubclassData32 Metadata slot.

Definition at line 4313 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

bool llvm::DICommonBlock::classof ( const Metadata * MD )

inlinestatic

Definition at line 4363 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

Metadata Metadata MDString Metadata unsigned LineNo TempDICommonBlock llvm::DICommonBlock::clone ( ) const

inline

Definition at line 4348 of file DebugInfoMetadata.h.

References clone().

Referenced by clone().

◆ DEFINE_MDNODE_GET()

llvm::DICommonBlock::DEFINE_MDNODE_GET	(	DICommonBlock	,
		(DIScope Scope, DIGlobalVariable Decl, StringRef Name, DIFile *File, unsigned LineNo)	,
		(Scope, Decl, Name, File, LineNo)	)

References Decl, llvm::DIScope::DIScope(), File, LineNo, Name, and Scope.

◆ getDecl()

DIGlobalVariable * llvm::DICommonBlock::getDecl ( ) const

inline

Definition at line 4351 of file DebugInfoMetadata.h.

References llvm::cast_or_null(), and getRawDecl().

Referenced by llvm::DwarfCompileUnit::getOrCreateCommonBlock().

◆ getFile()

DIFile * llvm::DICommonBlock::getFile ( ) const

inline

Definition at line 4355 of file DebugInfoMetadata.h.

References llvm::cast_or_null(), and getRawFile().

Referenced by llvm::DwarfCompileUnit::getOrCreateCommonBlock().

◆ getLineNo()

unsigned llvm::DICommonBlock::getLineNo ( ) const

inline

Definition at line 4356 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData32.

Referenced by llvm::DwarfCompileUnit::getOrCreateCommonBlock().

◆ getName()

StringRef llvm::DICommonBlock::getName ( ) const

inline

Definition at line 4354 of file DebugInfoMetadata.h.

References llvm::DINode::getStringOperand().

Referenced by llvm::DwarfCompileUnit::getOrCreateCommonBlock().

◆ getRawDecl()

Metadata * llvm::DICommonBlock::getRawDecl ( ) const

inline

Definition at line 4359 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getDecl().

◆ getRawFile()

Metadata * llvm::DICommonBlock::getRawFile ( ) const

inline

Definition at line 4361 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getFile().

◆ getRawName()

MDString * llvm::DICommonBlock::getRawName ( ) const

inline

Definition at line 4360 of file DebugInfoMetadata.h.

References llvm::DINode::getOperandAs().

◆ getRawScope()

Metadata * llvm::DICommonBlock::getRawScope ( ) const

inline

Definition at line 4358 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getScope().

◆ getScope()

DIScope * llvm::DICommonBlock::getScope ( ) const

inline

Definition at line 4350 of file DebugInfoMetadata.h.

References llvm::cast_or_null(), llvm::DIScope::DIScope(), and getRawScope().

Referenced by llvm::DwarfCompileUnit::getOrCreateCommonBlock().

◆ LLVMContextImpl

friend class LLVMContextImpl

friend

Definition at line 4314 of file DebugInfoMetadata.h.

References LLVMContextImpl.

Referenced by LLVMContextImpl.

◆ MDNode

friend class MDNode

friend

Definition at line 4315 of file DebugInfoMetadata.h.

References AbstractManglingParser< Derived, Alloc >::Ops, Decl, llvm::DIScope::DIScope(), File, LineNo, MDNode, Name, Scope, and llvm::Metadata::Storage.

Referenced by MDNode.

Member Data Documentation

◆ Decl [1/2]

Metadata Metadata* llvm::DICommonBlock::Decl

Definition at line 4344 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ Decl [2/2]

Metadata Metadata MDString Metadata unsigned llvm::DICommonBlock::Decl

Definition at line 4346 of file DebugInfoMetadata.h.

◆ File [1/2]

Metadata Metadata MDString Metadata* llvm::DICommonBlock::File

Definition at line 4345 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ File [2/2]

Metadata Metadata MDString Metadata unsigned llvm::DICommonBlock::File

Definition at line 4346 of file DebugInfoMetadata.h.

◆ LineNo

Metadata Metadata MDString Metadata unsigned llvm::DICommonBlock::LineNo

Definition at line 4345 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ Name [1/2]

Metadata Metadata MDString* llvm::DICommonBlock::Name

Definition at line 4344 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ Name [2/2]

Metadata Metadata MDString Metadata unsigned llvm::DICommonBlock::Name

Definition at line 4346 of file DebugInfoMetadata.h.

◆ Scope [1/2]

Metadata* llvm::DICommonBlock::Scope

Definition at line 4344 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ Scope [2/2]

Metadata Metadata MDString Metadata unsigned llvm::DICommonBlock::Scope

Definition at line 4346 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 Attributes
Metadata *	Scope
Metadata Metadata *	Decl
Metadata Metadata MDString *	Name
Metadata Metadata MDString Metadata *	File
Metadata Metadata MDString Metadata unsigned	LineNo
Metadata Metadata MDString Metadata unsigned	Scope
Metadata Metadata MDString Metadata unsigned	Decl
Metadata Metadata MDString Metadata unsigned	Name
Metadata Metadata MDString Metadata unsigned	File

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classof()

◆ clone()

◆ DEFINE_MDNODE_GET()

◆ getDecl()

◆ getFile()

◆ getLineNo()

◆ getName()

◆ getRawDecl()

◆ getRawFile()

◆ getRawName()

◆ getRawScope()

◆ getScope()

Friends And Related Symbol Documentation

◆ LLVMContextImpl

◆ MDNode

Member Data Documentation

◆ Decl [1/2]

◆ Decl [2/2]

◆ File [1/2]

◆ File [2/2]

◆ LineNo

◆ Name [1/2]

◆ Name [2/2]

◆ Scope [1/2]

◆ Scope [2/2]