A property of a class or structure. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIProperty:

Public Member Functions
	DEFINE_MDNODE_GET (DIProperty,(StringRef Name, DIFile File, unsigned Line, DIType Type, DINode *BackingStorage),(Name, File, Line, Type, BackingStorage)) DEFINE_MDNODE_GET(DIProperty
MDString Metadata unsigned Metadata Metadata BackingStorage TempDIProperty	clone () const
unsigned	getLine () const
StringRef	getName () const
DIFile *	getFile () const
DIType *	getType () const
DINode *	getBackingStorage () const
	The data member holding the property's backing storage, i.e.
StringRef	getFilename () const
StringRef	getDirectory () const
MDString *	getRawName () const
Metadata *	getRawFile () const
Metadata *	getRawType () const
Metadata *	getRawBackingStorage () const
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
bool	isAlwaysReplaceable () 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::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 *	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::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

A property of a class or structure.

An entity that is syntactically accessed like a data member, but whose access is implemented by invoking a user-defined or compiler-generated accessor.

Currently only the backing storage is modelled, and it must be a data member holding the property's storage.

Definition at line 4621 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 4690 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

MDString Metadata unsigned Metadata Metadata BackingStorage TempDIProperty llvm::DIProperty::clone ( ) const

inline

Definition at line 4659 of file DebugInfoMetadata.h.

References clone().

Referenced by clone().

◆ DEFINE_MDNODE_GET()

llvm::DIProperty::DEFINE_MDNODE_GET	(	DIProperty	,
		(StringRef Name, DIFile File, unsigned Line, DIType Type, DINode *BackingStorage)	,
		(Name, File, Line, Type, BackingStorage)	)

References BackingStorage, llvm::DINode::DINode(), File, Name, and Type.

◆ getBackingStorage()

DINode * llvm::DIProperty::getBackingStorage ( ) const

inline

The data member holding the property's backing storage, i.e.

the target of DW_AT_property_forward on this property's DW_TAG_property_getter child.

Definition at line 4669 of file DebugInfoMetadata.h.

References llvm::cast_or_null(), llvm::DINode::DINode(), and getRawBackingStorage().

◆ getDirectory()

StringRef llvm::DIProperty::getDirectory ( ) const

inline

Definition at line 4679 of file DebugInfoMetadata.h.

References F, and getFile().

◆ getFile()

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

inline

Definition at line 4663 of file DebugInfoMetadata.h.

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

Referenced by getDirectory(), and getFilename().

◆ getFilename()

StringRef llvm::DIProperty::getFilename ( ) const

inline

Definition at line 4673 of file DebugInfoMetadata.h.

References F, and getFile().

◆ getLine()

unsigned llvm::DIProperty::getLine ( ) const

inline

Definition at line 4661 of file DebugInfoMetadata.h.

◆ getName()

StringRef llvm::DIProperty::getName ( ) const

inline

Definition at line 4662 of file DebugInfoMetadata.h.

References llvm::DINode::getStringOperand().

◆ getRawBackingStorage()

Metadata * llvm::DIProperty::getRawBackingStorage ( ) const

inline

Definition at line 4688 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getBackingStorage().

◆ getRawFile()

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

inline

Definition at line 4686 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getFile().

◆ getRawName()

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

inline

Definition at line 4685 of file DebugInfoMetadata.h.

References llvm::DINode::getOperandAs().

◆ getRawType()

Metadata * llvm::DIProperty::getRawType ( ) const

inline

Definition at line 4687 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getType().

◆ getType()

DIType * llvm::DIProperty::getType ( ) const

inline

Definition at line 4664 of file DebugInfoMetadata.h.

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

◆ LLVMContextImpl

friend class LLVMContextImpl

friend

Definition at line 4622 of file DebugInfoMetadata.h.

References LLVMContextImpl.

Referenced by LLVMContextImpl.

◆ MDNode

friend class MDNode

friend

Definition at line 4623 of file DebugInfoMetadata.h.

References AbstractManglingParser< Derived, Alloc >::Ops, BackingStorage, C(), llvm::DINode::DINode(), File, MDNode, Name, llvm::Metadata::Storage, and Type.

Referenced by MDNode.

Member Data Documentation

◆ BackingStorage

MDString Metadata unsigned Metadata Metadata* llvm::DIProperty::BackingStorage

Definition at line 4656 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ File [1/2]

MDString Metadata* llvm::DIProperty::File

Definition at line 4655 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ File [2/2]

MDString Metadata unsigned Metadata Metadata llvm::DIProperty::File

Definition at line 4657 of file DebugInfoMetadata.h.

◆ Line [1/2]

MDString Metadata unsigned llvm::DIProperty::Line

Definition at line 4655 of file DebugInfoMetadata.h.

◆ Line [2/2]

MDString Metadata unsigned Metadata Metadata llvm::DIProperty::Line

Definition at line 4657 of file DebugInfoMetadata.h.

◆ Name [1/2]

MDString* llvm::DIProperty::Name

Definition at line 4655 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ Name [2/2]

MDString Metadata unsigned Metadata Metadata llvm::DIProperty::Name

Definition at line 4657 of file DebugInfoMetadata.h.

◆ Type [1/2]

MDString Metadata unsigned Metadata* llvm::DIProperty::Type

Definition at line 4656 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ Type [2/2]

MDString Metadata unsigned Metadata Metadata llvm::DIProperty::Type

Definition at line 4657 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
MDString *	Name
MDString Metadata *	File
MDString Metadata unsigned	Line
MDString Metadata unsigned Metadata *	Type
MDString Metadata unsigned Metadata Metadata *	BackingStorage
MDString Metadata unsigned Metadata Metadata	Name
MDString Metadata unsigned Metadata Metadata	File
MDString Metadata unsigned Metadata Metadata	Line
MDString Metadata unsigned Metadata Metadata	Type

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classof()

◆ clone()

◆ DEFINE_MDNODE_GET()

◆ getBackingStorage()

◆ getDirectory()

◆ getFile()

◆ getFilename()

◆ getLine()

◆ getName()

◆ getRawBackingStorage()

◆ getRawFile()

◆ getRawName()

◆ getRawType()

◆ getType()

Friends And Related Symbol Documentation

◆ LLVMContextImpl

◆ MDNode

Member Data Documentation

◆ BackingStorage

◆ File [1/2]

◆ File [2/2]

◆ Line [1/2]

◆ Line [2/2]

◆ Name [1/2]

◆ Name [2/2]

◆ Type [1/2]

◆ Type [2/2]