LLVM  14.0.0git
Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::MetadataAsValue Class Reference

Metadata wrapper in the Value hierarchy. More...

#include "llvm/IR/Metadata.h"

Inheritance diagram for llvm::MetadataAsValue:
Inheritance graph
Collaboration diagram for llvm::MetadataAsValue:
Collaboration graph

Public Member Functions

 ~MetadataAsValue ()
MetadatagetMetadata () const
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
Valueoperator= (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...
TypegetType () const
 All values are typed, get the type of this value. More...
LLVMContextgetContext () const
 All values hold a context through their type. More...
bool hasName () const
ValueNamegetValueName () 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...
std::string getNameOrAsOperand () const
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 replaceUsesWithIf (Value *New, llvm::function_ref< bool(Use &U)> ShouldReplace)
 Go through the uses list for this definition and make each use point to "V" if the callback ShouldReplace returns true for the given Use. 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_iteratormaterialized_uses ()
iterator_range< const_use_iteratormaterialized_uses () const
iterator_range< use_iteratoruses ()
iterator_range< const_use_iteratoruses () 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
Useruser_back ()
const Useruser_back () const
iterator_range< user_iteratormaterialized_users ()
iterator_range< const_user_iteratormaterialized_users () const
iterator_range< user_iteratorusers ()
iterator_range< const_user_iteratorusers () const
bool hasOneUse () const
 Return true if there is exactly one use of this value. More...
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N uses. More...
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N uses or more. More...
bool hasOneUser () const
 Return true if there is exactly one user of this value. More...
UsegetSingleUndroppableUse ()
 Return true if there is exactly one use of this value that cannot be dropped. More...
const UsegetSingleUndroppableUse () const
UsergetUniqueUndroppableUser ()
 Return true if there is exactly one unique user of this value that cannot be dropped (that user can have multiple uses of this value). More...
const UsergetUniqueUndroppableUser () const
bool hasNUndroppableUses (unsigned N) const
 Return true if there this value. More...
bool hasNUndroppableUsesOrMore (unsigned N) const
 Return true if this value has N uses or more. More...
void dropDroppableUses (llvm::function_ref< bool(const Use *)> ShouldDrop=[](const Use *) { return true;})
 Remove every uses that can safely be removed. More...
void dropDroppableUsesIn (User &Usr)
 Remove every use of this value in User that can safely be removed. 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 isTransitiveUsedByMetadataOnly () const
bool isSwiftError () const
 Return true if this value is a swifterror value. More...
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs and address space casts. More...
ValuestripPointerCasts ()
const ValuestripPointerCastsAndAliases () const
 Strip off pointer casts, all-zero GEPs, address space casts, and aliases. More...
ValuestripPointerCastsAndAliases ()
const ValuestripPointerCastsSameRepresentation () const
 Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same. More...
ValuestripPointerCastsSameRepresentation ()
const ValuestripPointerCastsForAliasAnalysis () const
 Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info. More...
ValuestripPointerCastsForAliasAnalysis ()
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
ValuestripInBoundsConstantOffsets ()
const ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr) const
 Accumulate the constant offset this value has compared to a base pointer. More...
ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds)
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false. More...
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
const ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const
 Strip off pointer casts and inbounds GEPs. More...
ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {})
bool canBeFreed () const
 Return true if the memory object referred to by V can by freed in the scope for which the SSA value defining the allocation is statically defined. More...
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
 Returns the number of bytes known to be dereferenceable for the pointer value. More...
Align getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value. More...
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block. More...
ValueDoPHITranslation (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 MetadataAsValueget (LLVMContext &Context, Metadata *MD)
static MetadataAsValuegetIfExists (LLVMContext &Context, Metadata *MD)
static bool classof (const Value *V)
- Static Public Member Functions inherited from llvm::Value
static void dropDroppableUse (Use &U)
 Remove the droppable use U. More...


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 constexpr unsigned MaxAlignmentExponent = 32
 The maximum alignment for instructions. More...
static constexpr uint64_t MaximumAlignment = 1ULL << MaxAlignmentExponent
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 27 }
 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...
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * >> &MDs) const
 Appends all metadata attached to this value to MDs, sorting by KindID. More...
bool hasMetadata () const
 Return true if this value has any metadata attached to it. More...
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind. More...
void clearMetadata ()
 Erase all metadata attached to this Value. More...
unsigned short getSubclassDataFromValue () const
void setValueSubclassData (unsigned short D)
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any. More...
MDNodegetMetadata (StringRef Kind) const
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order. More...
void getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
bool hasMetadata (unsigned KindID) const
 Return true if this value has the given type of metadata attached. More...
bool hasMetadata (StringRef Kind) const
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment. More...
void setMetadata (StringRef Kind, MDNode *Node)
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment. More...
void addMetadata (StringRef Kind, MDNode &MD)
- 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 HasMetadata: 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 176 of file Metadata.h.

Constructor & Destructor Documentation

◆ ~MetadataAsValue()

MetadataAsValue::~MetadataAsValue ( )

Member Function Documentation

◆ classof()

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

Definition at line 195 of file Metadata.h.

References llvm::Value::getValueID().

◆ get()

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

◆ getIfExists()

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

◆ getMetadata()

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

Definition at line 193 of file Metadata.h.

Referenced by extractMDNode().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl

Definition at line 178 of file Metadata.h.

◆ ReplaceableMetadataImpl

friend class ReplaceableMetadataImpl

Definition at line 177 of file Metadata.h.

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