LLVM 22.0.0git
llvm::DISubroutineType Class Reference

Type array for a subprogram. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DISubroutineType:
[legend]

Public Member Functions

 DEFINE_MDNODE_GET (DISubroutineType,(DIFlags Flags, uint8_t CC, DITypeRefArray TypeArray),(Flags, CC, TypeArray)) DEFINE_MDNODE_GET(DISubroutineType
DIFlags uint8_t Metadata TypeArray TempDISubroutineType clone () const
TempDISubroutineType cloneWithCC (uint8_t CC) const
uint8_t getCC () const
DITypeRefArray getTypeArray () const
MetadatagetRawTypeArray () const
Public Member Functions inherited from llvm::DIType
TempDIType clone () const
unsigned getLine () const
LLVM_ABI uint32_t getAlignInBits () const
uint32_t getAlignInBytes () const
uint32_t getNumExtraInhabitants () const
DIFlags getFlags () const
DIScopegetScope () const
StringRef getName () const
MetadatagetRawScope () const
MDStringgetRawName () const
MetadatagetRawSizeInBits () const
uint64_t getSizeInBits () const
MetadatagetRawOffsetInBits () const
uint64_t getOffsetInBits () const
TempDIType cloneWithFlags (DIFlags NewFlags) const
 Returns a new temporary DIType with updated Flags.
bool isPrivate () const
bool isProtected () const
bool isPublic () const
bool isForwardDecl () const
bool isAppleBlockExtension () const
bool isVirtual () const
bool isArtificial () const
bool isObjectPointer () const
bool isObjcClassComplete () const
bool isVector () const
bool isBitField () const
bool isStaticMember () const
bool isLValueReference () const
bool isRValueReference () const
bool isTypePassByValue () const
bool isTypePassByReference () const
bool isBigEndian () const
bool isLittleEndian () const
bool getExportSymbols () const
Public Member Functions inherited from llvm::DIScope
DIFilegetFile () const
StringRef getFilename () const
StringRef getDirectory () const
std::optional< StringRefgetSource () const
LLVM_ABI StringRef getName () const
LLVM_ABI DIScopegetScope () const
MetadatagetRawFile () const
 Return the raw underlying file.
Public Member Functions inherited from llvm::DINode
LLVM_ABI dwarf::Tag getTag () const
Public Member Functions inherited from llvm::MDNode
 MDNode (const MDNode &)=delete
void operator= (const MDNode &)=delete
void * operator new (size_t)=delete
LLVM_ABI TempMDNode clone () const
 Create a (temporary) clone of this.
LLVMContextgetContext () const
LLVM_ABI 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
bool hasGeneralizedMDString ()
 Check if this is a valid generalized type metadata node.
unsigned getNumTemporaryUses () const
void replaceAllUsesWith (Metadata *MD)
 RAUW a temporary.
LLVM_ABI void resolveCycles ()
 Resolve cycles.
LLVM_ABI 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.
LLVM_ABI bool isTBAAVtableAccess () const
 Check whether MDNode is a vtable access.
LLVM_ABI void printTree (raw_ostream &OS, const Module *M=nullptr) const
 Print in tree shape.
LLVM_ABI void printTree (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const
LLVM_ABI void dumpTree () const
 User-friendly dump in tree shape.
LLVM_ABI void dumpTree (const Module *M) const

Static Public Member Functions

static bool classof (const Metadata *MD)
Static Public Member Functions inherited from llvm::DIType
static bool classof (const Metadata *MD)
Static Public Member Functions inherited from llvm::DIScope
static bool classof (const Metadata *MD)
Static Public Member Functions inherited from llvm::DINode
static LLVM_ABI DIFlags getFlag (StringRef Flag)
static LLVM_ABI StringRef getFlagString (DIFlags Flag)
static LLVM_ABI DIFlags splitFlags (DIFlags Flags, SmallVectorImpl< DIFlags > &SplitFlags)
 Split up a flags bitfield.
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 LLVM_ABI 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 LLVM_ABI MDNodeconcatenate (MDNode *A, MDNode *B)
 Methods for metadata merging.
static LLVM_ABI MDNodeintersect (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericTBAA (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericFPMath (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericRange (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericNoaliasAddrspace (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericAliasScope (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMostGenericAlignmentOrDereferenceable (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMergedProfMetadata (MDNode *A, MDNode *B, const Instruction *AInstr, const Instruction *BInstr)
 Merge !prof metadata from two instructions.
static LLVM_ABI MDNodegetMergedMemProfMetadata (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMergedCallsiteMetadata (MDNode *A, MDNode *B)
static LLVM_ABI MDNodegetMergedCalleeTypeMetadata (const MDNode *A, const MDNode *B)

Public Attributes

DIFlags Flags
DIFlags uint8_t CC
DIFlags uint8_t MetadataTypeArray
DIFlags uint8_t Metadata Flags
DIFlags uint8_t Metadata CC

Friends

class LLVMContextImpl
class MDNode

Additional Inherited Members

Public Types inherited from llvm::DINode
enum  DIFlags : uint32_t { FlagAccessibility = FlagPrivate | FlagProtected | FlagPublic , FlagPtrToMemberRep }
 Debug info flags. More...
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::DIType
 DIType (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, unsigned Line, uint32_t AlignInBits, uint32_t NumExtraInhabitants, DIFlags Flags, ArrayRef< Metadata * > Ops)
 ~DIType ()=default
void init (unsigned Line, uint32_t AlignInBits, uint32_t NumExtraInhabitants, DIFlags Flags)
void mutate (unsigned Tag, unsigned Line, uint32_t AlignInBits, uint32_t NumExtraInhabitants, DIFlags Flags)
 Change fields in place.
Protected Member Functions inherited from llvm::DIScope
 DIScope (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops)
 ~DIScope ()=default
Protected Member Functions inherited from llvm::DINode
 DINode (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2={})
 ~DINode ()=default
template<class Ty>
Ty * getOperandAs (unsigned I) const
StringRef getStringOperand (unsigned I) const
void setTag (unsigned Tag)
 Allow subclasses to mutate the tag.
Protected Member Functions inherited from llvm::MDNode
LLVM_ABI MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2={})
 ~MDNode ()=default
LLVM_ABI void * operator new (size_t Size, size_t NumOps, StorageType Storage)
LLVM_ABI 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.
LLVM_ABI void dropAllReferences ()
MDOperandmutable_begin ()
MDOperandmutable_end ()
mutable_op_range mutable_operands ()
LLVM_ABI void setOperand (unsigned I, Metadata *New)
 Set an operand.
unsigned getNumUnresolved () const
void setNumUnresolved (unsigned N)
LLVM_ABI void storeDistinctInContext ()
void resize (size_t NumOps)
 Resize the node to hold NumOps operands.
Static Protected Member Functions inherited from llvm::DINode
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)
Static Protected Attributes inherited from llvm::DIType
static constexpr unsigned N_OPERANDS = 5

Detailed Description

Type array for a subprogram.

TODO: Fold the array of types in directly as operands.

Definition at line 1918 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

bool llvm::DISubroutineType::classof ( const Metadata * MD)
inlinestatic

Definition at line 1971 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

DIFlags uint8_t Metadata TypeArray TempDISubroutineType llvm::DISubroutineType::clone ( ) const
inline

Definition at line 1955 of file DebugInfoMetadata.h.

References clone().

Referenced by clone(), and cloneWithCC().

◆ cloneWithCC()

TempDISubroutineType llvm::DISubroutineType::cloneWithCC ( uint8_t CC) const
inline

Definition at line 1957 of file DebugInfoMetadata.h.

References clone().

◆ DEFINE_MDNODE_GET()

llvm::DISubroutineType::DEFINE_MDNODE_GET ( DISubroutineType ,
(DIFlags Flags, uint8_t CC, DITypeRefArray TypeArray) ,
(Flags, CC, TypeArray)  )

References Flags, and TypeArray.

◆ getCC()

uint8_t llvm::DISubroutineType::getCC ( ) const
inline

Definition at line 1963 of file DebugInfoMetadata.h.

◆ getRawTypeArray()

Metadata * llvm::DISubroutineType::getRawTypeArray ( ) const
inline

Definition at line 1969 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getTypeArray().

◆ getTypeArray()

DITypeRefArray llvm::DISubroutineType::getTypeArray ( ) const
inline

Definition at line 1965 of file DebugInfoMetadata.h.

References llvm::cast_or_null(), and getRawTypeArray().

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 1919 of file DebugInfoMetadata.h.

References LLVMContextImpl.

Referenced by LLVMContextImpl.

◆ MDNode

Member Data Documentation

◆ CC [1/2]

DIFlags uint8_t llvm::DISubroutineType::CC

Definition at line 1952 of file DebugInfoMetadata.h.

◆ CC [2/2]

DIFlags uint8_t Metadata llvm::DISubroutineType::CC

Definition at line 1953 of file DebugInfoMetadata.h.

◆ Flags [1/2]

DIFlags llvm::DISubroutineType::Flags

Definition at line 1952 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.

◆ Flags [2/2]

DIFlags uint8_t Metadata llvm::DISubroutineType::Flags

Definition at line 1953 of file DebugInfoMetadata.h.

◆ TypeArray

DIFlags uint8_t Metadata* llvm::DISubroutineType::TypeArray

Definition at line 1952 of file DebugInfoMetadata.h.

Referenced by DEFINE_MDNODE_GET(), and MDNode.


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