Value wrapper in the Metadata hierarchy. More...

#include "llvm/IR/Metadata.h"

Inheritance diagram for llvm::ValueAsMetadata:

Public Member Functions
Value *	getValue () const
Type *	getType () const
LLVMContext &	getContext () const
SmallVector< Metadata * >	getAllArgListUsers ()
SmallVector< DbgVariableRecord * >	getAllDbgVariableRecordUsers ()
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 ValueAsMetadata *	get (Value *V)
static ConstantAsMetadata *	getConstant (Value *C)
static LocalAsMetadata *	getLocal (Value *Local)
static LLVM_ABI ValueAsMetadata *	getIfExists (Value *V)
static ConstantAsMetadata *	getConstantIfExists (Value *C)
static LocalAsMetadata *	getLocalIfExists (Value *Local)
static LLVM_ABI void	handleDeletion (Value *V)
static LLVM_ABI void	handleRAUW (Value From, Value To)
static bool	classof (const Metadata *MD)

Protected Member Functions
	ValueAsMetadata (unsigned ID, Value *V)
	~ValueAsMetadata ()=default
void	replaceAllUsesWith (Metadata *MD)
	Handle collisions after Value::replaceAllUsesWith().
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.

Friends
class	ReplaceableUses
class	LLVMContextImpl

Additional Inherited Members
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::Metadata
enum	StorageType { Uniqued , Distinct , Temporary }
	Active type of storage. More...
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

Value wrapper in the Metadata hierarchy.

This is a custom value handle that allows other metadata to refer to classes in the Value hierarchy.

Because of full uniquing support, each value is only wrapped by a single ValueAsMetadata object, so the lookup maps are far more efficient than those using ValueHandleBase.

Definition at line 471 of file Metadata.h.

Constructor & Destructor Documentation

◆ ValueAsMetadata()

llvm::ValueAsMetadata::ValueAsMetadata	(	unsigned	ID,
		Value *	V )

inlineprotected

Definition at line 483 of file Metadata.h.

References assert(), llvm::Metadata::Metadata(), and llvm::Metadata::Uniqued.

Referenced by get(), getIfExists(), handleDeletion(), handleRAUW(), and ~ValueAsMetadata().

◆ ~ValueAsMetadata()

llvm::ValueAsMetadata::~ValueAsMetadata ( )

protecteddefault

References LLVM_ABI, and ValueAsMetadata().

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 535 of file Metadata.h.

References llvm::Metadata::getMetadataID(), and llvm::Metadata::Metadata().

◆ get()

ValueAsMetadata * ValueAsMetadata::get ( Value * V )

static

Definition at line 514 of file Metadata.cpp.

References assert(), C(), llvm::dyn_cast(), llvm::isa(), and ValueAsMetadata().

◆ getAllArgListUsers()

SmallVector< Metadata * > llvm::ValueAsMetadata::getAllArgListUsers ( )

inline

Definition at line 514 of file Metadata.h.

References llvm::ReplaceableUses::getAllArgListUsers().

◆ getAllDbgVariableRecordUsers()

SmallVector< DbgVariableRecord * > llvm::ValueAsMetadata::getAllDbgVariableRecordUsers ( )

inline

Definition at line 517 of file Metadata.h.

References llvm::ReplaceableUses::getAllDbgVariableRecordUsers().

◆ getConstant()

ConstantAsMetadata * llvm::ValueAsMetadata::getConstant ( Value * C )

inlinestatic

Definition at line 492 of file Metadata.h.

References C(), llvm::cast(), and get().

Referenced by llvm::applyDebugifyMetadataToMachineFunction(), llvm::SPIRVGlobalRegistry::buildAssignType(), llvm::buildMD(), llvm::ConstantAsMetadata::get(), and wrapConstantAsMetadata().

◆ getConstantIfExists()

ConstantAsMetadata * llvm::ValueAsMetadata::getConstantIfExists ( Value * C )

inlinestatic

Definition at line 502 of file Metadata.h.

References C(), llvm::cast_or_null(), and getIfExists().

Referenced by llvm::ConstantAsMetadata::getIfExists().

◆ getContext()

LLVMContext & llvm::ValueAsMetadata::getContext ( ) const

inline

Definition at line 512 of file Metadata.h.

◆ getIfExists()

ValueAsMetadata * ValueAsMetadata::getIfExists ( Value * V )

static

Definition at line 533 of file Metadata.cpp.

References assert(), and ValueAsMetadata().

Referenced by llvm::findDVRDeclares(), llvm::findDVRDeclareValues(), llvm::findDVRValues(), getConstantIfExists(), and getLocalIfExists().

◆ getLocal()

LocalAsMetadata * llvm::ValueAsMetadata::getLocal ( Value * Local )

inlinestatic

Definition at line 496 of file Metadata.h.

References llvm::cast(), get(), and Local.

Referenced by llvm::LocalAsMetadata::get().

◆ getLocalIfExists()

LocalAsMetadata * llvm::ValueAsMetadata::getLocalIfExists ( Value * Local )

inlinestatic

Definition at line 506 of file Metadata.h.

References llvm::cast_or_null(), getIfExists(), and Local.

Referenced by llvm::LocalAsMetadata::getIfExists().

◆ getType()

Type * llvm::ValueAsMetadata::getType ( ) const

inline

Definition at line 511 of file Metadata.h.

◆ getValue()

Value * llvm::ValueAsMetadata::getValue ( ) const

inline

Definition at line 510 of file Metadata.h.

Referenced by analyzeModule(), getHiPELiteral(), getOCLKernelArgAttribute(), llvm::ConstantAsMetadata::getValue(), handleDeletion(), handleRAUW(), llvm::DbgVariableRecord::location_op_iterator::operator*(), llvm::DbgVariableRecord::location_op_iterator::operator*(), llvm::location_op_iterator::operator*(), and llvm::location_op_iterator::operator*().

◆ handleDeletion()

void ValueAsMetadata::handleDeletion ( Value * V )

static

Definition at line 538 of file Metadata.cpp.

References assert(), getValue(), I, replaceAllUsesWith(), llvm::Store, and ValueAsMetadata().

Referenced by llvm::CallGraphUpdater::finalize().

◆ handleRAUW()

void ValueAsMetadata::handleRAUW	(	Value *	From,
		Value *	To )

static

Definition at line 557 of file Metadata.cpp.

References assert(), llvm::Value::getContext(), getValue(), llvm::Value::hasUseList(), I, llvm::Value::IsUsedByMD, llvm::Metadata::Metadata(), llvm::LLVMContext::pImpl, llvm::Store, ValueAsMetadata(), and llvm::LLVMContextImpl::ValuesAsMetadata.

◆ replaceAllUsesWith()

void llvm::ValueAsMetadata::replaceAllUsesWith ( Metadata * MD )

inlineprotected

Handle collisions after Value::replaceAllUsesWith().

RAUW isn't supported directly for ValueAsMetadata, but if the wrapped Value gets RAUW'ed and the target already exists, this is used to merge the two metadata nodes.

Definition at line 530 of file Metadata.h.

References llvm::Metadata::Metadata(), and llvm::ReplaceableUses::replaceAllUsesWith().

Referenced by handleDeletion().