LLVM 22.0.0git
Public Types | Public Member Functions | Friends | List of all members
llvm::NamedMDNode Class Reference

A tuple of MDNodes. More...

#include "llvm/IR/Metadata.h"

Inheritance diagram for llvm::NamedMDNode:
[legend]

Public Types

using op_iterator = op_iterator_impl<MDNode *>
using const_op_iterator = op_iterator_impl<const MDNode *>

Public Member Functions

 NamedMDNode (const NamedMDNode &)=delete
LLVM_ABI ~NamedMDNode ()
LLVM_ABI void eraseFromParent ()
 Drop all references and remove the node from parent module.
void dropAllReferences ()
 Remove all uses and clear node vector.
LLVM_ABI void clearOperands ()
 Drop all references to this node's operands.
Module * getParent ()
 Get the module that holds this named metadata collection.
const Module * getParent () const
LLVM_ABI MDNode * getOperand (unsigned i) const
LLVM_ABI unsigned getNumOperands () const
LLVM_ABI void addOperand (MDNode *M)
LLVM_ABI void setOperand (unsigned I, MDNode *New)
LLVM_ABI StringRef getName () const
LLVM_ABI void print (raw_ostream &ROS, bool IsForDebug=false) const
LLVM_ABI void print (raw_ostream &ROS, ModuleSlotTracker &MST, bool IsForDebug=false) const
LLVM_ABI void dump () const
op_iterator op_begin ()
op_iterator op_end ()
const_op_iterator op_begin () const
const_op_iterator op_end () const
iterator_range< op_iterator > operands ()
iterator_range< const_op_iterator > operands () const
Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< NamedMDNode, Options... >::type >
self_iterator getIterator ()
reverse_self_iterator getReverseIterator ()
std::enable_if_t< T::is_sentinel_tracking_explicit, bool > isSentinel () const
 Check whether this is the sentinel node.
Public Member Functions inherited from llvm::ilist_detail::node_parent_access< ilist_node_impl< ilist_detail::compute_node_options< NamedMDNode, Options... >::type >, ilist_detail::compute_node_options< NamedMDNode, Options... >::type::parent_ty >
const ilist_detail::compute_node_options< NamedMDNode, Options... >::type::parent_ty * getParent () const
void setParent (ilist_detail::compute_node_options< NamedMDNode, Options... >::type::parent_ty *Parent)

Friends

class LLVMContextImpl
class Module

Additional Inherited Members

Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< NamedMDNode, Options... >::type >
using self_iterator
using const_self_iterator
using reverse_self_iterator
using const_reverse_self_iterator
Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< NamedMDNode, Options... >::type >
 ilist_node_impl ()=default

Detailed Description

A tuple of MDNodes.

Despite its name, a NamedMDNode isn't itself an MDNode.

NamedMDNodes are named module-level entities that contain lists of MDNodes.

It is illegal for a NamedMDNode to appear as an operand of an MDNode.

Definition at line 1757 of file Metadata.h.

Member Typedef Documentation

◆ const_op_iterator

using llvm::NamedMDNode::const_op_iterator = op_iterator_impl<const MDNode *>

Definition at line 1848 of file Metadata.h.

◆ op_iterator

using llvm::NamedMDNode::op_iterator = op_iterator_impl<MDNode *>

Definition at line 1843 of file Metadata.h.

Constructor & Destructor Documentation

◆ NamedMDNode()

llvm::NamedMDNode::NamedMDNode ( const NamedMDNode & )
delete

References LLVM_ABI.

◆ ~NamedMDNode()

NamedMDNode::~NamedMDNode ( )

Definition at line 1484 of file Metadata.cpp.

References dropAllReferences(), and getNMDOps().

Member Function Documentation

◆ addOperand()

void NamedMDNode::addOperand ( MDNode * M)

Definition at line 1499 of file Metadata.cpp.

References getNMDOps().

Referenced by llvm::CloneModule(), llvm::DIBuilder::createCompileUnit(), llvm::embedBufferInModule(), llvm::emitAMDGPUPrintfCall(), emitDXILVersionTupleMD(), emitResourceMetadata(), emitShaderModelVersionMD(), emitValidatorVersionMD(), llvm::offloading::getOffloadingEntryInitializer(), stripDeadDebugInfoImpl(), llvm::stripDebugifyMetadata(), translateMetadata(), and llvm::UpgradeNVVMAnnotations().

◆ clearOperands()

void NamedMDNode::clearOperands ( )

Drop all references to this node's operands.

Definition at line 1508 of file Metadata.cpp.

References getNMDOps().

Referenced by dropAllReferences(), emitValidatorVersionMD(), stripDeadDebugInfoImpl(), llvm::stripDebugifyMetadata(), and llvm::UpgradeNVVMAnnotations().

◆ dropAllReferences()

void llvm::NamedMDNode::dropAllReferences ( )
inline

Remove all uses and clear node vector.

Definition at line 1822 of file Metadata.h.

References clearOperands().

Referenced by handleValVerMetadata(), and ~NamedMDNode().

◆ dump()

LLVM_DUMP_METHOD void NamedMDNode::dump ( ) const

Definition at line 5422 of file AsmWriter.cpp.

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

◆ eraseFromParent()

void NamedMDNode::eraseFromParent ( )

Drop all references and remove the node from parent module.

Definition at line 1506 of file Metadata.cpp.

References llvm::Module::eraseNamedMetadata(), and getParent().

Referenced by handleValVerMetadata(), and llvm::stripDebugifyMetadata().

◆ getName()

StringRef NamedMDNode::getName ( ) const

Definition at line 1510 of file Metadata.cpp.

Referenced by LLVMGetNamedMetadataName(), and llvm::stripNonLineTableDebugInfo().

◆ getNumOperands()

unsigned NamedMDNode::getNumOperands ( ) const

Definition at line 1489 of file Metadata.cpp.

References getNMDOps().

Referenced by analyzeModule(), llvm::cacheAnnotationFromMD(), llvm::emitAMDGPUPrintfCall(), getHiPELiteral(), getOCLKernelArgAttribute(), getOperand(), op_end(), op_end(), setOperand(), llvm::stripDebugifyMetadata(), and llvm::UpgradeModuleFlags().

◆ getOperand()

MDNode * NamedMDNode::getOperand ( unsigned i) const

Definition at line 1493 of file Metadata.cpp.

References assert(), llvm::cast_or_null(), getNMDOps(), getNumOperands(), and N.

Referenced by llvm::cacheAnnotationFromMD(), collectMetadataInfo(), getHiPELiteral(), getOCLKernelArgAttribute(), handleValVerMetadata(), translateMetadata(), llvm::UpgradeModuleFlags(), and upgradeRetainReleaseMarker().

◆ getParent() [1/2]

Module * llvm::NamedMDNode::getParent ( )
inline

Get the module that holds this named metadata collection.

Definition at line 1827 of file Metadata.h.

References Module.

Referenced by eraseFromParent(), LLVMGetNextNamedMetadata(), and LLVMGetPreviousNamedMetadata().

◆ getParent() [2/2]

const Module * llvm::NamedMDNode::getParent ( ) const
inline

Definition at line 1828 of file Metadata.h.

References Module.

◆ op_begin() [1/2]

op_iterator llvm::NamedMDNode::op_begin ( )
inline

Definition at line 1845 of file Metadata.h.

Referenced by operands(), and operands().

◆ op_begin() [2/2]

const_op_iterator llvm::NamedMDNode::op_begin ( ) const
inline

Definition at line 1850 of file Metadata.h.

◆ op_end() [1/2]

op_iterator llvm::NamedMDNode::op_end ( )
inline

Definition at line 1846 of file Metadata.h.

References getNumOperands().

Referenced by operands(), and operands().

◆ op_end() [2/2]

const_op_iterator llvm::NamedMDNode::op_end ( ) const
inline

Definition at line 1851 of file Metadata.h.

References getNumOperands().

◆ operands() [1/2]

iterator_range< op_iterator > llvm::NamedMDNode::operands ( )
inline

Definition at line 1853 of file Metadata.h.

References llvm::make_range(), op_begin(), and op_end().

Referenced by analyzeModule(), llvm::CodeViewDebug::beginModule(), llvm::TargetLoweringObjectFile::emitPseudoProbeDescMetadata(), llvm::hlsl::CBufferMetadata::get(), llvm::stripDebugifyMetadata(), and llvm::UpgradeNVVMAnnotations().

◆ operands() [2/2]

iterator_range< const_op_iterator > llvm::NamedMDNode::operands ( ) const
inline

Definition at line 1856 of file Metadata.h.

References llvm::make_range(), op_begin(), and op_end().

◆ print() [1/2]

void NamedMDNode::print ( raw_ostream & ROS,
bool IsForDebug = false ) const

Definition at line 5019 of file AsmWriter.cpp.

References getParent().

◆ print() [2/2]

void NamedMDNode::print ( raw_ostream & ROS,
ModuleSlotTracker & MST,
bool IsForDebug = false ) const

Definition at line 5026 of file AsmWriter.cpp.

References llvm::ModuleSlotTracker::getMachine(), and getParent().

◆ setOperand()

void NamedMDNode::setOperand ( unsigned I,
MDNode * New )

Definition at line 1501 of file Metadata.cpp.

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

Referenced by llvm::UpgradeModuleFlags().

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 1758 of file Metadata.h.

References LLVMContextImpl.

Referenced by LLVMContextImpl.

◆ Module

friend class Module
friend

Definition at line 1759 of file Metadata.h.

References Module.

Referenced by getParent(), getParent(), and Module.

The documentation for this class was generated from the following files:
Generated on for LLVM by doxygen 1.14.0