LLVM  8.0.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::DIType Class Reference

Base class for types. More...

#include "llvm/IR/DebugInfoMetadata.h"

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

Public Member Functions

TempDIType clone () const
 
unsigned getLine () const
 
uint64_t getSizeInBits () const
 
uint32_t getAlignInBits () const
 
uint32_t getAlignInBytes () const
 
uint64_t getOffsetInBits () const
 
DIFlags getFlags () const
 
DIScopeRef getScope () const
 
StringRef getName () const
 
MetadatagetRawScope () const
 
MDStringgetRawName () const
 
TempDIType cloneWithFlags (DIFlags NewFlags) const
 Returns a new temporary DIType with updated Flags. More...
 
bool isPrivate () const
 
bool isProtected () const
 
bool isPublic () const
 
bool isForwardDecl () const
 
bool isAppleBlockExtension () const
 
bool isBlockByrefStruct () 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
 
- Public Member Functions inherited from llvm::DIScope
DIFilegetFile () const
 
StringRef getFilename () const
 
StringRef getDirectory () const
 
Optional< StringRefgetSource () const
 
StringRef getName () const
 
DIScopeRef getScope () 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 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)
 

Protected Member Functions

 DIType (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, unsigned Line, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags, ArrayRef< Metadata *> Ops)
 
 ~DIType ()=default
 
void init (unsigned Line, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags)
 
void mutate (unsigned Tag, unsigned Line, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags)
 Change fields in place. More...
 
- 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 ()
 

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...
- 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

Base class for types.

TODO: Remove the hardcoded name and context, since many types don't use them. TODO: Split up flags.

Definition at line 630 of file DebugInfoMetadata.h.

Constructor & Destructor Documentation

◆ DIType()

llvm::DIType::DIType ( LLVMContext C,
unsigned  ID,
StorageType  Storage,
unsigned  Tag,
unsigned  Line,
uint64_t  SizeInBits,
uint32_t  AlignInBits,
uint64_t  OffsetInBits,
DIFlags  Flags,
ArrayRef< Metadata *>  Ops 
)
inlineprotected

Definition at line 638 of file DebugInfoMetadata.h.

References llvm::cl::init().

◆ ~DIType()

llvm::DIType::~DIType ( )
protecteddefault

Member Function Documentation

◆ classof()

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

Definition at line 719 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

TempDIType llvm::DIType::clone ( ) const
inline

Definition at line 664 of file DebugInfoMetadata.h.

References llvm::MDNode::clone(), and llvm::release.

◆ cloneWithFlags()

TempDIType llvm::DIType::cloneWithFlags ( DIFlags  NewFlags) const
inline

Returns a new temporary DIType with updated Flags.

Definition at line 683 of file DebugInfoMetadata.h.

Referenced by createTypeWithFlags().

◆ getAlignInBits()

uint32_t llvm::DIType::getAlignInBits ( ) const
inline

◆ getAlignInBytes()

uint32_t llvm::DIType::getAlignInBytes ( ) const
inline

◆ getFlags()

DIFlags llvm::DIType::getFlags ( ) const
inline

◆ getLine()

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

◆ getName()

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

◆ getOffsetInBits()

uint64_t llvm::DIType::getOffsetInBits ( ) const
inline

◆ getRawName()

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

◆ getRawScope()

Metadata* llvm::DIType::getRawScope ( ) const
inline

◆ getScope()

DIScopeRef llvm::DIType::getScope ( ) const
inline

◆ getSizeInBits()

uint64_t llvm::DIType::getSizeInBits ( ) const
inline

◆ init()

void llvm::DIType::init ( unsigned  Line,
uint64_t  SizeInBits,
uint32_t  AlignInBits,
uint64_t  OffsetInBits,
DIFlags  Flags 
)
inlineprotected

Definition at line 646 of file DebugInfoMetadata.h.

◆ isAppleBlockExtension()

bool llvm::DIType::isAppleBlockExtension ( ) const
inline

Definition at line 699 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::constructTypeDIE().

◆ isArtificial()

bool llvm::DIType::isArtificial ( ) const
inline

◆ isBigEndian()

bool llvm::DIType::isBigEndian ( ) const
inline

Definition at line 716 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::getParentContextString(), and isDINode().

◆ isBitField()

bool llvm::DIType::isBitField ( ) const
inline

Definition at line 708 of file DebugInfoMetadata.h.

Referenced by shouldAlwaysEmitCompleteClassType().

◆ isBlockByrefStruct()

bool llvm::DIType::isBlockByrefStruct ( ) const
inline

Definition at line 700 of file DebugInfoMetadata.h.

Referenced by llvm::DbgVariable::getType().

◆ isForwardDecl()

bool llvm::DIType::isForwardDecl ( ) const
inline

◆ isLittleEndian()

bool llvm::DIType::isLittleEndian ( ) const
inline

Definition at line 717 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::getParentContextString(), and isDINode().

◆ isLValueReference()

bool llvm::DIType::isLValueReference ( ) const
inline

Definition at line 710 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::constructSubprogramArguments().

◆ isObjcClassComplete()

bool llvm::DIType::isObjcClassComplete ( ) const
inline

Definition at line 704 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::constructTypeDIE().

◆ isObjectPointer()

bool llvm::DIType::isObjectPointer ( ) const
inline

Definition at line 703 of file DebugInfoMetadata.h.

Referenced by llvm::DIBuilder::createObjectPointerType(), and shouldEmitUdt().

◆ isPrivate()

bool llvm::DIType::isPrivate ( ) const
inline

◆ isProtected()

bool llvm::DIType::isProtected ( ) const
inline

◆ isPublic()

bool llvm::DIType::isPublic ( ) const
inline

◆ isRValueReference()

bool llvm::DIType::isRValueReference ( ) const
inline

Definition at line 711 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::constructSubprogramArguments().

◆ isStaticMember()

bool llvm::DIType::isStaticMember ( ) const
inline

Definition at line 709 of file DebugInfoMetadata.h.

Referenced by shouldAlwaysEmitCompleteClassType().

◆ isTypePassByReference()

bool llvm::DIType::isTypePassByReference ( ) const
inline

Definition at line 713 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::constructTypeDIE().

◆ isTypePassByValue()

bool llvm::DIType::isTypePassByValue ( ) const
inline

Definition at line 712 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::constructTypeDIE().

◆ isVector()

bool llvm::DIType::isVector ( ) const
inline

Definition at line 707 of file DebugInfoMetadata.h.

Referenced by hasConflictingReferenceFlags(), and hasVectorBeenPadded().

◆ isVirtual()

bool llvm::DIType::isVirtual ( ) const
inline

Definition at line 701 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::constructContainingTypeDIEs().

◆ mutate()

void llvm::DIType::mutate ( unsigned  Tag,
unsigned  Line,
uint64_t  SizeInBits,
uint32_t  AlignInBits,
uint64_t  OffsetInBits,
DIFlags  Flags 
)
inlineprotected

Change fields in place.

Definition at line 656 of file DebugInfoMetadata.h.

References assert(), and llvm::cl::init().


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