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.
67 /// \brief Duplicated debug info flags.
69 /// \see DebugNode::DIFlags.
71 #define HANDLE_DI_FLAG(ID, NAME) Flag##NAME = DebugNode::Flag##NAME,
72 #include "llvm/IR/DebugInfoFlags.def"
73 FlagAccessibility = DebugNode::FlagAccessibility
77 const MDNode *DbgNode;
80 explicit DIDescriptor(const MDNode *N = nullptr) : DbgNode(N) {}
81 DIDescriptor(const DebugNode *N) : DbgNode(N) {}
83 MDNode *get() const { return const_cast<MDNode *>(DbgNode); }
84 operator MDNode *() const { return get(); }
85 MDNode *operator->() const { return get(); }
86 MDNode &operator*() const {
87 assert(get() && "Expected valid pointer");
91 // An explicit operator bool so that we can do testing of DI values
93 // FIXME: This operator bool isn't actually protecting anything at the
94 // moment due to the conversion operator above making DIDescriptor nodes
95 // implicitly convertable to bool.
96 explicit operator bool() const { return DbgNode != nullptr; }
98 bool operator==(DIDescriptor Other) const { return DbgNode == Other.DbgNode; }
99 bool operator!=(DIDescriptor Other) const { return !operator==(Other); }
101 uint16_t getTag() const {
102 if (auto *N = dyn_cast_or_null<DebugNode>(get()))
107 void print(raw_ostream &OS) const;
111 #define DECLARE_SIMPLIFY_DESCRIPTOR(DESC) \
113 template <> struct simplify_type<const DESC>; \
114 template <> struct simplify_type<DESC>;
115 DECLARE_SIMPLIFY_DESCRIPTOR(DIDescriptor)
116 DECLARE_SIMPLIFY_DESCRIPTOR(DISubrange)
117 DECLARE_SIMPLIFY_DESCRIPTOR(DIEnumerator)
118 DECLARE_SIMPLIFY_DESCRIPTOR(DIScope)
119 DECLARE_SIMPLIFY_DESCRIPTOR(DIType)
120 DECLARE_SIMPLIFY_DESCRIPTOR(DIBasicType)
121 DECLARE_SIMPLIFY_DESCRIPTOR(DIDerivedType)
122 DECLARE_SIMPLIFY_DESCRIPTOR(DICompositeType)
123 DECLARE_SIMPLIFY_DESCRIPTOR(DISubroutineType)
124 DECLARE_SIMPLIFY_DESCRIPTOR(DIFile)
125 DECLARE_SIMPLIFY_DESCRIPTOR(DICompileUnit)
126 DECLARE_SIMPLIFY_DESCRIPTOR(DISubprogram)
127 DECLARE_SIMPLIFY_DESCRIPTOR(DILexicalBlock)
128 DECLARE_SIMPLIFY_DESCRIPTOR(DILexicalBlockFile)
129 DECLARE_SIMPLIFY_DESCRIPTOR(DINameSpace)
130 DECLARE_SIMPLIFY_DESCRIPTOR(DITemplateTypeParameter)
131 DECLARE_SIMPLIFY_DESCRIPTOR(DITemplateValueParameter)
132 DECLARE_SIMPLIFY_DESCRIPTOR(DIGlobalVariable)
133 DECLARE_SIMPLIFY_DESCRIPTOR(DIVariable)
134 DECLARE_SIMPLIFY_DESCRIPTOR(DIExpression)
135 DECLARE_SIMPLIFY_DESCRIPTOR(DILocation)
136 DECLARE_SIMPLIFY_DESCRIPTOR(DIObjCProperty)
137 DECLARE_SIMPLIFY_DESCRIPTOR(DIImportedEntity)
138 #undef DECLARE_SIMPLIFY_DESCRIPTOR
140 typedef DebugNodeArray DIArray;
141 typedef MDTypeRefArray DITypeArray;
143 /// \brief This is used to represent ranges, for array bounds.
144 class DISubrange : public DIDescriptor {
146 DISubrange() = default;
147 DISubrange(const MDSubrange *N) : DIDescriptor(N) {}
149 MDSubrange *get() const {
150 return cast_or_null<MDSubrange>(DIDescriptor::get());
152 operator MDSubrange *() const { return get(); }
153 MDSubrange *operator->() const { return get(); }
154 MDSubrange &operator*() const {
155 assert(get() && "Expected valid pointer");
159 int64_t getLo() const { return get()->getLowerBound(); }
160 int64_t getCount() const { return get()->getCount(); }
163 /// \brief A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
165 /// FIXME: it seems strange that this doesn't have either a reference to the
166 /// type/precision or a file/line pair for location info.
167 class DIEnumerator : public DIDescriptor {
169 DIEnumerator() = default;
170 DIEnumerator(const MDEnumerator *N) : DIDescriptor(N) {}
172 MDEnumerator *get() const {
173 return cast_or_null<MDEnumerator>(DIDescriptor::get());
175 operator MDEnumerator *() const { return get(); }
176 MDEnumerator *operator->() const { return get(); }
177 MDEnumerator &operator*() const {
178 assert(get() && "Expected valid pointer");
182 StringRef getName() const { return get()->getName(); }
183 int64_t getEnumValue() const { return get()->getValue(); }
186 template <typename T> class DIRef;
187 typedef DIRef<DIDescriptor> DIDescriptorRef;
188 typedef DIRef<DIScope> DIScopeRef;
189 typedef DIRef<DIType> DITypeRef;
191 /// \brief A base class for various scopes.
193 /// Although, implementation-wise, DIScope is the parent class of most
194 /// other DIxxx classes, including DIType and its descendants, most of
195 /// DIScope's descendants are not a substitutable subtype of
196 /// DIScope. The DIDescriptor::isScope() method only is true for
197 /// DIScopes that are scopes in the strict lexical scope sense
198 /// (DICompileUnit, DISubprogram, etc.), but not for, e.g., a DIType.
199 class DIScope : public DIDescriptor {
202 DIScope(const MDScope *N) : DIDescriptor(N) {}
204 MDScope *get() const { return cast_or_null<MDScope>(DIDescriptor::get()); }
205 operator MDScope *() const { return get(); }
206 MDScope *operator->() const { return get(); }
207 MDScope &operator*() const {
208 assert(get() && "Expected valid pointer");
212 inline DIScopeRef getContext() const;
213 StringRef getName() const { return get()->getName(); }
214 StringRef getFilename() const { return get()->getFilename(); }
215 StringRef getDirectory() const { return get()->getDirectory(); }
217 /// \brief Generate a reference to this DIScope.
219 /// Uses the type identifier instead of the actual MDNode if possible, to
220 /// help type uniquing.
221 DIScopeRef getRef() const;
224 /// \brief Represents reference to a DIDescriptor.
226 /// Abstracts over direct and identifier-based metadata references.
227 template <typename T> class DIRef {
228 /// \brief Val can be either a MDNode or a MDString.
230 /// In the latter, MDString specifies the type identifier.
235 DIRef(const TypedDebugNodeRef<U> &Ref,
236 typename std::enable_if<std::is_convertible<U *, T>::value>::type * =
240 T resolve(const DITypeIdentifierMap &Map) const;
241 operator Metadata *() const { return const_cast<Metadata *>(Val); }
245 DIDescriptor DIRef<DIDescriptor>::resolve(const DITypeIdentifierMap &Map) const;
247 DIScope DIRef<DIScope>::resolve(const DITypeIdentifierMap &Map) const;
248 template <> DIType DIRef<DIType>::resolve(const DITypeIdentifierMap &Map) const;
250 DIScopeRef DIScope::getContext() const { return get()->getScope(); }
252 /// \brief This is a wrapper for a type.
254 /// FIXME: Types should be factored much better so that CV qualifiers and
255 /// others do not require a huge and empty descriptor full of zeros.
256 class DIType : public DIScope {
259 DIType(const MDType *N) : DIScope(N) {}
261 MDType *get() const { return cast_or_null<MDType>(DIDescriptor::get()); }
262 operator MDType *() const { return get(); }
263 MDType *operator->() const { return get(); }
264 MDType &operator*() const {
265 assert(get() && "Expected valid pointer");
269 DIScopeRef getContext() const { return get()->getScope(); }
270 StringRef getName() const { return get()->getName(); }
271 unsigned getLineNumber() const { return get()->getLine(); }
272 uint64_t getSizeInBits() const { return get()->getSizeInBits(); }
273 uint64_t getAlignInBits() const { return get()->getAlignInBits(); }
274 // FIXME: Offset is only used for DW_TAG_member nodes. Making every type
275 // carry this is just plain insane.
276 uint64_t getOffsetInBits() const { return get()->getOffsetInBits(); }
277 unsigned getFlags() const { return get()->getFlags(); }
279 bool isPrivate() const { return get()->isPrivate(); }
280 bool isProtected() const { return get()->isProtected(); }
281 bool isPublic() const { return get()->isPublic(); }
282 bool isForwardDecl() const { return get()->isForwardDecl(); }
283 bool isAppleBlockExtension() const { return get()->isAppleBlockExtension(); }
284 bool isBlockByrefStruct() const { return get()->isBlockByrefStruct(); }
285 bool isVirtual() const { return get()->isVirtual(); }
286 bool isArtificial() const { return get()->isArtificial(); }
287 bool isObjectPointer() const { return get()->isObjectPointer(); }
288 bool isObjcClassComplete() const { return get()->isObjcClassComplete(); }
289 bool isVector() const { return get()->isVector(); }
290 bool isStaticMember() const { return get()->isStaticMember(); }
291 bool isLValueReference() const { return get()->isLValueReference(); }
292 bool isRValueReference() const { return get()->isRValueReference(); }
294 bool isValid() const { return DbgNode && isa<MDType>(*this); }
297 /// \brief A basic type, like 'int' or 'float'.
298 class DIBasicType : public DIType {
300 DIBasicType() = default;
301 DIBasicType(const MDBasicType *N) : DIType(N) {}
303 MDBasicType *get() const {
304 return cast_or_null<MDBasicType>(DIDescriptor::get());
306 operator MDBasicType *() const { return get(); }
307 MDBasicType *operator->() const { return get(); }
308 MDBasicType &operator*() const {
309 assert(get() && "Expected valid pointer");
313 unsigned getEncoding() const { return get()->getEncoding(); }
316 /// \brief A simple derived type
318 /// Like a const qualified type, a typedef, a pointer or reference, et cetera.
319 /// Or, a data member of a class/struct/union.
320 class DIDerivedType : public DIType {
322 DIDerivedType() = default;
323 DIDerivedType(const MDDerivedTypeBase *N) : DIType(N) {}
325 MDDerivedTypeBase *get() const {
326 return cast_or_null<MDDerivedTypeBase>(DIDescriptor::get());
328 operator MDDerivedTypeBase *() const { return get(); }
329 MDDerivedTypeBase *operator->() const { return get(); }
330 MDDerivedTypeBase &operator*() const {
331 assert(get() && "Expected valid pointer");
335 DITypeRef getTypeDerivedFrom() const { return get()->getBaseType(); }
337 /// \brief Return property node, if this ivar is associated with one.
338 MDNode *getObjCProperty() const {
339 if (auto *N = dyn_cast<MDDerivedType>(get()))
340 return dyn_cast_or_null<MDNode>(N->getExtraData());
344 DITypeRef getClassType() const {
345 assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
346 if (auto *N = dyn_cast<MDDerivedType>(get()))
347 return MDTypeRef(N->getExtraData());
351 Constant *getConstant() const {
352 assert((getTag() == dwarf::DW_TAG_member) && isStaticMember());
353 if (auto *N = dyn_cast<MDDerivedType>(get()))
354 if (auto *C = dyn_cast_or_null<ConstantAsMetadata>(N->getExtraData()))
355 return C->getValue();
361 /// \brief Types that refer to multiple other types.
363 /// This descriptor holds a type that can refer to multiple other types, like a
364 /// function or struct.
366 /// DICompositeType is derived from DIDerivedType because some
367 /// composite types (such as enums) can be derived from basic types
368 // FIXME: Make this derive from DIType directly & just store the
369 // base type in a single DIType field.
370 class DICompositeType : public DIDerivedType {
371 friend class DIBuilder;
374 DICompositeType() = default;
375 DICompositeType(const MDCompositeTypeBase *N) : DIDerivedType(N) {}
377 MDCompositeTypeBase *get() const {
378 return cast_or_null<MDCompositeTypeBase>(DIDescriptor::get());
380 operator MDCompositeTypeBase *() const { return get(); }
381 MDCompositeTypeBase *operator->() const { return get(); }
382 MDCompositeTypeBase &operator*() const {
383 assert(get() && "Expected valid pointer");
387 DIArray getElements() const {
388 assert(!isa<MDSubroutineType>(*this) && "no elements for DISubroutineType");
389 return DIArray(get()->getElements());
392 unsigned getRunTimeLang() const { return get()->getRuntimeLang(); }
393 DITypeRef getContainingType() const { return get()->getVTableHolder(); }
395 DIArray getTemplateParams() const { return get()->getTemplateParams(); }
396 MDString *getIdentifier() const { return get()->getRawIdentifier(); }
399 class DISubroutineType : public DICompositeType {
401 DISubroutineType() = default;
402 DISubroutineType(const MDSubroutineType *N) : DICompositeType(N) {}
404 MDSubroutineType *get() const {
405 return cast_or_null<MDSubroutineType>(DIDescriptor::get());
407 operator MDSubroutineType *() const { return get(); }
408 MDSubroutineType *operator->() const { return get(); }
409 MDSubroutineType &operator*() const {
410 assert(get() && "Expected valid pointer");
414 MDTypeRefArray getTypeArray() const { return get()->getTypeArray(); }
417 /// \brief This is a wrapper for a file.
418 class DIFile : public DIScope {
421 DIFile(const MDFile *N) : DIScope(N) {}
423 MDFile *get() const { return cast_or_null<MDFile>(DIDescriptor::get()); }
424 operator MDFile *() const { return get(); }
425 MDFile *operator->() const { return get(); }
426 MDFile &operator*() const {
427 assert(get() && "Expected valid pointer");
431 /// \brief Retrieve the MDNode for the directory/file pair.
432 MDNode *getFileNode() const { return get(); }
435 /// \brief A wrapper for a compile unit.
436 class DICompileUnit : public DIScope {
438 DICompileUnit() = default;
439 DICompileUnit(const MDCompileUnit *N) : DIScope(N) {}
441 MDCompileUnit *get() const {
442 return cast_or_null<MDCompileUnit>(DIDescriptor::get());
444 operator MDCompileUnit *() const { return get(); }
445 MDCompileUnit *operator->() const { return get(); }
446 MDCompileUnit &operator*() const {
447 assert(get() && "Expected valid pointer");
451 dwarf::SourceLanguage getLanguage() const {
452 return static_cast<dwarf::SourceLanguage>(get()->getSourceLanguage());
454 StringRef getProducer() const { return get()->getProducer(); }
455 bool isOptimized() const { return get()->isOptimized(); }
456 StringRef getFlags() const { return get()->getFlags(); }
457 unsigned getRunTimeVersion() const { return get()->getRuntimeVersion(); }
459 DIArray getEnumTypes() const { return DIArray(get()->getEnumTypes()); }
460 DIArray getRetainedTypes() const {
461 return DIArray(get()->getRetainedTypes());
463 DIArray getSubprograms() const { return DIArray(get()->getSubprograms()); }
464 DIArray getGlobalVariables() const {
465 return DIArray(get()->getGlobalVariables());
467 DIArray getImportedEntities() const {
468 return DIArray(get()->getImportedEntities());
471 void replaceSubprograms(DIArray Subprograms);
472 void replaceGlobalVariables(DIArray GlobalVariables);
474 StringRef getSplitDebugFilename() const {
475 return get()->getSplitDebugFilename();
477 unsigned getEmissionKind() const { return get()->getEmissionKind(); }
480 /// \brief This is a wrapper for a subprogram (e.g. a function).
481 class DISubprogram : public DIScope {
483 DISubprogram() = default;
484 DISubprogram(const MDSubprogram *N) : DIScope(N) {}
486 MDSubprogram *get() const {
487 return cast_or_null<MDSubprogram>(DIDescriptor::get());
489 operator MDSubprogram *() const { return get(); }
490 MDSubprogram *operator->() const { return get(); }
491 MDSubprogram &operator*() const {
492 assert(get() && "Expected valid pointer");
496 StringRef getName() const { return get()->getName(); }
497 StringRef getDisplayName() const { return get()->getDisplayName(); }
498 StringRef getLinkageName() const { return get()->getLinkageName(); }
499 unsigned getLineNumber() const { return get()->getLine(); }
501 /// \brief Check if this is local (like 'static' in C).
502 unsigned isLocalToUnit() const { return get()->isLocalToUnit(); }
503 unsigned isDefinition() const { return get()->isDefinition(); }
505 unsigned getVirtuality() const { return get()->getVirtuality(); }
506 unsigned getVirtualIndex() const { return get()->getVirtualIndex(); }
508 unsigned getFlags() const { return get()->getFlags(); }
510 unsigned isOptimized() const { return get()->isOptimized(); }
512 /// \brief Get the beginning of the scope of the function (not the name).
513 unsigned getScopeLineNumber() const { return get()->getScopeLine(); }
515 DIScopeRef getContext() const { return get()->getScope(); }
516 DISubroutineType getType() const {
517 return DISubroutineType(get()->getType());
520 DITypeRef getContainingType() const { return get()->getContainingType(); }
522 /// \brief Check if this provides debugging information for the function F.
523 bool describes(const Function *F) const { return get()->describes(F); }
525 Function *getFunction() const { return get()->getFunction(); }
527 void replaceFunction(Function *F) {
529 N->replaceFunction(F);
531 DIArray getTemplateParams() const {
532 return DIArray(get()->getTemplateParams());
534 DISubprogram getFunctionDeclaration() const {
535 return DISubprogram(get()->getDeclaration());
537 DIArray getVariables() const { return DIArray(get()->getVariables()); }
539 unsigned isArtificial() const { return get()->isArtificial(); }
540 bool isPrivate() const { return get()->isPrivate(); }
541 bool isProtected() const { return get()->isProtected(); }
542 bool isPublic() const { return get()->isPublic(); }
543 bool isExplicit() const { return get()->isExplicit(); }
544 bool isPrototyped() const { return get()->isPrototyped(); }
545 unsigned isLValueReference() const { return get()->isLValueReference(); }
546 unsigned isRValueReference() const { return get()->isRValueReference(); }
549 /// \brief This is a wrapper for a lexical block.
550 class DILexicalBlock : public DIScope {
552 DILexicalBlock() = default;
553 DILexicalBlock(const MDLexicalBlockBase *N) : DIScope(N) {}
555 MDLexicalBlockBase *get() const {
556 return cast_or_null<MDLexicalBlockBase>(DIDescriptor::get());
558 operator MDLexicalBlockBase *() const { return get(); }
559 MDLexicalBlockBase *operator->() const { return get(); }
560 MDLexicalBlockBase &operator*() const {
561 assert(get() && "Expected valid pointer");
565 DIScope getContext() const { return DIScope(get()->getScope()); }
566 unsigned getLineNumber() const {
567 if (auto *N = dyn_cast<MDLexicalBlock>(get()))
571 unsigned getColumnNumber() const {
572 if (auto *N = dyn_cast<MDLexicalBlock>(get()))
573 return N->getColumn();
578 /// \brief This is a wrapper for a lexical block with a filename change.
579 class DILexicalBlockFile : public DIScope {
581 DILexicalBlockFile() = default;
582 DILexicalBlockFile(const MDLexicalBlockFile *N) : DIScope(N) {}
584 MDLexicalBlockFile *get() const {
585 return cast_or_null<MDLexicalBlockFile>(DIDescriptor::get());
587 operator MDLexicalBlockFile *() const { return get(); }
588 MDLexicalBlockFile *operator->() const { return get(); }
589 MDLexicalBlockFile &operator*() const {
590 assert(get() && "Expected valid pointer");
594 DIScope getContext() const { return get()->getScope(); }
595 unsigned getDiscriminator() const { return get()->getDiscriminator(); }
598 /// \brief A wrapper for a C++ style name space.
599 class DINameSpace : public DIScope {
601 DINameSpace() = default;
602 DINameSpace(const MDNamespace *N) : DIScope(N) {}
604 MDNamespace *get() const {
605 return cast_or_null<MDNamespace>(DIDescriptor::get());
607 operator MDNamespace *() const { return get(); }
608 MDNamespace *operator->() const { return get(); }
609 MDNamespace &operator*() const {
610 assert(get() && "Expected valid pointer");
614 StringRef getName() const { return get()->getName(); }
615 unsigned getLineNumber() const { return get()->getLine(); }
616 DIScope getContext() const { return DIScope(get()->getScope()); }
619 /// \brief This is a wrapper for template type parameter.
620 class DITemplateTypeParameter : public DIDescriptor {
622 DITemplateTypeParameter() = default;
623 DITemplateTypeParameter(const MDTemplateTypeParameter *N) : DIDescriptor(N) {}
625 MDTemplateTypeParameter *get() const {
626 return cast_or_null<MDTemplateTypeParameter>(DIDescriptor::get());
628 operator MDTemplateTypeParameter *() const { return get(); }
629 MDTemplateTypeParameter *operator->() const { return get(); }
630 MDTemplateTypeParameter &operator*() const {
631 assert(get() && "Expected valid pointer");
635 StringRef getName() const { return get()->getName(); }
636 DITypeRef getType() const { return get()->getType(); }
639 /// \brief This is a wrapper for template value parameter.
640 class DITemplateValueParameter : public DIDescriptor {
642 DITemplateValueParameter() = default;
643 DITemplateValueParameter(const MDTemplateValueParameter *N)
646 MDTemplateValueParameter *get() const {
647 return cast_or_null<MDTemplateValueParameter>(DIDescriptor::get());
649 operator MDTemplateValueParameter *() const { return get(); }
650 MDTemplateValueParameter *operator->() const { return get(); }
651 MDTemplateValueParameter &operator*() const {
652 assert(get() && "Expected valid pointer");
656 StringRef getName() const { return get()->getName(); }
657 DITypeRef getType() const { return get()->getType(); }
658 Metadata *getValue() const { return get()->getValue(); }
661 /// \brief This is a wrapper for a global variable.
662 class DIGlobalVariable : public DIDescriptor {
663 DIFile getFile() const { return DIFile(get()->getFile()); }
666 DIGlobalVariable() = default;
667 DIGlobalVariable(const MDGlobalVariable *N) : DIDescriptor(N) {}
669 MDGlobalVariable *get() const {
670 return cast_or_null<MDGlobalVariable>(DIDescriptor::get());
672 operator MDGlobalVariable *() const { return get(); }
673 MDGlobalVariable *operator->() const { return get(); }
674 MDGlobalVariable &operator*() const {
675 assert(get() && "Expected valid pointer");
679 StringRef getName() const { return get()->getName(); }
680 StringRef getDisplayName() const { return get()->getDisplayName(); }
681 StringRef getLinkageName() const { return get()->getLinkageName(); }
682 unsigned getLineNumber() const { return get()->getLine(); }
683 unsigned isLocalToUnit() const { return get()->isLocalToUnit(); }
684 unsigned isDefinition() const { return get()->isDefinition(); }
686 DIScope getContext() const { return DIScope(get()->getScope()); }
687 StringRef getFilename() const { return get()->getFilename(); }
688 StringRef getDirectory() const { return get()->getDirectory(); }
689 DITypeRef getType() const { return get()->getType(); }
691 GlobalVariable *getGlobal() const;
692 Constant *getConstant() const { return get()->getVariable(); }
693 DIDerivedType getStaticDataMemberDeclaration() const {
694 return DIDerivedType(get()->getStaticDataMemberDeclaration());
698 /// \brief This is a wrapper for a variable (e.g. parameter, local, global etc).
699 class DIVariable : public DIDescriptor {
700 unsigned getFlags() const { return get()->getFlags(); }
703 DIVariable() = default;
704 DIVariable(const MDLocalVariable *N) : DIDescriptor(N) {}
706 MDLocalVariable *get() const {
707 return cast_or_null<MDLocalVariable>(DIDescriptor::get());
709 operator MDLocalVariable *() const { return get(); }
710 MDLocalVariable *operator->() const { return get(); }
711 MDLocalVariable &operator*() const {
712 assert(get() && "Expected valid pointer");
716 StringRef getName() const { return get()->getName(); }
717 unsigned getLineNumber() const { return get()->getLine(); }
718 unsigned getArgNumber() const { return get()->getArg(); }
720 DIScope getContext() const { return DIScope(get()->getScope()); }
721 DIFile getFile() const { return DIFile(get()->getFile()); }
722 DITypeRef getType() const { return get()->getType(); }
724 bool isArtificial() const { return get()->isArtificial(); }
725 bool isObjectPointer() const { return get()->isObjectPointer(); }
727 /// \brief If this variable is inlined then return inline location.
728 MDNode *getInlinedAt() const { return DIDescriptor(get()->getInlinedAt()); }
730 /// \brief Check if this is a "__block" variable (Apple Blocks).
731 bool isBlockByrefVariable(const DITypeIdentifierMap &Map) const {
732 return (getType().resolve(Map)).isBlockByrefStruct();
735 /// \brief Check if this is an inlined function argument.
736 bool isInlinedFnArgument(const Function *CurFn);
738 void printExtendedName(raw_ostream &OS) const;
741 /// \brief A complex location expression in postfix notation.
743 /// This is (almost) a DWARF expression that modifies the location of a
744 /// variable or (or the location of a single piece of a variable).
746 /// FIXME: Instead of DW_OP_plus taking an argument, this should use DW_OP_const
747 /// and have DW_OP_plus consume the topmost elements on the stack.
748 class DIExpression : public DIDescriptor {
750 DIExpression() = default;
751 DIExpression(const MDExpression *N) : DIDescriptor(N) {}
753 MDExpression *get() const {
754 return cast_or_null<MDExpression>(DIDescriptor::get());
756 operator MDExpression *() const { return get(); }
757 MDExpression *operator->() const { return get(); }
758 MDExpression &operator*() const {
759 assert(get() && "Expected valid pointer");
763 unsigned getNumElements() const { return get()->getNumElements(); }
764 uint64_t getElement(unsigned I) const { return get()->getElement(I); }
765 bool isBitPiece() const { return get()->isBitPiece(); }
766 uint64_t getBitPieceOffset() const { return get()->getBitPieceOffset(); }
767 uint64_t getBitPieceSize() const { return get()->getBitPieceSize(); }
770 /// \brief This object holds location information.
772 /// This object is not associated with any DWARF tag.
773 class DILocation : public DIDescriptor {
775 DILocation() = default;
776 DILocation(const MDLocation *N) : DIDescriptor(N) {}
778 MDLocation *get() const {
779 return cast_or_null<MDLocation>(DIDescriptor::get());
781 operator MDLocation *() const { return get(); }
782 MDLocation *operator->() const { return get(); }
783 MDLocation &operator*() const {
784 assert(get() && "Expected valid pointer");
788 unsigned getLineNumber() const { return get()->getLine(); }
789 unsigned getColumnNumber() const { return get()->getColumn(); }
790 DIScope getScope() const { return DIScope(get()->getScope()); }
791 DILocation getOrigLocation() const {
792 return DILocation(get()->getInlinedAt());
794 StringRef getFilename() const { return get()->getFilename(); }
795 StringRef getDirectory() const { return get()->getDirectory(); }
797 /// \brief Get the DWAF discriminator.
799 /// DWARF discriminators are used to distinguish identical file locations for
800 /// instructions that are on different basic blocks. If two instructions are
801 /// inside the same lexical block and are in different basic blocks, we
802 /// create a new lexical block with identical location as the original but
803 /// with a different discriminator value
804 /// (lib/Transforms/Util/AddDiscriminators.cpp for details).
805 unsigned getDiscriminator() const {
806 // Since discriminators are associated with lexical blocks, make
807 // sure this location is a lexical block before retrieving its
809 if (auto *F = dyn_cast<MDLexicalBlockFile>(get()->getScope()))
810 return F->getDiscriminator();
814 /// \brief Generate a new discriminator value for this location.
815 unsigned computeNewDiscriminator(LLVMContext &Ctx);
817 /// \brief Return a copy of this location with a different scope.
818 DILocation copyWithNewScope(LLVMContext &Ctx, DILexicalBlockFile NewScope);
821 class DIObjCProperty : public DIDescriptor {
823 DIObjCProperty() = default;
824 DIObjCProperty(const MDObjCProperty *N) : DIDescriptor(N) {}
826 MDObjCProperty *get() const {
827 return cast_or_null<MDObjCProperty>(DIDescriptor::get());
829 operator MDObjCProperty *() const { return get(); }
830 MDObjCProperty *operator->() const { return get(); }
831 MDObjCProperty &operator*() const {
832 assert(get() && "Expected valid pointer");
836 StringRef getObjCPropertyName() const { return get()->getName(); }
837 DIFile getFile() const { return DIFile(get()->getFile()); }
838 unsigned getLineNumber() const { return get()->getLine(); }
840 StringRef getObjCPropertyGetterName() const { return get()->getGetterName(); }
841 StringRef getObjCPropertySetterName() const { return get()->getSetterName(); }
842 unsigned getAttributes() const { return get()->getAttributes(); }
843 bool isReadOnlyObjCProperty() const {
844 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_readonly) != 0;
846 bool isReadWriteObjCProperty() const {
847 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_readwrite) != 0;
849 bool isAssignObjCProperty() const {
850 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_assign) != 0;
852 bool isRetainObjCProperty() const {
853 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_retain) != 0;
855 bool isCopyObjCProperty() const {
856 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_copy) != 0;
858 bool isNonAtomicObjCProperty() const {
859 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_nonatomic) != 0;
862 /// \brief Get the type.
864 /// \note Objective-C doesn't have an ODR, so there is no benefit in storing
865 /// the type as a DITypeRef here.
866 DIType getType() const { return DIType(get()->getType()); }
869 /// \brief An imported module (C++ using directive or similar).
870 class DIImportedEntity : public DIDescriptor {
872 DIImportedEntity() = default;
873 DIImportedEntity(const MDImportedEntity *N) : DIDescriptor(N) {}
875 MDImportedEntity *get() const {
876 return cast_or_null<MDImportedEntity>(DIDescriptor::get());
878 operator MDImportedEntity *() const { return get(); }
879 MDImportedEntity *operator->() const { return get(); }
880 MDImportedEntity &operator*() const {
881 assert(get() && "Expected valid pointer");
885 DIScope getContext() const { return DIScope(get()->getScope()); }
886 DIDescriptorRef getEntity() const { return get()->getEntity(); }
887 unsigned getLineNumber() const { return get()->getLine(); }
888 StringRef getName() const { return get()->getName(); }
891 #define SIMPLIFY_DESCRIPTOR(DESC) \
892 template <> struct simplify_type<const DESC> { \
893 typedef Metadata *SimpleType; \
894 static SimpleType getSimplifiedValue(const DESC &DI) { return DI; } \
896 template <> struct simplify_type<DESC> : simplify_type<const DESC> {};
897 SIMPLIFY_DESCRIPTOR(DIDescriptor)
898 SIMPLIFY_DESCRIPTOR(DISubrange)
899 SIMPLIFY_DESCRIPTOR(DIEnumerator)
900 SIMPLIFY_DESCRIPTOR(DIScope)
901 SIMPLIFY_DESCRIPTOR(DIType)
902 SIMPLIFY_DESCRIPTOR(DIBasicType)
903 SIMPLIFY_DESCRIPTOR(DIDerivedType)
904 SIMPLIFY_DESCRIPTOR(DICompositeType)
905 SIMPLIFY_DESCRIPTOR(DISubroutineType)
906 SIMPLIFY_DESCRIPTOR(DIFile)
907 SIMPLIFY_DESCRIPTOR(DICompileUnit)
908 SIMPLIFY_DESCRIPTOR(DISubprogram)
909 SIMPLIFY_DESCRIPTOR(DILexicalBlock)
910 SIMPLIFY_DESCRIPTOR(DILexicalBlockFile)
911 SIMPLIFY_DESCRIPTOR(DINameSpace)
912 SIMPLIFY_DESCRIPTOR(DITemplateTypeParameter)
913 SIMPLIFY_DESCRIPTOR(DITemplateValueParameter)
914 SIMPLIFY_DESCRIPTOR(DIGlobalVariable)
915 SIMPLIFY_DESCRIPTOR(DIVariable)
916 SIMPLIFY_DESCRIPTOR(DIExpression)
917 SIMPLIFY_DESCRIPTOR(DILocation)
918 SIMPLIFY_DESCRIPTOR(DIObjCProperty)
919 SIMPLIFY_DESCRIPTOR(DIImportedEntity)
920 #undef SIMPLIFY_DESCRIPTOR
922 /// \brief Find subprogram that is enclosing this scope.
923 DISubprogram getDISubprogram(const MDNode *Scope);
925 /// \brief Find debug info for a given function.
926 /// \returns a valid DISubprogram, if found. Otherwise, it returns an empty
928 DISubprogram getDISubprogram(const Function *F);
930 /// \brief Find underlying composite type.
931 DICompositeType getDICompositeType(DIType T);
933 /// \brief Create a new inlined variable based on current variable.
935 /// @param DV Current Variable.
936 /// @param InlinedScope Location at current variable is inlined.
937 DIVariable createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
938 LLVMContext &VMContext);
940 /// \brief Remove inlined scope from the variable.
941 DIVariable cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext);
943 /// \brief Generate map by visiting all retained types.
944 DITypeIdentifierMap generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes);
946 /// \brief Strip debug info in the module if it exists.
948 /// To do this, we remove all calls to the debugger intrinsics and any named
949 /// metadata for debugging. We also remove debug locations for instructions.
950 /// Return true if module is modified.
951 bool StripDebugInfo(Module &M);
952 bool stripDebugInfo(Function &F);
954 /// \brief Return Debug Info Metadata Version by checking module flags.
955 unsigned getDebugMetadataVersionFromModule(const Module &M);
957 /// \brief Utility to find all debug info in a module.
959 /// DebugInfoFinder tries to list all debug info MDNodes used in a module. To
960 /// list debug info MDNodes used by an instruction, DebugInfoFinder uses
961 /// processDeclare, processValue and processLocation to handle DbgDeclareInst,
962 /// DbgValueInst and DbgLoc attached to instructions. processModule will go
963 /// through all DICompileUnits in llvm.dbg.cu and list debug info MDNodes
965 class DebugInfoFinder {
967 DebugInfoFinder() : TypeMapInitialized(false) {}
969 /// \brief Process entire module and collect debug info anchors.
970 void processModule(const Module &M);
972 /// \brief Process DbgDeclareInst.
973 void processDeclare(const Module &M, const DbgDeclareInst *DDI);
974 /// \brief Process DbgValueInst.
975 void processValue(const Module &M, const DbgValueInst *DVI);
976 /// \brief Process DILocation.
977 void processLocation(const Module &M, DILocation Loc);
979 /// \brief Clear all lists.
983 void InitializeTypeMap(const Module &M);
985 void processType(DIType DT);
986 void processSubprogram(DISubprogram SP);
987 void processScope(DIScope Scope);
988 bool addCompileUnit(DICompileUnit CU);
989 bool addGlobalVariable(DIGlobalVariable DIG);
990 bool addSubprogram(DISubprogram SP);
991 bool addType(DIType DT);
992 bool addScope(DIScope Scope);
995 typedef SmallVectorImpl<DICompileUnit>::const_iterator compile_unit_iterator;
996 typedef SmallVectorImpl<DISubprogram>::const_iterator subprogram_iterator;
997 typedef SmallVectorImpl<DIGlobalVariable>::const_iterator
998 global_variable_iterator;
999 typedef SmallVectorImpl<DIType>::const_iterator type_iterator;
1000 typedef SmallVectorImpl<DIScope>::const_iterator scope_iterator;
1002 iterator_range<compile_unit_iterator> compile_units() const {
1003 return iterator_range<compile_unit_iterator>(CUs.begin(), CUs.end());
1006 iterator_range<subprogram_iterator> subprograms() const {
1007 return iterator_range<subprogram_iterator>(SPs.begin(), SPs.end());
1010 iterator_range<global_variable_iterator> global_variables() const {
1011 return iterator_range<global_variable_iterator>(GVs.begin(), GVs.end());
1014 iterator_range<type_iterator> types() const {
1015 return iterator_range<type_iterator>(TYs.begin(), TYs.end());
1018 iterator_range<scope_iterator> scopes() const {
1019 return iterator_range<scope_iterator>(Scopes.begin(), Scopes.end());
1022 unsigned compile_unit_count() const { return CUs.size(); }
1023 unsigned global_variable_count() const { return GVs.size(); }
1024 unsigned subprogram_count() const { return SPs.size(); }
1025 unsigned type_count() const { return TYs.size(); }
1026 unsigned scope_count() const { return Scopes.size(); }
1029 SmallVector<DICompileUnit, 8> CUs;
1030 SmallVector<DISubprogram, 8> SPs;
1031 SmallVector<DIGlobalVariable, 8> GVs;
1032 SmallVector<DIType, 8> TYs;
1033 SmallVector<DIScope, 8> Scopes;
1034 SmallPtrSet<MDNode *, 64> NodesSeen;
1035 DITypeIdentifierMap TypeIdentifierMap;
1037 /// \brief Specify if TypeIdentifierMap is initialized.
1038 bool TypeMapInitialized;
1041 DenseMap<const Function *, DISubprogram> makeSubprogramMap(const Module &M);
1043 } // end namespace llvm