LLVM  10.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::DISubprogram Class Reference

Subprogram description. More...

#include "llvm/IR/DebugInfoMetadata.h"

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

Public Types

enum  DISPFlags : uint32_t { SPFlagNonvirtual = SPFlagZero, SPFlagVirtuality = SPFlagVirtual | SPFlagPureVirtual }
 Debug info subprogram flags. More...
 
- 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 >
 

Public Member Functions

 DEFINE_MDNODE_GET (DISubprogram,(DIScope *Scope, StringRef Name, StringRef LinkageName, DIFile *File, unsigned Line, DISubroutineType *Type, unsigned ScopeLine, DIType *ContainingType, unsigned VirtualIndex, int ThisAdjustment, DIFlags Flags, DISPFlags SPFlags, DICompileUnit *Unit, DITemplateParameterArray TemplateParams=nullptr, DISubprogram *Declaration=nullptr, DINodeArray RetainedNodes=nullptr, DITypeArray ThrownTypes=nullptr),(Scope, Name, LinkageName, File, Line, Type, ScopeLine, ContainingType, VirtualIndex, ThisAdjustment, Flags, SPFlags, Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes)) DEFINE_MDNODE_GET(DISubprogram
 
- Public Member Functions inherited from llvm::DILocalScope
DISubprogramgetSubprogram () const
 Get the subprogram for this scope. More...
 
DILocalScopegetNonLexicalBlockFileScope () const
 Get the first non DILexicalBlockFile scope of this scope. More...
 
- Public Member Functions inherited from llvm::DIScope
DIFilegetFile () const
 
StringRef getFilename () const
 
StringRef getDirectory () const
 
Optional< StringRefgetSource () const
 
StringRef getName () const
 
DIScopegetScope () const
 
MetadatagetRawFile () const
 Return the raw underlying file. More...
 
- Public Member Functions inherited from llvm::DINode
unsigned getTag () 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. 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 DISPFlags getFlag (StringRef Flag)
 
static StringRef getFlagString (DISPFlags Flag)
 
static DISPFlags splitFlags (DISPFlags Flags, SmallVectorImpl< DISPFlags > &SplitFlags)
 Split up a flags bitfield for easier printing. More...
 
static DISPFlags toSPFlags (bool IsLocalToUnit, bool IsDefinition, bool IsOptimized, unsigned Virtuality=SPFlagNonvirtual, bool IsMainSubprogram=false)
 
static bool classof (const Metadata *MD)
 
- Static Public Member Functions inherited from llvm::DILocalScope
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 DIFlags getFlag (StringRef Flag)
 
static StringRef getFlagString (DIFlags Flag)
 
static DIFlags splitFlags (DIFlags Flags, SmallVectorImpl< DIFlags > &SplitFlags)
 Split up a flags bitfield. 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)
 

Public Attributes

MetadataScope
 
Metadata MDStringName
 
Metadata MDString MDStringLinkageName
 
Metadata MDString MDString MetadataFile
 
Metadata MDString MDString Metadata unsigned Line
 
Metadata MDString MDString Metadata unsigned MetadataType
 
Metadata MDString MDString Metadata unsigned Metadata unsigned ScopeLine
 
Metadata MDString MDString Metadata unsigned Metadata unsigned MetadataContainingType
 
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned VirtualIndex
 
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int ThisAdjustment
 
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags Flags
 
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags SPFlags
 
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags MetadataUnit
 
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata MetadataTemplateParams = nullptr
 
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata Metadata MetadataDeclaration = nullptr
 
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata Metadata Metadata MetadataRetainedNodes = nullptr
 
Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int DIFlags DISPFlags Metadata Metadata Metadata Metadata MetadataThrownTypes
 

Friends

class LLVMContextImpl
 
class MDNode
 

Additional Inherited Members

- Protected Types inherited from llvm::MDNode
using mutable_op_range = iterator_range< MDOperand * >
 
 Active type of storage. More...
- Protected Member Functions inherited from llvm::DILocalScope
 DILocalScope (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata *> Ops)
 
 ~DILocalScope ()=default
 
- 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=None)
 
 ~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. 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::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)
 

Detailed Description

Subprogram description.

Definition at line 1594 of file DebugInfoMetadata.h.

Member Enumeration Documentation

◆ DISPFlags

Debug info subprogram flags.

Enumerator
SPFlagNonvirtual 
SPFlagVirtuality 

Definition at line 1609 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

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

Definition at line 1836 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ DEFINE_MDNODE_GET()

llvm::DISubprogram::DEFINE_MDNODE_GET ( DISubprogram  ,
(DIScope *Scope, StringRef Name, StringRef LinkageName, DIFile *File, unsigned Line, DISubroutineType *Type, unsigned ScopeLine, DIType *ContainingType, unsigned VirtualIndex, int ThisAdjustment, DIFlags Flags, DISPFlags SPFlags, DICompileUnit *Unit, DITemplateParameterArray TemplateParams=nullptr, DISubprogram *Declaration=nullptr, DINodeArray RetainedNodes=nullptr, DITypeArray ThrownTypes=nullptr)  ,
(Scope, Name, LinkageName, File, Line, Type, ScopeLine, ContainingType, VirtualIndex, ThisAdjustment, Flags, SPFlags, Unit, TemplateParams, Declaration, RetainedNodes, ThrownTypes  
)

◆ getFlag()

DISubprogram::DISPFlags DISubprogram::getFlag ( StringRef  Flag)
static

Definition at line 592 of file DebugInfoMetadata.cpp.

References HANDLE_DISP_FLAG.

Referenced by FunctionNumber().

◆ getFlagString()

StringRef DISubprogram::getFlagString ( DISPFlags  Flag)
static

Definition at line 599 of file DebugInfoMetadata.cpp.

◆ splitFlags()

DISubprogram::DISPFlags DISubprogram::splitFlags ( DISPFlags  Flags,
SmallVectorImpl< DISPFlags > &  SplitFlags 
)
static

◆ toSPFlags()

static DISPFlags llvm::DISubprogram::toSPFlags ( bool  IsLocalToUnit,
bool  IsDefinition,
bool  IsOptimized,
unsigned  Virtuality = SPFlagNonvirtual,
bool  IsMainSubprogram = false 
)
inlinestatic

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 1595 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode
friend

Definition at line 1596 of file DebugInfoMetadata.h.

Member Data Documentation

◆ ContainingType

Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata* llvm::DISubprogram::ContainingType

Definition at line 1712 of file DebugInfoMetadata.h.

◆ Declaration

Definition at line 1716 of file DebugInfoMetadata.h.

◆ File

Metadata MDString MDString Metadata* llvm::DISubprogram::File

Definition at line 1712 of file DebugInfoMetadata.h.

◆ Flags

Definition at line 1712 of file DebugInfoMetadata.h.

◆ Line

Metadata MDString MDString Metadata unsigned llvm::DISubprogram::Line

Definition at line 1712 of file DebugInfoMetadata.h.

◆ LinkageName

Metadata MDString MDString* llvm::DISubprogram::LinkageName

Definition at line 1712 of file DebugInfoMetadata.h.

◆ Name

Metadata MDString* llvm::DISubprogram::Name

Definition at line 1712 of file DebugInfoMetadata.h.

◆ RetainedNodes

Definition at line 1717 of file DebugInfoMetadata.h.

◆ Scope

Metadata* llvm::DISubprogram::Scope

Definition at line 1712 of file DebugInfoMetadata.h.

◆ ScopeLine

Metadata MDString MDString Metadata unsigned Metadata unsigned llvm::DISubprogram::ScopeLine

Definition at line 1712 of file DebugInfoMetadata.h.

◆ SPFlags

Definition at line 1712 of file DebugInfoMetadata.h.

◆ TemplateParams

Definition at line 1716 of file DebugInfoMetadata.h.

◆ ThisAdjustment

Metadata MDString MDString Metadata unsigned Metadata unsigned Metadata unsigned int llvm::DISubprogram::ThisAdjustment

Definition at line 1712 of file DebugInfoMetadata.h.

◆ ThrownTypes

Definition at line 1717 of file DebugInfoMetadata.h.

◆ Type

Metadata MDString MDString Metadata unsigned Metadata* llvm::DISubprogram::Type

Definition at line 1712 of file DebugInfoMetadata.h.

◆ Unit

Definition at line 1712 of file DebugInfoMetadata.h.

◆ VirtualIndex

Definition at line 1712 of file DebugInfoMetadata.h.


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