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

Subprogram description. More...

#include <DebugInfoMetadata.h>

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

Public Member Functions

 DEFINE_MDNODE_GET (DISubprogram,(DIScopeRef Scope, StringRef Name, StringRef LinkageName, DIFile *File, unsigned Line, DISubroutineType *Type, bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine, DITypeRef ContainingType, unsigned Virtuality, unsigned VirtualIndex, unsigned Flags, bool IsOptimized, Constant *Function=nullptr, DITemplateParameterArray TemplateParams=nullptr, DISubprogram *Declaration=nullptr, DILocalVariableArray Variables=nullptr),(Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition, ScopeLine, ContainingType, Virtuality, VirtualIndex, Flags, IsOptimized, Function, TemplateParams, Declaration, Variables)) DEFINE_MDNODE_GET(DISubprogram
 
bool describes (const Function *F) const
 Check if this subprogram decribes the given function. More...
 
void replaceFunction (Function *F)
 Replace the function. More...
 
void replaceFunction (ConstantAsMetadata *MD)
 
void replaceFunction (std::nullptr_t)
 
- Public Member Functions inherited from llvm::DILocalScope
DISubprogramgetSubprogram () const
 Get the subprogram for this scope. More...
 
- Public Member Functions inherited from llvm::DIScope
DIFilegetFile () const
 
StringRef getFilename () const
 
StringRef getDirectory () const
 
StringRef getName () const
 
DIScopeRef getScope () const
 
MetadatagetRawFile () const
 Return the raw underlying file. More...
 
DIScopeRef getRef () const
 
- Public Member Functions inherited from llvm::DINode
unsigned getTag () const
 
DINodeRef getRef () const
 
- Public Member Functions inherited from llvm::MDNode
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...
 
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 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 unsigned getFlag (StringRef Flag)
 
static const char * getFlagString (unsigned Flag)
 
static unsigned splitFlags (unsigned Flags, SmallVectorImpl< unsigned > &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)
 

Public Attributes

MetadataScope
 
Metadata MDStringName
 
Metadata MDString MDStringLinkageName
 
Metadata MDString MDString
Metadata
File
 
Metadata MDString MDString
Metadata unsigned 
Line
 
Metadata MDString MDString
Metadata unsigned Metadata
Type
 
Metadata MDString MDString
Metadata unsigned Metadata
bool 
IsLocalToUnit
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool 
IsDefinition
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool unsigned 
ScopeLine
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool unsigned Metadata
ContainingType
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool unsigned Metadata
unsigned 
Virtuality
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool unsigned Metadata
unsigned unsigned 
VirtualIndex
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool unsigned Metadata
unsigned unsigned unsigned 
Flags
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool unsigned Metadata
unsigned unsigned unsigned
bool 
IsOptimized
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool unsigned Metadata
unsigned unsigned unsigned
bool Metadata
Function = nullptr
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool unsigned Metadata
unsigned unsigned unsigned
bool Metadata Metadata
TemplateParams = nullptr
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool unsigned Metadata
unsigned unsigned unsigned
bool Metadata Metadata
Metadata
Declaration = nullptr
 
Metadata MDString MDString
Metadata unsigned Metadata
bool bool unsigned Metadata
unsigned unsigned unsigned
bool Metadata Metadata
Metadata Metadata
Variables
 

Friends

class LLVMContextImpl
 
class MDNode
 

Additional Inherited Members

- Public Types inherited from llvm::DINode
enum  DIFlags { FlagAccessibility = FlagPrivate | FlagProtected | FlagPublic }
 Debug info flags. More...
 
- Public Types inherited from llvm::MDNode
typedef const MDOperandop_iterator
 
typedef iterator_range
< op_iterator
op_range
 
- Protected Types inherited from llvm::MDNode
typedef iterator_range
< MDOperand * > 
mutable_op_range
 
 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
 
- Protected Member Functions inherited from llvm::MDNode
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...
 
 MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2=None)
 
 ~MDNode ()=default
 
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)
 
- Protected Attributes inherited from llvm::MDNode
ContextAndReplaceableUses Context
 

Detailed Description

Subprogram description.

TODO: Remove DisplayName. It's always equal to Name. TODO: Split up flags.

Definition at line 1249 of file DebugInfoMetadata.h.

Member Function Documentation

static bool llvm::DISubprogram::classof ( const Metadata MD)
inlinestatic
llvm::DISubprogram::DEFINE_MDNODE_GET ( DISubprogram  ,
(DIScopeRef Scope, StringRef Name, StringRef LinkageName,DIFile *File, unsigned Line, DISubroutineType *Type,bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,DITypeRef ContainingType, unsigned Virtuality,unsigned VirtualIndex, unsigned Flags, bool IsOptimized,Constant *Function=nullptr,DITemplateParameterArray TemplateParams=nullptr,DISubprogram *Declaration=nullptr,DILocalVariableArray Variables=nullptr)  ,
(Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,IsDefinition, ScopeLine, ContainingType, Virtuality,VirtualIndex, Flags, IsOptimized, Function, TemplateParams,Declaration, Variables  
)
bool DISubprogram::describes ( const Function F) const

Check if this subprogram decribes the given function.

FIXME: Should this be looking through bitcasts?

Definition at line 373 of file DebugInfoMetadata.cpp.

References llvm::StringRef::empty(), llvm::Value::getName(), llvm::DIScope::getName(), and Name.

void DISubprogram::replaceFunction ( Function F)

Replace the function.

If isUniqued() and not isResolved(), this could node will be RAUW'ed and deleted out from under the caller. Use a TrackingMDRef if that's a problem.

Definition at line 383 of file DebugInfoMetadata.cpp.

References llvm::ConstantAsMetadata::get().

void llvm::DISubprogram::replaceFunction ( ConstantAsMetadata MD)
inline

Definition at line 1429 of file DebugInfoMetadata.h.

References llvm::MDNode::replaceOperandWith().

void llvm::DISubprogram::replaceFunction ( std::nullptr_t  )
inline

Definition at line 1430 of file DebugInfoMetadata.h.

References llvm::MDNode::replaceOperandWith().

Friends And Related Function Documentation

friend class LLVMContextImpl
friend

Definition at line 1250 of file DebugInfoMetadata.h.

friend class MDNode
friend

Definition at line 1251 of file DebugInfoMetadata.h.

Member Data Documentation

Definition at line 1325 of file DebugInfoMetadata.h.

Definition at line 1330 of file DebugInfoMetadata.h.

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

Definition at line 1325 of file DebugInfoMetadata.h.

Definition at line 1325 of file DebugInfoMetadata.h.

Definition at line 1329 of file DebugInfoMetadata.h.

Metadata MDString MDString Metadata unsigned Metadata bool bool llvm::DISubprogram::IsDefinition

Definition at line 1325 of file DebugInfoMetadata.h.

Metadata MDString MDString Metadata unsigned Metadata bool llvm::DISubprogram::IsLocalToUnit

Definition at line 1325 of file DebugInfoMetadata.h.

Definition at line 1325 of file DebugInfoMetadata.h.

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

Definition at line 1325 of file DebugInfoMetadata.h.

Metadata MDString MDString* llvm::DISubprogram::LinkageName

Definition at line 1325 of file DebugInfoMetadata.h.

Metadata MDString* llvm::DISubprogram::Name

Definition at line 1325 of file DebugInfoMetadata.h.

Referenced by describes().

Metadata* llvm::DISubprogram::Scope

Definition at line 1325 of file DebugInfoMetadata.h.

Definition at line 1325 of file DebugInfoMetadata.h.

Definition at line 1329 of file DebugInfoMetadata.h.

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

Definition at line 1325 of file DebugInfoMetadata.h.

Definition at line 1330 of file DebugInfoMetadata.h.

Definition at line 1325 of file DebugInfoMetadata.h.

Definition at line 1325 of file DebugInfoMetadata.h.


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