A scope for locals. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DILocalScope:

Public Member Functions
LLVM_ABI DISubprogram *	getSubprogram () const
	Get the subprogram for this scope.

LLVM_ABI DILocalScope *	getNonLexicalBlockFileScope () const
	Get the first non DILexicalBlockFile scope of this scope.

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

bool	isAlwaysReplaceable () const

bool	hasGeneralizedMDString ()
	Check if this is a valid generalized type metadata node.

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 LLVM_ABI DILocalScope *	cloneScopeForSubprogram (DILocalScope &RootScope, DISubprogram &NewSP, LLVMContext &Ctx, DenseMap< const MDNode , MDNode > &Cache)
	Traverses the scope chain rooted at RootScope until it hits a Subprogram, recreating the chain with "NewSP" instead.

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

Protected Member Functions
	DILocalScope (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops)

	~DILocalScope ()=default

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.

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

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 scope for locals.

A legal scope for lexical blocks, local variables, and debug info locations. Subclasses are DISubprogram, DILexicalBlock, and DILexicalBlockFile.

Definition at line 2185 of file DebugInfoMetadata.h.

Constructor & Destructor Documentation

◆ DILocalScope()

llvm::DILocalScope::DILocalScope	(	LLVMContext &	C,
		unsigned	ID,
		StorageType	Storage,
		unsigned	Tag,
		ArrayRef< Metadata * >	Ops
	)

inlineprotected

Definition at line 2187 of file DebugInfoMetadata.h.

◆ ~DILocalScope()

llvm::DILocalScope::~DILocalScope ( )

protecteddefault

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 2212 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ cloneScopeForSubprogram()

DILocalScope * DILocalScope::cloneScopeForSubprogram	(	DILocalScope &	RootScope,
		DISubprogram &	NewSP,
		LLVMContext &	Ctx,
		DenseMap< const MDNode , MDNode > &	Cache
	)

static

Traverses the scope chain rooted at RootScope until it hits a Subprogram, recreating the chain with "NewSP" instead.

Definition at line 1315 of file DebugInfoMetadata.cpp.

References cloneAndReplaceParentScope(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::find(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::reverse().

Referenced by fixupDebugInfoPostExtraction(), and llvm::DebugLoc::replaceInlinedAtSubprogram().

◆ getNonLexicalBlockFileScope()

DILocalScope * DILocalScope::getNonLexicalBlockFileScope ( ) const

Get the first non DILexicalBlockFile scope of this scope.

Return this if it's not a DILexicalBlockFIle; otherwise, look up the scope chain.

Definition at line 1309 of file DebugInfoMetadata.cpp.

◆ getSubprogram()

DISubprogram * DILocalScope::getSubprogram ( ) const

Get the subprogram for this scope.

Return this if it's an DISubprogram; otherwise, look up the scope chain.

Definition at line 1303 of file DebugInfoMetadata.cpp.

References llvm::Block.

Referenced by llvm::getDISubprogram(), llvm::DwarfCompileUnit::getLexicalBlockDIE(), getSubprogram(), llvm::DIBuilder::insertDeclare(), llvm::DIBuilder::insertLabel(), llvm::DILocalVariable::isValidLocationForIntrinsic(), and llvm::DILabel::isValidLocationForIntrinsic().

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