class DILexicalBlock;
class DILexicalBlockFile;
class DIVariable;
-class DIType;
-class DIScope;
class DIObjCProperty;
/// \brief Maps from type identifier to the actual MDNode.
typedef DenseMap<const MDString *, MDNode *> DITypeIdentifierMap;
-/// \brief A thin wraper around MDNode to access encoded debug info.
-///
-/// This should not be stored in a container, because the underlying MDNode may
-/// change in certain situations.
-class DIDescriptor {
-public:
- /// \brief Duplicated debug info flags.
- ///
- /// \see DebugNode::DIFlags.
- enum {
-#define HANDLE_DI_FLAG(ID, NAME) Flag##NAME = DebugNode::Flag##NAME,
-#include "llvm/IR/DebugInfoFlags.def"
- FlagAccessibility = DebugNode::FlagAccessibility
- };
-
-protected:
- const MDNode *DbgNode;
-
-public:
- explicit DIDescriptor(const MDNode *N = nullptr) : DbgNode(N) {}
- DIDescriptor(const DebugNode *N) : DbgNode(N) {}
-
- MDNode *get() const { return const_cast<MDNode *>(DbgNode); }
- operator MDNode *() const { return get(); }
- MDNode *operator->() const { return get(); }
- MDNode &operator*() const { return *get(); }
-
- // An explicit operator bool so that we can do testing of DI values
- // easily.
- // FIXME: This operator bool isn't actually protecting anything at the
- // moment due to the conversion operator above making DIDescriptor nodes
- // implicitly convertable to bool.
- explicit operator bool() const { return DbgNode != nullptr; }
-
- bool operator==(DIDescriptor Other) const { return DbgNode == Other.DbgNode; }
- bool operator!=(DIDescriptor Other) const { return !operator==(Other); }
-
- uint16_t getTag() const {
- if (auto *N = dyn_cast_or_null<DebugNode>(get()))
- return N->getTag();
- return 0;
- }
-
- void print(raw_ostream &OS) const;
- void dump() const;
-};
-
#define DECLARE_SIMPLIFY_DESCRIPTOR(DESC) \
class DESC; \
template <> struct simplify_type<const DESC>; \
template <> struct simplify_type<DESC>;
-DECLARE_SIMPLIFY_DESCRIPTOR(DIDescriptor)
DECLARE_SIMPLIFY_DESCRIPTOR(DISubrange)
DECLARE_SIMPLIFY_DESCRIPTOR(DIEnumerator)
-DECLARE_SIMPLIFY_DESCRIPTOR(DIScope)
-DECLARE_SIMPLIFY_DESCRIPTOR(DIType)
-DECLARE_SIMPLIFY_DESCRIPTOR(DIBasicType)
-DECLARE_SIMPLIFY_DESCRIPTOR(DIDerivedType)
-DECLARE_SIMPLIFY_DESCRIPTOR(DICompositeType)
-DECLARE_SIMPLIFY_DESCRIPTOR(DISubroutineType)
DECLARE_SIMPLIFY_DESCRIPTOR(DIFile)
DECLARE_SIMPLIFY_DESCRIPTOR(DICompileUnit)
DECLARE_SIMPLIFY_DESCRIPTOR(DISubprogram)
typedef DebugNodeArray DIArray;
typedef MDTypeRefArray DITypeArray;
-/// \brief This is used to represent ranges, for array bounds.
-class DISubrange : public DIDescriptor {
-public:
- DISubrange() = default;
- DISubrange(const MDSubrange *N) : DIDescriptor(N) {}
-
- MDSubrange *get() const {
- return cast_or_null<MDSubrange>(DIDescriptor::get());
- }
- operator MDSubrange *() const { return get(); }
- MDSubrange *operator->() const { return get(); }
- MDSubrange &operator*() const { return *get(); }
+class DISubrange {
+ MDSubrange *N;
- int64_t getLo() const { return get()->getLowerBound(); }
- int64_t getCount() const { return get()->getCount(); }
-};
-
-/// \brief A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
-///
-/// FIXME: it seems strange that this doesn't have either a reference to the
-/// type/precision or a file/line pair for location info.
-class DIEnumerator : public DIDescriptor {
public:
- DIEnumerator() = default;
- DIEnumerator(const MDEnumerator *N) : DIDescriptor(N) {}
+ DISubrange(const MDSubrange *N = nullptr) : N(const_cast<MDSubrange *>(N)) {}
- MDEnumerator *get() const {
- return cast_or_null<MDEnumerator>(DIDescriptor::get());
- }
- operator MDEnumerator *() const { return get(); }
- MDEnumerator *operator->() const { return get(); }
- MDEnumerator &operator*() const { return *get(); }
-
- StringRef getName() const { return get()->getName(); }
- int64_t getEnumValue() const { return get()->getValue(); }
-};
-
-template <typename T> class DIRef;
-typedef DIRef<DIDescriptor> DIDescriptorRef;
-typedef DIRef<DIScope> DIScopeRef;
-typedef DIRef<DIType> DITypeRef;
-
-/// \brief A base class for various scopes.
-///
-/// Although, implementation-wise, DIScope is the parent class of most
-/// other DIxxx classes, including DIType and its descendants, most of
-/// DIScope's descendants are not a substitutable subtype of
-/// DIScope. The DIDescriptor::isScope() method only is true for
-/// DIScopes that are scopes in the strict lexical scope sense
-/// (DICompileUnit, DISubprogram, etc.), but not for, e.g., a DIType.
-class DIScope : public DIDescriptor {
-public:
- DIScope() = default;
- DIScope(const MDScope *N) : DIDescriptor(N) {}
-
- MDScope *get() const { return cast_or_null<MDScope>(DIDescriptor::get()); }
- operator MDScope *() const { return get(); }
- MDScope *operator->() const { return get(); }
- MDScope &operator*() const { return *get(); }
-
- inline DIScopeRef getContext() const;
- StringRef getName() const { return get()->getName(); }
- StringRef getFilename() const { return get()->getFilename(); }
- StringRef getDirectory() const { return get()->getDirectory(); }
-
- /// \brief Generate a reference to this DIScope.
- ///
- /// Uses the type identifier instead of the actual MDNode if possible, to
- /// help type uniquing.
- DIScopeRef getRef() const;
-};
-
-/// \brief Represents reference to a DIDescriptor.
-///
-/// Abstracts over direct and identifier-based metadata references.
-template <typename T> class DIRef {
- /// \brief Val can be either a MDNode or a MDString.
- ///
- /// In the latter, MDString specifies the type identifier.
- const Metadata *Val;
-
-public:
- template <class U>
- DIRef(const TypedDebugNodeRef<U> &Ref,
- typename std::enable_if<std::is_convertible<U *, T>::value>::type * =
- nullptr)
- : Val(Ref) {}
-
- T resolve(const DITypeIdentifierMap &Map) const;
- operator Metadata *() const { return const_cast<Metadata *>(Val); }
+ operator MDSubrange *() const { return N; }
+ MDSubrange *operator->() const { return N; }
+ MDSubrange &operator*() const { return *N; }
};
-template <>
-DIDescriptor DIRef<DIDescriptor>::resolve(const DITypeIdentifierMap &Map) const;
-template <>
-DIScope DIRef<DIScope>::resolve(const DITypeIdentifierMap &Map) const;
-template <> DIType DIRef<DIType>::resolve(const DITypeIdentifierMap &Map) const;
+class DIEnumerator {
+ MDEnumerator *N;
-DIScopeRef DIScope::getContext() const { return get()->getScope(); }
-
-/// \brief This is a wrapper for a type.
-///
-/// FIXME: Types should be factored much better so that CV qualifiers and
-/// others do not require a huge and empty descriptor full of zeros.
-class DIType : public DIScope {
public:
- DIType() = default;
- DIType(const MDType *N) : DIScope(N) {}
-
- MDType *get() const { return cast_or_null<MDType>(DIDescriptor::get()); }
- operator MDType *() const { return get(); }
- MDType *operator->() const { return get(); }
- MDType &operator*() const { return *get(); }
-
- DIScopeRef getContext() const { return get()->getScope(); }
- StringRef getName() const { return get()->getName(); }
- unsigned getLineNumber() const { return get()->getLine(); }
- uint64_t getSizeInBits() const { return get()->getSizeInBits(); }
- uint64_t getAlignInBits() const { return get()->getAlignInBits(); }
- // FIXME: Offset is only used for DW_TAG_member nodes. Making every type
- // carry this is just plain insane.
- uint64_t getOffsetInBits() const { return get()->getOffsetInBits(); }
- unsigned getFlags() const { return get()->getFlags(); }
-
- bool isPrivate() const { return get()->isPrivate(); }
- bool isProtected() const { return get()->isProtected(); }
- bool isPublic() const { return get()->isPublic(); }
- bool isForwardDecl() const { return get()->isForwardDecl(); }
- bool isAppleBlockExtension() const { return get()->isAppleBlockExtension(); }
- bool isBlockByrefStruct() const { return get()->isBlockByrefStruct(); }
- bool isVirtual() const { return get()->isVirtual(); }
- bool isArtificial() const { return get()->isArtificial(); }
- bool isObjectPointer() const { return get()->isObjectPointer(); }
- bool isObjcClassComplete() const { return get()->isObjcClassComplete(); }
- bool isVector() const { return get()->isVector(); }
- bool isStaticMember() const { return get()->isStaticMember(); }
- bool isLValueReference() const { return get()->isLValueReference(); }
- bool isRValueReference() const { return get()->isRValueReference(); }
-};
-
-/// \brief A basic type, like 'int' or 'float'.
-class DIBasicType : public DIType {
-public:
- DIBasicType() = default;
- DIBasicType(const MDBasicType *N) : DIType(N) {}
-
- MDBasicType *get() const {
- return cast_or_null<MDBasicType>(DIDescriptor::get());
- }
- operator MDBasicType *() const { return get(); }
- MDBasicType *operator->() const { return get(); }
- MDBasicType &operator*() const { return *get(); }
-
- unsigned getEncoding() const { return get()->getEncoding(); }
-};
-
-/// \brief A simple derived type
-///
-/// Like a const qualified type, a typedef, a pointer or reference, et cetera.
-/// Or, a data member of a class/struct/union.
-class DIDerivedType : public DIType {
-public:
- DIDerivedType() = default;
- DIDerivedType(const MDDerivedTypeBase *N) : DIType(N) {}
-
- MDDerivedTypeBase *get() const {
- return cast_or_null<MDDerivedTypeBase>(DIDescriptor::get());
- }
- operator MDDerivedTypeBase *() const { return get(); }
- MDDerivedTypeBase *operator->() const { return get(); }
- MDDerivedTypeBase &operator*() const { return *get(); }
-
- DITypeRef getTypeDerivedFrom() const { return get()->getBaseType(); }
-};
-
-/// \brief Types that refer to multiple other types.
-///
-/// This descriptor holds a type that can refer to multiple other types, like a
-/// function or struct.
-///
-/// DICompositeType is derived from DIDerivedType because some
-/// composite types (such as enums) can be derived from basic types
-// FIXME: Make this derive from DIType directly & just store the
-// base type in a single DIType field.
-class DICompositeType : public DIDerivedType {
- friend class DIBuilder;
-
-public:
- DICompositeType() = default;
- DICompositeType(const MDCompositeTypeBase *N) : DIDerivedType(N) {}
-
- MDCompositeTypeBase *get() const {
- return cast_or_null<MDCompositeTypeBase>(DIDescriptor::get());
- }
- operator MDCompositeTypeBase *() const { return get(); }
- MDCompositeTypeBase *operator->() const { return get(); }
- MDCompositeTypeBase &operator*() const { return *get(); }
-
- DIArray getElements() const { return get()->getElements(); }
-
- unsigned getRunTimeLang() const { return get()->getRuntimeLang(); }
- DITypeRef getContainingType() const { return get()->getVTableHolder(); }
-
- DIArray getTemplateParams() const { return get()->getTemplateParams(); }
- MDString *getIdentifier() const { return get()->getRawIdentifier(); }
-};
-
-class DISubroutineType : public DICompositeType {
-public:
- DISubroutineType() = default;
- DISubroutineType(const MDSubroutineType *N) : DICompositeType(N) {}
-
- MDSubroutineType *get() const {
- return cast_or_null<MDSubroutineType>(DIDescriptor::get());
- }
- operator MDSubroutineType *() const { return get(); }
- MDSubroutineType *operator->() const { return get(); }
- MDSubroutineType &operator*() const { return *get(); }
+ DIEnumerator(const MDEnumerator *N = nullptr)
+ : N(const_cast<MDEnumerator *>(N)) {}
- MDTypeRefArray getTypeArray() const { return get()->getTypeArray(); }
+ operator MDEnumerator *() const { return N; }
+ MDEnumerator *operator->() const { return N; }
+ MDEnumerator &operator*() const { return *N; }
};
class DIFile {
public:
DIFile(const MDFile *N = nullptr) : N(const_cast<MDFile *>(N)) {}
- operator DIDescriptor() const { return N; }
- operator DIScope() const { return N; }
operator MDFile *() const { return N; }
MDFile *operator->() const { return N; }
MDFile &operator*() const { return *N; }
DICompileUnit(const MDCompileUnit *N = nullptr)
: N(const_cast<MDCompileUnit *>(N)) {}
- operator DIDescriptor() const { return N; }
- operator DIScope() const { return N; }
operator MDCompileUnit *() const { return N; }
MDCompileUnit *operator->() const { return N; }
MDCompileUnit &operator*() const { return *N; }
DISubprogram(const MDSubprogram *N = nullptr)
: N(const_cast<MDSubprogram *>(N)) {}
- operator DIDescriptor() const { return N; }
- operator DIScope() const { return N; }
operator MDSubprogram *() const { return N; }
MDSubprogram *operator->() const { return N; }
MDSubprogram &operator*() const { return *N; }
DILexicalBlock(const MDLexicalBlockBase *N = nullptr)
: N(const_cast<MDLexicalBlockBase *>(N)) {}
- operator DIDescriptor() const { return N; }
operator MDLexicalBlockBase *() const { return N; }
MDLexicalBlockBase *operator->() const { return N; }
MDLexicalBlockBase &operator*() const { return *N; }
DILexicalBlockFile(const MDLexicalBlockFile *N = nullptr)
: N(const_cast<MDLexicalBlockFile *>(N)) {}
- operator DIDescriptor() const { return N; }
operator MDLexicalBlockFile *() const { return N; }
MDLexicalBlockFile *operator->() const { return N; }
MDLexicalBlockFile &operator*() const { return *N; }
DINameSpace(const MDNamespace *N = nullptr)
: N(const_cast<MDNamespace *>(N)) {}
- operator DIDescriptor() const { return N; }
- operator DIScope() const { return N; }
operator MDNamespace *() const { return N; }
MDNamespace *operator->() const { return N; }
MDNamespace &operator*() const { return *N; }
DIGlobalVariable(const MDGlobalVariable *N = nullptr)
: N(const_cast<MDGlobalVariable *>(N)) {}
- operator DIDescriptor() const { return N; }
operator MDGlobalVariable *() const { return N; }
MDGlobalVariable *operator->() const { return N; }
MDGlobalVariable &operator*() const { return *N; }
DIImportedEntity(const MDImportedEntity *N = nullptr)
: N(const_cast<MDImportedEntity *>(N)) {}
- operator DIDescriptor() const { return N; }
operator MDImportedEntity *() const { return N; }
MDImportedEntity *operator->() const { return N; }
MDImportedEntity &operator*() const { return *N; }
static SimpleType getSimplifiedValue(const DESC &DI) { return DI; } \
}; \
template <> struct simplify_type<DESC> : simplify_type<const DESC> {};
-SIMPLIFY_DESCRIPTOR(DIDescriptor)
SIMPLIFY_DESCRIPTOR(DISubrange)
SIMPLIFY_DESCRIPTOR(DIEnumerator)
-SIMPLIFY_DESCRIPTOR(DIScope)
-SIMPLIFY_DESCRIPTOR(DIType)
-SIMPLIFY_DESCRIPTOR(DIBasicType)
-SIMPLIFY_DESCRIPTOR(DIDerivedType)
-SIMPLIFY_DESCRIPTOR(DICompositeType)
-SIMPLIFY_DESCRIPTOR(DISubroutineType)
SIMPLIFY_DESCRIPTOR(DIFile)
SIMPLIFY_DESCRIPTOR(DICompileUnit)
SIMPLIFY_DESCRIPTOR(DISubprogram)
#undef SIMPLIFY_DESCRIPTOR
/// \brief Find subprogram that is enclosing this scope.
-DISubprogram getDISubprogram(const MDNode *Scope);
+MDSubprogram *getDISubprogram(const MDNode *Scope);
/// \brief Find debug info for a given function.
/// \returns a valid DISubprogram, if found. Otherwise, it returns an empty
/// DISubprogram.
-DISubprogram getDISubprogram(const Function *F);
+MDSubprogram *getDISubprogram(const Function *F);
/// \brief Find underlying composite type.
-DICompositeType getDICompositeType(DIType T);
+MDCompositeTypeBase *getDICompositeType(MDType *T);
/// \brief Generate map by visiting all retained types.
DITypeIdentifierMap generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes);
/// \brief Process DbgValueInst.
void processValue(const Module &M, const DbgValueInst *DVI);
/// \brief Process DILocation.
- void processLocation(const Module &M, DILocation Loc);
+ void processLocation(const Module &M, const MDLocation *Loc);
/// \brief Clear all lists.
void reset();
private:
void InitializeTypeMap(const Module &M);
- void processType(DIType DT);
- void processSubprogram(DISubprogram SP);
- void processScope(DIScope Scope);
- bool addCompileUnit(DICompileUnit CU);
- bool addGlobalVariable(DIGlobalVariable DIG);
- bool addSubprogram(DISubprogram SP);
- bool addType(DIType DT);
- bool addScope(DIScope Scope);
+ void processType(MDType *DT);
+ void processSubprogram(MDSubprogram *SP);
+ void processScope(MDScope *Scope);
+ bool addCompileUnit(MDCompileUnit *CU);
+ bool addGlobalVariable(MDGlobalVariable *DIG);
+ bool addSubprogram(MDSubprogram *SP);
+ bool addType(MDType *DT);
+ bool addScope(MDScope *Scope);
public:
- typedef SmallVectorImpl<DICompileUnit>::const_iterator compile_unit_iterator;
- typedef SmallVectorImpl<DISubprogram>::const_iterator subprogram_iterator;
- typedef SmallVectorImpl<DIGlobalVariable>::const_iterator
+ typedef SmallVectorImpl<MDCompileUnit *>::const_iterator
+ compile_unit_iterator;
+ typedef SmallVectorImpl<MDSubprogram *>::const_iterator subprogram_iterator;
+ typedef SmallVectorImpl<MDGlobalVariable *>::const_iterator
global_variable_iterator;
- typedef SmallVectorImpl<DIType>::const_iterator type_iterator;
- typedef SmallVectorImpl<DIScope>::const_iterator scope_iterator;
+ typedef SmallVectorImpl<MDType *>::const_iterator type_iterator;
+ typedef SmallVectorImpl<MDScope *>::const_iterator scope_iterator;
iterator_range<compile_unit_iterator> compile_units() const {
return iterator_range<compile_unit_iterator>(CUs.begin(), CUs.end());
unsigned scope_count() const { return Scopes.size(); }
private:
- SmallVector<DICompileUnit, 8> CUs;
- SmallVector<DISubprogram, 8> SPs;
- SmallVector<DIGlobalVariable, 8> GVs;
- SmallVector<DIType, 8> TYs;
- SmallVector<DIScope, 8> Scopes;
- SmallPtrSet<MDNode *, 64> NodesSeen;
+ SmallVector<MDCompileUnit *, 8> CUs;
+ SmallVector<MDSubprogram *, 8> SPs;
+ SmallVector<MDGlobalVariable *, 8> GVs;
+ SmallVector<MDType *, 8> TYs;
+ SmallVector<MDScope *, 8> Scopes;
+ SmallPtrSet<const MDNode *, 64> NodesSeen;
DITypeIdentifierMap TypeIdentifierMap;
/// \brief Specify if TypeIdentifierMap is initialized.
bool TypeMapInitialized;
};
-DenseMap<const Function *, DISubprogram> makeSubprogramMap(const Module &M);
+DenseMap<const Function *, MDSubprogram *> makeSubprogramMap(const Module &M);
} // end namespace llvm
projects / oota-llvm.git / blobdiff