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 class DIHeaderFieldIterator
62 : public std::iterator<std::input_iterator_tag, StringRef, std::ptrdiff_t,
63 const StringRef *, StringRef> {
68 DIHeaderFieldIterator() {}
69 explicit DIHeaderFieldIterator(StringRef Header)
70 : Header(Header), Current(Header.slice(0, Header.find('\0'))) {}
71 StringRef operator*() const { return Current; }
72 const StringRef *operator->() const { return &Current; }
73 DIHeaderFieldIterator &operator++() {
77 DIHeaderFieldIterator operator++(int) {
78 DIHeaderFieldIterator X(*this);
82 bool operator==(const DIHeaderFieldIterator &X) const {
83 return Current.data() == X.Current.data();
85 bool operator!=(const DIHeaderFieldIterator &X) const {
89 StringRef getHeader() const { return Header; }
90 StringRef getCurrent() const { return Current; }
91 StringRef getPrefix() const {
92 if (Current.begin() == Header.begin())
94 return Header.slice(0, Current.begin() - Header.begin() - 1);
96 StringRef getSuffix() const {
97 if (Current.end() == Header.end())
99 return Header.slice(Current.end() - Header.begin() + 1, StringRef::npos);
102 /// \brief Get the current field as a number.
104 /// Convert the current field into a number. Return \c 0 on error.
105 template <class T> T getNumber() const {
107 if (getCurrent().getAsInteger(0, Int))
114 assert(Current.data() != nullptr && "Cannot increment past the end");
115 StringRef Suffix = getSuffix();
116 Current = Suffix.slice(0, Suffix.find('\0'));
120 /// \brief A thin wraper around MDNode to access encoded debug info.
122 /// This should not be stored in a container, because the underlying MDNode may
123 /// change in certain situations.
125 // Befriends DIRef so DIRef can befriend the protected member
126 // function: getFieldAs<DIRef>.
127 template <typename T> friend class DIRef;
130 /// \brief Accessibility flags.
132 /// The three accessibility flags are mutually exclusive and rolled together
133 /// in the first two bits.
135 FlagAccessibility = 1 << 0 | 1 << 1,
140 FlagFwdDecl = 1 << 2,
141 FlagAppleBlock = 1 << 3,
142 FlagBlockByrefStruct = 1 << 4,
143 FlagVirtual = 1 << 5,
144 FlagArtificial = 1 << 6,
145 FlagExplicit = 1 << 7,
146 FlagPrototyped = 1 << 8,
147 FlagObjcClassComplete = 1 << 9,
148 FlagObjectPointer = 1 << 10,
149 FlagVector = 1 << 11,
150 FlagStaticMember = 1 << 12,
151 FlagLValueReference = 1 << 13,
152 FlagRValueReference = 1 << 14
156 const MDNode *DbgNode;
158 StringRef getStringField(unsigned Elt) const;
159 unsigned getUnsignedField(unsigned Elt) const {
160 return (unsigned)getUInt64Field(Elt);
162 uint64_t getUInt64Field(unsigned Elt) const;
163 int64_t getInt64Field(unsigned Elt) const;
164 DIDescriptor getDescriptorField(unsigned Elt) const;
166 template <typename DescTy> DescTy getFieldAs(unsigned Elt) const {
167 return DescTy(getDescriptorField(Elt));
170 GlobalVariable *getGlobalVariableField(unsigned Elt) const;
171 Constant *getConstantField(unsigned Elt) const;
172 Function *getFunctionField(unsigned Elt) const;
173 void replaceFunctionField(unsigned Elt, Function *F);
176 explicit DIDescriptor(const MDNode *N = nullptr) : DbgNode(N) {}
180 MDNode *get() const { return const_cast<MDNode *>(DbgNode); }
181 operator MDNode *() const { return get(); }
182 MDNode *operator->() const { return get(); }
184 // An explicit operator bool so that we can do testing of DI values
186 // FIXME: This operator bool isn't actually protecting anything at the
187 // moment due to the conversion operator above making DIDescriptor nodes
188 // implicitly convertable to bool.
189 explicit operator bool() const { return DbgNode != nullptr; }
191 bool operator==(DIDescriptor Other) const { return DbgNode == Other.DbgNode; }
192 bool operator!=(DIDescriptor Other) const { return !operator==(Other); }
194 StringRef getHeader() const { return getStringField(0); }
196 size_t getNumHeaderFields() const {
197 return std::distance(DIHeaderFieldIterator(getHeader()),
198 DIHeaderFieldIterator());
201 DIHeaderFieldIterator header_begin() const {
202 return DIHeaderFieldIterator(getHeader());
204 DIHeaderFieldIterator header_end() const { return DIHeaderFieldIterator(); }
206 DIHeaderFieldIterator getHeaderIterator(unsigned Index) const {
207 // Since callers expect an empty string for out-of-range accesses, we can't
208 // use std::advance() here.
209 for (auto I = header_begin(), E = header_end(); I != E; ++I, --Index)
215 StringRef getHeaderField(unsigned Index) const {
216 return *getHeaderIterator(Index);
219 template <class T> T getHeaderFieldAs(unsigned Index) const {
220 return getHeaderIterator(Index).getNumber<T>();
223 uint16_t getTag() const { return getHeaderFieldAs<uint16_t>(0); }
225 bool isDerivedType() const;
226 bool isCompositeType() const;
227 bool isSubroutineType() const;
228 bool isBasicType() const;
229 bool isVariable() const;
230 bool isSubprogram() const;
231 bool isGlobalVariable() const;
232 bool isScope() const;
234 bool isCompileUnit() const;
235 bool isNameSpace() const;
236 bool isLexicalBlockFile() const;
237 bool isLexicalBlock() const;
238 bool isSubrange() const;
239 bool isEnumerator() const;
241 bool isTemplateTypeParameter() const;
242 bool isTemplateValueParameter() const;
243 bool isObjCProperty() const;
244 bool isImportedEntity() const;
245 bool isExpression() const;
247 void print(raw_ostream &OS) const;
250 /// \brief Replace all uses of debug info referenced by this descriptor.
251 void replaceAllUsesWith(LLVMContext &VMContext, DIDescriptor D);
252 void replaceAllUsesWith(MDNode *D);
255 /// \brief This is used to represent ranges, for array bounds.
256 class DISubrange : public DIDescriptor {
257 friend class DIDescriptor;
258 void printInternal(raw_ostream &OS) const;
261 explicit DISubrange(const MDNode *N = nullptr) : DIDescriptor(N) {}
263 int64_t getLo() const { return getHeaderFieldAs<int64_t>(1); }
264 int64_t getCount() const { return getHeaderFieldAs<int64_t>(2); }
268 /// \brief This descriptor holds an array of nodes with type T.
269 template <typename T> class DITypedArray : public DIDescriptor {
271 explicit DITypedArray(const MDNode *N = nullptr) : DIDescriptor(N) {}
272 unsigned getNumElements() const {
273 return DbgNode ? DbgNode->getNumOperands() : 0;
275 T getElement(unsigned Idx) const { return getFieldAs<T>(Idx); }
278 typedef DITypedArray<DIDescriptor> DIArray;
280 /// \brief A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
282 /// FIXME: it seems strange that this doesn't have either a reference to the
283 /// type/precision or a file/line pair for location info.
284 class DIEnumerator : public DIDescriptor {
285 friend class DIDescriptor;
286 void printInternal(raw_ostream &OS) const;
289 explicit DIEnumerator(const MDNode *N = nullptr) : DIDescriptor(N) {}
291 StringRef getName() const { return getHeaderField(1); }
292 int64_t getEnumValue() const { return getHeaderFieldAs<int64_t>(2); }
296 template <typename T> class DIRef;
297 typedef DIRef<DIScope> DIScopeRef;
298 typedef DIRef<DIType> DITypeRef;
299 typedef DITypedArray<DITypeRef> DITypeArray;
301 /// \brief A base class for various scopes.
303 /// Although, implementation-wise, DIScope is the parent class of most
304 /// other DIxxx classes, including DIType and its descendants, most of
305 /// DIScope's descendants are not a substitutable subtype of
306 /// DIScope. The DIDescriptor::isScope() method only is true for
307 /// DIScopes that are scopes in the strict lexical scope sense
308 /// (DICompileUnit, DISubprogram, etc.), but not for, e.g., a DIType.
309 class DIScope : public DIDescriptor {
311 friend class DIDescriptor;
312 void printInternal(raw_ostream &OS) const;
315 explicit DIScope(const MDNode *N = nullptr) : DIDescriptor(N) {}
317 /// \brief Get the parent scope.
319 /// Gets the parent scope for this scope node or returns a default
320 /// constructed scope.
321 DIScopeRef getContext() const;
322 /// \brief Get the scope name.
324 /// If the scope node has a name, return that, else return an empty string.
325 StringRef getName() const;
326 StringRef getFilename() const;
327 StringRef getDirectory() const;
329 /// \brief Generate a reference to this DIScope.
331 /// Uses the type identifier instead of the actual MDNode if possible, to
332 /// help type uniquing.
333 DIScopeRef getRef() const;
336 /// \brief Represents reference to a DIDescriptor.
338 /// Abstracts over direct and identifier-based metadata references.
339 template <typename T> class DIRef {
340 template <typename DescTy>
341 friend DescTy DIDescriptor::getFieldAs(unsigned Elt) const;
342 friend DIScopeRef DIScope::getContext() const;
343 friend DIScopeRef DIScope::getRef() const;
346 /// \brief Val can be either a MDNode or a MDString.
348 /// In the latter, MDString specifies the type identifier.
350 explicit DIRef(const Metadata *V);
353 T resolve(const DITypeIdentifierMap &Map) const;
354 StringRef getName() const;
355 operator Metadata *() const { return const_cast<Metadata *>(Val); }
358 template <typename T>
359 T DIRef<T>::resolve(const DITypeIdentifierMap &Map) const {
363 if (const MDNode *MD = dyn_cast<MDNode>(Val))
366 const MDString *MS = cast<MDString>(Val);
367 // Find the corresponding MDNode.
368 DITypeIdentifierMap::const_iterator Iter = Map.find(MS);
369 assert(Iter != Map.end() && "Identifier not in the type map?");
370 assert(DIDescriptor(Iter->second).isType() &&
371 "MDNode in DITypeIdentifierMap should be a DIType.");
372 return T(Iter->second);
375 template <typename T> StringRef DIRef<T>::getName() const {
379 if (const MDNode *MD = dyn_cast<MDNode>(Val))
380 return T(MD).getName();
382 const MDString *MS = cast<MDString>(Val);
383 return MS->getString();
386 /// \brief Handle fields that are references to DIScopes.
387 template <> DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const;
388 /// \brief Specialize DIRef constructor for DIScopeRef.
389 template <> DIRef<DIScope>::DIRef(const Metadata *V);
391 /// \brief Handle fields that are references to DITypes.
392 template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const;
393 /// \brief Specialize DIRef constructor for DITypeRef.
394 template <> DIRef<DIType>::DIRef(const Metadata *V);
396 /// \brief This is a wrapper for a type.
398 /// FIXME: Types should be factored much better so that CV qualifiers and
399 /// others do not require a huge and empty descriptor full of zeros.
400 class DIType : public DIScope {
402 friend class DIDescriptor;
403 void printInternal(raw_ostream &OS) const;
406 explicit DIType(const MDNode *N = nullptr) : DIScope(N) {}
407 operator DITypeRef() const {
409 "constructing DITypeRef from an MDNode that is not a type");
410 return DITypeRef(&*getRef());
415 DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(2); }
416 StringRef getName() const { return getHeaderField(1); }
417 unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(2); }
418 uint64_t getSizeInBits() const { return getHeaderFieldAs<unsigned>(3); }
419 uint64_t getAlignInBits() const { return getHeaderFieldAs<unsigned>(4); }
420 // FIXME: Offset is only used for DW_TAG_member nodes. Making every type
421 // carry this is just plain insane.
422 uint64_t getOffsetInBits() const { return getHeaderFieldAs<unsigned>(5); }
423 unsigned getFlags() const { return getHeaderFieldAs<unsigned>(6); }
424 bool isPrivate() const {
425 return (getFlags() & FlagAccessibility) == FlagPrivate;
427 bool isProtected() const {
428 return (getFlags() & FlagAccessibility) == FlagProtected;
430 bool isPublic() const {
431 return (getFlags() & FlagAccessibility) == FlagPublic;
433 bool isForwardDecl() const { return (getFlags() & FlagFwdDecl) != 0; }
434 bool isAppleBlockExtension() const {
435 return (getFlags() & FlagAppleBlock) != 0;
437 bool isBlockByrefStruct() const {
438 return (getFlags() & FlagBlockByrefStruct) != 0;
440 bool isVirtual() const { return (getFlags() & FlagVirtual) != 0; }
441 bool isArtificial() const { return (getFlags() & FlagArtificial) != 0; }
442 bool isObjectPointer() const { return (getFlags() & FlagObjectPointer) != 0; }
443 bool isObjcClassComplete() const {
444 return (getFlags() & FlagObjcClassComplete) != 0;
446 bool isVector() const { return (getFlags() & FlagVector) != 0; }
447 bool isStaticMember() const { return (getFlags() & FlagStaticMember) != 0; }
448 bool isLValueReference() const {
449 return (getFlags() & FlagLValueReference) != 0;
451 bool isRValueReference() const {
452 return (getFlags() & FlagRValueReference) != 0;
454 bool isValid() const { return DbgNode && isType(); }
457 /// \brief A basic type, like 'int' or 'float'.
458 class DIBasicType : public DIType {
460 explicit DIBasicType(const MDNode *N = nullptr) : DIType(N) {}
462 unsigned getEncoding() const { return getHeaderFieldAs<unsigned>(7); }
467 /// \brief A simple derived type
469 /// Like a const qualified type, a typedef, a pointer or reference, et cetera.
470 /// Or, a data member of a class/struct/union.
471 class DIDerivedType : public DIType {
472 friend class DIDescriptor;
473 void printInternal(raw_ostream &OS) const;
476 explicit DIDerivedType(const MDNode *N = nullptr) : DIType(N) {}
478 DITypeRef getTypeDerivedFrom() const { return getFieldAs<DITypeRef>(3); }
480 /// \brief Return property node, if this ivar is associated with one.
481 MDNode *getObjCProperty() const;
483 DITypeRef getClassType() const {
484 assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
485 return getFieldAs<DITypeRef>(4);
488 Constant *getConstant() const {
489 assert((getTag() == dwarf::DW_TAG_member) && isStaticMember());
490 return getConstantField(4);
496 /// \brief Types that refer to multiple other types.
498 /// This descriptor holds a type that can refer to multiple other types, like a
499 /// function or struct.
501 /// DICompositeType is derived from DIDerivedType because some
502 /// composite types (such as enums) can be derived from basic types
503 // FIXME: Make this derive from DIType directly & just store the
504 // base type in a single DIType field.
505 class DICompositeType : public DIDerivedType {
506 friend class DIBuilder;
507 friend class DIDescriptor;
508 void printInternal(raw_ostream &OS) const;
510 /// \brief Set the array of member DITypes.
511 void setArraysHelper(MDNode *Elements, MDNode *TParams);
514 explicit DICompositeType(const MDNode *N = nullptr) : DIDerivedType(N) {}
516 DIArray getElements() const {
517 assert(!isSubroutineType() && "no elements for DISubroutineType");
518 return getFieldAs<DIArray>(4);
522 template <typename T>
523 void setArrays(DITypedArray<T> Elements, DIArray TParams = DIArray()) {
525 (!TParams || DbgNode->getNumOperands() == 8) &&
526 "If you're setting the template parameters this should include a slot "
528 setArraysHelper(Elements, TParams);
532 unsigned getRunTimeLang() const { return getHeaderFieldAs<unsigned>(7); }
533 DITypeRef getContainingType() const { return getFieldAs<DITypeRef>(5); }
536 /// \brief Set the containing type.
537 void setContainingType(DICompositeType ContainingType);
540 DIArray getTemplateParams() const { return getFieldAs<DIArray>(6); }
541 MDString *getIdentifier() const;
546 class DISubroutineType : public DICompositeType {
548 explicit DISubroutineType(const MDNode *N = nullptr) : DICompositeType(N) {}
549 DITypedArray<DITypeRef> getTypeArray() const {
550 return getFieldAs<DITypedArray<DITypeRef>>(4);
554 /// \brief This is a wrapper for a file.
555 class DIFile : public DIScope {
556 friend class DIDescriptor;
559 explicit DIFile(const MDNode *N = nullptr) : DIScope(N) {}
561 /// \brief Retrieve the MDNode for the directory/file pair.
562 MDNode *getFileNode() const;
566 /// \brief A wrapper for a compile unit.
567 class DICompileUnit : public DIScope {
568 friend class DIDescriptor;
569 void printInternal(raw_ostream &OS) const;
572 explicit DICompileUnit(const MDNode *N = nullptr) : DIScope(N) {}
574 dwarf::SourceLanguage getLanguage() const {
575 return static_cast<dwarf::SourceLanguage>(getHeaderFieldAs<unsigned>(1));
577 StringRef getProducer() const { return getHeaderField(2); }
579 bool isOptimized() const { return getHeaderFieldAs<bool>(3) != 0; }
580 StringRef getFlags() const { return getHeaderField(4); }
581 unsigned getRunTimeVersion() const { return getHeaderFieldAs<unsigned>(5); }
583 DIArray getEnumTypes() const;
584 DIArray getRetainedTypes() const;
585 DIArray getSubprograms() const;
586 DIArray getGlobalVariables() const;
587 DIArray getImportedEntities() const;
589 void replaceSubprograms(DIArray Subprograms);
590 void replaceGlobalVariables(DIArray GlobalVariables);
592 StringRef getSplitDebugFilename() const { return getHeaderField(6); }
593 unsigned getEmissionKind() const { return getHeaderFieldAs<unsigned>(7); }
598 /// \brief This is a wrapper for a subprogram (e.g. a function).
599 class DISubprogram : public DIScope {
600 friend class DIDescriptor;
601 void printInternal(raw_ostream &OS) const;
604 explicit DISubprogram(const MDNode *N = nullptr) : DIScope(N) {}
606 StringRef getName() const { return getHeaderField(1); }
607 StringRef getDisplayName() const { return getHeaderField(2); }
608 StringRef getLinkageName() const { return getHeaderField(3); }
609 unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(4); }
611 /// \brief Check if this is local (like 'static' in C).
612 unsigned isLocalToUnit() const { return getHeaderFieldAs<unsigned>(5); }
613 unsigned isDefinition() const { return getHeaderFieldAs<unsigned>(6); }
615 unsigned getVirtuality() const { return getHeaderFieldAs<unsigned>(7); }
616 unsigned getVirtualIndex() const { return getHeaderFieldAs<unsigned>(8); }
618 unsigned getFlags() const { return getHeaderFieldAs<unsigned>(9); }
620 unsigned isOptimized() const { return getHeaderFieldAs<bool>(10); }
622 /// \brief Get the beginning of the scope of the function (not the name).
623 unsigned getScopeLineNumber() const { return getHeaderFieldAs<unsigned>(11); }
625 DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(2); }
626 DISubroutineType getType() const { return getFieldAs<DISubroutineType>(3); }
628 DITypeRef getContainingType() const { return getFieldAs<DITypeRef>(4); }
632 /// \brief Check if this provides debugging information for the function F.
633 bool describes(const Function *F);
635 Function *getFunction() const { return getFunctionField(5); }
636 void replaceFunction(Function *F) { replaceFunctionField(5, F); }
637 DIArray getTemplateParams() const { return getFieldAs<DIArray>(6); }
638 DISubprogram getFunctionDeclaration() const {
639 return getFieldAs<DISubprogram>(7);
641 MDNode *getVariablesNodes() const;
642 DIArray getVariables() const;
644 unsigned isArtificial() const { return (getFlags() & FlagArtificial) != 0; }
645 /// \brief Check for the "private" access specifier.
646 bool isPrivate() const {
647 return (getFlags() & FlagAccessibility) == FlagPrivate;
649 /// \brief Check for the "protected" access specifier.
650 bool isProtected() const {
651 return (getFlags() & FlagAccessibility) == FlagProtected;
653 /// \brief Check for the "public" access specifier.
654 bool isPublic() const {
655 return (getFlags() & FlagAccessibility) == FlagPublic;
657 /// \brief Check for "explicit".
658 bool isExplicit() const { return (getFlags() & FlagExplicit) != 0; }
659 /// \brief Check if this is prototyped.
660 bool isPrototyped() const { return (getFlags() & FlagPrototyped) != 0; }
662 /// \brief Check if this is reference-qualified.
664 /// Return true if this subprogram is a C++11 reference-qualified non-static
665 /// member function (void foo() &).
666 unsigned isLValueReference() const {
667 return (getFlags() & FlagLValueReference) != 0;
670 /// \brief Check if this is rvalue-reference-qualified.
672 /// Return true if this subprogram is a C++11 rvalue-reference-qualified
673 /// non-static member function (void foo() &&).
674 unsigned isRValueReference() const {
675 return (getFlags() & FlagRValueReference) != 0;
679 /// \brief This is a wrapper for a lexical block.
680 class DILexicalBlock : public DIScope {
682 explicit DILexicalBlock(const MDNode *N = nullptr) : DIScope(N) {}
683 DIScope getContext() const { return getFieldAs<DIScope>(2); }
684 unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(1); }
685 unsigned getColumnNumber() const { return getHeaderFieldAs<unsigned>(2); }
689 /// \brief This is a wrapper for a lexical block with a filename change.
690 class DILexicalBlockFile : public DIScope {
692 explicit DILexicalBlockFile(const MDNode *N = nullptr) : DIScope(N) {}
693 DIScope getContext() const {
694 // FIXME: This logic is horrible. getScope() returns a DILexicalBlock, but
695 // then we check if it's a subprogram? WHAT?!?
696 if (getScope().isSubprogram())
698 return getScope().getContext();
700 unsigned getLineNumber() const { return getScope().getLineNumber(); }
701 unsigned getColumnNumber() const { return getScope().getColumnNumber(); }
702 DILexicalBlock getScope() const { return getFieldAs<DILexicalBlock>(2); }
703 unsigned getDiscriminator() const { return getHeaderFieldAs<unsigned>(1); }
707 /// \brief A wrapper for a C++ style name space.
708 class DINameSpace : public DIScope {
709 friend class DIDescriptor;
710 void printInternal(raw_ostream &OS) const;
713 explicit DINameSpace(const MDNode *N = nullptr) : DIScope(N) {}
714 StringRef getName() const { return getHeaderField(1); }
715 unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(2); }
716 DIScope getContext() const { return getFieldAs<DIScope>(2); }
720 /// \brief This is a wrapper for template type parameter.
721 class DITemplateTypeParameter : public DIDescriptor {
723 explicit DITemplateTypeParameter(const MDNode *N = nullptr)
726 StringRef getName() const { return getHeaderField(1); }
728 DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(1); }
729 DITypeRef getType() const { return getFieldAs<DITypeRef>(2); }
733 /// \brief This is a wrapper for template value parameter.
734 class DITemplateValueParameter : public DIDescriptor {
736 explicit DITemplateValueParameter(const MDNode *N = nullptr)
739 StringRef getName() const { return getHeaderField(1); }
741 DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(1); }
742 DITypeRef getType() const { return getFieldAs<DITypeRef>(2); }
743 Metadata *getValue() const;
747 /// \brief This is a wrapper for a global variable.
748 class DIGlobalVariable : public DIDescriptor {
749 friend class DIDescriptor;
750 void printInternal(raw_ostream &OS) const;
753 explicit DIGlobalVariable(const MDNode *N = nullptr) : DIDescriptor(N) {}
755 StringRef getName() const { return getHeaderField(1); }
756 StringRef getDisplayName() const { return getHeaderField(2); }
757 StringRef getLinkageName() const { return getHeaderField(3); }
758 unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(4); }
759 unsigned isLocalToUnit() const { return getHeaderFieldAs<bool>(5); }
760 unsigned isDefinition() const { return getHeaderFieldAs<bool>(6); }
762 DIScope getContext() const { return getFieldAs<DIScope>(1); }
763 StringRef getFilename() const { return getFieldAs<DIFile>(2).getFilename(); }
764 StringRef getDirectory() const {
765 return getFieldAs<DIFile>(2).getDirectory();
767 DITypeRef getType() const { return getFieldAs<DITypeRef>(3); }
769 GlobalVariable *getGlobal() const { return getGlobalVariableField(4); }
770 Constant *getConstant() const { return getConstantField(4); }
771 DIDerivedType getStaticDataMemberDeclaration() const {
772 return getFieldAs<DIDerivedType>(5);
778 /// \brief This is a wrapper for a variable (e.g. parameter, local, global etc).
779 class DIVariable : public DIDescriptor {
780 friend class DIDescriptor;
781 void printInternal(raw_ostream &OS) const;
784 explicit DIVariable(const MDNode *N = nullptr) : DIDescriptor(N) {}
786 StringRef getName() const { return getHeaderField(1); }
787 unsigned getLineNumber() const {
788 // FIXME: Line number and arg number shouldn't be merged together like this.
789 return (getHeaderFieldAs<unsigned>(2) << 8) >> 8;
791 unsigned getArgNumber() const { return getHeaderFieldAs<unsigned>(2) >> 24; }
793 DIScope getContext() const { return getFieldAs<DIScope>(1); }
794 DIFile getFile() const { return getFieldAs<DIFile>(2); }
795 DITypeRef getType() const { return getFieldAs<DITypeRef>(3); }
797 /// \brief Return true if this variable is marked as "artificial".
798 bool isArtificial() const {
799 return (getHeaderFieldAs<unsigned>(3) & FlagArtificial) != 0;
802 bool isObjectPointer() const {
803 return (getHeaderFieldAs<unsigned>(3) & FlagObjectPointer) != 0;
806 /// \brief If this variable is inlined then return inline location.
807 MDNode *getInlinedAt() const;
811 /// \brief Check if this is a "__block" variable (Apple Blocks).
812 bool isBlockByrefVariable(const DITypeIdentifierMap &Map) const {
813 return (getType().resolve(Map)).isBlockByrefStruct();
816 /// \brief Check if this is an inlined function argument.
817 bool isInlinedFnArgument(const Function *CurFn);
819 /// \brief Return the size reported by the variable's type.
820 unsigned getSizeInBits(const DITypeIdentifierMap &Map);
822 void printExtendedName(raw_ostream &OS) const;
825 /// \brief A complex location expression in postfix notation.
827 /// This is (almost) a DWARF expression that modifies the location of a
828 /// variable or (or the location of a single piece of a variable).
830 /// FIXME: Instead of DW_OP_plus taking an argument, this should use DW_OP_const
831 /// and have DW_OP_plus consume the topmost elements on the stack.
832 class DIExpression : public DIDescriptor {
833 friend class DIDescriptor;
834 void printInternal(raw_ostream &OS) const;
837 explicit DIExpression(const MDNode *N = nullptr) : DIDescriptor(N) {}
841 /// \brief Return the number of elements in the complex expression.
842 unsigned getNumElements() const {
845 unsigned N = getNumHeaderFields();
846 assert(N > 0 && "missing tag");
850 /// \brief return the Idx'th complex address element.
851 uint64_t getElement(unsigned Idx) const;
853 /// \brief Return whether this is a piece of an aggregate variable.
854 bool isBitPiece() const;
855 /// \brief Return the offset of this piece in bits.
856 uint64_t getBitPieceOffset() const;
857 /// \brief Return the size of this piece in bits.
858 uint64_t getBitPieceSize() const;
861 /// \brief A lightweight wrapper around an element of a DIExpression.
863 friend class iterator;
864 DIHeaderFieldIterator I;
866 Operand(DIHeaderFieldIterator I) : I(I) {}
868 /// \brief Operands such as DW_OP_piece have explicit (non-stack) arguments.
869 /// Argument 0 is the operand itself.
870 uint64_t getArg(unsigned N) const {
871 DIHeaderFieldIterator In = I;
873 return In.getNumber<uint64_t>();
875 operator uint64_t () const { return I.getNumber<uint64_t>(); }
876 /// \brief Returns underlying DIHeaderFieldIterator.
877 const DIHeaderFieldIterator &getBase() const { return I; }
878 /// \brief Returns the next operand.
879 Operand getNext() const;
882 /// \brief An iterator for DIExpression elements.
883 class iterator : public std::iterator<std::input_iterator_tag, StringRef,
884 unsigned, const Operand*, Operand> {
885 friend class Operand;
886 DIHeaderFieldIterator I;
888 iterator(DIHeaderFieldIterator I) : I(I) {}
891 iterator(const DIExpression &Expr) : I(++Expr.header_begin()) {}
892 const Operand &operator*() { return Tmp = Operand(I); }
893 const Operand *operator->() { return &(Tmp = Operand(I)); }
894 iterator &operator++() {
898 iterator operator++(int) {
903 bool operator==(const iterator &X) const { return I == X.I; }
904 bool operator!=(const iterator &X) const { return !(*this == X); }
909 case dwarf::DW_OP_bit_piece: std::advance(I, 3); break;
910 case dwarf::DW_OP_plus: std::advance(I, 2); break;
911 case dwarf::DW_OP_deref: std::advance(I, 1); break;
913 llvm_unreachable("unsupported operand");
918 iterator begin() const;
919 iterator end() const;
922 /// \brief This object holds location information.
924 /// This object is not associated with any DWARF tag.
925 class DILocation : public DIDescriptor {
927 explicit DILocation(const MDNode *N) : DIDescriptor(N) {}
929 unsigned getLineNumber() const {
930 if (auto *L = dyn_cast_or_null<MDLocation>(DbgNode))
934 unsigned getColumnNumber() const {
935 if (auto *L = dyn_cast_or_null<MDLocation>(DbgNode))
936 return L->getColumn();
939 DIScope getScope() const {
940 if (auto *L = dyn_cast_or_null<MDLocation>(DbgNode))
941 return DIScope(dyn_cast_or_null<MDNode>(L->getScope()));
942 return DIScope(nullptr);
944 DILocation getOrigLocation() const {
945 if (auto *L = dyn_cast_or_null<MDLocation>(DbgNode))
946 return DILocation(dyn_cast_or_null<MDNode>(L->getInlinedAt()));
947 return DILocation(nullptr);
949 StringRef getFilename() const { return getScope().getFilename(); }
950 StringRef getDirectory() const { return getScope().getDirectory(); }
952 bool atSameLineAs(const DILocation &Other) const {
953 return (getLineNumber() == Other.getLineNumber() &&
954 getFilename() == Other.getFilename());
956 /// \brief Get the DWAF discriminator.
958 /// DWARF discriminators are used to distinguish identical file locations for
959 /// instructions that are on different basic blocks. If two instructions are
960 /// inside the same lexical block and are in different basic blocks, we
961 /// create a new lexical block with identical location as the original but
962 /// with a different discriminator value
963 /// (lib/Transforms/Util/AddDiscriminators.cpp for details).
964 unsigned getDiscriminator() const {
965 // Since discriminators are associated with lexical blocks, make
966 // sure this location is a lexical block before retrieving its
968 return getScope().isLexicalBlockFile()
969 ? DILexicalBlockFile(
970 cast<MDNode>(cast<MDLocation>(DbgNode)->getScope()))
975 /// \brief Generate a new discriminator value for this location.
976 unsigned computeNewDiscriminator(LLVMContext &Ctx);
978 /// \brief Return a copy of this location with a different scope.
979 DILocation copyWithNewScope(LLVMContext &Ctx, DILexicalBlockFile NewScope);
982 class DIObjCProperty : public DIDescriptor {
983 friend class DIDescriptor;
984 void printInternal(raw_ostream &OS) const;
987 explicit DIObjCProperty(const MDNode *N) : DIDescriptor(N) {}
989 StringRef getObjCPropertyName() const { return getHeaderField(1); }
990 DIFile getFile() const { return getFieldAs<DIFile>(1); }
991 unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(2); }
993 StringRef getObjCPropertyGetterName() const { return getHeaderField(3); }
994 StringRef getObjCPropertySetterName() const { return getHeaderField(4); }
995 unsigned getAttributes() const { return getHeaderFieldAs<unsigned>(5); }
996 bool isReadOnlyObjCProperty() const {
997 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_readonly) != 0;
999 bool isReadWriteObjCProperty() const {
1000 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_readwrite) != 0;
1002 bool isAssignObjCProperty() const {
1003 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_assign) != 0;
1005 bool isRetainObjCProperty() const {
1006 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_retain) != 0;
1008 bool isCopyObjCProperty() const {
1009 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_copy) != 0;
1011 bool isNonAtomicObjCProperty() const {
1012 return (getAttributes() & dwarf::DW_APPLE_PROPERTY_nonatomic) != 0;
1015 /// \brief Get the type.
1017 /// \note Objective-C doesn't have an ODR, so there is no benefit in storing
1018 /// the type as a DITypeRef here.
1019 DIType getType() const { return getFieldAs<DIType>(2); }
1021 bool Verify() const;
1024 /// \brief An imported module (C++ using directive or similar).
1025 class DIImportedEntity : public DIDescriptor {
1026 friend class DIDescriptor;
1027 void printInternal(raw_ostream &OS) const;
1030 explicit DIImportedEntity(const MDNode *N) : DIDescriptor(N) {}
1031 DIScope getContext() const { return getFieldAs<DIScope>(1); }
1032 DIScopeRef getEntity() const { return getFieldAs<DIScopeRef>(2); }
1033 unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(1); }
1034 StringRef getName() const { return getHeaderField(2); }
1035 bool Verify() const;
1038 /// \brief Find subprogram that is enclosing this scope.
1039 DISubprogram getDISubprogram(const MDNode *Scope);
1041 /// \brief Find debug info for a given function.
1042 /// \returns a valid DISubprogram, if found. Otherwise, it returns an empty
1044 DISubprogram getDISubprogram(const Function *F);
1046 /// \brief Find underlying composite type.
1047 DICompositeType getDICompositeType(DIType T);
1049 /// \brief Create a new inlined variable based on current variable.
1051 /// @param DV Current Variable.
1052 /// @param InlinedScope Location at current variable is inlined.
1053 DIVariable createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
1054 LLVMContext &VMContext);
1056 /// \brief Remove inlined scope from the variable.
1057 DIVariable cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext);
1059 /// \brief Generate map by visiting all retained types.
1060 DITypeIdentifierMap generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes);
1062 /// \brief Strip debug info in the module if it exists.
1064 /// To do this, we remove all calls to the debugger intrinsics and any named
1065 /// metadata for debugging. We also remove debug locations for instructions.
1066 /// Return true if module is modified.
1067 bool StripDebugInfo(Module &M);
1069 /// \brief Return Debug Info Metadata Version by checking module flags.
1070 unsigned getDebugMetadataVersionFromModule(const Module &M);
1072 /// \brief Utility to find all debug info in a module.
1074 /// DebugInfoFinder tries to list all debug info MDNodes used in a module. To
1075 /// list debug info MDNodes used by an instruction, DebugInfoFinder uses
1076 /// processDeclare, processValue and processLocation to handle DbgDeclareInst,
1077 /// DbgValueInst and DbgLoc attached to instructions. processModule will go
1078 /// through all DICompileUnits in llvm.dbg.cu and list debug info MDNodes
1079 /// used by the CUs.
1080 class DebugInfoFinder {
1082 DebugInfoFinder() : TypeMapInitialized(false) {}
1084 /// \brief Process entire module and collect debug info anchors.
1085 void processModule(const Module &M);
1087 /// \brief Process DbgDeclareInst.
1088 void processDeclare(const Module &M, const DbgDeclareInst *DDI);
1089 /// \brief Process DbgValueInst.
1090 void processValue(const Module &M, const DbgValueInst *DVI);
1091 /// \brief Process DILocation.
1092 void processLocation(const Module &M, DILocation Loc);
1094 /// \brief Process DIExpression.
1095 void processExpression(DIExpression Expr);
1097 /// \brief Clear all lists.
1101 void InitializeTypeMap(const Module &M);
1103 void processType(DIType DT);
1104 void processSubprogram(DISubprogram SP);
1105 void processScope(DIScope Scope);
1106 bool addCompileUnit(DICompileUnit CU);
1107 bool addGlobalVariable(DIGlobalVariable DIG);
1108 bool addSubprogram(DISubprogram SP);
1109 bool addType(DIType DT);
1110 bool addScope(DIScope Scope);
1113 typedef SmallVectorImpl<DICompileUnit>::const_iterator compile_unit_iterator;
1114 typedef SmallVectorImpl<DISubprogram>::const_iterator subprogram_iterator;
1115 typedef SmallVectorImpl<DIGlobalVariable>::const_iterator
1116 global_variable_iterator;
1117 typedef SmallVectorImpl<DIType>::const_iterator type_iterator;
1118 typedef SmallVectorImpl<DIScope>::const_iterator scope_iterator;
1120 iterator_range<compile_unit_iterator> compile_units() const {
1121 return iterator_range<compile_unit_iterator>(CUs.begin(), CUs.end());
1124 iterator_range<subprogram_iterator> subprograms() const {
1125 return iterator_range<subprogram_iterator>(SPs.begin(), SPs.end());
1128 iterator_range<global_variable_iterator> global_variables() const {
1129 return iterator_range<global_variable_iterator>(GVs.begin(), GVs.end());
1132 iterator_range<type_iterator> types() const {
1133 return iterator_range<type_iterator>(TYs.begin(), TYs.end());
1136 iterator_range<scope_iterator> scopes() const {
1137 return iterator_range<scope_iterator>(Scopes.begin(), Scopes.end());
1140 unsigned compile_unit_count() const { return CUs.size(); }
1141 unsigned global_variable_count() const { return GVs.size(); }
1142 unsigned subprogram_count() const { return SPs.size(); }
1143 unsigned type_count() const { return TYs.size(); }
1144 unsigned scope_count() const { return Scopes.size(); }
1147 SmallVector<DICompileUnit, 8> CUs;
1148 SmallVector<DISubprogram, 8> SPs;
1149 SmallVector<DIGlobalVariable, 8> GVs;
1150 SmallVector<DIType, 8> TYs;
1151 SmallVector<DIScope, 8> Scopes;
1152 SmallPtrSet<MDNode *, 64> NodesSeen;
1153 DITypeIdentifierMap TypeIdentifierMap;
1155 /// \brief Specify if TypeIdentifierMap is initialized.
1156 bool TypeMapInitialized;
1159 DenseMap<const Function *, DISubprogram> makeSubprogramMap(const Module &M);
1161 } // end namespace llvm