/// \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;
+ MDNode *N;
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;
- }
+ DIDescriptor(const MDNode *N = nullptr) : N(const_cast<MDNode *>(N)) {}
- void print(raw_ostream &OS) const;
- void dump() const;
+ operator MDNode *() const { return N; }
+ MDNode *operator->() const { return N; }
+ MDNode &operator*() const { return *N; }
};
#define DECLARE_SIMPLIFY_DESCRIPTOR(DESC) \
typedef DebugNodeArray DIArray;
typedef MDTypeRefArray DITypeArray;
+typedef DebugNodeRef DIDescriptorRef;
+typedef MDScopeRef DIScopeRef;
+typedef MDTypeRef DITypeRef;
-/// \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(); }
-};
+class DISubrange {
+ MDSubrange *N;
-/// \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(); }
+ DISubrange(const MDSubrange *N = nullptr) : N(const_cast<MDSubrange *>(N)) {}
- StringRef getName() const { return get()->getName(); }
- int64_t getEnumValue() const { return get()->getValue(); }
+ operator MDSubrange *() const { return N; }
+ MDSubrange *operator->() const { return N; }
+ MDSubrange &operator*() const { return *N; }
};
-template <typename T> class DIRef;
-typedef DIRef<DIDescriptor> DIDescriptorRef;
-typedef DIRef<DIScope> DIScopeRef;
-typedef DIRef<DIType> DITypeRef;
+class DIEnumerator {
+ MDEnumerator *N;
-/// \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;
+ DIEnumerator(const MDEnumerator *N = nullptr)
+ : N(const_cast<MDEnumerator *>(N)) {}
-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 MDEnumerator *() const { return N; }
+ MDEnumerator *operator->() const { return N; }
+ MDEnumerator &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 DIScope {
+ MDScope *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(); }
-
- bool isValid() const { return DbgNode && isa<MDType>(*this); }
-};
-
-/// \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(); }
+ DIScope(const MDScope *N = nullptr) : N(const_cast<MDScope *>(N)) {}
- unsigned getEncoding() const { return get()->getEncoding(); }
+ operator DIDescriptor() const { return N; }
+ operator MDScope *() const { return N; }
+ MDScope *operator->() const { return N; }
+ MDScope &operator*() const { return *N; }
};
-/// \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) {}
+class DIType {
+ MDType *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(); }
+public:
+ DIType(const MDType *N = nullptr) : N(const_cast<MDType *>(N)) {}
- DITypeRef getTypeDerivedFrom() const { return get()->getBaseType(); }
+ 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; }
+};
- /// \brief Return property node, if this ivar is associated with one.
- MDObjCProperty *getObjCProperty() const {
- return cast<MDDerivedType>(get())->getObjCProperty();
- }
+class DIBasicType {
+ MDBasicType *N;
- DITypeRef getClassType() const {
- return cast<MDDerivedType>(get())->getClassType();
- }
+public:
+ DIBasicType(const MDBasicType *N = nullptr)
+ : N(const_cast<MDBasicType *>(N)) {}
- Constant *getConstant() const {
- return cast<MDDerivedType>(get())->getConstant();
- }
+ 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; }
};
-/// \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;
+class DIDerivedType {
+ MDDerivedTypeBase *N;
public:
- DICompositeType() = default;
- DICompositeType(const MDCompositeTypeBase *N) : DIDerivedType(N) {}
+ DIDerivedType(const MDDerivedTypeBase *N = nullptr)
+ : N(const_cast<MDDerivedTypeBase *>(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(); }
+ 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; }
+};
- DIArray getElements() const { return get()->getElements(); }
+class DICompositeType {
+ MDCompositeTypeBase *N;
- unsigned getRunTimeLang() const { return get()->getRuntimeLang(); }
- DITypeRef getContainingType() const { return get()->getVTableHolder(); }
+public:
+ DICompositeType(const MDCompositeTypeBase *N = nullptr)
+ : N(const_cast<MDCompositeTypeBase *>(N)) {}
- DIArray getTemplateParams() const { return get()->getTemplateParams(); }
- MDString *getIdentifier() const { return get()->getRawIdentifier(); }
+ 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 : public DICompositeType {
-public:
- DISubroutineType() = default;
- DISubroutineType(const MDSubroutineType *N) : DICompositeType(N) {}
+class DISubroutineType {
+ MDSubroutineType *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(); }
+public:
+ DISubroutineType(const MDSubroutineType *N = nullptr)
+ : N(const_cast<MDSubroutineType *>(N)) {}
- MDTypeRefArray getTypeArray() const { return get()->getTypeArray(); }
+ 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; }
};
-/// \brief This is a wrapper for a file.
-class DIFile : public DIScope {
-public:
- DIFile() = default;
- DIFile(const MDFile *N) : DIScope(N) {}
+class DIFile {
+ MDFile *N;
- MDFile *get() const { return cast_or_null<MDFile>(DIDescriptor::get()); }
- operator MDFile *() const { return get(); }
- MDFile *operator->() const { return get(); }
- MDFile &operator*() const { return *get(); }
+public:
+ DIFile(const MDFile *N = nullptr) : N(const_cast<MDFile *>(N)) {}
- /// \brief Retrieve the MDNode for the directory/file pair.
- MDNode *getFileNode() const { return get(); }
+ 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; }
};
-/// \brief A wrapper for a compile unit.
-class DICompileUnit : public DIScope {
-public:
- DICompileUnit() = default;
- DICompileUnit(const MDCompileUnit *N) : DIScope(N) {}
+class DICompileUnit {
+ MDCompileUnit *N;
- MDCompileUnit *get() const {
- return cast_or_null<MDCompileUnit>(DIDescriptor::get());
- }
- operator MDCompileUnit *() const { return get(); }
- MDCompileUnit *operator->() const { return get(); }
- MDCompileUnit &operator*() const { return *get(); }
+public:
+ DICompileUnit(const MDCompileUnit *N = nullptr)
+ : N(const_cast<MDCompileUnit *>(N)) {}
- dwarf::SourceLanguage getLanguage() const {
- return static_cast<dwarf::SourceLanguage>(get()->getSourceLanguage());
- }
- StringRef getProducer() const { return get()->getProducer(); }
- bool isOptimized() const { return get()->isOptimized(); }
- StringRef getFlags() const { return get()->getFlags(); }
- unsigned getRunTimeVersion() const { return get()->getRuntimeVersion(); }
-
- DIArray getEnumTypes() const { return get()->getEnumTypes(); }
- DIArray getRetainedTypes() const { return get()->getRetainedTypes(); }
- DIArray getSubprograms() const { return get()->getSubprograms(); }
- DIArray getGlobalVariables() const { return get()->getGlobalVariables(); }
- DIArray getImportedEntities() const { return get()->getImportedEntities(); }
-
- void replaceSubprograms(DIArray Subprograms);
- void replaceGlobalVariables(DIArray GlobalVariables);
-
- StringRef getSplitDebugFilename() const {
- return get()->getSplitDebugFilename();
- }
- unsigned getEmissionKind() const { return get()->getEmissionKind(); }
+ 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 {
: 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; }
/// \brief Find underlying composite type.
DICompositeType getDICompositeType(DIType T);
-/// \brief Create a new inlined variable based on current variable.
-///
-/// @param DV Current Variable.
-/// @param InlinedScope Location at current variable is inlined.
-DIVariable createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
- LLVMContext &VMContext);
-
-/// \brief Remove inlined scope from the variable.
-DIVariable cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext);
-
/// \brief Generate map by visiting all retained types.
DITypeIdentifierMap generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes);