LLVM  6.0.0svn
Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::MDTuple Class Reference

Tuple of metadata. More...

#include "llvm/IR/Metadata.h"

Inheritance diagram for llvm::MDTuple:
Inheritance graph
[legend]
Collaboration diagram for llvm::MDTuple:
Collaboration graph
[legend]

Public Member Functions

unsigned getHash () const
 Get the hash, if any. More...
 
TempMDTuple clone () const
 Return a (temporary) clone of this. More...
 
- Public Member Functions inherited from llvm::MDNode
 MDNode (const MDNode &)=delete
 
void operator= (const MDNode &)=delete
 
void * operator new (size_t)=delete
 
TempMDNode clone () const
 Create a (temporary) clone of this. More...
 
LLVMContextgetContext () const
 
void replaceOperandWith (unsigned I, Metadata *New)
 Replace a specific operand. More...
 
bool isResolved () const
 Check if node is fully resolved. More...
 
bool isUniqued () const
 
bool isDistinct () const
 
bool isTemporary () const
 
void replaceAllUsesWith (Metadata *MD)
 RAUW a temporary. More...
 
void resolveCycles ()
 Resolve cycles. More...
 
void resolve ()
 Resolve a unique, unresolved node. More...
 
op_iterator op_begin () const
 
op_iterator op_end () const
 
op_range operands () const
 
const MDOperandgetOperand (unsigned I) const
 
unsigned getNumOperands () const
 Return number of MDNode operands. More...
 
bool isTBAAVtableAccess () const
 Check whether MDNode is a vtable access. More...
 

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)
 Return a distinct node. More...
 
static TempMDTuple getTemporary (LLVMContext &Context, ArrayRef< Metadata *> MDs)
 Return a temporary node. More...
 
static bool classof (const Metadata *MD)
 
- Static Public Member Functions inherited from llvm::MDNode
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. More...
 
template<class T >
static std::enable_if< std::is_base_of< MDNode, T >::value, T * >::type replaceWithPermanent (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a permanent one. More...
 
template<class T >
static std::enable_if< std::is_base_of< MDNode, T >::value, T * >::type replaceWithUniqued (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a uniqued one. More...
 
template<class T >
static std::enable_if< std::is_base_of< MDNode, T >::value, T * >::type replaceWithDistinct (std::unique_ptr< T, TempMDNodeDeleter > N)
 Replace a temporary node with a distinct one. More...
 
static bool classof (const Metadata *MD)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
static MDNodeconcatenate (MDNode *A, MDNode *B)
 Methods for metadata merging. More...
 
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)
 

Friends

class LLVMContextImpl
 
class MDNode
 

Additional Inherited Members

- Public Types inherited from llvm::MDNode
using op_iterator = const MDOperand *
 
using op_range = iterator_range< op_iterator >
 
- Protected Types inherited from llvm::MDNode
using mutable_op_range = iterator_range< MDOperand * >
 
 Active type of storage. More...
- Protected Member Functions inherited from llvm::MDNode
 MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata *> Ops1, ArrayRef< Metadata *> Ops2=None)
 
 ~MDNode ()=default
 
void * operator new (size_t Size, unsigned NumOps)
 
void operator delete (void *Mem)
 
void operator delete (void *, unsigned)
 Required by std, but never called. More...
 
void operator delete (void *, unsigned, bool)
 Required by std, but never called. More...
 
void dropAllReferences ()
 
MDOperandmutable_begin ()
 
MDOperandmutable_end ()
 
mutable_op_range mutable_operands ()
 
void setOperand (unsigned I, Metadata *New)
 Set an operand. More...
 
void storeDistinctInContext ()
 
- Static Protected Member Functions inherited from llvm::MDNode
template<class T , class StoreT >
static TstoreImpl (T *N, StorageType Storage, StoreT &Store)
 
template<class T >
static TstoreImpl (T *N, StorageType Storage)
 

Detailed Description

Tuple of metadata.

This is the simple MDNode arbitrary tuple. Nodes are uniqued by default based on their operands.

Definition at line 1104 of file Metadata.h.

Member Function Documentation

◆ classof()

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

Definition at line 1159 of file Metadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

TempMDTuple llvm::MDTuple::clone ( ) const
inline

Return a (temporary) clone of this.

Definition at line 1157 of file Metadata.h.

◆ get()

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

◆ getDistinct()

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

Return a distinct node.

Return a distinct node – i.e., a node that is not uniqued.

Definition at line 1142 of file Metadata.h.

References llvm::Metadata::Distinct, and getImpl().

Referenced by FunctionNumber(), and llvm::MDNode::getDistinct().

◆ getHash()

unsigned llvm::MDTuple::getHash ( ) const
inline

Get the hash, if any.

Definition at line 1129 of file Metadata.h.

References llvm::Metadata::SubclassData32.

◆ getIfExists()

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

Definition at line 1135 of file Metadata.h.

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

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

◆ getTemporary()

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

Return a temporary node.

For use in constructing cyclic MDNode structures. A temporary MDNode is not uniqued, may be RAUW'd, and must be manually deleted with deleteTemporary.

Definition at line 1151 of file Metadata.h.

References getImpl(), and llvm::Metadata::Temporary.

Referenced by CloneAliasScopeMetadata(), llvm::DIBuilder::createFunction(), llvm::MDNode::getTemporary(), and llvm::LLParser::parseTypeAtBeginning().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 1105 of file Metadata.h.

◆ MDNode

friend class MDNode
friend

Definition at line 1106 of file Metadata.h.


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