#include <iterator>
namespace llvm {
-class BasicBlock;
-class Constant;
-class Function;
-class GlobalVariable;
class Module;
-class Type;
-class Value;
class DbgDeclareInst;
class DbgValueInst;
-class Instruction;
-class Metadata;
-class MDNode;
-class MDString;
-class NamedMDNode;
-class LLVMContext;
-class raw_ostream;
-
-class DIFile;
-class DISubprogram;
-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)
-DECLARE_SIMPLIFY_DESCRIPTOR(DILexicalBlock)
-DECLARE_SIMPLIFY_DESCRIPTOR(DILexicalBlockFile)
-DECLARE_SIMPLIFY_DESCRIPTOR(DINameSpace)
-DECLARE_SIMPLIFY_DESCRIPTOR(DITemplateTypeParameter)
-DECLARE_SIMPLIFY_DESCRIPTOR(DITemplateValueParameter)
-DECLARE_SIMPLIFY_DESCRIPTOR(DIGlobalVariable)
-DECLARE_SIMPLIFY_DESCRIPTOR(DIVariable)
-DECLARE_SIMPLIFY_DESCRIPTOR(DIExpression)
-DECLARE_SIMPLIFY_DESCRIPTOR(DILocation)
-DECLARE_SIMPLIFY_DESCRIPTOR(DIObjCProperty)
-DECLARE_SIMPLIFY_DESCRIPTOR(DIImportedEntity)
-#undef DECLARE_SIMPLIFY_DESCRIPTOR
-
-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(); }
-
- 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) {}
-
- 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); }
-};
-
-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;
-
-DIScopeRef DIScope::getContext() const { return get()->getScope(); }
-
-class DIType {
- MDType *N;
-
-public:
- DIType(const MDType *N = nullptr) : N(const_cast<MDType *>(N)) {}
-
- operator DIDescriptor() const { return N; }
- operator DIScope() const { return N; }
- operator MDType *() const { return N; }
- MDType *operator->() const { return N; }
- MDType &operator*() const { return *N; }
-};
-
-class DIBasicType {
- MDBasicType *N;
-
-public:
- DIBasicType(const MDBasicType *N = nullptr)
- : N(const_cast<MDBasicType *>(N)) {}
-
- operator DIDescriptor() const { return N; }
- operator DIType() const { return N; }
- operator MDBasicType *() const { return N; }
- MDBasicType *operator->() const { return N; }
- MDBasicType &operator*() const { return *N; }
-};
-
-class DIDerivedType {
- MDDerivedTypeBase *N;
-
-public:
- DIDerivedType(const MDDerivedTypeBase *N = nullptr)
- : N(const_cast<MDDerivedTypeBase *>(N)) {}
-
- operator DIDescriptor() const { return N; }
- operator DIType() const { return N; }
- operator MDDerivedTypeBase *() const { return N; }
- MDDerivedTypeBase *operator->() const { return N; }
- MDDerivedTypeBase &operator*() const { return *N; }
-};
-
-class DICompositeType {
- MDCompositeTypeBase *N;
-
-public:
- DICompositeType(const MDCompositeTypeBase *N = nullptr)
- : N(const_cast<MDCompositeTypeBase *>(N)) {}
-
- operator DIDescriptor() const { return N; }
- operator DIType() const { return N; }
- operator MDCompositeTypeBase *() const { return N; }
- MDCompositeTypeBase *operator->() const { return N; }
- MDCompositeTypeBase &operator*() const { return *N; }
-};
-
-class DISubroutineType {
- MDSubroutineType *N;
-
-public:
- DISubroutineType(const MDSubroutineType *N = nullptr)
- : N(const_cast<MDSubroutineType *>(N)) {}
-
- operator DIDescriptor() const { return N; }
- operator DIType() const { return N; }
- operator DICompositeType() const { return N; }
- operator MDSubroutineType *() const { return N; }
- MDSubroutineType *operator->() const { return N; }
- MDSubroutineType &operator*() const { return *N; }
-};
-
-class DIFile {
- MDFile *N;
-
-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; }
-};
-
-class DICompileUnit {
- MDCompileUnit *N;
-
-public:
- 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; }
-};
-
-class DISubprogram {
- MDSubprogram *N;
-
-public:
- 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; }
-};
-
-class DILexicalBlock {
- MDLexicalBlockBase *N;
-
-public:
- 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; }
-};
-
-class DILexicalBlockFile {
- MDLexicalBlockFile *N;
-
-public:
- 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; }
-};
-
-class DINameSpace {
- MDNamespace *N;
-
-public:
- 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; }
-};
-
-class DITemplateTypeParameter {
- MDTemplateTypeParameter *N;
-
-public:
- DITemplateTypeParameter(const MDTemplateTypeParameter *N = nullptr)
- : N(const_cast<MDTemplateTypeParameter *>(N)) {}
-
- operator MDTemplateTypeParameter *() const { return N; }
- MDTemplateTypeParameter *operator->() const { return N; }
- MDTemplateTypeParameter &operator*() const { return *N; }
-};
-
-class DITemplateValueParameter {
- MDTemplateValueParameter *N;
-
-public:
- DITemplateValueParameter(const MDTemplateValueParameter *N = nullptr)
- : N(const_cast<MDTemplateValueParameter *>(N)) {}
-
- operator MDTemplateValueParameter *() const { return N; }
- MDTemplateValueParameter *operator->() const { return N; }
- MDTemplateValueParameter &operator*() const { return *N; }
-};
-
-class DIGlobalVariable {
- MDGlobalVariable *N;
-
-public:
- 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; }
-};
-
-class DIVariable {
- MDLocalVariable *N;
-
-public:
- DIVariable(const MDLocalVariable *N = nullptr)
- : N(const_cast<MDLocalVariable *>(N)) {}
-
- operator MDLocalVariable *() const { return N; }
- MDLocalVariable *operator->() const { return N; }
- MDLocalVariable &operator*() const { return *N; }
-};
-
-class DIExpression {
- MDExpression *N;
-
-public:
- DIExpression(const MDExpression *N = nullptr)
- : N(const_cast<MDExpression *>(N)) {}
-
- operator MDExpression *() const { return N; }
- MDExpression *operator->() const { return N; }
- MDExpression &operator*() const { return *N; }
-};
-
-class DILocation {
- MDLocation *N;
-
-public:
- DILocation(const MDLocation *N = nullptr) : N(const_cast<MDLocation *>(N)) {}
-
- operator MDLocation *() const { return N; }
- MDLocation *operator->() const { return N; }
- MDLocation &operator*() const { return *N; }
-};
-
-class DIObjCProperty {
- MDObjCProperty *N;
-
-public:
- DIObjCProperty(const MDObjCProperty *N = nullptr)
- : N(const_cast<MDObjCProperty *>(N)) {}
-
- operator MDObjCProperty *() const { return N; }
- MDObjCProperty *operator->() const { return N; }
- MDObjCProperty &operator*() const { return *N; }
-};
-
-class DIImportedEntity {
- MDImportedEntity *N;
-
-public:
- 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; }
-};
-
-#define SIMPLIFY_DESCRIPTOR(DESC) \
- template <> struct simplify_type<const DESC> { \
- typedef Metadata *SimpleType; \
- 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)
-SIMPLIFY_DESCRIPTOR(DILexicalBlock)
-SIMPLIFY_DESCRIPTOR(DILexicalBlockFile)
-SIMPLIFY_DESCRIPTOR(DINameSpace)
-SIMPLIFY_DESCRIPTOR(DITemplateTypeParameter)
-SIMPLIFY_DESCRIPTOR(DITemplateValueParameter)
-SIMPLIFY_DESCRIPTOR(DIGlobalVariable)
-SIMPLIFY_DESCRIPTOR(DIVariable)
-SIMPLIFY_DESCRIPTOR(DIExpression)
-SIMPLIFY_DESCRIPTOR(DILocation)
-SIMPLIFY_DESCRIPTOR(DIObjCProperty)
-SIMPLIFY_DESCRIPTOR(DIImportedEntity)
-#undef SIMPLIFY_DESCRIPTOR
+typedef DenseMap<const MDString *, DIType *> DITypeIdentifierMap;
/// \brief Find subprogram that is enclosing this scope.
-DISubprogram getDISubprogram(const MDNode *Scope);
+DISubprogram *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);
+///
+/// \returns a valid subprogram, if found. Otherwise, return \c nullptr.
+DISubprogram *getDISubprogram(const Function *F);
/// \brief Find underlying composite type.
-DICompositeType getDICompositeType(DIType T);
+DICompositeTypeBase *getDICompositeType(DIType *T);
/// \brief Generate map by visiting all retained types.
DITypeIdentifierMap generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes);
void processDeclare(const Module &M, const DbgDeclareInst *DDI);
/// \brief Process DbgValueInst.
void processValue(const Module &M, const DbgValueInst *DVI);
- /// \brief Process DILocation.
- void processLocation(const Module &M, DILocation Loc);
+ /// \brief Process debug info location.
+ void processLocation(const Module &M, const DILocation *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(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);
public:
- typedef SmallVectorImpl<DICompileUnit>::const_iterator compile_unit_iterator;
- typedef SmallVectorImpl<DISubprogram>::const_iterator subprogram_iterator;
- typedef SmallVectorImpl<DIGlobalVariable>::const_iterator
+ typedef SmallVectorImpl<DICompileUnit *>::const_iterator
+ compile_unit_iterator;
+ typedef SmallVectorImpl<DISubprogram *>::const_iterator subprogram_iterator;
+ typedef SmallVectorImpl<DIGlobalVariable *>::const_iterator
global_variable_iterator;
- typedef SmallVectorImpl<DIType>::const_iterator type_iterator;
- typedef SmallVectorImpl<DIScope>::const_iterator scope_iterator;
+ typedef SmallVectorImpl<DIType *>::const_iterator type_iterator;
+ typedef SmallVectorImpl<DIScope *>::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<DICompileUnit *, 8> CUs;
+ SmallVector<DISubprogram *, 8> SPs;
+ SmallVector<DIGlobalVariable *, 8> GVs;
+ SmallVector<DIType *, 8> TYs;
+ SmallVector<DIScope *, 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 *, DISubprogram *> makeSubprogramMap(const Module &M);
} // end namespace llvm