A tuple of MDNodes. More...

#include "llvm/IR/Metadata.h"

Inheritance diagram for llvm::NamedMDNode:

[legend]

Collaboration diagram for llvm::NamedMDNode:

[legend]

Public Types
using	op_iterator = op_iterator_impl< MDNode *, MDNode >

using	const_op_iterator = op_iterator_impl< const MDNode *, MDNode >

Public Member Functions
	NamedMDNode (const NamedMDNode &)=delete

	~NamedMDNode ()

void	eraseFromParent ()
	Drop all references and remove the node from parent module.

void	dropAllReferences ()
	Remove all uses and clear node vector.

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

MDNode *	getOperand (unsigned i) const

unsigned	getNumOperands () const

void	addOperand (MDNode *M)

void	setOperand (unsigned I, MDNode *New)

StringRef	getName () const

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

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

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< OptionsT >
self_iterator	getIterator ()

const_self_iterator	getIterator () const

reverse_self_iterator	getReverseIterator ()

const_reverse_self_iterator	getReverseIterator () const

bool	isSentinel () const
	Check whether this is the sentinel node.

Friends
class	LLVMContextImpl

class	Module

Additional Inherited Members
Protected Types inherited from llvm::ilist_node_impl< OptionsT >
using	self_iterator = ilist_iterator< OptionsT, false, false >

using	const_self_iterator = ilist_iterator< OptionsT, false, true >

using	reverse_self_iterator = ilist_iterator< OptionsT, true, false >

using	const_reverse_self_iterator = ilist_iterator< OptionsT, true, true >

Protected Member Functions inherited from llvm::ilist_node_impl< OptionsT >
	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 1587 of file Metadata.h.

Member Typedef Documentation

◆ const_op_iterator

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

Definition at line 1678 of file Metadata.h.

◆ op_iterator

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

Definition at line 1673 of file Metadata.h.

Constructor & Destructor Documentation

◆ NamedMDNode()

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

delete

◆ ~NamedMDNode()

NamedMDNode::~NamedMDNode ( )

Definition at line 1206 of file Metadata.cpp.

References dropAllReferences(), and getNMDOps().

Member Function Documentation

◆ addOperand()

void NamedMDNode::addOperand ( MDNode * M )

Definition at line 1221 of file Metadata.cpp.

References getNMDOps().

Referenced by llvm::Module::addModuleFlag(), llvm::CloneModule(), llvm::DIBuilder::createCompileUnit(), llvm::dxil::createEntryMD(), llvm::OpenMPIRBuilder::createOffloadEntriesAndInfoMetadata(), llvm::OpenMPIRBuilder::createOffloadEntry(), llvm::embedBufferInModule(), stripDeadDebugInfoImpl(), llvm::stripDebugifyMetadata(), llvm::dxil::ValidatorVersionMD::update(), and llvm::dxil::Resources::write().

◆ clearOperands()

void NamedMDNode::clearOperands ( )

Drop all references to this node's operands.

Definition at line 1230 of file Metadata.cpp.

References getNMDOps().

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

◆ dropAllReferences()

void llvm::NamedMDNode::dropAllReferences ( )

inline

Remove all uses and clear node vector.

Definition at line 1652 of file Metadata.h.

References clearOperands().

Referenced by ~NamedMDNode().

◆ dump()

LLVM_DUMP_METHOD void NamedMDNode::dump ( ) const

Definition at line 4960 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 1228 of file Metadata.cpp.

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

Referenced by llvm::stripDebugifyMetadata().

◆ getName()

StringRef NamedMDNode::getName ( ) const

Definition at line 1232 of file Metadata.cpp.

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

◆ getNumOperands()

unsigned NamedMDNode::getNumOperands ( ) const

Definition at line 1211 of file Metadata.cpp.

References getNMDOps().

Referenced by llvm::cacheAnnotationFromMD(), getHiPELiteral(), getKernelArgAttribute(), getOperand(), llvm::dxil::ValidatorVersionMD::isEmpty(), op_end(), llvm::Module::setModuleFlag(), setOperand(), llvm::stripDebugifyMetadata(), and llvm::UpgradeModuleFlags().

◆ getOperand()

MDNode * NamedMDNode::getOperand ( unsigned i ) const

Definition at line 1215 of file Metadata.cpp.

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

Referenced by llvm::cacheAnnotationFromMD(), getHiPELiteral(), getKernelArgAttribute(), llvm::Module::debug_compile_units_iterator::operator*(), llvm::Module::setModuleFlag(), llvm::UpgradeModuleFlags(), and UpgradeRetainReleaseMarker().

◆ getParent() [1/2]

Module * llvm::NamedMDNode::getParent ( )

inline

Get the module that holds this named metadata collection.

Definition at line 1657 of file Metadata.h.

Referenced by eraseFromParent(), LLVMGetNextNamedMetadata(), LLVMGetPreviousNamedMetadata(), print(), and llvm::dxil::ValidatorVersionMD::update().

◆ getParent() [2/2]

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

inline

Definition at line 1658 of file Metadata.h.

◆ op_begin() [1/2]

op_iterator llvm::NamedMDNode::op_begin ( )

inline

Definition at line 1675 of file Metadata.h.

Referenced by operands().

◆ op_begin() [2/2]

const_op_iterator llvm::NamedMDNode::op_begin ( ) const

inline

Definition at line 1680 of file Metadata.h.

◆ op_end() [1/2]

op_iterator llvm::NamedMDNode::op_end ( )

inline

Definition at line 1676 of file Metadata.h.

References getNumOperands().

Referenced by operands().

◆ op_end() [2/2]

const_op_iterator llvm::NamedMDNode::op_end ( ) const

inline

Definition at line 1681 of file Metadata.h.

References getNumOperands().

◆ operands() [1/2]

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

inline

Definition at line 1683 of file Metadata.h.

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

Referenced by llvm::omp::getDeviceKernels(), llvm::Module::getModuleFlagsMetadata(), llvm::OpenMPIRBuilder::loadOffloadInfoMetadata(), and llvm::stripDebugifyMetadata().

◆ operands() [2/2]

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

inline

Definition at line 1686 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 4624 of file AsmWriter.cpp.

References getParent(), and OS.

Referenced by dump().

◆ print() [2/2]

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

Definition at line 4631 of file AsmWriter.cpp.

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

◆ setOperand()

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

Definition at line 1223 of file Metadata.cpp.

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

Referenced by llvm::dxil::ValidatorVersionMD::update(), and llvm::UpgradeModuleFlags().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl

friend

Definition at line 1588 of file Metadata.h.

◆ Module

friend class Module

friend

Definition at line 1589 of file Metadata.h.

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

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

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_op_iterator

◆ op_iterator

Constructor & Destructor Documentation

◆ NamedMDNode()

◆ ~NamedMDNode()

Member Function Documentation

◆ addOperand()

◆ clearOperands()

◆ dropAllReferences()

◆ dump()

◆ eraseFromParent()

◆ getName()

◆ getNumOperands()

◆ getOperand()

◆ getParent() [1/2]

◆ getParent() [2/2]

◆ op_begin() [1/2]

◆ op_begin() [2/2]

◆ op_end() [1/2]

◆ op_end() [2/2]

◆ operands() [1/2]

◆ operands() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ setOperand()

Friends And Related Function Documentation

◆ LLVMContextImpl

◆ Module