LLVM 19.0.0git
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::DIMacro Class Reference

Macro. More...

#include "llvm/IR/DebugInfoMetadata.h"

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

Public Member Functions

 DEFINE_MDNODE_GET (DIMacro,(unsigned MIType, unsigned Line, StringRef Name, StringRef Value=""),(MIType, Line, Name, Value)) DEFINE_MDNODE_GET(DIMacro
 
unsigned unsigned MDString MDString Value TempDIMacro clone () const
 
unsigned getLine () const
 
StringRef getName () const
 
StringRef getValue () const
 
MDStringgetRawName () const
 
MDStringgetRawValue () const
 
- Public Member Functions inherited from llvm::DIMacroNode
unsigned getMacinfoType () const
 
- 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.
 
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 bool classof (const Metadata *MD)
 
- Static Public Member Functions inherited from llvm::DIMacroNode
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.
 
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.
 

Public Attributes

unsigned MIType
 
unsigned unsigned Line
 
unsigned unsigned MDStringName
 
unsigned unsigned MDString MDStringValue
 
unsigned unsigned MDString MDString MIType
 
unsigned unsigned MDString MDString Line
 
unsigned unsigned MDString MDString Name
 

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::DIMacroNode
 DIMacroNode (LLVMContext &C, unsigned ID, StorageType Storage, unsigned MIType, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2=std::nullopt)
 
 ~DIMacroNode ()=default
 
template<class Ty >
Ty * getOperandAs (unsigned I) const
 
StringRef getStringOperand (unsigned I) const
 
- Protected Member Functions inherited from llvm::MDNode
 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 inherited from llvm::DIMacroNode
static MDStringgetCanonicalMDString (LLVMContext &Context, StringRef S)
 
- 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

Macro.

Uses the SubclassData32 Metadata slot.

Definition at line 3693 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

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

Definition at line 3739 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

unsigned unsigned MDString MDString Value TempDIMacro llvm::DIMacro::clone ( ) const
inline

Definition at line 3729 of file DebugInfoMetadata.h.

◆ DEFINE_MDNODE_GET()

llvm::DIMacro::DEFINE_MDNODE_GET ( DIMacro  ,
(unsigned MIType, unsigned Line, StringRef Name, StringRef Value="")  ,
(MIType, Line, Name, Value  
)

◆ getLine()

unsigned llvm::DIMacro::getLine ( ) const
inline

Definition at line 3731 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData32.

◆ getName()

StringRef llvm::DIMacro::getName ( ) const
inline

Definition at line 3733 of file DebugInfoMetadata.h.

References llvm::DIMacroNode::getStringOperand().

◆ getRawName()

MDString * llvm::DIMacro::getRawName ( ) const
inline

Definition at line 3736 of file DebugInfoMetadata.h.

◆ getRawValue()

MDString * llvm::DIMacro::getRawValue ( ) const
inline

Definition at line 3737 of file DebugInfoMetadata.h.

◆ getValue()

StringRef llvm::DIMacro::getValue ( ) const
inline

Definition at line 3734 of file DebugInfoMetadata.h.

References llvm::DIMacroNode::getStringOperand().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 3694 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode
friend

Definition at line 3695 of file DebugInfoMetadata.h.

Member Data Documentation

◆ Line [1/2]

unsigned unsigned llvm::DIMacro::Line

Definition at line 3725 of file DebugInfoMetadata.h.

◆ Line [2/2]

unsigned unsigned MDString MDString llvm::DIMacro::Line

Definition at line 3727 of file DebugInfoMetadata.h.

◆ MIType [1/2]

unsigned llvm::DIMacro::MIType

Definition at line 3725 of file DebugInfoMetadata.h.

◆ MIType [2/2]

unsigned unsigned MDString MDString llvm::DIMacro::MIType

Definition at line 3727 of file DebugInfoMetadata.h.

◆ Name [1/2]

unsigned unsigned MDString* llvm::DIMacro::Name

Definition at line 3725 of file DebugInfoMetadata.h.

◆ Name [2/2]

unsigned unsigned MDString MDString llvm::DIMacro::Name

Definition at line 3727 of file DebugInfoMetadata.h.

◆ Value

unsigned unsigned MDString MDString* llvm::DIMacro::Value

Definition at line 3726 of file DebugInfoMetadata.h.


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