1 //===- DebugInfo.h - Debug Information Helpers ------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines a bunch of datatypes that are useful for creating and
11 // walking debug info in LLVM IR form. They essentially provide wrappers around
12 // the information in the global variables that's needed when constructing the
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_IR_DEBUGINFO_H
18 #define LLVM_IR_DEBUGINFO_H
20 #include "llvm/ADT/DenseMap.h"
21 #include "llvm/ADT/SmallPtrSet.h"
22 #include "llvm/ADT/SmallVector.h"
23 #include "llvm/ADT/StringRef.h"
24 #include "llvm/ADT/iterator_range.h"
25 #include "llvm/IR/DebugInfoMetadata.h"
26 #include "llvm/Support/Casting.h"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/ErrorHandling.h"
52 class DILexicalBlockFile;
58 /// \brief Maps from type identifier to the actual MDNode.
59 typedef DenseMap<const MDString *, MDNode *> DITypeIdentifierMap;
61 /// \brief A thin wraper around MDNode to access encoded debug info.
63 /// This should not be stored in a container, because the underlying MDNode may
64 /// change in certain situations.
66 // Befriends DIRef so DIRef can befriend the protected member
67 // function: getFieldAs<DIRef>.
68 template <typename T> friend class DIRef;
71 /// \brief Duplicated debug info flags.
73 /// \see DebugNode::DIFlags.
75 #define HANDLE_DI_FLAG(ID, NAME) Flag##NAME = DebugNode::Flag##NAME,
76 #include "llvm/IR/DebugInfoFlags.def"
77 FlagAccessibility = DebugNode::FlagAccessibility
81 const MDNode *DbgNode;
83 DIDescriptor getDescriptorField(unsigned Elt) const;
84 template <typename DescTy> DescTy getFieldAs(unsigned Elt) const {
85 return DescTy(getDescriptorField(Elt));
89 explicit DIDescriptor(const MDNode *N = nullptr) : DbgNode(N) {}
91 MDNode *get() const { return const_cast<MDNode *>(DbgNode); }
92 operator MDNode *() const { return get(); }
93 MDNode *operator->() const { return get(); }
94 MDNode &operator*() const {
95 assert(get() && "Expected valid pointer");
99 // An explicit operator bool so that we can do testing of DI values
101 // FIXME: This operator bool isn't actually protecting anything at the
102 // moment due to the conversion operator above making DIDescriptor nodes
103 // implicitly convertable to bool.
104 explicit operator bool() const { return DbgNode != nullptr; }
106 bool operator==(DIDescriptor Other) const { return DbgNode == Other.DbgNode; }
107 bool operator!=(DIDescriptor Other) const { return !operator==(Other); }
109 uint16_t getTag() const {
110 if (auto *N = dyn_cast_or_null<DebugNode>(get()))
115 void print(raw_ostream &OS) const;
118 /// \brief Replace all uses of debug info referenced by this descriptor.
119 void replaceAllUsesWith(LLVMContext &VMContext, DIDescriptor D);
120 void replaceAllUsesWith(MDNode *D);
123 #define DECLARE_SIMPLIFY_DESCRIPTOR(DESC) \
125 template <> struct simplify_type<const DESC>; \
126 template <> struct simplify_type<DESC>;
127 DECLARE_SIMPLIFY_DESCRIPTOR(DIDescriptor)
128 DECLARE_SIMPLIFY_DESCRIPTOR(DISubrange)
129 DECLARE_SIMPLIFY_DESCRIPTOR(DIEnumerator)
130 DECLARE_SIMPLIFY_DESCRIPTOR(DIScope)
131 DECLARE_SIMPLIFY_DESCRIPTOR(DIType)
132 DECLARE_SIMPLIFY_DESCRIPTOR(DIBasicType)
133 DECLARE_SIMPLIFY_DESCRIPTOR(DIDerivedType)
134 DECLARE_SIMPLIFY_DESCRIPTOR(DICompositeType)
135 DECLARE_SIMPLIFY_DESCRIPTOR(DISubroutineType)
136 DECLARE_SIMPLIFY_DESCRIPTOR(DIFile)
137 DECLARE_SIMPLIFY_DESCRIPTOR(DICompileUnit)
138 DECLARE_SIMPLIFY_DESCRIPTOR(DISubprogram)
139 DECLARE_SIMPLIFY_DESCRIPTOR(DILexicalBlock)
140 DECLARE_SIMPLIFY_DESCRIPTOR(DILexicalBlockFile)
141 DECLARE_SIMPLIFY_DESCRIPTOR(DINameSpace)
142 DECLARE_SIMPLIFY_DESCRIPTOR(DITemplateTypeParameter)
143 DECLARE_SIMPLIFY_DESCRIPTOR(DITemplateValueParameter)
144 DECLARE_SIMPLIFY_DESCRIPTOR(DIGlobalVariable)
145 DECLARE_SIMPLIFY_DESCRIPTOR(DIVariable)
146 DECLARE_SIMPLIFY_DESCRIPTOR(DIExpression)
147 DECLARE_SIMPLIFY_DESCRIPTOR(DILocation)
148 DECLARE_SIMPLIFY_DESCRIPTOR(DIObjCProperty)
149 DECLARE_SIMPLIFY_DESCRIPTOR(DIImportedEntity)
150 #undef DECLARE_SIMPLIFY_DESCRIPTOR
152 /// \brief This is used to represent ranges, for array bounds.
153 class DISubrange : public DIDescriptor {
155 DISubrange() = default;
156 DISubrange(const MDSubrange *N) : DIDescriptor(N) {}
158 MDSubrange *get() const {
159 return cast_or_null<MDSubrange>(DIDescriptor::get());
161 operator MDSubrange *() const { return get(); }
162 MDSubrange *operator->() const { return get(); }
163 MDSubrange &operator*() const {
164 assert(get() && "Expected valid pointer");
168 int64_t getLo() const { return get()->getLowerBound(); }
169 int64_t getCount() const { return get()->getCount(); }
172 /// \brief This descriptor holds an array of nodes with type T.
173 template <typename T> class DITypedArray : public DIDescriptor {
175 explicit DITypedArray(const MDNode *N = nullptr) : DIDescriptor(N) {}
176 operator MDTuple *() const {
177 return const_cast<MDTuple *>(cast_or_null<MDTuple>(DbgNode));
179 unsigned getNumElements() const {
180 return DbgNode ? DbgNode->getNumOperands() : 0;
182 T getElement(unsigned Idx) const { return getFieldAs<T>(Idx); }
185 typedef DITypedArray<DIDescriptor> DIArray;
187 /// \brief A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
189 /// FIXME: it seems strange that this doesn't have either a reference to the
190 /// type/precision or a file/line pair for location info.
191 class DIEnumerator : public DIDescriptor {
193 DIEnumerator() = default;
194 DIEnumerator(const MDEnumerator *N) : DIDescriptor(N) {}
196 MDEnumerator *get() const {
197 return cast_or_null<MDEnumerator>(DIDescriptor::get());
199 operator MDEnumerator *() const { return get(); }
200 MDEnumerator *operator->() const { return get(); }
201 MDEnumerator &operator*() const {
202 assert(get() && "Expected valid pointer");
206 StringRef getName() const { return get()->getName(); }
207 int64_t getEnumValue() const { return get()->getValue(); }
210 template <typename T> class DIRef;
211 typedef DIRef<DIDescriptor> DIDescriptorRef;
212 typedef DIRef<DIScope> DIScopeRef;
213 typedef DIRef<DIType> DITypeRef;
214 typedef DITypedArray<DITypeRef> DITypeArray;
216 /// \brief A base class for various scopes.
218 /// Although, implementation-wise, DIScope is the parent class of most
219 /// other DIxxx classes, including DIType and its descendants, most of
220 /// DIScope's descendants are not a substitutable subtype of
221 /// DIScope. The DIDescriptor::isScope() method only is true for
222 /// DIScopes that are scopes in the strict lexical scope sense
223 /// (DICompileUnit, DISubprogram, etc.), but not for, e.g., a DIType.
224 class DIScope : public DIDescriptor {
227 DIScope(const MDScope *N) : DIDescriptor(N) {}
229 MDScope *get() const { return cast_or_null<MDScope>(DIDescriptor::get()); }
230 operator MDScope *() const { return get(); }
231 MDScope *operator->() const { return get(); }
232 MDScope &operator*() const {
233 assert(get() && "Expected valid pointer");
237 /// \brief Get the parent scope.
239 /// Gets the parent scope for this scope node or returns a default
240 /// constructed scope.
241 DIScopeRef getContext() const;
242 /// \brief Get the scope name.
244 /// If the scope node has a name, return that, else return an empty string.
245 StringRef getName() const;
246 StringRef getFilename() const;
247 StringRef getDirectory() const;
249 /// \brief Generate a reference to this DIScope.
251 /// Uses the type identifier instead of the actual MDNode if possible, to
252 /// help type uniquing.
253 DIScopeRef getRef() const;
256 /// \brief Represents reference to a DIDescriptor.
258 /// Abstracts over direct and identifier-based metadata references.
259 template <typename T> class DIRef {
260 template <typename DescTy>
261 friend DescTy DIDescriptor::getFieldAs(unsigned Elt) const;
262 friend DIScopeRef DIScope::getContext() const;
263 friend DIScopeRef DIScope::getRef() const;
266 /// \brief Val can be either a MDNode or a MDString.
268 /// In the latter, MDString specifies the type identifier.
270 explicit DIRef(const Metadata *V);
274 DIRef(const TypedDebugNodeRef<U> &Ref,
275 typename std::enable_if<std::is_convertible<U *, T>::value>::type * =
279 T resolve(const DITypeIdentifierMap &Map) const;
280 operator Metadata *() const { return const_cast<Metadata *>(Val); }
282 static DIRef get(const Metadata *MD) { return DIRef(MD); }
286 DIDescriptor DIRef<DIDescriptor>::resolve(const DITypeIdentifierMap &Map) const;
288 DIScope DIRef<DIScope>::resolve(const DITypeIdentifierMap &Map) const;
289 template <> DIType DIRef<DIType>::resolve(const DITypeIdentifierMap &Map) const;
291 /// \brief Handle fields that are references to DIDescriptors.
293 DIDescriptorRef DIDescriptor::getFieldAs<DIDescriptorRef>(unsigned Elt) const;
294 /// \brief Specialize DIRef constructor for DIDescriptorRef.
295 template <> DIRef<DIDescriptor>::DIRef(const Metadata *V);
297 /// \brief Handle fields that are references to DIScopes.
298 template <> DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const;
299 /// \brief Specialize DIRef constructor for DIScopeRef.
300 template <> DIRef<DIScope>::DIRef(const Metadata *V);
302 /// \brief Handle fields that are references to DITypes.
303 template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const;
304 /// \brief Specialize DIRef constructor for DITypeRef.
305 template <> DIRef<DIType>::DIRef(const Metadata *V);
307 /// \brief This is a wrapper for a type.
309 /// FIXME: Types should be factored much better so that CV qualifiers and
310 /// others do not require a huge and empty descriptor full of zeros.
311 class DIType : public DIScope {
314 DIType(const MDType *N) : DIScope(N) {}
316 MDType *get() const { return cast_or_null<MDType>(DIDescriptor::get()); }
317 operator MDType *() const { return get(); }
318 MDType *operator->() const { return get(); }
319 MDType &operator*() const {
320 assert(get() && "Expected valid pointer");
324 DIScopeRef getContext() const { return DIScopeRef::get(get()->getScope()); }
325 StringRef getName() const { return get()->getName(); }
326 unsigned getLineNumber() const { return get()->getLine(); }
327 uint64_t getSizeInBits() const { return get()->getSizeInBits(); }
328 uint64_t getAlignInBits() const { return get()->getAlignInBits(); }
329 // FIXME: Offset is only used for DW_TAG_member nodes. Making every type
330 // carry this is just plain insane.
331 uint64_t getOffsetInBits() const { return get()->getOffsetInBits(); }
332 unsigned getFlags() const { return get()->getFlags(); }
334 bool isPrivate() const { return get()->isPrivate(); }
335 bool isProtected() const { return get()->isProtected(); }
336 bool isPublic() const { return get()->isPublic(); }
337 bool isForwardDecl() const { return get()->isForwardDecl(); }
338 bool isAppleBlockExtension() const { return get()->isAppleBlockExtension(); }
339 bool isBlockByrefStruct() const { return get()->isBlockByrefStruct(); }
340 bool isVirtual() const { return get()->isVirtual(); }
341 bool isArtificial() const { return get()->isArtificial(); }
342 bool isObjectPointer() const { return get()->isObjectPointer(); }
343 bool isObjcClassComplete() const { return get()->isObjcClassComplete(); }
344 bool isVector() const { return get()->isVector(); }
345 bool isStaticMember() const { return get()->isStaticMember(); }
346 bool isLValueReference() const { return get()->isLValueReference(); }
347 bool isRValueReference() const { return get()->isRValueReference(); }
349 bool isValid() const { return DbgNode && isa<MDType>(*this); }
352 /// \brief A basic type, like 'int' or 'float'.
353 class DIBasicType : public DIType {
355 DIBasicType() = default;
356 DIBasicType(const MDBasicType *N) : DIType(N) {}
358 MDBasicType *get() const {
359 return cast_or_null<MDBasicType>(DIDescriptor::get());
361 operator MDBasicType *() const { return get(); }
362 MDBasicType *operator->() const { return get(); }
363 MDBasicType &operator*() const {
364 assert(get() && "Expected valid pointer");
368 unsigned getEncoding() const { return get()->getEncoding(); }
371 /// \brief A simple derived type
373 /// Like a const qualified type, a typedef, a pointer or reference, et cetera.
374 /// Or, a data member of a class/struct/union.
375 class DIDerivedType : public DIType {
377 DIDerivedType() = default;
378 DIDerivedType(const MDDerivedTypeBase *N) : DIType(N) {}
380 MDDerivedTypeBase *get() const {
381 return cast_or_null<MDDerivedTypeBase>(DIDescriptor::get());
383 operator MDDerivedTypeBase *() const { return get(); }
384 MDDerivedTypeBase *operator->() const { return get(); }
385 MDDerivedTypeBase &operator*() const {
386 assert(get() && "Expected valid pointer");
390 DITypeRef getTypeDerivedFrom() const {
391 return DITypeRef::get(get()->getBaseType());
394 /// \brief Return property node, if this ivar is associated with one.
395 MDNode *getObjCProperty() const {
396 if (auto *N = dyn_cast<MDDerivedType>(get()))
397 return dyn_cast_or_null<MDNode>(N->getExtraData());
401 DITypeRef getClassType() const {
402 assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
403 if (auto *N = dyn_cast<MDDerivedType>(get()))
404 return DITypeRef::get(N->getExtraData());
405 return DITypeRef::get(nullptr);
408 Constant *getConstant() const {
409 assert((getTag() == dwarf::DW_TAG_member) && isStaticMember());
410 if (auto *N = dyn_cast<MDDerivedType>(get()))
411 if (auto *C = dyn_cast_or_null<ConstantAsMetadata>(N->getExtraData()))
412 return C->getValue();
418 /// \brief Types that refer to multiple other types.
420 /// This descriptor holds a type that can refer to multiple other types, like a
421 /// function or struct.
423 /// DICompositeType is derived from DIDerivedType because some
424 /// composite types (such as enums) can be derived from basic types
425 // FIXME: Make this derive from DIType directly & just store the
426 // base type in a single DIType field.
427 class DICompositeType : public DIDerivedType {
428 friend class DIBuilder;
430 /// \brief Set the array of member DITypes.
431 void setArraysHelper(MDNode *Elements, MDNode *TParams);
434 DICompositeType() = default;
435 DICompositeType(const MDCompositeTypeBase *N) : DIDerivedType(N) {}
437 MDCompositeTypeBase *get() const {
438 return cast_or_null<MDCompositeTypeBase>(DIDescriptor::get());
440 operator MDCompositeTypeBase *() const { return get(); }
441 MDCompositeTypeBase *operator->() const { return get(); }
442 MDCompositeTypeBase &operator*() const {
443 assert(get() && "Expected valid pointer");
447 DIArray getElements() const {
448 assert(!isa<MDSubroutineType>(*this) && "no elements for DISubroutineType");
449 return DIArray(get()->getElements());
453 template <typename T>
454 void setArrays(DITypedArray<T> Elements, DIArray TParams = DIArray()) {
456 (!TParams || DbgNode->getNumOperands() == 8) &&
457 "If you're setting the template parameters this should include a slot "
459 setArraysHelper(Elements, TParams);
463 unsigned getRunTimeLang() const { return get()->getRuntimeLang(); }
464 DITypeRef getContainingType() const {
465 return DITypeRef::get(get()->getVTableHolder());
469 /// \brief Set the containing type.
470 void setContainingType(DICompositeType ContainingType);
473 DIArray getTemplateParams() const {
474 return DIArray(get()->getTemplateParams());
476 MDString *getIdentifier() const { return get()->getRawIdentifier(); }
479 class DISubroutineType : public DICompositeType {
481 DISubroutineType() = default;
482 DISubroutineType(const MDSubroutineType *N) : DICompositeType(N) {}
484 MDSubroutineType *get() const {
485 return cast_or_null<MDSubroutineType>(DIDescriptor::get());
487 operator MDSubroutineType *() const { return get(); }
488 MDSubroutineType *operator->() const { return get(); }
489 MDSubroutineType &operator*() const {
490 assert(get() && "Expected valid pointer");
494 DITypedArray<DITypeRef> getTypeArray() const {
495 return DITypedArray<DITypeRef>(get()->getTypeArray());
499 /// \brief This is a wrapper for a file.
500 class DIFile : public DIScope {
503 DIFile(const MDFile *N) : DIScope(N) {}
505 MDFile *get() const { return cast_or_null<MDFile>(DIDescriptor::get()); }
506 operator MDFile *() const { return get(); }
507 MDFile *operator->() const { return get(); }
508 MDFile &operator*() const {
509 assert(get() && "Expected valid pointer");
513 /// \brief Retrieve the MDNode for the directory/file pair.
514 MDNode *getFileNode() const { return get(); }
517 /// \brief A wrapper for a compile unit.
518 class DICompileUnit : public DIScope {
520 DICompileUnit() = default;
521 DICompileUnit(const MDCompileUnit *N) : DIScope(N) {}
523 MDCompileUnit *get() const {
524 return cast_or_null<MDCompileUnit>(DIDescriptor::get());
526 operator MDCompileUnit *() const { return get(); }
527 MDCompileUnit *operator->() const { return get(); }
528 MDCompileUnit &operator*() const {
529 assert(get() && "Expected valid pointer");
533 dwarf::SourceLanguage getLanguage() const {
534 return static_cast<dwarf::SourceLanguage>(get()->getSourceLanguage());
536 StringRef getProducer() const { return get()->getProducer(); }
537 bool isOptimized() const { return get()->isOptimized(); }
538 StringRef getFlags() const { return get()->getFlags(); }
539 unsigned getRunTimeVersion() const { return get()->getRuntimeVersion(); }
541 DIArray getEnumTypes() const { return DIArray(get()->getEnumTypes()); }
542 DIArray getRetainedTypes() const {
543 return DIArray(get()->getRetainedTypes());
545 DIArray getSubprograms() const { return DIArray(get()->getSubprograms()); }
546 DIArray getGlobalVariables() const {
547 return DIArray(get()->getGlobalVariables());
549 DIArray getImportedEntities() const {
550 return DIArray(get()->getImportedEntities());
553 void replaceSubprograms(DIArray Subprograms);
554 void replaceGlobalVariables(DIArray GlobalVariables);
556 StringRef getSplitDebugFilename() const {
557 return get()->getSplitDebugFilename();
559 unsigned getEmissionKind() const { return get()->getEmissionKind(); }
562 /// \brief This is a wrapper for a subprogram (e.g. a function).
563 class DISubprogram : public DIScope {
565 DISubprogram() = default;
566 DISubprogram(const MDSubprogram *N) : DIScope(N) {}
568 MDSubprogram *get() const {
569 return cast_or_null<MDSubprogram>(DIDescriptor::get());
571 operator MDSubprogram *() const { return get(); }
572 MDSubprogram *operator->() const { return get(); }
573 MDSubprogram &operator*() const {
574 assert(get() && "Expected valid pointer");
578 StringRef getName() const { return get()->getName(); }
579 StringRef getDisplayName() const { return get()->getDisplayName(); }
580 StringRef getLinkageName() const { return get()->getLinkageName(); }
581 unsigned getLineNumber() const { return get()->getLine(); }
583 /// \brief Check if this is local (like 'static' in C).
584 unsigned isLocalToUnit() const { return get()->isLocalToUnit(); }
585 unsigned isDefinition() const { return get()->isDefinition(); }
587 unsigned getVirtuality() const { return get()->getVirtuality(); }
588 unsigned getVirtualIndex() const { return get()->getVirtualIndex(); }
590 unsigned getFlags() const { return get()->getFlags(); }
592 unsigned isOptimized() const { return get()->isOptimized(); }
594 /// \brief Get the beginning of the scope of the function (not the name).
595 unsigned getScopeLineNumber() const { return get()->getScopeLine(); }
597 DIScopeRef getContext() const { return DIScopeRef::get(get()->getScope()); }
598 DISubroutineType getType() const {
599 return DISubroutineType(get()->getType());
602 DITypeRef getContainingType() const {
603 return DITypeRef::get(get()->getContainingType());
606 /// \brief Check if this provides debugging information for the function F.
607 bool describes(const Function *F);
609 Function *getFunction() const;
611 void replaceFunction(Function *F) {
613 N->replaceFunction(F);
615 DIArray getTemplateParams() const {
616 return DIArray(get()->getTemplateParams());
618 DISubprogram getFunctionDeclaration() const {
619 return DISubprogram(get()->getDeclaration());
621 MDNode *getVariablesNodes() const { return getVariables(); }
622 DIArray getVariables() const { return DIArray(get()->getVariables()); }
624 unsigned isArtificial() const { return (getFlags() & FlagArtificial) != 0; }
625 /// \brief Check for the "private" access specifier.
626 bool isPrivate() const {
627 return (getFlags() & FlagAccessibility) == FlagPrivate;
629 /// \brief Check for the "protected" access specifier.
630 bool isProtected() const {
631 return (getFlags() & FlagAccessibility) == FlagProtected;
633 /// \brief Check for the "public" access specifier.
634 bool isPublic() const {
635 return (getFlags() & FlagAccessibility) == FlagPublic;
637 /// \brief Check for "explicit".
638 bool isExplicit() const { return (getFlags() & FlagExplicit) != 0; }
639 /// \brief Check if this is prototyped.
640 bool isPrototyped() const { return (getFlags() & FlagPrototyped) != 0; }
642 /// \brief Check if this is reference-qualified.
644 /// Return true if this subprogram is a C++11 reference-qualified non-static
645 /// member function (void foo() &).
646 unsigned isLValueReference() const {
647 return (getFlags() & FlagLValueReference) != 0;
650 /// \brief Check if this is rvalue-reference-qualified.
652 /// Return true if this subprogram is a C++11 rvalue-reference-qualified
653 /// non-static member function (void foo() &&).
654 unsigned isRValueReference() const {
655 return (getFlags() & FlagRValueReference) != 0;
659 /// \brief This is a wrapper for a lexical block.
660 class DILexicalBlock : public DIScope {
662 DILexicalBlock() = default;
663 DILexicalBlock(const MDLexicalBlockBase *N) : DIScope(N) {}
665 MDLexicalBlockBase *get() const {
666 return cast_or_null<MDLexicalBlockBase>(DIDescriptor::get());
668 operator MDLexicalBlockBase *() const { return get(); }
669 MDLexicalBlockBase *operator->() const { return get(); }
670 MDLexicalBlockBase &operator*() const {
671 assert(get() && "Expected valid pointer");
675 DIScope getContext() const { return DIScope(get()->getScope()); }
676 unsigned getLineNumber() const {
677 if (auto *N = dyn_cast<MDLexicalBlock>(get()))
681 unsigned getColumnNumber() const {
682 if (auto *N = dyn_cast<MDLexicalBlock>(get()))
683 return N->getColumn();
688 /// \brief This is a wrapper for a lexical block with a filename change.
689 class DILexicalBlockFile : public DIScope {
691 DILexicalBlockFile() = default;
692 DILexicalBlockFile(const MDLexicalBlockFile *N) : DIScope(N) {}
694 MDLexicalBlockFile *get() const {
695 return cast_or_null<MDLexicalBlockFile>(DIDescriptor::get());
697 operator MDLexicalBlockFile *() const { return get(); }
698 MDLexicalBlockFile *operator->() const { return get(); }
699 MDLexicalBlockFile &operator*() const {
700 assert(get() && "Expected valid pointer");
704 DIScope getContext() const { return get()->getScope(); }
705 unsigned getDiscriminator() const { return get()->getDiscriminator(); }
708 /// \brief A wrapper for a C++ style name space.
709 class DINameSpace : public DIScope {
711 DINameSpace() = default;
712 DINameSpace(const MDNamespace *N) : DIScope(N) {}
714 MDNamespace *get() const {
715 return cast_or_null<MDNamespace>(DIDescriptor::get());
717 operator MDNamespace *() const { return get(); }
718 MDNamespace *operator->() const { return get(); }
719 MDNamespace &operator*() const {
720 assert(get() && "Expected valid pointer");
724 StringRef getName() const { return get()->getName(); }
725 unsigned getLineNumber() const { return get()->getLine(); }
726 DIScope getContext() const { return DIScope(get()->getScope()); }
729 /// \brief This is a wrapper for template type parameter.
730 class DITemplateTypeParameter : public DIDescriptor {
732 DITemplateTypeParameter() = default;
733 DITemplateTypeParameter(const MDTemplateTypeParameter *N) : DIDescriptor(N) {}
735 MDTemplateTypeParameter *get() const {
736 return cast_or_null<MDTemplateTypeParameter>(DIDescriptor::get());
738 operator MDTemplateTypeParameter *() const { return get(); }
739 MDTemplateTypeParameter *operator->() const { return get(); }
740 MDTemplateTypeParameter &operator*() const {
741 assert(get() && "Expected valid pointer");
745 StringRef getName() const { return get()->getName(); }
747 DITypeRef getType() const { return DITypeRef::get(get()->getType()); }
750 /// \brief This is a wrapper for template value parameter.
751 class DITemplateValueParameter : public DIDescriptor {
753 DITemplateValueParameter() = default;
754 DITemplateValueParameter(const MDTemplateValueParameter *N)
757 MDTemplateValueParameter *get() const {
758 return cast_or_null<MDTemplateValueParameter>(DIDescriptor::get());
760 operator MDTemplateValueParameter *() const { return get(); }
761 MDTemplateValueParameter *operator->() const { return get(); }
762 MDTemplateValueParameter &operator*() const {
763 assert(get() && "Expected valid pointer");
767 StringRef getName() const { return get()->getName(); }
768 DITypeRef getType() const { return DITypeRef::get(get()->getType()); }
769 Metadata *getValue() const { return get()->getValue(); }
772 /// \brief This is a wrapper for a global variable.
773 class DIGlobalVariable : public DIDescriptor {
774 DIFile getFile() const { return DIFile(get()->getFile()); }
777 DIGlobalVariable() = default;
778 DIGlobalVariable(const MDGlobalVariable *N) : DIDescriptor(N) {}
780 MDGlobalVariable *get() const {
781 return cast_or_null<MDGlobalVariable>(DIDescriptor::get());
783 operator MDGlobalVariable *() const { return get(); }
784 MDGlobalVariable *operator->() const { return get(); }
785 MDGlobalVariable &operator*() const {
786 assert(get() && "Expected valid pointer");
790 StringRef getName() const { return get()->getName(); }
791 StringRef getDisplayName() const { return get()->getDisplayName(); }
792 StringRef getLinkageName() const { return get()->getLinkageName(); }
793 unsigned getLineNumber() const { return get()->getLine(); }
794 unsigned isLocalToUnit() const { return get()->isLocalToUnit(); }
795 unsigned isDefinition() const { return get()->isDefinition(); }
797 DIScope getContext() const { return DIScope(get()->getScope()); }
798 StringRef getFilename() const { return getFile().getFilename(); }
799 StringRef getDirectory() const { return getFile().getDirectory(); }
800 DITypeRef getType() const { return DITypeRef::get(get()->getType()); }
802 GlobalVariable *getGlobal() const;
803 Constant *getConstant() const {
805 if (auto *C = dyn_cast_or_null<ConstantAsMetadata>(N->getVariable()))
806 return C->getValue();
809 DIDerivedType getStaticDataMemberDeclaration() const {
810 return DIDerivedType(get()->getStaticDataMemberDeclaration());
814 /// \brief This is a wrapper for a variable (e.g. parameter, local, global etc).
815 class DIVariable : public DIDescriptor {
816 unsigned getFlags() const { return get()->getFlags(); }
819 DIVariable() = default;
820 DIVariable(const MDLocalVariable *N) : DIDescriptor(N) {}
822 MDLocalVariable *get() const {
823 return cast_or_null<MDLocalVariable>(DIDescriptor::get());
825 operator MDLocalVariable *() const { return get(); }
826 MDLocalVariable *operator->() const { return get(); }
827 MDLocalVariable &operator*() const {
828 assert(get() && "Expected valid pointer");
832 StringRef getName() const { return get()->getName(); }
833 unsigned getLineNumber() const { return get()->getLine(); }
834 unsigned getArgNumber() const { return get()->getArg(); }
836 DIScope getContext() const { return DIScope(get()->getScope()); }
837 DIFile getFile() const { return DIFile(get()->getFile()); }
838 DITypeRef getType() const { return DITypeRef::get(get()->getType()); }
840 /// \brief Return true if this variable is marked as "artificial".
841 bool isArtificial() const {
842 return (getFlags() & FlagArtificial) != 0;
845 bool isObjectPointer() const {
846 return (getFlags() & FlagObjectPointer) != 0;
849 /// \brief If this variable is inlined then return inline location.
850 MDNode *getInlinedAt() const { return DIDescriptor(get()->getInlinedAt()); }
852 /// \brief Check if this is a "__block" variable (Apple Blocks).
853 bool isBlockByrefVariable(const DITypeIdentifierMap &Map) const {
854 return (getType().resolve(Map)).isBlockByrefStruct();
857 /// \brief Check if this is an inlined function argument.
858 bool isInlinedFnArgument(const Function *CurFn);
860 /// \brief Return the size reported by the variable's type.
861 unsigned getSizeInBits(const DITypeIdentifierMap &Map);
863 void printExtendedName(raw_ostream &OS) const;
866 /// \brief A complex location expression in postfix notation.
868 /// This is (almost) a DWARF expression that modifies the location of a
869 /// variable or (or the location of a single piece of a variable).
871 /// FIXME: Instead of DW_OP_plus taking an argument, this should use DW_OP_const
872 /// and have DW_OP_plus consume the topmost elements on the stack.
873 class DIExpression : public DIDescriptor {
875 DIExpression() = default;
876 DIExpression(const MDExpression *N) : DIDescriptor(N) {}
878 MDExpression *get() const {
879 return cast_or_null<MDExpression>(DIDescriptor::get());
881 operator MDExpression *() const { return get(); }
882 MDExpression *operator->() const { return get(); }
883 MDExpression &operator*() const {
884 assert(get() && "Expected valid pointer");
888 /// \brief Return the number of elements in the complex expression.
889 unsigned getNumElements() const { return get()->getNumElements(); }
891 /// \brief return the Idx'th complex address element.
892 uint64_t getElement(unsigned I) const { return get()->getElement(I); }
894 /// \brief Return whether this is a piece of an aggregate variable.
895 bool isBitPiece() const;
896 /// \brief Return the offset of this piece in bits.
897 uint64_t getBitPieceOffset() const;
898 /// \brief Return the size of this piece in bits.
899 uint64_t getBitPieceSize() const;
902 /// \brief A lightweight wrapper around an element of a DIExpression.
904 friend class iterator;
905 MDExpression::element_iterator I;
907 Operand(MDExpression::element_iterator I) : I(I) {}
909 /// \brief Operands such as DW_OP_piece have explicit (non-stack) arguments.
910 /// Argument 0 is the operand itself.
911 uint64_t getArg(unsigned N) const {
912 MDExpression::element_iterator In = I;
916 operator uint64_t () const { return *I; }
917 /// \brief Returns underlying MDExpression::element_iterator.
918 const MDExpression::element_iterator &getBase() const { return I; }
919 /// \brief Returns the next operand.
920 iterator getNext() const;
923 /// \brief An iterator for DIExpression elements.
924 class iterator : public std::iterator<std::input_iterator_tag, StringRef,
925 unsigned, const Operand*, Operand> {
926 friend class Operand;
927 MDExpression::element_iterator I;
931 iterator(MDExpression::element_iterator I) : I(I) {}
932 const Operand &operator*() { return Tmp = Operand(I); }
933 const Operand *operator->() { return &(Tmp = Operand(I)); }
934 iterator &operator++() {
938 iterator operator++(int) {
943 bool operator==(const iterator &X) const { return I == X.I; }
944 bool operator!=(const iterator &X) const { return !(*this == X); }
949 case dwarf::DW_OP_bit_piece: std::advance(I, 3); break;
950 case dwarf::DW_OP_plus: std::advance(I, 2); break;
951 case dwarf::DW_OP_deref: std::advance(I, 1); break;
953 llvm_unreachable("unsupported operand");
958 iterator begin() const { return get()->elements_begin(); }
959 iterator end() const { return get()->elements_end(); }
962 /// \brief This object holds location information.
964 /// This object is not associated with any DWARF tag.
965 class DILocation : public DIDescriptor {
967 DILocation() = default;
968 DILocation(const MDLocation *N) : DIDescriptor(N) {}
970 MDLocation *get() const {
971 return cast_or_null<MDLocation>(DIDescriptor::get());
973 operator MDLocation *() const { return get(); }
974 MDLocation *operator->() const { return get(); }
975 MDLocation &operator*() const {
976 assert(get() && "Expected valid pointer");
980 unsigned getLineNumber() const { return get()->getLine(); }
981 unsigned getColumnNumber() const { return get()->getColumn(); }
982 DIScope getScope() const { return DIScope(get()->getScope()); }
983 DILocation getOrigLocation() const {
984 return DILocation(get()->getInlinedAt());
986 StringRef getFilename() const { return getScope().getFilename(); }
987 StringRef getDirectory() const { return getScope().getDirectory(); }
988 bool atSameLineAs(const DILocation &Other) const {
989 return (getLineNumber() == Other.getLineNumber() &&
990 getFilename() == Other.getFilename());
992 /// \brief Get the DWAF discriminator.
994 /// DWARF discriminators are used to distinguish identical file locations for
995 /// instructions that are on different basic blocks. If two instructions are
996 /// inside the same lexical block and are in different basic blocks, we
997 /// create a new lexical block with identical location as the original but
998 /// with a different discriminator value
999 /// (lib/Transforms/Util/AddDiscriminators.cpp for details).
1000 unsigned getDiscriminator() const {
1001 // Since discriminators are associated with lexical blocks, make
1002 // sure this location is a lexical block before retrieving its
1004 if (auto *F = dyn_cast<MDLexicalBlockFile>(get()->getScope()))
1005 return F->getDiscriminator();
1009 /// \brief Generate a new discriminator value for this location.
1010 unsigned computeNewDiscriminator(LLVMContext &Ctx);
1012 /// \brief Return a copy of this location with a different scope.
1013 DILocation copyWithNewScope(LLVMContext &Ctx, DILexicalBlockFile NewScope);
1016 class DIObjCProperty : public DIDescriptor {
1018 DIObjCProperty() = default;
1019 DIObjCProperty(const MDObjCProperty *N) : DIDescriptor(N) {}
1021 MDObjCProperty *get() const {
1022 return cast_or_null<MDObjCProperty>(DIDescriptor::get());
1024 operator MDObjCProperty *() const { return get(); }
1025 MDObjCProperty *operator->() const { return get(); }
1026 MDObjCProperty &operator*() const {
1027 assert(get() && "Expected valid pointer");
1031 StringRef getObjCPropertyName() const { return get()->getName(); }
1032 DIFile getFile() const { return DIFile(get()->getFile()); }
1033 unsigned getLineNumber() const { return get()->getLine(); }
1035 StringRef getObjCPropertyGetterName() const { return get()->getGetterName(); }
1036 StringRef getObjCPropertySetterName() const { return get()->getSetterName(); }
1037 unsigned getAttributes() const { return get()->getAttributes(); }
1038 bool isReadOnlyObjCProperty() const {
1039 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_readonly) != 0;
1041 bool isReadWriteObjCProperty() const {
1042 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_readwrite) != 0;
1044 bool isAssignObjCProperty() const {
1045 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_assign) != 0;
1047 bool isRetainObjCProperty() const {
1048 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_retain) != 0;
1050 bool isCopyObjCProperty() const {
1051 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_copy) != 0;
1053 bool isNonAtomicObjCProperty() const {
1054 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_nonatomic) != 0;
1057 /// \brief Get the type.
1059 /// \note Objective-C doesn't have an ODR, so there is no benefit in storing
1060 /// the type as a DITypeRef here.
1061 DIType getType() const { return DIType(get()->getType()); }
1064 /// \brief An imported module (C++ using directive or similar).
1065 class DIImportedEntity : public DIDescriptor {
1067 DIImportedEntity() = default;
1068 DIImportedEntity(const MDImportedEntity *N) : DIDescriptor(N) {}
1070 MDImportedEntity *get() const {
1071 return cast_or_null<MDImportedEntity>(DIDescriptor::get());
1073 operator MDImportedEntity *() const { return get(); }
1074 MDImportedEntity *operator->() const { return get(); }
1075 MDImportedEntity &operator*() const {
1076 assert(get() && "Expected valid pointer");
1080 DIScope getContext() const { return DIScope(get()->getScope()); }
1081 DIDescriptorRef getEntity() const {
1082 return DIDescriptorRef::get(get()->getEntity());
1084 unsigned getLineNumber() const { return get()->getLine(); }
1085 StringRef getName() const { return get()->getName(); }
1088 #define SIMPLIFY_DESCRIPTOR(DESC) \
1089 template <> struct simplify_type<const DESC> { \
1090 typedef Metadata *SimpleType; \
1091 static SimpleType getSimplifiedValue(const DESC &DI) { return DI; } \
1093 template <> struct simplify_type<DESC> : simplify_type<const DESC> {};
1094 SIMPLIFY_DESCRIPTOR(DIDescriptor)
1095 SIMPLIFY_DESCRIPTOR(DISubrange)
1096 SIMPLIFY_DESCRIPTOR(DIEnumerator)
1097 SIMPLIFY_DESCRIPTOR(DIScope)
1098 SIMPLIFY_DESCRIPTOR(DIType)
1099 SIMPLIFY_DESCRIPTOR(DIBasicType)
1100 SIMPLIFY_DESCRIPTOR(DIDerivedType)
1101 SIMPLIFY_DESCRIPTOR(DICompositeType)
1102 SIMPLIFY_DESCRIPTOR(DISubroutineType)
1103 SIMPLIFY_DESCRIPTOR(DIFile)
1104 SIMPLIFY_DESCRIPTOR(DICompileUnit)
1105 SIMPLIFY_DESCRIPTOR(DISubprogram)
1106 SIMPLIFY_DESCRIPTOR(DILexicalBlock)
1107 SIMPLIFY_DESCRIPTOR(DILexicalBlockFile)
1108 SIMPLIFY_DESCRIPTOR(DINameSpace)
1109 SIMPLIFY_DESCRIPTOR(DITemplateTypeParameter)
1110 SIMPLIFY_DESCRIPTOR(DITemplateValueParameter)
1111 SIMPLIFY_DESCRIPTOR(DIGlobalVariable)
1112 SIMPLIFY_DESCRIPTOR(DIVariable)
1113 SIMPLIFY_DESCRIPTOR(DIExpression)
1114 SIMPLIFY_DESCRIPTOR(DILocation)
1115 SIMPLIFY_DESCRIPTOR(DIObjCProperty)
1116 SIMPLIFY_DESCRIPTOR(DIImportedEntity)
1117 #undef SIMPLIFY_DESCRIPTOR
1119 /// \brief Find subprogram that is enclosing this scope.
1120 DISubprogram getDISubprogram(const MDNode *Scope);
1122 /// \brief Find debug info for a given function.
1123 /// \returns a valid DISubprogram, if found. Otherwise, it returns an empty
1125 DISubprogram getDISubprogram(const Function *F);
1127 /// \brief Find underlying composite type.
1128 DICompositeType getDICompositeType(DIType T);
1130 /// \brief Create a new inlined variable based on current variable.
1132 /// @param DV Current Variable.
1133 /// @param InlinedScope Location at current variable is inlined.
1134 DIVariable createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
1135 LLVMContext &VMContext);
1137 /// \brief Remove inlined scope from the variable.
1138 DIVariable cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext);
1140 /// \brief Generate map by visiting all retained types.
1141 DITypeIdentifierMap generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes);
1143 /// \brief Strip debug info in the module if it exists.
1145 /// To do this, we remove all calls to the debugger intrinsics and any named
1146 /// metadata for debugging. We also remove debug locations for instructions.
1147 /// Return true if module is modified.
1148 bool StripDebugInfo(Module &M);
1149 bool stripDebugInfo(Function &F);
1151 /// \brief Return Debug Info Metadata Version by checking module flags.
1152 unsigned getDebugMetadataVersionFromModule(const Module &M);
1154 /// \brief Utility to find all debug info in a module.
1156 /// DebugInfoFinder tries to list all debug info MDNodes used in a module. To
1157 /// list debug info MDNodes used by an instruction, DebugInfoFinder uses
1158 /// processDeclare, processValue and processLocation to handle DbgDeclareInst,
1159 /// DbgValueInst and DbgLoc attached to instructions. processModule will go
1160 /// through all DICompileUnits in llvm.dbg.cu and list debug info MDNodes
1161 /// used by the CUs.
1162 class DebugInfoFinder {
1164 DebugInfoFinder() : TypeMapInitialized(false) {}
1166 /// \brief Process entire module and collect debug info anchors.
1167 void processModule(const Module &M);
1169 /// \brief Process DbgDeclareInst.
1170 void processDeclare(const Module &M, const DbgDeclareInst *DDI);
1171 /// \brief Process DbgValueInst.
1172 void processValue(const Module &M, const DbgValueInst *DVI);
1173 /// \brief Process DILocation.
1174 void processLocation(const Module &M, DILocation Loc);
1176 /// \brief Clear all lists.
1180 void InitializeTypeMap(const Module &M);
1182 void processType(DIType DT);
1183 void processSubprogram(DISubprogram SP);
1184 void processScope(DIScope Scope);
1185 bool addCompileUnit(DICompileUnit CU);
1186 bool addGlobalVariable(DIGlobalVariable DIG);
1187 bool addSubprogram(DISubprogram SP);
1188 bool addType(DIType DT);
1189 bool addScope(DIScope Scope);
1192 typedef SmallVectorImpl<DICompileUnit>::const_iterator compile_unit_iterator;
1193 typedef SmallVectorImpl<DISubprogram>::const_iterator subprogram_iterator;
1194 typedef SmallVectorImpl<DIGlobalVariable>::const_iterator
1195 global_variable_iterator;
1196 typedef SmallVectorImpl<DIType>::const_iterator type_iterator;
1197 typedef SmallVectorImpl<DIScope>::const_iterator scope_iterator;
1199 iterator_range<compile_unit_iterator> compile_units() const {
1200 return iterator_range<compile_unit_iterator>(CUs.begin(), CUs.end());
1203 iterator_range<subprogram_iterator> subprograms() const {
1204 return iterator_range<subprogram_iterator>(SPs.begin(), SPs.end());
1207 iterator_range<global_variable_iterator> global_variables() const {
1208 return iterator_range<global_variable_iterator>(GVs.begin(), GVs.end());
1211 iterator_range<type_iterator> types() const {
1212 return iterator_range<type_iterator>(TYs.begin(), TYs.end());
1215 iterator_range<scope_iterator> scopes() const {
1216 return iterator_range<scope_iterator>(Scopes.begin(), Scopes.end());
1219 unsigned compile_unit_count() const { return CUs.size(); }
1220 unsigned global_variable_count() const { return GVs.size(); }
1221 unsigned subprogram_count() const { return SPs.size(); }
1222 unsigned type_count() const { return TYs.size(); }
1223 unsigned scope_count() const { return Scopes.size(); }
1226 SmallVector<DICompileUnit, 8> CUs;
1227 SmallVector<DISubprogram, 8> SPs;
1228 SmallVector<DIGlobalVariable, 8> GVs;
1229 SmallVector<DIType, 8> TYs;
1230 SmallVector<DIScope, 8> Scopes;
1231 SmallPtrSet<MDNode *, 64> NodesSeen;
1232 DITypeIdentifierMap TypeIdentifierMap;
1234 /// \brief Specify if TypeIdentifierMap is initialized.
1235 bool TypeMapInitialized;
1238 DenseMap<const Function *, DISubprogram> makeSubprogramMap(const Module &M);
1240 } // end namespace llvm