Make DIExpression::Verify() stricter by checking that the number of
[opencl/llvm.git] / include / llvm / IR / DebugInfo.h
1 //===- DebugInfo.h - Debug Information Helpers ------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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
13 // DWARF information.
14 //
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/Metadata.h"
26 #include "llvm/Support/Casting.h"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include <iterator>
31 namespace llvm {
32 class BasicBlock;
33 class Constant;
34 class Function;
35 class GlobalVariable;
36 class Module;
37 class Type;
38 class Value;
39 class DbgDeclareInst;
40 class DbgValueInst;
41 class Instruction;
42 class Metadata;
43 class MDNode;
44 class MDString;
45 class NamedMDNode;
46 class LLVMContext;
47 class raw_ostream;
49 class DIFile;
50 class DISubprogram;
51 class DILexicalBlock;
52 class DILexicalBlockFile;
53 class DIVariable;
54 class DIType;
55 class DIScope;
56 class DIObjCProperty;
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> {
64   StringRef Header;
65   StringRef Current;
67 public:
68   DIHeaderFieldIterator() {}
69   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++() {
74     increment();
75     return *this;
76   }
77   DIHeaderFieldIterator operator++(int) {
78     DIHeaderFieldIterator X(*this);
79     increment();
80     return X;
81   }
82   bool operator==(const DIHeaderFieldIterator &X) const {
83     return Current.data() == X.Current.data();
84   }
85   bool operator!=(const DIHeaderFieldIterator &X) const {
86     return !(*this == X);
87   }
89   StringRef getHeader() const { return Header; }
90   StringRef getCurrent() const { return Current; }
91   StringRef getPrefix() const {
92     if (Current.begin() == Header.begin())
93       return StringRef();
94     return Header.slice(0, Current.begin() - Header.begin() - 1);
95   }
96   StringRef getSuffix() const {
97     if (Current.end() == Header.end())
98       return StringRef();
99     return Header.slice(Current.end() - Header.begin() + 1, StringRef::npos);
100   }
102 private:
103   void increment() {
104     assert(Current.data() != nullptr && "Cannot increment past the end");
105     StringRef Suffix = getSuffix();
106     Current = Suffix.slice(0, Suffix.find('\0'));
107   }
108 };
110 /// \brief A thin wraper around MDNode to access encoded debug info.
111 ///
112 /// This should not be stored in a container, because the underlying MDNode may
113 /// change in certain situations.
114 class DIDescriptor {
115   // Befriends DIRef so DIRef can befriend the protected member
116   // function: getFieldAs<DIRef>.
117   template <typename T> friend class DIRef;
119 public:
120   /// \brief Accessibility flags.
121   ///
122   /// The three accessibility flags are mutually exclusive and rolled together
123   /// in the first two bits.
124   enum {
125     FlagAccessibility     = 1 << 0 | 1 << 1,
126     FlagPrivate           = 1,
127     FlagProtected         = 2,
128     FlagPublic            = 3,
130     FlagFwdDecl           = 1 << 2,
131     FlagAppleBlock        = 1 << 3,
132     FlagBlockByrefStruct  = 1 << 4,
133     FlagVirtual           = 1 << 5,
134     FlagArtificial        = 1 << 6,
135     FlagExplicit          = 1 << 7,
136     FlagPrototyped        = 1 << 8,
137     FlagObjcClassComplete = 1 << 9,
138     FlagObjectPointer     = 1 << 10,
139     FlagVector            = 1 << 11,
140     FlagStaticMember      = 1 << 12,
141     FlagLValueReference   = 1 << 13,
142     FlagRValueReference   = 1 << 14
143   };
145 protected:
146   const MDNode *DbgNode;
148   StringRef getStringField(unsigned Elt) const;
149   unsigned getUnsignedField(unsigned Elt) const {
150     return (unsigned)getUInt64Field(Elt);
151   }
152   uint64_t getUInt64Field(unsigned Elt) const;
153   int64_t getInt64Field(unsigned Elt) const;
154   DIDescriptor getDescriptorField(unsigned Elt) const;
156   template <typename DescTy> DescTy getFieldAs(unsigned Elt) const {
157     return DescTy(getDescriptorField(Elt));
158   }
160   GlobalVariable *getGlobalVariableField(unsigned Elt) const;
161   Constant *getConstantField(unsigned Elt) const;
162   Function *getFunctionField(unsigned Elt) const;
163   void replaceFunctionField(unsigned Elt, Function *F);
165 public:
166   explicit DIDescriptor(const MDNode *N = nullptr) : DbgNode(N) {}
168   bool Verify() const;
170   MDNode *get() const { return const_cast<MDNode *>(DbgNode); }
171   operator MDNode *() const { return get(); }
172   MDNode *operator->() const { return get(); }
174   // An explicit operator bool so that we can do testing of DI values
175   // easily.
176   // FIXME: This operator bool isn't actually protecting anything at the
177   // moment due to the conversion operator above making DIDescriptor nodes
178   // implicitly convertable to bool.
179   LLVM_EXPLICIT operator bool() const { return DbgNode != nullptr; }
181   bool operator==(DIDescriptor Other) const { return DbgNode == Other.DbgNode; }
182   bool operator!=(DIDescriptor Other) const { return !operator==(Other); }
184   StringRef getHeader() const {
185     return getStringField(0);
186   }
188   size_t getNumHeaderFields() const {
189     return std::distance(DIHeaderFieldIterator(getHeader()),
190                          DIHeaderFieldIterator());
191   }
193   StringRef getHeaderField(unsigned Index) const {
194     // Since callers expect an empty string for out-of-range accesses, we can't
195     // use std::advance() here.
196     for (DIHeaderFieldIterator I(getHeader()), E; I != E; ++I, --Index)
197       if (!Index)
198         return *I;
199     return StringRef();
200   }
202   template <class T> T getHeaderFieldAs(unsigned Index) const {
203     T Int;
204     if (getHeaderField(Index).getAsInteger(0, Int))
205       return 0;
206     return Int;
207   }
209   uint16_t getTag() const { return getHeaderFieldAs<uint16_t>(0); }
211   bool isDerivedType() const;
212   bool isCompositeType() const;
213   bool isSubroutineType() const;
214   bool isBasicType() const;
215   bool isVariable() const;
216   bool isSubprogram() const;
217   bool isGlobalVariable() const;
218   bool isScope() const;
219   bool isFile() const;
220   bool isCompileUnit() const;
221   bool isNameSpace() const;
222   bool isLexicalBlockFile() const;
223   bool isLexicalBlock() const;
224   bool isSubrange() const;
225   bool isEnumerator() const;
226   bool isType() const;
227   bool isTemplateTypeParameter() const;
228   bool isTemplateValueParameter() const;
229   bool isObjCProperty() const;
230   bool isImportedEntity() const;
231   bool isExpression() const;
233   void print(raw_ostream &OS) const;
234   void dump() const;
236   /// \brief Replace all uses of debug info referenced by this descriptor.
237   void replaceAllUsesWith(LLVMContext &VMContext, DIDescriptor D);
238   void replaceAllUsesWith(MDNode *D);
239 };
241 /// \brief This is used to represent ranges, for array bounds.
242 class DISubrange : public DIDescriptor {
243   friend class DIDescriptor;
244   void printInternal(raw_ostream &OS) const;
246 public:
247   explicit DISubrange(const MDNode *N = nullptr) : DIDescriptor(N) {}
249   int64_t getLo() const { return getHeaderFieldAs<int64_t>(1); }
250   int64_t getCount() const { return getHeaderFieldAs<int64_t>(2); }
251   bool Verify() const;
252 };
254 /// \brief This descriptor holds an array of nodes with type T.
255 template <typename T> class DITypedArray : public DIDescriptor {
256 public:
257   explicit DITypedArray(const MDNode *N = nullptr) : DIDescriptor(N) {}
258   unsigned getNumElements() const {
259     return DbgNode ? DbgNode->getNumOperands() : 0;
260   }
261   T getElement(unsigned Idx) const {
262     return getFieldAs<T>(Idx);
263   }
264 };
266 typedef DITypedArray<DIDescriptor> DIArray;
268 /// \brief A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
269 ///
270 /// FIXME: it seems strange that this doesn't have either a reference to the
271 /// type/precision or a file/line pair for location info.
272 class DIEnumerator : public DIDescriptor {
273   friend class DIDescriptor;
274   void printInternal(raw_ostream &OS) const;
276 public:
277   explicit DIEnumerator(const MDNode *N = nullptr) : DIDescriptor(N) {}
279   StringRef getName() const { return getHeaderField(1); }
280   int64_t getEnumValue() const { return getHeaderFieldAs<int64_t>(2); }
281   bool Verify() const;
282 };
284 template <typename T> class DIRef;
285 typedef DIRef<DIScope> DIScopeRef;
286 typedef DIRef<DIType> DITypeRef;
287 typedef DITypedArray<DITypeRef> DITypeArray;
289 /// \brief A base class for various scopes.
290 ///
291 /// Although, implementation-wise, DIScope is the parent class of most
292 /// other DIxxx classes, including DIType and its descendants, most of
293 /// DIScope's descendants are not a substitutable subtype of
294 /// DIScope. The DIDescriptor::isScope() method only is true for
295 /// DIScopes that are scopes in the strict lexical scope sense
296 /// (DICompileUnit, DISubprogram, etc.), but not for, e.g., a DIType.
297 class DIScope : public DIDescriptor {
298 protected:
299   friend class DIDescriptor;
300   void printInternal(raw_ostream &OS) const;
302 public:
303   explicit DIScope(const MDNode *N = nullptr) : DIDescriptor(N) {}
305   /// \brief Get the parent scope.
306   ///
307   /// Gets the parent scope for this scope node or returns a default
308   /// constructed scope.
309   DIScopeRef getContext() const;
310   /// \brief Get the scope name.
311   ///
312   /// If the scope node has a name, return that, else return an empty string.
313   StringRef getName() const;
314   StringRef getFilename() const;
315   StringRef getDirectory() const;
317   /// \brief Generate a reference to this DIScope.
318   ///
319   /// Uses the type identifier instead of the actual MDNode if possible, to
320   /// help type uniquing.
321   DIScopeRef getRef() const;
322 };
324 /// \brief Represents reference to a DIDescriptor.
325 ///
326 /// Abstracts over direct and identifier-based metadata references.
327 template <typename T> class DIRef {
328   template <typename DescTy>
329   friend DescTy DIDescriptor::getFieldAs(unsigned Elt) const;
330   friend DIScopeRef DIScope::getContext() const;
331   friend DIScopeRef DIScope::getRef() const;
332   friend class DIType;
334   /// \brief Val can be either a MDNode or a MDString.
335   ///
336   /// In the latter, MDString specifies the type identifier.
337   const Metadata *Val;
338   explicit DIRef(const Metadata *V);
340 public:
341   T resolve(const DITypeIdentifierMap &Map) const;
342   StringRef getName() const;
343   operator Metadata *() const { return const_cast<Metadata *>(Val); }
344 };
346 template <typename T>
347 T DIRef<T>::resolve(const DITypeIdentifierMap &Map) const {
348   if (!Val)
349     return T();
351   if (const MDNode *MD = dyn_cast<MDNode>(Val))
352     return T(MD);
354   const MDString *MS = cast<MDString>(Val);
355   // Find the corresponding MDNode.
356   DITypeIdentifierMap::const_iterator Iter = Map.find(MS);
357   assert(Iter != Map.end() && "Identifier not in the type map?");
358   assert(DIDescriptor(Iter->second).isType() &&
359          "MDNode in DITypeIdentifierMap should be a DIType.");
360   return T(Iter->second);
363 template <typename T> StringRef DIRef<T>::getName() const {
364   if (!Val)
365     return StringRef();
367   if (const MDNode *MD = dyn_cast<MDNode>(Val))
368     return T(MD).getName();
370   const MDString *MS = cast<MDString>(Val);
371   return MS->getString();
374 /// \brief Handle fields that are references to DIScopes.
375 template <> DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const;
376 /// \brief Specialize DIRef constructor for DIScopeRef.
377 template <> DIRef<DIScope>::DIRef(const Metadata *V);
379 /// \brief Handle fields that are references to DITypes.
380 template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const;
381 /// \brief Specialize DIRef constructor for DITypeRef.
382 template <> DIRef<DIType>::DIRef(const Metadata *V);
384 /// \briefThis is a wrapper for a type.
385 ///
386 /// FIXME: Types should be factored much better so that CV qualifiers and
387 /// others do not require a huge and empty descriptor full of zeros.
388 class DIType : public DIScope {
389 protected:
390   friend class DIDescriptor;
391   void printInternal(raw_ostream &OS) const;
393 public:
394   explicit DIType(const MDNode *N = nullptr) : DIScope(N) {}
395   operator DITypeRef () const {
396     assert(isType() &&
397            "constructing DITypeRef from an MDNode that is not a type");
398     return DITypeRef(&*getRef());
399   }
401   bool Verify() const;
403   DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(2); }
404   StringRef getName() const { return getHeaderField(1); }
405   unsigned getLineNumber() const {
406     return getHeaderFieldAs<unsigned>(2);
407   }
408   uint64_t getSizeInBits() const {
409     return getHeaderFieldAs<unsigned>(3);
410   }
411   uint64_t getAlignInBits() const {
412     return getHeaderFieldAs<unsigned>(4);
413   }
414   // FIXME: Offset is only used for DW_TAG_member nodes.  Making every type
415   // carry this is just plain insane.
416   uint64_t getOffsetInBits() const {
417     return getHeaderFieldAs<unsigned>(5);
418   }
419   unsigned getFlags() const { return getHeaderFieldAs<unsigned>(6); }
420   bool isPrivate() const {
421     return (getFlags() & FlagAccessibility) == FlagPrivate;
422   }
423   bool isProtected() const {
424     return (getFlags() & FlagAccessibility) == FlagProtected;
425   }
426   bool isPublic() const {
427     return (getFlags() & FlagAccessibility) == FlagPublic;
428   }
429   bool isForwardDecl() const { return (getFlags() & FlagFwdDecl) != 0; }
430   bool isAppleBlockExtension() const {
431     return (getFlags() & FlagAppleBlock) != 0;
432   }
433   bool isBlockByrefStruct() const {
434     return (getFlags() & FlagBlockByrefStruct) != 0;
435   }
436   bool isVirtual() const { return (getFlags() & FlagVirtual) != 0; }
437   bool isArtificial() const { return (getFlags() & FlagArtificial) != 0; }
438   bool isObjectPointer() const { return (getFlags() & FlagObjectPointer) != 0; }
439   bool isObjcClassComplete() const {
440     return (getFlags() & FlagObjcClassComplete) != 0;
441   }
442   bool isVector() const { return (getFlags() & FlagVector) != 0; }
443   bool isStaticMember() const { return (getFlags() & FlagStaticMember) != 0; }
444   bool isLValueReference() const {
445     return (getFlags() & FlagLValueReference) != 0;
446   }
447   bool isRValueReference() const {
448     return (getFlags() & FlagRValueReference) != 0;
449   }
450   bool isValid() const { return DbgNode && isType(); }
451 };
453 /// \brief A basic type, like 'int' or 'float'.
454 class DIBasicType : public DIType {
455 public:
456   explicit DIBasicType(const MDNode *N = nullptr) : DIType(N) {}
458   unsigned getEncoding() const { return getHeaderFieldAs<unsigned>(7); }
460   bool Verify() const;
461 };
463 /// \brief A simple derived type
464 ///
465 /// Like a const qualified type, a typedef, a pointer or reference, et cetera.
466 /// Or, a data member of a class/struct/union.
467 class DIDerivedType : public DIType {
468   friend class DIDescriptor;
469   void printInternal(raw_ostream &OS) const;
471 public:
472   explicit DIDerivedType(const MDNode *N = nullptr) : DIType(N) {}
474   DITypeRef getTypeDerivedFrom() const { return getFieldAs<DITypeRef>(3); }
476   /// \brief Return property node, if this ivar is associated with one.
477   MDNode *getObjCProperty() const;
479   DITypeRef getClassType() const {
480     assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
481     return getFieldAs<DITypeRef>(4);
482   }
484   Constant *getConstant() const {
485     assert((getTag() == dwarf::DW_TAG_member) && isStaticMember());
486     return getConstantField(4);
487   }
489   bool Verify() const;
490 };
492 /// \brief Types that refer to multiple other types.
493 ///
494 /// This descriptor holds a type that can refer to multiple other types, like a
495 /// function or struct.
496 ///
497 /// DICompositeType is derived from DIDerivedType because some
498 /// composite types (such as enums) can be derived from basic types
499 // FIXME: Make this derive from DIType directly & just store the
500 // base type in a single DIType field.
501 class DICompositeType : public DIDerivedType {
502   friend class DIBuilder;
503   friend class DIDescriptor;
504   void printInternal(raw_ostream &OS) const;
506   /// \brief Set the array of member DITypes.
507   void setArraysHelper(MDNode *Elements, MDNode *TParams);
509 public:
510   explicit DICompositeType(const MDNode *N = nullptr) : DIDerivedType(N) {}
512   DIArray getElements() const {
513     assert(!isSubroutineType() && "no elements for DISubroutineType");
514     return getFieldAs<DIArray>(4);
515   }
517 private:
518   template <typename T>
519   void setArrays(DITypedArray<T> Elements, DIArray TParams = DIArray()) {
520     assert((!TParams || DbgNode->getNumOperands() == 8) &&
521            "If you're setting the template parameters this should include a slot "
522            "for that!");
523     setArraysHelper(Elements, TParams);
524   }
526 public:
527   unsigned getRunTimeLang() const {
528     return getHeaderFieldAs<unsigned>(7);
529   }
530   DITypeRef getContainingType() const { return getFieldAs<DITypeRef>(5); }
532 private:
533   /// \brief Set the containing type.
534   void setContainingType(DICompositeType ContainingType);
536 public:
537   DIArray getTemplateParams() const { return getFieldAs<DIArray>(6); }
538   MDString *getIdentifier() const;
540   bool Verify() const;
541 };
543 class DISubroutineType : public DICompositeType {
544 public:
545   explicit DISubroutineType(const MDNode *N = nullptr) : DICompositeType(N) {}
546   DITypedArray<DITypeRef> getTypeArray() const {
547     return getFieldAs<DITypedArray<DITypeRef>>(4);
548   }
549 };
551 /// \brief This is a wrapper for a file.
552 class DIFile : public DIScope {
553   friend class DIDescriptor;
555 public:
556   explicit DIFile(const MDNode *N = nullptr) : DIScope(N) {}
558   /// \brief Retrieve the MDNode for the directory/file pair.
559   MDNode *getFileNode() const;
560   bool Verify() const;
561 };
563 /// \brief A wrapper for a compile unit.
564 class DICompileUnit : public DIScope {
565   friend class DIDescriptor;
566   void printInternal(raw_ostream &OS) const;
568 public:
569   explicit DICompileUnit(const MDNode *N = nullptr) : DIScope(N) {}
571   dwarf::SourceLanguage getLanguage() const {
572     return static_cast<dwarf::SourceLanguage>(getHeaderFieldAs<unsigned>(1));
573   }
574   StringRef getProducer() const { return getHeaderField(2); }
576   bool isOptimized() const { return getHeaderFieldAs<bool>(3) != 0; }
577   StringRef getFlags() const { return getHeaderField(4); }
578   unsigned getRunTimeVersion() const { return getHeaderFieldAs<unsigned>(5); }
580   DIArray getEnumTypes() const;
581   DIArray getRetainedTypes() const;
582   DIArray getSubprograms() const;
583   DIArray getGlobalVariables() const;
584   DIArray getImportedEntities() const;
586   void replaceSubprograms(DIArray Subprograms);
587   void replaceGlobalVariables(DIArray GlobalVariables);
589   StringRef getSplitDebugFilename() const { return getHeaderField(6); }
590   unsigned getEmissionKind() const { return getHeaderFieldAs<unsigned>(7); }
592   bool Verify() const;
593 };
595 /// \brief This is a wrapper for a subprogram (e.g. a function).
596 class DISubprogram : public DIScope {
597   friend class DIDescriptor;
598   void printInternal(raw_ostream &OS) const;
600 public:
601   explicit DISubprogram(const MDNode *N = nullptr) : DIScope(N) {}
603   StringRef getName() const { return getHeaderField(1); }
604   StringRef getDisplayName() const { return getHeaderField(2); }
605   StringRef getLinkageName() const { return getHeaderField(3); }
606   unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(4); }
608   /// \brief Check if this is local (like 'static' in C).
609   unsigned isLocalToUnit() const { return getHeaderFieldAs<unsigned>(5); }
610   unsigned isDefinition() const { return getHeaderFieldAs<unsigned>(6); }
612   unsigned getVirtuality() const { return getHeaderFieldAs<unsigned>(7); }
613   unsigned getVirtualIndex() const { return getHeaderFieldAs<unsigned>(8); }
615   unsigned getFlags() const { return getHeaderFieldAs<unsigned>(9); }
617   unsigned isOptimized() const { return getHeaderFieldAs<bool>(10); }
619   /// \brief Get the beginning of the scope of the function (not the name).
620   unsigned getScopeLineNumber() const { return getHeaderFieldAs<unsigned>(11); }
622   DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(2); }
623   DISubroutineType getType() const { return getFieldAs<DISubroutineType>(3); }
625   DITypeRef getContainingType() const { return getFieldAs<DITypeRef>(4); }
627   bool Verify() const;
629   /// \brief Check if this provides debugging information for the function F.
630   bool describes(const Function *F);
632   Function *getFunction() const { return getFunctionField(5); }
633   void replaceFunction(Function *F) { replaceFunctionField(5, F); }
634   DIArray getTemplateParams() const { return getFieldAs<DIArray>(6); }
635   DISubprogram getFunctionDeclaration() const {
636     return getFieldAs<DISubprogram>(7);
637   }
638   MDNode *getVariablesNodes() const;
639   DIArray getVariables() const;
641   unsigned isArtificial() const { return (getFlags() & FlagArtificial) != 0; }
642   /// \brief Check for the "private" access specifier.
643   bool isPrivate() const {
644     return (getFlags() & FlagAccessibility) == FlagPrivate;
645   }
646   /// \brief Check for the "protected" access specifier.
647   bool isProtected() const {
648     return (getFlags() & FlagAccessibility) == FlagProtected;
649   }
650   /// \brief Check for the "public" access specifier.
651   bool isPublic() const {
652     return (getFlags() & FlagAccessibility) == FlagPublic;
653   }
654   /// \brief Check for "explicit".
655   bool isExplicit() const { return (getFlags() & FlagExplicit) != 0; }
656   /// \brief Check if this is prototyped.
657   bool isPrototyped() const { return (getFlags() & FlagPrototyped) != 0; }
659   /// \brief Check if this is reference-qualified.
660   ///
661   /// Return true if this subprogram is a C++11 reference-qualified non-static
662   /// member function (void foo() &).
663   unsigned isLValueReference() const {
664     return (getFlags() & FlagLValueReference) != 0;
665   }
667   /// \brief Check if this is rvalue-reference-qualified.
668   ///
669   /// Return true if this subprogram is a C++11 rvalue-reference-qualified
670   /// non-static member function (void foo() &&).
671   unsigned isRValueReference() const {
672     return (getFlags() & FlagRValueReference) != 0;
673   }
675 };
677 /// \brief This is a wrapper for a lexical block.
678 class DILexicalBlock : public DIScope {
679 public:
680   explicit DILexicalBlock(const MDNode *N = nullptr) : DIScope(N) {}
681   DIScope getContext() const { return getFieldAs<DIScope>(2); }
682   unsigned getLineNumber() const {
683     return getHeaderFieldAs<unsigned>(1);
684   }
685   unsigned getColumnNumber() const {
686     return getHeaderFieldAs<unsigned>(2);
687   }
688   bool Verify() const;
689 };
691 /// \brief This is a wrapper for a lexical block with a filename change.
692 class DILexicalBlockFile : public DIScope {
693 public:
694   explicit DILexicalBlockFile(const MDNode *N = nullptr) : DIScope(N) {}
695   DIScope getContext() const {
696     if (getScope().isSubprogram())
697       return getScope();
698     return getScope().getContext();
699   }
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); }
704   bool Verify() const;
705 };
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;
712 public:
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); }
717   bool Verify() const;
718 };
720 /// \brief This is a wrapper for template type parameter.
721 class DITemplateTypeParameter : public DIDescriptor {
722 public:
723   explicit DITemplateTypeParameter(const MDNode *N = nullptr)
724     : DIDescriptor(N) {}
726   StringRef getName() const { return getHeaderField(1); }
727   unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(2); }
728   unsigned getColumnNumber() const { return getHeaderFieldAs<unsigned>(3); }
730   DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(1); }
731   DITypeRef getType() const { return getFieldAs<DITypeRef>(2); }
732   StringRef getFilename() const { return getFieldAs<DIFile>(3).getFilename(); }
733   StringRef getDirectory() const {
734     return getFieldAs<DIFile>(3).getDirectory();
735   }
736   bool Verify() const;
737 };
739 /// \brief This is a wrapper for template value parameter.
740 class DITemplateValueParameter : public DIDescriptor {
741 public:
742   explicit DITemplateValueParameter(const MDNode *N = nullptr)
743     : DIDescriptor(N) {}
745   StringRef getName() const { return getHeaderField(1); }
746   unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(2); }
747   unsigned getColumnNumber() const { return getHeaderFieldAs<unsigned>(3); }
749   DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(1); }
750   DITypeRef getType() const { return getFieldAs<DITypeRef>(2); }
751   Metadata *getValue() const;
752   StringRef getFilename() const { return getFieldAs<DIFile>(4).getFilename(); }
753   StringRef getDirectory() const {
754     return getFieldAs<DIFile>(4).getDirectory();
755   }
756   bool Verify() const;
757 };
759 /// \brief This is a wrapper for a global variable.
760 class DIGlobalVariable : public DIDescriptor {
761   friend class DIDescriptor;
762   void printInternal(raw_ostream &OS) const;
764 public:
765   explicit DIGlobalVariable(const MDNode *N = nullptr) : DIDescriptor(N) {}
767   StringRef getName() const { return getHeaderField(1); }
768   StringRef getDisplayName() const { return getHeaderField(2); }
769   StringRef getLinkageName() const { return getHeaderField(3); }
770   unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(4); }
771   unsigned isLocalToUnit() const { return getHeaderFieldAs<bool>(5); }
772   unsigned isDefinition() const { return getHeaderFieldAs<bool>(6); }
774   DIScope getContext() const { return getFieldAs<DIScope>(1); }
775   StringRef getFilename() const { return getFieldAs<DIFile>(2).getFilename(); }
776   StringRef getDirectory() const {
777     return getFieldAs<DIFile>(2).getDirectory();
778   }
779   DITypeRef getType() const { return getFieldAs<DITypeRef>(3); }
781   GlobalVariable *getGlobal() const { return getGlobalVariableField(4); }
782   Constant *getConstant() const { return getConstantField(4); }
783   DIDerivedType getStaticDataMemberDeclaration() const {
784     return getFieldAs<DIDerivedType>(5);
785   }
787   bool Verify() const;
788 };
790 /// \brief This is a wrapper for a variable (e.g. parameter, local, global etc).
791 class DIVariable : public DIDescriptor {
792   friend class DIDescriptor;
793   void printInternal(raw_ostream &OS) const;
795 public:
796   explicit DIVariable(const MDNode *N = nullptr) : DIDescriptor(N) {}
798   StringRef getName() const { return getHeaderField(1); }
799   unsigned getLineNumber() const {
800     // FIXME: Line number and arg number shouldn't be merged together like this.
801     return (getHeaderFieldAs<unsigned>(2) << 8) >> 8;
802   }
803   unsigned getArgNumber() const { return getHeaderFieldAs<unsigned>(2) >> 24; }
805   DIScope getContext() const { return getFieldAs<DIScope>(1); }
806   DIFile getFile() const { return getFieldAs<DIFile>(2); }
807   DITypeRef getType() const { return getFieldAs<DITypeRef>(3); }
809   /// \brief Return true if this variable is marked as "artificial".
810   bool isArtificial() const {
811     return (getHeaderFieldAs<unsigned>(3) & FlagArtificial) != 0;
812   }
814   bool isObjectPointer() const {
815     return (getHeaderFieldAs<unsigned>(3) & FlagObjectPointer) != 0;
816   }
818   /// \brief If this variable is inlined then return inline location.
819   MDNode *getInlinedAt() const;
821   bool Verify() const;
823   /// \brief Check if this is a "__block" variable (Apple Blocks).
824   bool isBlockByrefVariable(const DITypeIdentifierMap &Map) const {
825     return (getType().resolve(Map)).isBlockByrefStruct();
826   }
828   /// \brief Check if this is an inlined function argument.
829   bool isInlinedFnArgument(const Function *CurFn);
831   /// \brief Return the size reported by the variable's type.
832   unsigned getSizeInBits(const DITypeIdentifierMap &Map);
834   void printExtendedName(raw_ostream &OS) const;
835 };
837 /// \brief A complex location expression.
838 class DIExpression : public DIDescriptor {
839   friend class DIDescriptor;
840   void printInternal(raw_ostream &OS) const;
842 public:
843   explicit DIExpression(const MDNode *N = nullptr) : DIDescriptor(N) {}
845   bool Verify() const;
847   /// \brief Return the number of elements in the complex expression.
848   unsigned getNumElements() const {
849     if (!DbgNode)
850       return 0;
851     unsigned N = getNumHeaderFields();
852     assert(N > 0 && "missing tag");
853     return N - 1;
854   }
856   /// \brief return the Idx'th complex address element.
857   uint64_t getElement(unsigned Idx) const;
859   /// \brief Return whether this is a piece of an aggregate variable.
860   bool isVariablePiece() const;
861   /// \brief Return the offset of this piece in bytes.
862   uint64_t getPieceOffset() const;
863   /// \brief Return the size of this piece in bytes.
864   uint64_t getPieceSize() const;
865 };
867 /// \brief This object holds location information.
868 ///
869 /// This object is not associated with any DWARF tag.
870 class DILocation : public DIDescriptor {
871 public:
872   explicit DILocation(const MDNode *N) : DIDescriptor(N) {}
874   unsigned getLineNumber() const {
875     if (auto *L = dyn_cast_or_null<MDLocation>(DbgNode))
876       return L->getLine();
877     return 0;
878   }
879   unsigned getColumnNumber() const {
880     if (auto *L = dyn_cast_or_null<MDLocation>(DbgNode))
881       return L->getColumn();
882     return 0;
883   }
884   DIScope getScope() const {
885     if (auto *L = dyn_cast_or_null<MDLocation>(DbgNode))
886       return DIScope(dyn_cast_or_null<MDNode>(L->getScope()));
887     return DIScope(nullptr);
888   }
889   DILocation getOrigLocation() const {
890     if (auto *L = dyn_cast_or_null<MDLocation>(DbgNode))
891       return DILocation(dyn_cast_or_null<MDNode>(L->getInlinedAt()));
892     return DILocation(nullptr);
893   }
894   StringRef getFilename() const { return getScope().getFilename(); }
895   StringRef getDirectory() const { return getScope().getDirectory(); }
896   bool Verify() const;
897   bool atSameLineAs(const DILocation &Other) const {
898     return (getLineNumber() == Other.getLineNumber() &&
899             getFilename() == Other.getFilename());
900   }
901   /// \brief Get the DWAF discriminator.
902   ///
903   /// DWARF discriminators are used to distinguish identical file locations for
904   /// instructions that are on different basic blocks. If two instructions are
905   /// inside the same lexical block and are in different basic blocks, we
906   /// create a new lexical block with identical location as the original but
907   /// with a different discriminator value
908   /// (lib/Transforms/Util/AddDiscriminators.cpp for details).
909   unsigned getDiscriminator() const {
910     // Since discriminators are associated with lexical blocks, make
911     // sure this location is a lexical block before retrieving its
912     // value.
913     return getScope().isLexicalBlockFile()
914                ? DILexicalBlockFile(
915                      cast<MDNode>(cast<MDLocation>(DbgNode)->getScope()))
916                      .getDiscriminator()
917                : 0;
918   }
920   /// \brief Generate a new discriminator value for this location.
921   unsigned computeNewDiscriminator(LLVMContext &Ctx);
923   /// \brief Return a copy of this location with a different scope.
924   DILocation copyWithNewScope(LLVMContext &Ctx, DILexicalBlockFile NewScope);
925 };
927 class DIObjCProperty : public DIDescriptor {
928   friend class DIDescriptor;
929   void printInternal(raw_ostream &OS) const;
931 public:
932   explicit DIObjCProperty(const MDNode *N) : DIDescriptor(N) {}
934   StringRef getObjCPropertyName() const { return getHeaderField(1); }
935   DIFile getFile() const { return getFieldAs<DIFile>(1); }
936   unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(2); }
938   StringRef getObjCPropertyGetterName() const { return getHeaderField(3); }
939   StringRef getObjCPropertySetterName() const { return getHeaderField(4); }
940   unsigned getAttributes() const { return getHeaderFieldAs<unsigned>(5); }
941   bool isReadOnlyObjCProperty() const {
942     return (getAttributes() & dwarf::DW_APPLE_PROPERTY_readonly) != 0;
943   }
944   bool isReadWriteObjCProperty() const {
945     return (getAttributes() & dwarf::DW_APPLE_PROPERTY_readwrite) != 0;
946   }
947   bool isAssignObjCProperty() const {
948     return (getAttributes() & dwarf::DW_APPLE_PROPERTY_assign) != 0;
949   }
950   bool isRetainObjCProperty() const {
951     return (getAttributes() & dwarf::DW_APPLE_PROPERTY_retain) != 0;
952   }
953   bool isCopyObjCProperty() const {
954     return (getAttributes() & dwarf::DW_APPLE_PROPERTY_copy) != 0;
955   }
956   bool isNonAtomicObjCProperty() const {
957     return (getAttributes() & dwarf::DW_APPLE_PROPERTY_nonatomic) != 0;
958   }
960   /// \brief Get the type.
961   ///
962   /// \note Objective-C doesn't have an ODR, so there is no benefit in storing
963   /// the type as a DITypeRef here.
964   DIType getType() const { return getFieldAs<DIType>(2); }
966   bool Verify() const;
967 };
969 /// \brief An imported module (C++ using directive or similar).
970 class DIImportedEntity : public DIDescriptor {
971   friend class DIDescriptor;
972   void printInternal(raw_ostream &OS) const;
974 public:
975   explicit DIImportedEntity(const MDNode *N) : DIDescriptor(N) {}
976   DIScope getContext() const { return getFieldAs<DIScope>(1); }
977   DIScopeRef getEntity() const { return getFieldAs<DIScopeRef>(2); }
978   unsigned getLineNumber() const { return getHeaderFieldAs<unsigned>(1); }
979   StringRef getName() const { return getHeaderField(2); }
980   bool Verify() const;
981 };
983 /// \brief Find subprogram that is enclosing this scope.
984 DISubprogram getDISubprogram(const MDNode *Scope);
986 /// \brief Find debug info for a given function.
987 /// \returns a valid DISubprogram, if found. Otherwise, it returns an empty
988 /// DISubprogram.
989 DISubprogram getDISubprogram(const Function *F);
991 /// \brief Find underlying composite type.
992 DICompositeType getDICompositeType(DIType T);
994 /// \brief Create a new inlined variable based on current variable.
995 ///
996 /// @param DV            Current Variable.
997 /// @param InlinedScope  Location at current variable is inlined.
998 DIVariable createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
999                                  LLVMContext &VMContext);
1001 /// \brief Remove inlined scope from the variable.
1002 DIVariable cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext);
1004 /// \brief Generate map by visiting all retained types.
1005 DITypeIdentifierMap generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes);
1007 /// \brief Strip debug info in the module if it exists.
1008 ///
1009 /// To do this, we remove all calls to the debugger intrinsics and any named
1010 /// metadata for debugging. We also remove debug locations for instructions.
1011 /// Return true if module is modified.
1012 bool StripDebugInfo(Module &M);
1014 /// \brief Return Debug Info Metadata Version by checking module flags.
1015 unsigned getDebugMetadataVersionFromModule(const Module &M);
1017 /// \brief Utility to find all debug info in a module.
1018 ///
1019 /// DebugInfoFinder tries to list all debug info MDNodes used in a module. To
1020 /// list debug info MDNodes used by an instruction, DebugInfoFinder uses
1021 /// processDeclare, processValue and processLocation to handle DbgDeclareInst,
1022 /// DbgValueInst and DbgLoc attached to instructions. processModule will go
1023 /// through all DICompileUnits in llvm.dbg.cu and list debug info MDNodes
1024 /// used by the CUs.
1025 class DebugInfoFinder {
1026 public:
1027   DebugInfoFinder() : TypeMapInitialized(false) {}
1029   /// \brief Process entire module and collect debug info anchors.
1030   void processModule(const Module &M);
1032   /// \brief Process DbgDeclareInst.
1033   void processDeclare(const Module &M, const DbgDeclareInst *DDI);
1034   /// \brief Process DbgValueInst.
1035   void processValue(const Module &M, const DbgValueInst *DVI);
1036   /// \brief Process DILocation.
1037   void processLocation(const Module &M, DILocation Loc);
1039   /// \brief Process DIExpression.
1040   void processExpression(DIExpression Expr);
1042   /// \brief Clear all lists.
1043   void reset();
1045 private:
1046   void InitializeTypeMap(const Module &M);
1048   void processType(DIType DT);
1049   void processSubprogram(DISubprogram SP);
1050   void processScope(DIScope Scope);
1051   bool addCompileUnit(DICompileUnit CU);
1052   bool addGlobalVariable(DIGlobalVariable DIG);
1053   bool addSubprogram(DISubprogram SP);
1054   bool addType(DIType DT);
1055   bool addScope(DIScope Scope);
1057 public:
1058   typedef SmallVectorImpl<DICompileUnit>::const_iterator compile_unit_iterator;
1059   typedef SmallVectorImpl<DISubprogram>::const_iterator subprogram_iterator;
1060   typedef SmallVectorImpl<DIGlobalVariable>::const_iterator global_variable_iterator;
1061   typedef SmallVectorImpl<DIType>::const_iterator type_iterator;
1062   typedef SmallVectorImpl<DIScope>::const_iterator scope_iterator;
1064   iterator_range<compile_unit_iterator> compile_units() const {
1065     return iterator_range<compile_unit_iterator>(CUs.begin(), CUs.end());
1066   }
1068   iterator_range<subprogram_iterator> subprograms() const {
1069     return iterator_range<subprogram_iterator>(SPs.begin(), SPs.end());
1070   }
1072   iterator_range<global_variable_iterator> global_variables() const {
1073     return iterator_range<global_variable_iterator>(GVs.begin(), GVs.end());
1074   }
1076   iterator_range<type_iterator> types() const {
1077     return iterator_range<type_iterator>(TYs.begin(), TYs.end());
1078   }
1080   iterator_range<scope_iterator> scopes() const {
1081     return iterator_range<scope_iterator>(Scopes.begin(), Scopes.end());
1082   }
1084   unsigned compile_unit_count() const { return CUs.size(); }
1085   unsigned global_variable_count() const { return GVs.size(); }
1086   unsigned subprogram_count() const { return SPs.size(); }
1087   unsigned type_count() const { return TYs.size(); }
1088   unsigned scope_count() const { return Scopes.size(); }
1090 private:
1091   SmallVector<DICompileUnit, 8> CUs;
1092   SmallVector<DISubprogram, 8> SPs;
1093   SmallVector<DIGlobalVariable, 8> GVs;
1094   SmallVector<DIType, 8> TYs;
1095   SmallVector<DIScope, 8> Scopes;
1096   SmallPtrSet<MDNode *, 64> NodesSeen;
1097   DITypeIdentifierMap TypeIdentifierMap;
1099   /// \brief Specify if TypeIdentifierMap is initialized.
1100   bool TypeMapInitialized;
1101 };
1103 DenseMap<const Function *, DISubprogram> makeSubprogramMap(const Module &M);
1105 } // end namespace llvm
1107 #endif