LLVM  6.0.0svn
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::DICompositeType Class Reference

Composite types. More...

#include "llvm/IR/DebugInfoMetadata.h"

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

Public Member Functions

 DEFINE_MDNODE_GET (DICompositeType,(unsigned Tag, StringRef Name, DIFile *File, unsigned Line, DIScopeRef Scope, DITypeRef BaseType, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags, DINodeArray Elements, unsigned RuntimeLang, DITypeRef VTableHolder, DITemplateParameterArray TemplateParams=nullptr, StringRef Identifier=""),(Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, VTableHolder, TemplateParams, Identifier)) DEFINE_MDNODE_GET(DICompositeType
 
DITypeRef getBaseType () const
 
DINodeArray getElements () const
 
DITypeRef getVTableHolder () const
 
DITemplateParameterArray getTemplateParams () const
 
StringRef getIdentifier () const
 
unsigned getRuntimeLang () const
 
MetadatagetRawBaseType () const
 
MetadatagetRawElements () const
 
MetadatagetRawVTableHolder () const
 
MetadatagetRawTemplateParams () const
 
MDStringgetRawIdentifier () const
 
void replaceElements (DINodeArray Elements)
 Replace operands. More...
 
void replaceVTableHolder (DITypeRef VTableHolder)
 
void replaceTemplateParams (DITemplateParameterArray TemplateParams)
 
- Public Member Functions inherited from llvm::DIType
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
 
void setFlags (DIFlags NewFlags)
 
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
 
- 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...
 
- 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 DICompositeTypegetODRTypeIfExists (LLVMContext &Context, MDString &Identifier)
 
static DICompositeTypebuildODRType (LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name, Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags, Metadata *Elements, unsigned RuntimeLang, Metadata *VTableHolder, Metadata *TemplateParams)
 Build a DICompositeType with the given ODR identifier. More...
 
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 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

unsigned Tag
 
unsigned MDStringName
 
unsigned MDString MetadataFile
 
unsigned MDString Metadata unsigned Line
 
unsigned MDString Metadata unsigned MetadataScope
 
unsigned MDString Metadata unsigned Metadata MetadataBaseType
 
unsigned MDString Metadata unsigned Metadata Metadata uint64_t SizeInBits
 
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t AlignInBits
 
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t OffsetInBits
 
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Flags
 
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags MetadataElements
 
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned RuntimeLang
 
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned MetadataVTableHolder
 
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata MetadataTemplateParams = nullptr
 
unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata Metadata MDStringIdentifier
 

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, 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 ()
 
- 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

Composite types.

TODO: Detach from DerivedTypeBase (split out MDEnumType?). TODO: Create a custom, unrelated node for DW_TAG_array_type.

Definition at line 833 of file DebugInfoMetadata.h.

Member Function Documentation

◆ buildODRType()

DICompositeType * DICompositeType::buildODRType ( LLVMContext Context,
MDString Identifier,
unsigned  Tag,
MDString Name,
Metadata File,
unsigned  Line,
Metadata Scope,
Metadata BaseType,
uint64_t  SizeInBits,
uint32_t  AlignInBits,
uint64_t  OffsetInBits,
DIFlags  Flags,
Metadata Elements,
unsigned  RuntimeLang,
Metadata VTableHolder,
Metadata TemplateParams 
)
static

Build a DICompositeType with the given ODR identifier.

Looks up the mapped DICompositeType for the given ODR Identifier. If it doesn't exist, creates a new one. If it does exist and isForwardDecl(), and the new arguments would be a definition, mutates the the type in place. In either case, returns the type.

If not LLVMContext::isODRUniquingDebugTypes(), this function returns nullptr.

Definition at line 315 of file DebugInfoMetadata.cpp.

References assert(), llvm::sys::path::begin(), llvm::LLVMContextImpl::DITypeMap, E, llvm::StringRef::empty(), llvm::sys::path::end(), llvm::ARMBuildAttrs::File, llvm::MDNode::getDistinct(), llvm::MDString::getString(), I, llvm::LLVMContext::isODRUniquingDebugTypes(), llvm::LLVMContext::pImpl, and llvm::DILocation::Scope.

Referenced by FunctionNumber(), and llvm::MetadataLoader::MetadataLoaderImpl::parseMetadata().

◆ classof()

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

Definition at line 988 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ DEFINE_MDNODE_GET()

llvm::DICompositeType::DEFINE_MDNODE_GET ( DICompositeType  ,
(unsigned Tag, StringRef Name, DIFile *File, unsigned Line, DIScopeRef Scope, DITypeRef BaseType, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags, DINodeArray Elements, unsigned RuntimeLang, DITypeRef VTableHolder, DITemplateParameterArray TemplateParams=nullptr, StringRef Identifier="")  ,
(Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, VTableHolder, TemplateParams, Identifier  
)

◆ getBaseType()

DITypeRef llvm::DICompositeType::getBaseType ( ) const
inline

◆ getElements()

DINodeArray llvm::DICompositeType::getElements ( ) const
inline

◆ getIdentifier()

StringRef llvm::DICompositeType::getIdentifier ( ) const
inline

Definition at line 955 of file DebugInfoMetadata.h.

Referenced by getCommonClassOptions().

◆ getODRTypeIfExists()

DICompositeType * DICompositeType::getODRTypeIfExists ( LLVMContext Context,
MDString Identifier 
)
static

◆ getRawBaseType()

Metadata* llvm::DICompositeType::getRawBaseType ( ) const
inline

◆ getRawElements()

Metadata* llvm::DICompositeType::getRawElements ( ) const
inline

◆ getRawIdentifier()

MDString* llvm::DICompositeType::getRawIdentifier ( ) const
inline

◆ getRawTemplateParams()

Metadata* llvm::DICompositeType::getRawTemplateParams ( ) const
inline

◆ getRawVTableHolder()

Metadata* llvm::DICompositeType::getRawVTableHolder ( ) const
inline

◆ getRuntimeLang()

unsigned llvm::DICompositeType::getRuntimeLang ( ) const
inline

◆ getTemplateParams()

DITemplateParameterArray llvm::DICompositeType::getTemplateParams ( ) const
inline

Definition at line 952 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::constructTypeDIE(), and rotateSign().

◆ getVTableHolder()

DITypeRef llvm::DICompositeType::getVTableHolder ( ) const
inline

Definition at line 951 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfUnit::constructTypeDIE(), and rotateSign().

◆ replaceElements()

void llvm::DICompositeType::replaceElements ( DINodeArray  Elements)
inline

Replace operands.

If this isUniqued() and not isResolved(), on a uniquing collision this will be RAUW'ed and deleted. Use a TrackingMDRef to keep track of its movement if necessary.

Definition at line 970 of file DebugInfoMetadata.h.

References assert(), and llvm::is_contained().

Referenced by llvm::DIBuilder::replaceArrays().

◆ replaceTemplateParams()

void llvm::DICompositeType::replaceTemplateParams ( DITemplateParameterArray  TemplateParams)
inline

Definition at line 983 of file DebugInfoMetadata.h.

Referenced by llvm::DIBuilder::replaceArrays().

◆ replaceVTableHolder()

void llvm::DICompositeType::replaceVTableHolder ( DITypeRef  VTableHolder)
inline

Definition at line 979 of file DebugInfoMetadata.h.

Referenced by llvm::DIBuilder::replaceVTableHolder().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 834 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode
friend

Definition at line 835 of file DebugInfoMetadata.h.

Member Data Documentation

◆ AlignInBits

unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t llvm::DICompositeType::AlignInBits

Definition at line 900 of file DebugInfoMetadata.h.

◆ BaseType

unsigned MDString Metadata unsigned Metadata Metadata* llvm::DICompositeType::BaseType

Definition at line 900 of file DebugInfoMetadata.h.

◆ Elements

unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata* llvm::DICompositeType::Elements

Definition at line 900 of file DebugInfoMetadata.h.

◆ File

unsigned MDString Metadata* llvm::DICompositeType::File

Definition at line 900 of file DebugInfoMetadata.h.

◆ Flags

unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags llvm::DICompositeType::Flags

Definition at line 900 of file DebugInfoMetadata.h.

◆ Identifier

Initial value:
= nullptr),
TempDICompositeType clone() const { return cloneImpl(); }
static DICompositeType *
getODRType(LLVMContext &Context, MDString &Identifier, unsigned Tag,
MDString *Name, Metadata *File, unsigned Line, Metadata *Scope,
unsigned RuntimeLang, Metadata *VTableHolder,

Definition at line 906 of file DebugInfoMetadata.h.

◆ Line

unsigned MDString Metadata unsigned llvm::DICompositeType::Line

Definition at line 900 of file DebugInfoMetadata.h.

◆ Name

unsigned MDString* llvm::DICompositeType::Name

Definition at line 900 of file DebugInfoMetadata.h.

◆ OffsetInBits

unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t llvm::DICompositeType::OffsetInBits

Definition at line 900 of file DebugInfoMetadata.h.

◆ RuntimeLang

unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned llvm::DICompositeType::RuntimeLang

Definition at line 900 of file DebugInfoMetadata.h.

◆ Scope

unsigned MDString Metadata unsigned Metadata* llvm::DICompositeType::Scope

Definition at line 900 of file DebugInfoMetadata.h.

◆ SizeInBits

unsigned MDString Metadata unsigned Metadata Metadata uint64_t llvm::DICompositeType::SizeInBits

Definition at line 900 of file DebugInfoMetadata.h.

◆ Tag

unsigned llvm::DICompositeType::Tag

Definition at line 900 of file DebugInfoMetadata.h.

◆ TemplateParams

unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata Metadata* llvm::DICompositeType::TemplateParams = nullptr

Definition at line 905 of file DebugInfoMetadata.h.

◆ VTableHolder

unsigned MDString Metadata unsigned Metadata Metadata uint64_t uint32_t uint64_t DIFlags Metadata unsigned Metadata* llvm::DICompositeType::VTableHolder

Definition at line 900 of file DebugInfoMetadata.h.


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