LLVM 19.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
llvm::MDNode Class Reference

Metadata node. More...

#include "llvm/IR/Metadata.h"

Inheritance diagram for llvm::MDNode:
Inheritance graph
[legend]

Public Types

using op_iterator = const MDOperand *
 
using op_range = iterator_range< op_iterator >
 

Public Member Functions

 MDNode (const MDNode &)=delete
 
void operator= (const MDNode &)=delete
 
void * operator new (size_t)=delete
 
TempMDNode clone () const
 Create a (temporary) clone of this.
 
LLVMContextgetContext () const
 
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
 
unsigned getNumTemporaryUses () const
 
void replaceAllUsesWith (Metadata *MD)
 RAUW a temporary.
 
void resolveCycles ()
 Resolve cycles.
 
void resolve ()
 Resolve a unique, unresolved node.
 
op_iterator op_begin () const
 
op_iterator op_end () const
 
ArrayRef< MDOperandoperands () const
 
const MDOperandgetOperand (unsigned I) const
 
unsigned getNumOperands () const
 Return number of MDNode operands.
 
bool isTBAAVtableAccess () const
 Check whether MDNode is a vtable access.
 
void printTree (raw_ostream &OS, const Module *M=nullptr) const
 Print in tree shape.
 
void printTree (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const
 
void dumpTree () const
 User-friendly dump in tree shape.
 
void dumpTree (const Module *M) const
 

Static Public Member Functions

static MDTupleget (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static MDTuplegetIfExists (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static MDTuplegetDistinct (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static TempMDTuple getTemporary (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static 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 MDNodeconcatenate (MDNode *A, MDNode *B)
 Methods for metadata merging.
 
static MDNodeintersect (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericTBAA (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericFPMath (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericRange (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericAliasScope (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericAlignmentOrDereferenceable (MDNode *A, MDNode *B)
 
static MDNodegetMergedProfMetadata (MDNode *A, MDNode *B, const Instruction *AInstr, const Instruction *BInstr)
 Merge !prof metadata from two instructions.
 

Protected Types

using mutable_op_range = iterator_range< MDOperand * >
 
 Active type of storage. More...

Protected Member Functions

 MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2=std::nullopt)
 
 ~MDNode ()=default
 
void * operator new (size_t Size, size_t NumOps, StorageType Storage)
 
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.
 
void dropAllReferences ()
 
MDOperandmutable_begin ()
 
MDOperandmutable_end ()
 
mutable_op_range mutable_operands ()
 
void setOperand (unsigned I, Metadata *New)
 Set an operand.
 
unsigned getNumUnresolved () const
 
void setNumUnresolved (unsigned N)
 
void storeDistinctInContext ()
 
void resize (size_t NumOps)
 Resize the node to hold NumOps operands.
 

Static Protected Member Functions

template<class T , class StoreT >
static TstoreImpl (T *N, StorageType Storage, StoreT &Store)
 
template<class T >
static TstoreImpl (T *N, StorageType Storage)
 

Friends

class ReplaceableMetadataImpl
 
class LLVMContextImpl
 
class DIAssignID
 

Additional Inherited Members

Detailed Description

Metadata node.

Metadata nodes can be uniqued, like constants, or distinct. Temporary metadata nodes (with full support for RAUW) can be used to delay uniquing until forward references are known. The basic metadata node is an MDTuple.

There is limited support for RAUW at construction time. At construction time, if any operand is a temporary node (or an unresolved uniqued node, which indicates a transitive temporary operand), the node itself will be unresolved. As soon as all operands become resolved, it will drop RAUW support permanently.

If an unresolved node is part of a cycle, resolveCycles() needs to be called on some member of the cycle once all temporary nodes have been replaced.

MDNodes can be large or small, as well as resizable or non-resizable. Large MDNodes' operands are allocated in a separate storage vector, whereas small MDNodes' operands are co-allocated. Distinct and temporary MDnodes are resizable, but only MDTuples support this capability.

Clients can add operands to resizable MDNodes using push_back().

Definition at line 1067 of file Metadata.h.

Member Typedef Documentation

◆ mutable_op_range

Definition at line 1203 of file Metadata.h.

◆ op_iterator

Definition at line 1415 of file Metadata.h.

◆ op_range

Definition at line 1416 of file Metadata.h.

Constructor & Destructor Documentation

◆ MDNode() [1/2]

MDNode::MDNode ( LLVMContext Context,
unsigned  ID,
StorageType  Storage,
ArrayRef< Metadata * >  Ops1,
ArrayRef< Metadata * >  Ops2 = std::nullopt 
)
protected

Definition at line 644 of file Metadata.cpp.

References Context, isUniqued(), and setOperand().

◆ ~MDNode()

llvm::MDNode::~MDNode ( )
protecteddefault

◆ MDNode() [2/2]

llvm::MDNode::MDNode ( const MDNode )
delete

Member Function Documentation

◆ classof()

static bool llvm::MDNode::classof ( const Metadata MD)
inlinestatic

Methods for support type inquiry through isa, cast, and dyn_cast:

Definition at line 1437 of file Metadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

TempMDNode MDNode::clone ( ) const

Create a (temporary) clone of this.

Definition at line 661 of file Metadata.cpp.

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

Referenced by llvm::DIType::clone(), and llvm::DILocalScope::cloneScopeForSubprogram().

◆ concatenate()

MDNode * MDNode::concatenate ( MDNode A,
MDNode B 
)
static

◆ deleteTemporary()

void MDNode::deleteTemporary ( MDNode N)
static

Deallocate a node created by getTemporary.

Calls replaceAllUsesWith(nullptr) before deleting, so any remaining references will be reset.

Definition at line 1043 of file Metadata.cpp.

References assert(), and N.

Referenced by LLVMDisposeTemporaryMDNode(), LLVMMetadataReplaceAllUsesWith(), and llvm::TempMDNodeDeleter::operator()().

◆ dropAllReferences()

void MDNode::dropAllReferences ( )
protected

Definition at line 901 of file Metadata.cpp.

References Context, getNumOperands(), I, and setOperand().

◆ dumpTree() [1/2]

LLVM_DUMP_METHOD void MDNode::dumpTree ( ) const

User-friendly dump in tree shape.

If M is provided, metadata nodes will be numbered canonically; otherwise, pointer addresses are substituted.

Note: this uses an explicit overload instead of default arguments so that the nullptr version is easy to call from a debugger.

Definition at line 5281 of file AsmWriter.cpp.

References dumpTree().

Referenced by dumpTree().

◆ dumpTree() [2/2]

LLVM_DUMP_METHOD void MDNode::dumpTree ( const Module M) const

Definition at line 5284 of file AsmWriter.cpp.

References llvm::dbgs(), and printTree().

◆ get()

MDTuple * llvm::MDNode::get ( LLVMContext Context,
ArrayRef< Metadata * >  MDs 
)
inlinestatic

Definition at line 1541 of file Metadata.h.

References Context, and llvm::MDTuple::get().

Referenced by llvm::adaptNoAliasScopes(), AddAliasScopeMetadata(), llvm::Module::addModuleFlag(), addModuleFlags(), AddRuntimeUnrollDisableMetaData(), llvm::addStringMetadataToLoop(), llvm::LoopVersioning::annotateInstWithNoAlias(), llvm::annotateValueSite(), llvm::DIExpression::append(), llvm::DIExpression::appendOpsToArg(), llvm::OpenMPIRBuilder::applySimd(), llvm::memprof::CallStackTrie::buildAndAttachMIBMetadata(), llvm::memprof::buildCallstackMetadata(), canonicalizeMetadataForValue(), llvm::DILocation::cloneWithDiscriminator(), collectCallSiteParameters(), llvm::DIExpression::constantFold(), llvm::DIExpression::convertToNonVariadicExpression(), llvm::DIExpression::convertToUndefExpression(), llvm::DIExpression::convertToVariadicExpression(), llvm::GlobalObject::copyMetadata(), llvm::copyRangeMetadata(), createAccessTag(), llvm::MDBuilder::createAliasScope(), llvm::MDBuilder::createAliasScopeDomain(), llvm::DIBuilder::createArrayType(), llvm::DIBuilder::createBasicType(), llvm::DIBuilder::createBitFieldMemberType(), llvm::MDBuilder::createBranchWeights(), llvm::MDBuilder::createCallbackEncoding(), llvm::MDBuilder::createCallees(), llvm::DIBuilder::createClassType(), llvm::DIBuilder::createCommonBlock(), llvm::DIBuilder::createConstantValueExpression(), llvm::DIBuilder::createEnumerationType(), llvm::DIBuilder::createEnumerator(), llvm::DIBuilder::createExpression(), CreateFailBB(), llvm::DIBuilder::createFile(), llvm::DIBuilder::createForwardDecl(), llvm::MDBuilder::createFPMath(), llvm::DIExpression::createFragmentExpression(), llvm::DIBuilder::createFriend(), llvm::MDBuilder::createFunctionEntryCount(), llvm::MDBuilder::createFunctionSectionPrefix(), llvm::DIBuilder::createGlobalVariableExpression(), createImportedModule(), llvm::DIBuilder::createInheritance(), llvm::MDBuilder::createIrrLoopHeaderWeight(), llvm::DIBuilder::createLabel(), llvm::DIBuilder::createLexicalBlockFile(), llvm::MDBuilder::createLLVMStats(), createLocalVariable(), llvm::DIBuilder::createMacro(), llvm::DIBuilder::createMemberPointerType(), llvm::DIBuilder::createMemberType(), llvm::createMemCpyLoopKnownSize(), createMIBNode(), llvm::DIBuilder::createModule(), llvm::DIBuilder::createNameSpace(), llvm::DIBuilder::createObjCIVar(), llvm::DIBuilder::createObjCProperty(), llvm::OpenMPIRBuilder::createOffloadEntriesAndInfoMetadata(), llvm::OpenMPIRBuilder::createOffloadEntry(), llvm::MDBuilder::createPCSections(), llvm::createPGOFuncNameMetadata(), llvm::DIBuilder::createPointerType(), llvm::MDBuilder::createPseudoProbeDesc(), llvm::DIBuilder::createPtrAuthQualifiedType(), llvm::DIBuilder::createQualifiedType(), llvm::MDBuilder::createRange(), llvm::DIBuilder::createReferenceType(), llvm::MDBuilder::createRTTIPointerPrologue(), llvm::DIBuilder::createSetType(), llvm::dxil::createShaderModelMD(), llvm::DIBuilder::createStaticMemberType(), createStringMetadata(), llvm::DIBuilder::createStringType(), llvm::DIBuilder::createStructType(), llvm::DIBuilder::createSubroutineType(), llvm::MDBuilder::createTBAAAccessTag(), llvm::MDBuilder::createTBAANode(), llvm::MDBuilder::createTBAARoot(), llvm::MDBuilder::createTBAAScalarTypeNode(), llvm::MDBuilder::createTBAAStructNode(), llvm::MDBuilder::createTBAAStructTagNode(), llvm::MDBuilder::createTBAAStructTypeNode(), llvm::MDBuilder::createTBAATypeNode(), llvm::DIBuilder::createTemplateAlias(), llvm::DIBuilder::createTemplateParameterPack(), llvm::DIBuilder::createTemplateTypeParameter(), createTemplateValueParameterHelper(), llvm::DIBuilder::createTypedef(), llvm::DIBuilder::createUnionType(), llvm::MDBuilder::createUnpredictable(), llvm::DIBuilder::createUnspecifiedType(), llvm::DIBuilder::createVariantMemberType(), llvm::DIBuilder::createVariantPart(), llvm::DIBuilder::createVectorType(), llvm::TargetInstrInfo::describeLoadedValue(), llvm::MipsInstrInfo::describeLoadedValue(), llvm::X86InstrInfo::describeLoadedValue(), describeMOVrrLoadedValue(), describeORRLoadedValue(), DisableAllLoopOptsOnLoop(), llvm::Instruction::dropLocation(), llvm::embedBufferInModule(), llvm::emitAMDGPUPrintfCall(), emitDbgAssign(), llvm::InstrumentationIRBuilder::ensureDebugInfo(), llvm::AAMDNodes::extendToTBAA(), llvm::DIExpression::extractAddressClass(), extractMDNode(), llvm::DIBuilder::finalize(), findBasePointer(), fixupDebugInfoPostExtraction(), foldCtpop(), foldCttzCtlz(), llvm::hlsl::FrontendResource::FrontendResource(), llvm::DebugLoc::getFnDebugLoc(), llvm::DILocation::getMergedLocation(), getMostGenericRange(), llvm::DIBuilder::getOrCreateGenericSubrange(), llvm::OpenMPIRBuilder::getOrCreateRuntimeFunction(), llvm::DIBuilder::getOrCreateSubrange(), llvm::DIBuilder::getOrCreateTypeArray(), getOrSelfReference(), getSubprogram(), hostParallelCallback(), llvm::FunctionImporter::importFunctions(), llvm::GCNTTIImpl::instCombineIntrinsic(), llvm::ARMTTIImpl::instCombineIntrinsic(), llvm::SampleProfileProber::instrumentOneFunc(), interpretValues(), llvm::intersectAccessGroups(), LLVMDIBuilderCreateDebugLocation(), LLVMMDNodeInContext(), LLVMMDNodeInContext2(), lowerKernelArguments(), llvm::makeFollowupLoopID(), llvm::MDBuilder::mergeCallbackEncodings(), moveFunctionData(), postUnswitch(), llvm::LoopVersioning::prepareNoAliasMetadata(), llvm::DIExpression::prependOpcodes(), llvm::memtag::readRegister(), llvm::DIExpression::replaceArg(), llvm::DebugLoc::replaceInlinedAtSubprogram(), runImpl(), runIPSCCP(), llvm::scaleProfData(), llvm::LoopVectorizeHints::setAlreadyVectorized(), llvm::setKCFIType(), llvm::Loop::setLoopAlreadyUnrolled(), llvm::Loop::setLoopMustProgress(), llvm::Instruction::setNoSanitizeMetadata(), llvm::IRBuilderBase::SetNoSanitizeMetadata(), llvm::GlobalObject::setVCallVisibilityMetadata(), llvm::AAMDNodes::shiftTBAAStruct(), splitGlobal(), stripLoopMDLoc(), llvm::stripNonLineTableDebugInfo(), llvm::Instruction::swapProfMetadata(), llvm::uniteAccessGroups(), llvm::OpenMPIRBuilder::unrollLoopFull(), llvm::OpenMPIRBuilder::unrollLoopHeuristic(), llvm::OpenMPIRBuilder::unrollLoopPartial(), llvm::dxil::ValidatorVersionMD::update(), updateNVPTXMetadata(), llvm::UpgradeIntrinsicCall(), llvm::UpgradeModuleFlags(), llvm::UpgradeTBAANode(), llvm::InstCombinerImpl::visitCallInst(), llvm::dxil::UAVResource::write(), llvm::dxil::ConstantBuffer::write(), llvm::dxil::ResourceBase::ExtendedProperties::write(), llvm::dxil::ResourceTable< T >::write(), and llvm::dxil::Resources::write().

◆ getContext()

LLVMContext & llvm::MDNode::getContext ( ) const
inline

◆ getDistinct()

MDTuple * llvm::MDNode::getDistinct ( LLVMContext Context,
ArrayRef< Metadata * >  MDs 
)
inlinestatic

◆ getIfExists()

MDTuple * llvm::MDNode::getIfExists ( LLVMContext Context,
ArrayRef< Metadata * >  MDs 
)
inlinestatic

Definition at line 1545 of file Metadata.h.

References Context, and llvm::MDTuple::getIfExists().

◆ getMergedProfMetadata()

MDNode * MDNode::getMergedProfMetadata ( MDNode A,
MDNode B,
const Instruction AInstr,
const Instruction BInstr 
)
static

Merge !prof metadata from two instructions.

Currently only implemented with direct callsites with branch weights.

Definition at line 1217 of file Metadata.cpp.

References A, assert(), B, llvm::CallBase::getCalledFunction(), and llvm::Instruction::getMetadata().

Referenced by llvm::combineMetadata().

◆ getMostGenericAliasScope()

MDNode * MDNode::getMostGenericAliasScope ( MDNode A,
MDNode B 
)
static

◆ getMostGenericAlignmentOrDereferenceable()

MDNode * MDNode::getMostGenericAlignmentOrDereferenceable ( MDNode A,
MDNode B 
)
static

Definition at line 1351 of file Metadata.cpp.

References A, B, and llvm::ConstantInt::getZExtValue().

Referenced by llvm::combineMetadata().

◆ getMostGenericFPMath()

MDNode * MDNode::getMostGenericFPMath ( MDNode A,
MDNode B 
)
static

Definition at line 1167 of file Metadata.cpp.

References A, and B.

Referenced by llvm::combineMetadata(), and llvm::propagateMetadata().

◆ getMostGenericRange()

MDNode * MDNode::getMostGenericRange ( MDNode A,
MDNode B 
)
static

◆ getMostGenericTBAA()

MDNode * MDNode::getMostGenericTBAA ( MDNode A,
MDNode B 
)
static

◆ getNumOperands()

unsigned llvm::MDNode::getNumOperands ( ) const
inline

Return number of MDNode operands.

Definition at line 1434 of file Metadata.h.

Referenced by llvm::AbstractCallSite::AbstractCallSite(), llvm::memprof::CallStackTrie::addCallStack(), AddRuntimeUnrollDisableMetaData(), llvm::addStringMetadataToLoop(), addToAccessGroupList(), llvm::cacheAnnotationFromMD(), createAccessTag(), dropAllReferences(), llvm::MachineInstr::emitError(), llvm::extractFromBranchWeightMD(), llvm::extractProfTotalWeight(), llvm::findOptionMDForLoopID(), llvm::findStringMetadataForLoop(), GetBranchWeights(), getConstInt(), llvm::DOTGraphTraits< DOTFuncInfo * >::getEdgeAttributes(), llvm::ProfileSummary::getFromMD(), GetFunctionFromMDNode(), llvm::AMDGPUMachineFunction::getLDSKernelIdMetadata(), getLocCookie(), llvm::Loop::getLoopID(), llvm::MachineLoop::getLoopID(), llvm::memprof::getMIBAllocType(), llvm::memprof::getMIBStackNode(), llvm::GenericDINode::getNumDwarfOperands(), getOperand(), llvm::getOptionalBoolLoopAttribute(), getOptionalVal(), llvm::DILocation::getRawInlinedAt(), getSummaryFromMD(), llvm::GetUnrollMetadata(), getValMD(), llvm::getValueProfDataFromInstImpl(), haveCommonPrefix(), llvm::SwitchInstProfUpdateWrapper::init(), llvm::intersectAccessGroups(), isKeyValuePair(), AliasScopeTracker::isNoAliasScopeDeclDead(), IsRootTBAANode(), IsScalarTBAANodeImpl(), isStructPathTBAA(), isTBAAVtableAccess(), llvm::Module::isValidModuleFlag(), llvm::SPIRVCallLowering::lowerFormalArguments(), llvm::makeFollowupLoopID(), llvm::mayHaveValueProfileOfKind(), llvm::MDBuilder::mergeCallbackEncodings(), llvm::MDTuple::pop_back(), propagateMemProfHelper(), llvm::MDTuple::push_back(), llvm::Loop::setLoopID(), setOperand(), llvm::AAMDNodes::shiftTBAAStruct(), llvm::Instruction::swapProfMetadata(), unrollAndJamCountPragmaValue(), unrollCountPragmaValue(), updateLoopMetadataDebugLocationsImpl(), llvm::UpgradeTBAANode(), llvm::TBAAVerifier::visitTBAAMetadata(), and llvm::TBAAVerifier::visitTBAAStructMetadata().

◆ getNumTemporaryUses()

unsigned llvm::MDNode::getNumTemporaryUses ( ) const
inline

Definition at line 1256 of file Metadata.h.

References assert(), Context, and isTemporary().

◆ getNumUnresolved()

unsigned llvm::MDNode::getNumUnresolved ( ) const
inlineprotected

Definition at line 1349 of file Metadata.h.

Referenced by isResolved(), and storeDistinctInContext().

◆ getOperand()

const MDOperand & llvm::MDNode::getOperand ( unsigned  I) const
inline

Definition at line 1428 of file Metadata.h.

References assert(), getNumOperands(), and I.

Referenced by llvm::AbstractCallSite::AbstractCallSite(), AccessQualFromMD(), llvm::DwarfUnit::addAnnotation(), AddRuntimeUnrollDisableMetaData(), llvm::addStringMetadataToLoop(), ArgTypeFromMD(), llvm::cacheAnnotationFromMD(), collectReqs(), llvm::MDBuilder::createMutableTBAAAccessTag(), llvm::TargetLoweringObjectFile::emitCGProfileMetadata(), llvm::MachineInstr::emitError(), llvm::AsmPrinter::emitPCSections(), llvm::extractFromBranchWeightMD(), llvm::extractProfTotalWeight(), llvm::findOptionMDForLoopID(), llvm::findStringMetadataForLoop(), GetArgMD(), GetBranchWeights(), llvm::AbstractCallSite::getCallbackUses(), getConstInt(), llvm::GenericDINode::getDwarfOperand(), llvm::DOTGraphTraits< DOTFuncInfo * >::getEdgeAttributes(), llvm::hlsl::FrontendResource::getElementType(), llvm::Function::getEntryCount(), llvm::FPMathOperator::getFPAccuracy(), llvm::ProfileSummary::getFromMD(), GetFunctionFromMDNode(), llvm::hlsl::FrontendResource::getGlobalVariable(), llvm::hlsl::FrontendResource::getIsROV(), llvm::AMDGPUMachineFunction::getLDSKernelIdMetadata(), getLinkedToSymbol(), getLocCookie(), llvm::Loop::getLoopID(), llvm::MachineLoop::getLoopID(), llvm::memprof::getMIBAllocType(), llvm::memprof::getMIBStackNode(), getOCLKernelArgAttribute(), llvm::DINode::getOperandAs(), llvm::DIMacroNode::getOperandAs(), llvm::getOptionalBoolLoopAttribute(), getOptionalVal(), getOriginalFunctionType(), llvm::DICompositeType::getRawAllocated(), llvm::DIDerivedType::getRawAnnotations(), llvm::DICompositeType::getRawAnnotations(), llvm::DIGlobalVariable::getRawAnnotations(), llvm::DILocalVariable::getRawAnnotations(), llvm::DICompositeType::getRawAssociated(), llvm::DICompositeType::getRawBaseType(), llvm::DIGenericSubrange::getRawCountNode(), llvm::DICompositeType::getRawDataLocation(), llvm::DICommonBlock::getRawDecl(), llvm::DICompositeType::getRawDiscriminator(), llvm::DICompositeType::getRawElements(), llvm::DIMacroFile::getRawElements(), llvm::DICompileUnit::getRawEnumTypes(), llvm::DIGlobalVariableExpression::getRawExpression(), llvm::DIDerivedType::getRawExtraData(), llvm::DIScope::getRawFile(), llvm::DIVariable::getRawFile(), llvm::DICommonBlock::getRawFile(), llvm::DILabel::getRawFile(), llvm::DIObjCProperty::getRawFile(), llvm::DIMacroFile::getRawFile(), llvm::DICompileUnit::getRawGlobalVariables(), llvm::DICompileUnit::getRawImportedEntities(), llvm::DILocation::getRawInlinedAt(), llvm::DIGenericSubrange::getRawLowerBound(), llvm::DICompileUnit::getRawMacros(), llvm::DICompositeType::getRawRank(), llvm::DICompileUnit::getRawRetainedTypes(), llvm::DIType::getRawScope(), llvm::DILocation::getRawScope(), llvm::DILexicalBlockBase::getRawScope(), llvm::DINamespace::getRawScope(), llvm::DIVariable::getRawScope(), llvm::DICommonBlock::getRawScope(), llvm::DILabel::getRawScope(), llvm::DIGlobalVariable::getRawStaticDataMemberDeclaration(), llvm::DIGenericSubrange::getRawStride(), llvm::DIStringType::getRawStringLength(), llvm::DIStringType::getRawStringLengthExp(), llvm::DIStringType::getRawStringLocationExp(), llvm::DICompositeType::getRawTemplateParams(), llvm::DIGlobalVariable::getRawTemplateParams(), llvm::DITemplateParameter::getRawType(), llvm::DIVariable::getRawType(), llvm::DIObjCProperty::getRawType(), llvm::DISubroutineType::getRawTypeArray(), llvm::DIGenericSubrange::getRawUpperBound(), llvm::DIGlobalVariableExpression::getRawVariable(), llvm::DICompositeType::getRawVTableHolder(), llvm::hlsl::FrontendResource::getResourceIndex(), llvm::hlsl::FrontendResource::getResourceKind(), llvm::hlsl::FrontendResource::getSpace(), getSummaryFromMD(), llvm::RISCVTargetLowering::getTargetMMOFlags(), llvm::GetUnrollMetadata(), getValMD(), llvm::DITemplateValueParameter::getValue(), llvm::getValueProfDataFromInstImpl(), hasAnyUnrollPragma(), isKeyValuePair(), AliasScopeTracker::isNoAliasScopeDeclDead(), IsScalarTBAANodeImpl(), isStructPathTBAA(), isTBAAVtableAccess(), llvm::Module::isValidModuleFlag(), llvm::lookupPGONameFromMetadata(), llvm::makeFollowupLoopID(), llvm::mayHaveValueProfileOfKind(), llvm::MDBuilder::mergeCallbackEncodings(), replaceOperandWith(), llvm::Loop::setLoopID(), llvm::AAMDNodes::shiftTBAAStruct(), llvm::Instruction::swapProfMetadata(), unrollAndJamCountPragmaValue(), unrollCountPragmaValue(), updateLoopMetadataDebugLocationsImpl(), updateNVPTXMetadata(), llvm::UpgradeTBAANode(), llvm::TBAAVerifier::visitTBAAMetadata(), and llvm::TBAAVerifier::visitTBAAStructMetadata().

◆ getTemporary()

TempMDTuple llvm::MDNode::getTemporary ( LLVMContext Context,
ArrayRef< Metadata * >  MDs 
)
inlinestatic

◆ intersect()

MDNode * MDNode::intersect ( MDNode A,
MDNode B 
)
static

◆ isAlwaysReplaceable()

bool llvm::MDNode::isAlwaysReplaceable ( ) const
inline

Definition at line 1254 of file Metadata.h.

References llvm::Metadata::getMetadataID().

Referenced by isReplaceable().

◆ isDistinct()

bool llvm::MDNode::isDistinct ( ) const
inline

Definition at line 1250 of file Metadata.h.

References llvm::Metadata::Distinct, and llvm::Metadata::Storage.

Referenced by llvm::DIType::mutate().

◆ isReplaceable()

bool llvm::MDNode::isReplaceable ( ) const
inline

Definition at line 1253 of file Metadata.h.

References isAlwaysReplaceable(), and isTemporary().

Referenced by replaceAllUsesWith().

◆ isResolved()

bool llvm::MDNode::isResolved ( ) const
inline

Check if node is fully resolved.

If isTemporary(), this always returns false; if isDistinct(), this always returns true.

If isUniqued(), returns true if this has already dropped RAUW support (because all operands are resolved).

As forward declarations are resolved, their containers should get resolved automatically. However, if this (or one of its operands) is involved in a cycle, resolveCycles() needs to be called explicitly.

Definition at line 1247 of file Metadata.h.

References getNumUnresolved(), and isTemporary().

Referenced by resolve(), resolveCycles(), and storeDistinctInContext().

◆ isTBAAVtableAccess()

bool MDNode::isTBAAVtableAccess ( ) const

Check whether MDNode is a vtable access.

Definition at line 453 of file TypeBasedAliasAnalysis.cpp.

References getNumOperands(), getOperand(), and isStructPathTBAA().

◆ isTemporary()

bool llvm::MDNode::isTemporary ( ) const
inline

◆ isUniqued()

bool llvm::MDNode::isUniqued ( ) const
inline

◆ mutable_begin()

MDOperand * llvm::MDNode::mutable_begin ( )
inlineprotected

Definition at line 1200 of file Metadata.h.

Referenced by mutable_operands(), op_begin(), replaceOperandWith(), and setOperand().

◆ mutable_end()

MDOperand * llvm::MDNode::mutable_end ( )
inlineprotected

Definition at line 1201 of file Metadata.h.

Referenced by mutable_operands(), and op_end().

◆ mutable_operands()

mutable_op_range llvm::MDNode::mutable_operands ( )
inlineprotected

Definition at line 1205 of file Metadata.h.

References mutable_begin(), and mutable_end().

◆ op_begin()

op_iterator llvm::MDNode::op_begin ( ) const
inline

Definition at line 1418 of file Metadata.h.

References mutable_begin().

Referenced by llvm::GenericDINode::dwarf_op_begin(), and haveCommonPrefix().

◆ op_end()

op_iterator llvm::MDNode::op_end ( ) const
inline

Definition at line 1422 of file Metadata.h.

References mutable_end().

Referenced by llvm::GenericDINode::dwarf_op_end(), and haveCommonPrefix().

◆ operands()

ArrayRef< MDOperand > llvm::MDNode::operands ( ) const
inline

◆ operator delete() [1/3]

void llvm::MDNode::operator delete ( void *  ,
unsigned   
)
inlineprotected

Required by std, but never called.

Definition at line 1189 of file Metadata.h.

References llvm_unreachable.

◆ operator delete() [2/3]

void llvm::MDNode::operator delete ( void *  ,
unsigned  ,
bool   
)
inlineprotected

Required by std, but never called.

Definition at line 1194 of file Metadata.h.

References llvm_unreachable.

◆ operator delete() [3/3]

void MDNode::operator delete ( void *  Mem)
protected

Definition at line 637 of file Metadata.cpp.

References H, and N.

◆ operator new() [1/2]

void * MDNode::operator new ( size_t  Size,
size_t  NumOps,
StorageType  Storage 
)
protected

Definition at line 627 of file Metadata.cpp.

References llvm::alignTo(), H, and Size.

◆ operator new() [2/2]

void * llvm::MDNode::operator new ( size_t  )
delete

◆ operator=()

void llvm::MDNode::operator= ( const MDNode )
delete

◆ printTree() [1/2]

void MDNode::printTree ( raw_ostream OS,
const Module M = nullptr 
) const

Print in tree shape.

Prints definition of this in tree shape.

If M is provided, metadata nodes will be numbered canonically; otherwise, pointer addresses are substituted.

Definition at line 5206 of file AsmWriter.cpp.

References OS, and printMetadataImpl().

Referenced by dumpTree().

◆ printTree() [2/2]

void MDNode::printTree ( raw_ostream OS,
ModuleSlotTracker MST,
const Module M = nullptr 
) const

Definition at line 5212 of file AsmWriter.cpp.

References OS, and printMetadataImpl().

◆ replaceAllUsesWith()

void llvm::MDNode::replaceAllUsesWith ( Metadata MD)
inline

RAUW a temporary.

Precondition
isTemporary() must be true.

Definition at line 1264 of file Metadata.h.

References assert(), Context, and isReplaceable().

Referenced by llvm::at::RAUW().

◆ replaceOperandWith()

void MDNode::replaceOperandWith ( unsigned  I,
Metadata New 
)

◆ replaceWithDistinct()

template<class T >
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > llvm::MDNode::replaceWithDistinct ( std::unique_ptr< T, TempMDNodeDeleter N)
inlinestatic

Replace a temporary node with a distinct one.

Create a distinct version of N – in place, if possible – and return it. Takes ownership of the temporary node.

Definition at line 1309 of file Metadata.h.

References N.

Referenced by llvm::DIBuilder::createArtificialSubprogram().

◆ replaceWithPermanent()

template<class T >
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > llvm::MDNode::replaceWithPermanent ( std::unique_ptr< T, TempMDNodeDeleter N)
inlinestatic

Replace a temporary node with a permanent one.

Try to create a uniqued version of N – in place, if possible – and return it. If N cannot be uniqued, return a distinct node instead.

Definition at line 1287 of file Metadata.h.

References N.

◆ replaceWithUniqued()

template<class T >
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * > llvm::MDNode::replaceWithUniqued ( std::unique_ptr< T, TempMDNodeDeleter N)
inlinestatic

Replace a temporary node with a uniqued one.

Create a uniqued version of N – in place, if possible – and return it. Takes ownership of the temporary node.

Precondition
N does not self-reference.

Definition at line 1299 of file Metadata.h.

References N.

Referenced by llvm::DILocalScope::cloneScopeForSubprogram(), createTypeWithFlags(), and llvm::DIBuilder::replaceTemporary().

◆ resize()

void llvm::MDNode::resize ( size_t  NumOps)
inlineprotected

Resize the node to hold NumOps operands.

Precondition
isTemporary() or isDistinct()
MetadataID == MDTupleKind

Definition at line 1361 of file Metadata.h.

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

Referenced by llvm::MDTuple::pop_back(), and llvm::MDTuple::push_back().

◆ resolve()

void MDNode::resolve ( )

Resolve a unique, unresolved node.

Definition at line 789 of file Metadata.cpp.

References assert(), isResolved(), isUniqued(), and setNumUnresolved().

Referenced by resolveCycles().

◆ resolveCycles()

void MDNode::resolveCycles ( )

Resolve cycles.

Once all forward declarations have been resolved, force cycles to be resolved.

Precondition
No operands (or operands' operands, etc.) have isTemporary().

Definition at line 835 of file Metadata.cpp.

References assert(), isResolved(), N, operands(), and resolve().

◆ setNumUnresolved()

void llvm::MDNode::setNumUnresolved ( unsigned  N)
inlineprotected

Definition at line 1351 of file Metadata.h.

References N.

Referenced by resolve().

◆ setOperand()

void MDNode::setOperand ( unsigned  I,
Metadata New 
)
protected

Set an operand.

Sets the operand directly, without worrying about uniquing.

Definition at line 1083 of file Metadata.cpp.

References assert(), getNumOperands(), I, isUniqued(), mutable_begin(), and llvm::MDOperand::reset().

Referenced by dropAllReferences(), MDNode(), llvm::MDTuple::push_back(), replaceOperandWith(), and llvm::DILexicalBlockBase::replaceScope().

◆ storeDistinctInContext()

void MDNode::storeDistinctInContext ( )
protected

◆ storeImpl() [1/2]

template<class T >
T * llvm::MDNode::storeImpl ( T N,
StorageType  Storage 
)
staticprotected

◆ storeImpl() [2/2]

template<class T , class StoreT >
T * llvm::MDNode::storeImpl ( T N,
StorageType  Storage,
StoreT &  Store 
)
staticprotected

Friends And Related Function Documentation

◆ DIAssignID

friend class DIAssignID
friend

Definition at line 1070 of file Metadata.h.

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 1069 of file Metadata.h.

◆ ReplaceableMetadataImpl

friend class ReplaceableMetadataImpl
friend

Definition at line 1068 of file Metadata.h.


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