Base class for variables. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIVariable:

[legend]

Collaboration diagram for llvm::DIVariable:

[legend]

Public Member Functions
unsigned	getLine () const

DIScope *	getScope () const

StringRef	getName () const

DIFile *	getFile () const

DITypeRef	getType () const

uint32_t	getAlignInBits () const

uint32_t	getAlignInBytes () const

Optional< uint64_t >	getSizeInBits () const
	Determines the size of the variable's type. More...

Optional< DIBasicType::Signedness >	getSignedness () const
	Return the signedness of this variable's type, or None if this type is neither signed nor unsigned. More...

StringRef	getFilename () const

StringRef	getDirectory () const

Optional< StringRef >	getSource () const

Metadata *	getRawScope () const

MDString *	getRawName () const

Metadata *	getRawFile () const

Metadata *	getRawType () const

Public Member Functions inherited from llvm::DINode
unsigned	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. More...

LLVMContext &	getContext () const

void	replaceOperandWith (unsigned I, Metadata *New)
	Replace a specific operand. More...

bool	isResolved () const
	Check if node is fully resolved. More...

bool	isUniqued () const

bool	isDistinct () const

bool	isTemporary () const

void	replaceAllUsesWith (Metadata *MD)
	RAUW a temporary. More...

void	resolveCycles ()
	Resolve cycles. More...

void	resolve ()
	Resolve a unique, unresolved node. More...

op_iterator	op_begin () const

op_iterator	op_end () const

op_range	operands () const

const MDOperand &	getOperand (unsigned I) const

unsigned	getNumOperands () const
	Return number of MDNode operands. More...

bool	isTBAAVtableAccess () const
	Check whether MDNode is a vtable access. More...

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

void	dump () const
	User-friendly dump. More...

void	dump (const Module *M) const

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

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

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

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

template<class T >
static std::enable_if< std::is_base_of< MDNode, T >::value, T * >::type	replaceWithPermanent (std::unique_ptr< T, TempMDNodeDeleter > N)
	Replace a temporary node with a permanent one. More...

template<class T >
static std::enable_if< std::is_base_of< MDNode, T >::value, T * >::type	replaceWithUniqued (std::unique_ptr< T, TempMDNodeDeleter > N)
	Replace a temporary node with a uniqued one. More...

template<class T >
static std::enable_if< std::is_base_of< MDNode, T >::value, T * >::type	replaceWithDistinct (std::unique_ptr< T, TempMDNodeDeleter > N)
	Replace a temporary node with a distinct one. More...

static bool	classof (const Metadata *MD)
	Methods for support type inquiry through isa, cast, and dyn_cast: More...

static MDNode *	concatenate (MDNode A, MDNode B)
	Methods for metadata merging. More...

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)

Protected Member Functions
	DIVariable (LLVMContext &C, unsigned ID, StorageType Storage, unsigned 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=None)

	~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. More...

Protected Member Functions inherited from llvm::MDNode
	MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata > Ops1, ArrayRef< Metadata > Ops2=None)

	~MDNode ()=default

void *	operator new (size_t Size, unsigned NumOps)

void	operator delete (void *Mem)

void	operator delete (void *, unsigned)
	Required by std, but never called. More...

void	operator delete (void *, unsigned, bool)
	Required by std, but never called. More...

void	dropAllReferences ()

MDOperand *	mutable_begin ()

MDOperand *	mutable_end ()

mutable_op_range	mutable_operands ()

void	setOperand (unsigned I, Metadata *New)
	Set an operand. More...

void	storeDistinctInContext ()

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

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

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

unsigned char	ImplicitCode: 1

unsigned short	SubclassData16 = 0

unsigned	SubclassData32 = 0

Detailed Description

Base class for variables.

Definition at line 2275 of file DebugInfoMetadata.h.

Constructor & Destructor Documentation

◆ DIVariable()

llvm::DIVariable::DIVariable	(	LLVMContext &	C,
		unsigned	ID,
		StorageType	Storage,
		unsigned	Line,
		ArrayRef< Metadata *>	Ops,
		uint32_t	AlignInBits = `0`
	)

inlineprotected

Definition at line 2280 of file DebugInfoMetadata.h.

◆ ~DIVariable()

llvm::DIVariable::~DIVariable ( )

protecteddefault

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 2328 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ getAlignInBits()

uint32_t llvm::DIVariable::getAlignInBits ( ) const

inline

Definition at line 2292 of file DebugInfoMetadata.h.

Referenced by llvm::MDNodeKeyImpl< DIGlobalVariable >::isKeyOf(), llvm::MDNodeKeyImpl< DILocalVariable >::isKeyOf(), and rotateSign().

◆ getAlignInBytes()

uint32_t llvm::DIVariable::getAlignInBytes ( ) const

inline

Definition at line 2293 of file DebugInfoMetadata.h.

References llvm::getSizeInBits().

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

◆ getDirectory()

StringRef llvm::DIVariable::getDirectory ( ) const

inline

Definition at line 2311 of file DebugInfoMetadata.h.

References F().

◆ getFile()

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

inline

Definition at line 2290 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::addSourceLine(), and rotateSign().

◆ getFilename()

StringRef llvm::DIVariable::getFilename ( ) const

inline

Definition at line 2305 of file DebugInfoMetadata.h.

References F().

◆ getLine()

unsigned llvm::DIVariable::getLine ( ) const

inline

Definition at line 2287 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::addSourceLine(), llvm::MDNodeKeyImpl< DIGlobalVariable >::isKeyOf(), llvm::MDNodeKeyImpl< DILocalVariable >::isKeyOf(), printExtendedName(), and rotateSign().

◆ getName()

StringRef llvm::DIVariable::getName ( ) const

inline

Definition at line 2289 of file DebugInfoMetadata.h.

Referenced by llvm::DbgValueHistoryMap::dump(), emitDebugValueComment(), llvm::DwarfCompileUnit::getOrCreateGlobalVariableDIE(), and printExtendedName().

◆ getRawFile()

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

inline

Definition at line 2325 of file DebugInfoMetadata.h.

Referenced by llvm::MDNodeKeyImpl< DIGlobalVariable >::isKeyOf(), and llvm::MDNodeKeyImpl< DILocalVariable >::isKeyOf().

◆ getRawName()

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

inline

Definition at line 2324 of file DebugInfoMetadata.h.

Referenced by llvm::MDNodeKeyImpl< DIGlobalVariable >::isKeyOf(), llvm::MDNodeKeyImpl< DILocalVariable >::isKeyOf(), and rotateSign().

◆ getRawScope()

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

inline

Definition at line 2323 of file DebugInfoMetadata.h.

Referenced by getSubprogram(), llvm::MDNodeKeyImpl< DIGlobalVariable >::isKeyOf(), and llvm::MDNodeKeyImpl< DILocalVariable >::isKeyOf().

◆ getRawType()

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

inline

Definition at line 2326 of file DebugInfoMetadata.h.

Referenced by getSubprogram(), llvm::MDNodeKeyImpl< DIGlobalVariable >::isKeyOf(), and llvm::MDNodeKeyImpl< DILocalVariable >::isKeyOf().

◆ getScope()

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

inline

Definition at line 2288 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfCompileUnit::getOrCreateGlobalVariableDIE(), llvm::DILocalVariable::getScope(), and rotateSign().

◆ getSignedness()

Optional<DIBasicType::Signedness> llvm::DIVariable::getSignedness ( ) const

inline

Return the signedness of this variable's type, or None if this type is neither signed nor unsigned.

Definition at line 2299 of file DebugInfoMetadata.h.

References getType(), llvm::None, and llvm::TypedDINodeRef< T >::resolve().

Referenced by llvm::replaceAllDbgUsesWith().

◆ getSizeInBits()

Optional< uint64_t > DIVariable::getSizeInBits ( ) const

Determines the size of the variable's type.

Definition at line 773 of file DebugInfoMetadata.cpp.

References assert(), DEFINE_GETIMPL_LOOKUP, DEFINE_GETIMPL_STORE, DEFINE_GETIMPL_STORE_NO_OPS, isCanonical(), Name, llvm::None, llvm::DILocation::Scope, and Size.

Referenced by llvm::DbgVariableIntrinsic::getFragmentSizeInBits(), and getSubprogram().

◆ getSource()

Optional<StringRef> llvm::DIVariable::getSource ( ) const

inline

Definition at line 2317 of file DebugInfoMetadata.h.

References F(), and llvm::None.

◆ getType()

DITypeRef llvm::DIVariable::getType ( ) const

inline

Definition at line 2291 of file DebugInfoMetadata.h.

Referenced by llvm::BTFDebug::endModule(), llvm::DwarfCompileUnit::getOrCreateGlobalVariableDIE(), rotateSign(), and validThroughout().

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

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DIVariable()

◆ ~DIVariable()

Member Function Documentation

◆ classof()

◆ getAlignInBits()

◆ getAlignInBytes()

◆ getDirectory()

◆ getFile()

◆ getFilename()

◆ getLine()

◆ getName()

◆ getRawFile()

◆ getRawName()

◆ getRawScope()

◆ getRawType()

◆ getScope()

◆ getSignedness()

◆ getSizeInBits()

◆ getSource()

◆ getType()