Metadata wrapper in the Value hierarchy. More...

#include "llvm/IR/Metadata.h"

Inheritance diagram for llvm::MetadataAsValue:

Collaboration diagram for llvm::MetadataAsValue:

Public Member Functions
	~MetadataAsValue ()

Metadata *	getMetadata () const

Public Member Functions inherited from llvm::Value
	Value (const Value &)=delete

Value &	operator= (const Value &)=delete

void	deleteValue ()
	Delete a pointer to a generic Value. More...

void	dump () const
	Support for debugging, callable in GDB: V->dump() More...

Type *	getType () const
	All values are typed, get the type of this value. More...

LLVMContext &	getContext () const
	All values hold a context through their type. More...

bool	hasName () const

ValueName *	getValueName () const

void	setValueName (ValueName *VN)

StringRef	getName () const
	Return a constant reference to the value's name. More...

void	setName (const Twine &Name)
	Change the name of the value. More...

void	takeName (Value *V)
	Transfer the name from V to this value. More...

void	replaceAllUsesWith (Value *V)
	Change all uses of this to point to a new Value. More...

void	replaceNonMetadataUsesWith (Value *V)
	Change non-metadata uses of this to point to a new Value. More...

void	replaceUsesOutsideBlock (Value V, BasicBlock BB)
	replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...

void	assertModuleIsMaterializedImpl () const

void	assertModuleIsMaterialized () const

bool	use_empty () const

bool	materialized_use_empty () const

use_iterator	materialized_use_begin ()

const_use_iterator	materialized_use_begin () const

use_iterator	use_begin ()

const_use_iterator	use_begin () const

use_iterator	use_end ()

const_use_iterator	use_end () const

iterator_range< use_iterator >	materialized_uses ()

iterator_range< const_use_iterator >	materialized_uses () const

iterator_range< use_iterator >	uses ()

iterator_range< const_use_iterator >	uses () const

bool	user_empty () const

user_iterator	materialized_user_begin ()

const_user_iterator	materialized_user_begin () const

user_iterator	user_begin ()

const_user_iterator	user_begin () const

user_iterator	user_end ()

const_user_iterator	user_end () const

User *	user_back ()

const User *	user_back () const

iterator_range< user_iterator >	materialized_users ()

iterator_range< const_user_iterator >	materialized_users () const

iterator_range< user_iterator >	users ()

iterator_range< const_user_iterator >	users () const

bool	hasOneUse () const
	Return true if there is exactly one user of this value. More...

bool	hasNUses (unsigned N) const
	Return true if this Value has exactly N users. More...

bool	hasNUsesOrMore (unsigned N) const
	Return true if this value has N users or more. More...

bool	isUsedInBasicBlock (const BasicBlock *BB) const
	Check if this value is used in the specified basic block. More...

unsigned	getNumUses () const
	This method computes the number of uses of this Value. More...

void	addUse (Use &U)
	This method should only be used by the Use class. More...

unsigned	getValueID () const
	Return an ID for the concrete type of this object. More...

unsigned	getRawSubclassOptionalData () const
	Return the raw optional flags value contained in this value. More...

void	clearSubclassOptionalData ()
	Clear the optional flags contained in this value. More...

bool	hasSameSubclassOptionalData (const Value *V) const
	Check the optional flags for equality. More...

bool	hasValueHandle () const
	Return true if there is a value handle associated with this value. More...

bool	isUsedByMetadata () const
	Return true if there is metadata referencing this value. More...

bool	isSwiftError () const
	Return true if this value is a swifterror value. More...

const Value *	stripPointerCasts () const
	Strip off pointer casts, all-zero GEPs, and aliases. More...

Value *	stripPointerCasts ()

const Value *	stripPointerCastsAndInvariantGroups () const
	Strip off pointer casts, all-zero GEPs, aliases and invariant group info. More...

Value *	stripPointerCastsAndInvariantGroups ()

const Value *	stripPointerCastsNoFollowAliases () const
	Strip off pointer casts and all-zero GEPs. More...

Value *	stripPointerCastsNoFollowAliases ()

const Value *	stripInBoundsConstantOffsets () const
	Strip off pointer casts and all-constant inbounds GEPs. More...

Value *	stripInBoundsConstantOffsets ()

const Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
	Accumulate offsets from stripInBoundsConstantOffsets(). More...

Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)

const Value *	stripInBoundsOffsets () const
	Strip off pointer casts and inbounds GEPs. More...

Value *	stripInBoundsOffsets ()

uint64_t	getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const
	Returns the number of bytes known to be dereferenceable for the pointer value. More...

unsigned	getPointerAlignment (const DataLayout &DL) const
	Returns an alignment of the pointer value. More...

const Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB) const
	Translate PHI node to its predecessor from the given basic block. More...

Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB)

void	mutateType (Type *Ty)
	Mutate the type of this Value to be of the specified type. More...

template<class Compare >
void	sortUseList (Compare Cmp)
	Sort the use-list. More...

void	reverseUseList ()
	Reverse the use-list. More...

void	print (raw_ostream &O, bool IsForDebug=false) const
	Implement operator<< on Value. More...

void	print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const

void	printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
	Print the name of this Value out to the specified raw_ostream. More...

void	printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const

Static Public Member Functions
static MetadataAsValue *	get (LLVMContext &Context, Metadata *MD)

static MetadataAsValue *	getIfExists (LLVMContext &Context, Metadata *MD)

static bool	classof (const Value *V)

Friends
class	ReplaceableMetadataImpl

class	LLVMContextImpl

Additional Inherited Members
Public Types inherited from llvm::Value
enum	ValueTy
	Concrete subclass of this. More...

using	use_iterator = use_iterator_impl< Use >

using	const_use_iterator = use_iterator_impl< const Use >

using	user_iterator = user_iterator_impl< User >

using	const_user_iterator = user_iterator_impl< const User >

Static Public Attributes inherited from llvm::Value
static const unsigned	MaxAlignmentExponent = 29
	The maximum alignment for instructions. More...

static const unsigned	MaximumAlignment = 1u << MaxAlignmentExponent

Protected Types inherited from llvm::Value
enum	: unsigned { NumUserOperandsBits = 28 }
	The number of operands in the subclass. More...

Protected Member Functions inherited from llvm::Value
	Value (Type *Ty, unsigned scid)

	~Value ()
	Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More...

unsigned short	getSubclassDataFromValue () const

void	setValueSubclassData (unsigned short D)

Protected Attributes inherited from llvm::Value
unsigned char	SubclassOptionalData: 7
	Hold subclass data that can be dropped. More...

unsigned	NumUserOperands: NumUserOperandsBits

unsigned	IsUsedByMD: 1

unsigned	HasName: 1

unsigned	HasHungOffUses: 1

unsigned	HasDescriptor: 1

Detailed Description

Metadata wrapper in the Value hierarchy.

A member of the Value hierarchy to represent a reference to metadata. This allows, e.g., instrinsics to have metadata as operands.

Notably, this is the only thing in either hierarchy that is allowed to reference LocalAsMetadata.

Definition at line 174 of file Metadata.h.

Constructor & Destructor Documentation

◆ ~MetadataAsValue()

MetadataAsValue::~MetadataAsValue ( )

Definition at line 68 of file Metadata.cpp.

References getType().

Member Function Documentation

◆ classof()

static bool llvm::MetadataAsValue::classof ( const Value * V )

inlinestatic

Definition at line 193 of file Metadata.h.

References llvm::Value::getValueID().

◆ get()

MetadataAsValue * MetadataAsValue::get	(	LLVMContext &	Context,
		Metadata *	MD
	)

static

◆ getIfExists()

MetadataAsValue * MetadataAsValue::getIfExists	(	LLVMContext &	Context,
		Metadata *	MD
	)

static

Definition at line 114 of file Metadata.cpp.

References assert(), canonicalizeMetadataForValue(), llvm::LLVMContextImpl::MetadataAsValues, llvm::LLVMContext::pImpl, llvm::Ref, llvm::SPII::Store, llvm::MetadataTracking::track(), and llvm::MetadataTracking::untrack().

Referenced by llvm::FindDbgAddrUses(), llvm::findDbgUsers(), llvm::findDbgValues(), mergeInlinedArrayAllocas(), and llvm::replaceDbgValueForAlloca().

◆ getMetadata()

Metadata* llvm::MetadataAsValue::getMetadata ( ) const

inline

Definition at line 191 of file Metadata.h.

Referenced by extractMDNode(), and forEachUser().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl

friend

Definition at line 176 of file Metadata.h.

◆ ReplaceableMetadataImpl

friend class ReplaceableMetadataImpl

friend

Definition at line 175 of file Metadata.h.

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

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

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members