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 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_IR_DEBUGINFO_H
  18 #define LLVM_IR_DEBUGINFO_H
  19
  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/IR/Metadata.h"
  25 #include "llvm/Support/Casting.h"
  26 #include "llvm/Support/Dwarf.h"
  27
  28 namespace llvm {
  29 class BasicBlock;
  30 class Constant;
  31 class Function;
  32 class GlobalVariable;
  33 class Module;
  34 class Type;
  35 class Value;
  36 class DbgDeclareInst;
  37 class DbgValueInst;
  38 class Instruction;
  39 class MDNode;
  40 class MDString;
  41 class NamedMDNode;
  42 class LLVMContext;
  43 class raw_ostream;
  44
  45 class DIFile;
  46 class DISubprogram;
  47 class DILexicalBlock;
  48 class DILexicalBlockFile;
  49 class DIVariable;
  50 class DIType;
  51 class DIScope;
  52 class DIObjCProperty;
  53
  54 /// Maps from type identifier to the actual MDNode.
  55 typedef DenseMap<const MDString *, MDNode *> DITypeIdentifierMap;
  56
  57 /// DIDescriptor - A thin wraper around MDNode to access encoded debug info.
  58 /// This should not be stored in a container, because the underlying MDNode
  59 /// may change in certain situations.
  60 class DIDescriptor {
  61   // Befriends DIRef so DIRef can befriend the protected member
  62   // function: getFieldAs<DIRef>.
  63   template <typename T> friend class DIRef;
  64
  65 public:
  66   enum {
  67     FlagPrivate           = 1 << 0,
  68     FlagProtected         = 1 << 1,
  69     FlagFwdDecl           = 1 << 2,
  70     FlagAppleBlock        = 1 << 3,
  71     FlagBlockByrefStruct  = 1 << 4,
  72     FlagVirtual           = 1 << 5,
  73     FlagArtificial        = 1 << 6,
  74     FlagExplicit          = 1 << 7,
  75     FlagPrototyped        = 1 << 8,
  76     FlagObjcClassComplete = 1 << 9,
  77     FlagObjectPointer     = 1 << 10,
  78     FlagVector            = 1 << 11,
  79     FlagStaticMember      = 1 << 12,
  80     FlagIndirectVariable  = 1 << 13,
  81     FlagLValueReference   = 1 << 14,
  82     FlagRValueReference   = 1 << 15
  83   };
  84
  85 protected:
  86   const MDNode *DbgNode;
  87
  88   StringRef getStringField(unsigned Elt) const;
  89   unsigned getUnsignedField(unsigned Elt) const {
  90     return (unsigned)getUInt64Field(Elt);
  91   }
  92   uint64_t getUInt64Field(unsigned Elt) const;
  93   int64_t getInt64Field(unsigned Elt) const;
  94   DIDescriptor getDescriptorField(unsigned Elt) const;
  95
  96   template <typename DescTy> DescTy getFieldAs(unsigned Elt) const {
  97     return DescTy(getDescriptorField(Elt));
  98   }
  99
 100   GlobalVariable *getGlobalVariableField(unsigned Elt) const;
 101   Constant *getConstantField(unsigned Elt) const;
 102   Function *getFunctionField(unsigned Elt) const;
 103   void replaceFunctionField(unsigned Elt, Function *F);
 104
 105 public:
 106   explicit DIDescriptor(const MDNode *N = 0) : DbgNode(N) {}
 107
 108   bool Verify() const;
 109
 110   operator MDNode *() const { return const_cast<MDNode *>(DbgNode); }
 111   MDNode *operator->() const { return const_cast<MDNode *>(DbgNode); }
 112
 113   // An explicit operator bool so that we can do testing of DI values
 114   // easily.
 115   // FIXME: This operator bool isn't actually protecting anything at the
 116   // moment due to the conversion operator above making DIDescriptor nodes
 117   // implicitly convertable to bool.
 118   LLVM_EXPLICIT operator bool() const { return DbgNode != 0; }
 119
 120   bool operator==(DIDescriptor Other) const { return DbgNode == Other.DbgNode; }
 121   bool operator!=(DIDescriptor Other) const { return !operator==(Other); }
 122
 123   uint16_t getTag() const {
 124     return getUnsignedField(0) & ~LLVMDebugVersionMask;
 125   }
 126
 127   bool isDerivedType() const;
 128   bool isCompositeType() const;
 129   bool isBasicType() const;
 130   bool isVariable() const;
 131   bool isSubprogram() const;
 132   bool isGlobalVariable() const;
 133   bool isScope() const;
 134   bool isFile() const;
 135   bool isCompileUnit() const;
 136   bool isNameSpace() const;
 137   bool isLexicalBlockFile() const;
 138   bool isLexicalBlock() const;
 139   bool isSubrange() const;
 140   bool isEnumerator() const;
 141   bool isType() const;
 142   bool isUnspecifiedParameter() const;
 143   bool isTemplateTypeParameter() const;
 144   bool isTemplateValueParameter() const;
 145   bool isObjCProperty() const;
 146   bool isImportedEntity() const;
 147
 148   /// print - print descriptor.
 149   void print(raw_ostream &OS) const;
 150
 151   /// dump - print descriptor to dbgs() with a newline.
 152   void dump() const;
 153 };
 154
 155 /// DISubrange - This is used to represent ranges, for array bounds.
 156 class DISubrange : public DIDescriptor {
 157   friend class DIDescriptor;
 158   void printInternal(raw_ostream &OS) const;
 159
 160 public:
 161   explicit DISubrange(const MDNode *N = 0) : DIDescriptor(N) {}
 162
 163   int64_t getLo() const { return getInt64Field(1); }
 164   int64_t getCount() const { return getInt64Field(2); }
 165   bool Verify() const;
 166 };
 167
 168 /// DIArray - This descriptor holds an array of descriptors.
 169 class DIArray : public DIDescriptor {
 170 public:
 171   explicit DIArray(const MDNode *N = 0) : DIDescriptor(N) {}
 172
 173   unsigned getNumElements() const;
 174   DIDescriptor getElement(unsigned Idx) const {
 175     return getDescriptorField(Idx);
 176   }
 177 };
 178
 179 /// DIEnumerator - A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
 180 /// FIXME: it seems strange that this doesn't have either a reference to the
 181 /// type/precision or a file/line pair for location info.
 182 class DIEnumerator : public DIDescriptor {
 183   friend class DIDescriptor;
 184   void printInternal(raw_ostream &OS) const;
 185
 186 public:
 187   explicit DIEnumerator(const MDNode *N = 0) : DIDescriptor(N) {}
 188
 189   StringRef getName() const { return getStringField(1); }
 190   int64_t getEnumValue() const { return getInt64Field(2); }
 191   bool Verify() const;
 192 };
 193
 194 template <typename T> class DIRef;
 195 typedef DIRef<DIScope> DIScopeRef;
 196 typedef DIRef<DIType> DITypeRef;
 197
 198 /// DIScope - A base class for various scopes.
 199 class DIScope : public DIDescriptor {
 200 protected:
 201   friend class DIDescriptor;
 202   void printInternal(raw_ostream &OS) const;
 203
 204 public:
 205   explicit DIScope(const MDNode *N = 0) : DIDescriptor(N) {}
 206
 207   /// Gets the parent scope for this scope node or returns a
 208   /// default constructed scope.
 209   DIScopeRef getContext() const;
 210   /// If the scope node has a name, return that, else return an empty string.
 211   StringRef getName() const;
 212   StringRef getFilename() const;
 213   StringRef getDirectory() const;
 214
 215   /// Generate a reference to this DIScope. Uses the type identifier instead
 216   /// of the actual MDNode if possible, to help type uniquing.
 217   DIScopeRef getRef() const;
 218 };
 219
 220 /// Represents reference to a DIDescriptor, abstracts over direct and
 221 /// identifier-based metadata references.
 222 template <typename T> class DIRef {
 223   template <typename DescTy>
 224   friend DescTy DIDescriptor::getFieldAs(unsigned Elt) const;
 225   friend DIScopeRef DIScope::getContext() const;
 226   friend DIScopeRef DIScope::getRef() const;
 227
 228   /// Val can be either a MDNode or a MDString, in the latter,
 229   /// MDString specifies the type identifier.
 230   const Value *Val;
 231   explicit DIRef(const Value *V);
 232
 233 public:
 234   T resolve(const DITypeIdentifierMap &Map) const;
 235   StringRef getName() const;
 236   operator Value *() const { return const_cast<Value *>(Val); }
 237 };
 238
 239 template <typename T>
 240 T DIRef<T>::resolve(const DITypeIdentifierMap &Map) const {
 241   if (!Val)
 242     return T();
 243
 244   if (const MDNode *MD = dyn_cast<MDNode>(Val))
 245     return T(MD);
 246
 247   const MDString *MS = cast<MDString>(Val);
 248   // Find the corresponding MDNode.
 249   DITypeIdentifierMap::const_iterator Iter = Map.find(MS);
 250   assert(Iter != Map.end() && "Identifier not in the type map?");
 251   assert(DIDescriptor(Iter->second).isType() &&
 252          "MDNode in DITypeIdentifierMap should be a DIType.");
 253   return T(Iter->second);
 254 }
 255
 256 template <typename T> StringRef DIRef<T>::getName() const {
 257   if (!Val)
 258     return StringRef();
 259
 260   if (const MDNode *MD = dyn_cast<MDNode>(Val))
 261     return T(MD).getName();
 262
 263   const MDString *MS = cast<MDString>(Val);
 264   return MS->getString();
 265 }
 266
 267 /// Specialize getFieldAs to handle fields that are references to DIScopes.
 268 template <> DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const;
 269 /// Specialize DIRef constructor for DIScopeRef.
 270 template <> DIRef<DIScope>::DIRef(const Value *V);
 271
 272 /// Specialize getFieldAs to handle fields that are references to DITypes.
 273 template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const;
 274 /// Specialize DIRef constructor for DITypeRef.
 275 template <> DIRef<DIType>::DIRef(const Value *V);
 276
 277 /// DIType - This is a wrapper for a type.
 278 /// FIXME: Types should be factored much better so that CV qualifiers and
 279 /// others do not require a huge and empty descriptor full of zeros.
 280 class DIType : public DIScope {
 281 protected:
 282   friend class DIDescriptor;
 283   void printInternal(raw_ostream &OS) const;
 284
 285 public:
 286   explicit DIType(const MDNode *N = 0) : DIScope(N) {}
 287
 288   /// Verify - Verify that a type descriptor is well formed.
 289   bool Verify() const;
 290
 291   DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(2); }
 292   StringRef getName() const { return getStringField(3); }
 293   unsigned getLineNumber() const { return getUnsignedField(4); }
 294   uint64_t getSizeInBits() const { return getUInt64Field(5); }
 295   uint64_t getAlignInBits() const { return getUInt64Field(6); }
 296   // FIXME: Offset is only used for DW_TAG_member nodes.  Making every type
 297   // carry this is just plain insane.
 298   uint64_t getOffsetInBits() const { return getUInt64Field(7); }
 299   unsigned getFlags() const { return getUnsignedField(8); }
 300   bool isPrivate() const { return (getFlags() & FlagPrivate) != 0; }
 301   bool isProtected() const { return (getFlags() & FlagProtected) != 0; }
 302   bool isForwardDecl() const { return (getFlags() & FlagFwdDecl) != 0; }
 303   // isAppleBlock - Return true if this is the Apple Blocks extension.
 304   bool isAppleBlockExtension() const {
 305     return (getFlags() & FlagAppleBlock) != 0;
 306   }
 307   bool isBlockByrefStruct() const {
 308     return (getFlags() & FlagBlockByrefStruct) != 0;
 309   }
 310   bool isVirtual() const { return (getFlags() & FlagVirtual) != 0; }
 311   bool isArtificial() const { return (getFlags() & FlagArtificial) != 0; }
 312   bool isObjectPointer() const { return (getFlags() & FlagObjectPointer) != 0; }
 313   bool isObjcClassComplete() const {
 314     return (getFlags() & FlagObjcClassComplete) != 0;
 315   }
 316   bool isVector() const { return (getFlags() & FlagVector) != 0; }
 317   bool isStaticMember() const { return (getFlags() & FlagStaticMember) != 0; }
 318   bool isLValueReference() const {
 319     return (getFlags() & FlagLValueReference) != 0;
 320   }
 321   bool isRValueReference() const {
 322     return (getFlags() & FlagRValueReference) != 0;
 323   }
 324   bool isValid() const { return DbgNode && isType(); }
 325
 326   /// replaceAllUsesWith - Replace all uses of debug info referenced by
 327   /// this descriptor.
 328   void replaceAllUsesWith(DIDescriptor &D);
 329   void replaceAllUsesWith(MDNode *D);
 330 };
 331
 332 /// DIBasicType - A basic type, like 'int' or 'float'.
 333 class DIBasicType : public DIType {
 334 public:
 335   explicit DIBasicType(const MDNode *N = 0) : DIType(N) {}
 336
 337   unsigned getEncoding() const { return getUnsignedField(9); }
 338
 339   /// Verify - Verify that a basic type descriptor is well formed.
 340   bool Verify() const;
 341 };
 342
 343 /// DIDerivedType - A simple derived type, like a const qualified type,
 344 /// a typedef, a pointer or reference, et cetera.  Or, a data member of
 345 /// a class/struct/union.
 346 class DIDerivedType : public DIType {
 347   friend class DIDescriptor;
 348   void printInternal(raw_ostream &OS) const;
 349
 350 public:
 351   explicit DIDerivedType(const MDNode *N = 0) : DIType(N) {}
 352
 353   DITypeRef getTypeDerivedFrom() const { return getFieldAs<DITypeRef>(9); }
 354
 355   /// getObjCProperty - Return property node, if this ivar is
 356   /// associated with one.
 357   MDNode *getObjCProperty() const;
 358
 359   DITypeRef getClassType() const {
 360     assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
 361     return getFieldAs<DITypeRef>(10);
 362   }
 363
 364   Constant *getConstant() const {
 365     assert((getTag() == dwarf::DW_TAG_member) && isStaticMember());
 366     return getConstantField(10);
 367   }
 368
 369   /// Verify - Verify that a derived type descriptor is well formed.
 370   bool Verify() const;
 371 };
 372
 373 /// DICompositeType - This descriptor holds a type that can refer to multiple
 374 /// other types, like a function or struct.
 375 /// DICompositeType is derived from DIDerivedType because some
 376 /// composite types (such as enums) can be derived from basic types
 377 // FIXME: Make this derive from DIType directly & just store the
 378 // base type in a single DIType field.
 379 class DICompositeType : public DIDerivedType {
 380   friend class DIDescriptor;
 381   void printInternal(raw_ostream &OS) const;
 382
 383 public:
 384   explicit DICompositeType(const MDNode *N = 0) : DIDerivedType(N) {}
 385
 386   DIArray getTypeArray() const { return getFieldAs<DIArray>(10); }
 387   void setTypeArray(DIArray Elements, DIArray TParams = DIArray());
 388   unsigned getRunTimeLang() const { return getUnsignedField(11); }
 389   DITypeRef getContainingType() const { return getFieldAs<DITypeRef>(12); }
 390   void setContainingType(DICompositeType ContainingType);
 391   DIArray getTemplateParams() const { return getFieldAs<DIArray>(13); }
 392   MDString *getIdentifier() const;
 393
 394   /// Verify - Verify that a composite type descriptor is well formed.
 395   bool Verify() const;
 396 };
 397
 398 /// DIFile - This is a wrapper for a file.
 399 class DIFile : public DIScope {
 400   friend class DIDescriptor;
 401
 402 public:
 403   explicit DIFile(const MDNode *N = 0) : DIScope(N) {}
 404   MDNode *getFileNode() const;
 405   bool Verify() const;
 406 };
 407
 408 /// DICompileUnit - A wrapper for a compile unit.
 409 class DICompileUnit : public DIScope {
 410   friend class DIDescriptor;
 411   void printInternal(raw_ostream &OS) const;
 412
 413 public:
 414   explicit DICompileUnit(const MDNode *N = 0) : DIScope(N) {}
 415
 416   unsigned getLanguage() const { return getUnsignedField(2); }
 417   StringRef getProducer() const { return getStringField(3); }
 418
 419   bool isOptimized() const { return getUnsignedField(4) != 0; }
 420   StringRef getFlags() const { return getStringField(5); }
 421   unsigned getRunTimeVersion() const { return getUnsignedField(6); }
 422
 423   DIArray getEnumTypes() const;
 424   DIArray getRetainedTypes() const;
 425   DIArray getSubprograms() const;
 426   DIArray getGlobalVariables() const;
 427   DIArray getImportedEntities() const;
 428
 429   StringRef getSplitDebugFilename() const { return getStringField(12); }
 430   unsigned getEmissionKind() const { return getUnsignedField(13); }
 431
 432   /// Verify - Verify that a compile unit is well formed.
 433   bool Verify() const;
 434 };
 435
 436 /// DISubprogram - This is a wrapper for a subprogram (e.g. a function).
 437 class DISubprogram : public DIScope {
 438   friend class DIDescriptor;
 439   void printInternal(raw_ostream &OS) const;
 440
 441 public:
 442   explicit DISubprogram(const MDNode *N = 0) : DIScope(N) {}
 443
 444   DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(2); }
 445   StringRef getName() const { return getStringField(3); }
 446   StringRef getDisplayName() const { return getStringField(4); }
 447   StringRef getLinkageName() const { return getStringField(5); }
 448   unsigned getLineNumber() const { return getUnsignedField(6); }
 449   DICompositeType getType() const { return getFieldAs<DICompositeType>(7); }
 450
 451   /// isLocalToUnit - Return true if this subprogram is local to the current
 452   /// compile unit, like 'static' in C.
 453   unsigned isLocalToUnit() const { return getUnsignedField(8); }
 454   unsigned isDefinition() const { return getUnsignedField(9); }
 455
 456   unsigned getVirtuality() const { return getUnsignedField(10); }
 457   unsigned getVirtualIndex() const { return getUnsignedField(11); }
 458
 459   DITypeRef getContainingType() const { return getFieldAs<DITypeRef>(12); }
 460
 461   unsigned getFlags() const { return getUnsignedField(13); }
 462
 463   unsigned isArtificial() const {
 464     return (getUnsignedField(13) & FlagArtificial) != 0;
 465   }
 466   /// isPrivate - Return true if this subprogram has "private"
 467   /// access specifier.
 468   bool isPrivate() const { return (getUnsignedField(13) & FlagPrivate) != 0; }
 469   /// isProtected - Return true if this subprogram has "protected"
 470   /// access specifier.
 471   bool isProtected() const {
 472     return (getUnsignedField(13) & FlagProtected) != 0;
 473   }
 474   /// isExplicit - Return true if this subprogram is marked as explicit.
 475   bool isExplicit() const { return (getUnsignedField(13) & FlagExplicit) != 0; }
 476   /// isPrototyped - Return true if this subprogram is prototyped.
 477   bool isPrototyped() const {
 478     return (getUnsignedField(13) & FlagPrototyped) != 0;
 479   }
 480
 481   /// Return true if this subprogram is a C++11 reference-qualified
 482   /// non-static member function (void foo() &).
 483   unsigned isLValueReference() const {
 484     return (getUnsignedField(13) & FlagLValueReference) != 0;
 485   }
 486
 487   /// Return true if this subprogram is a C++11
 488   /// rvalue-reference-qualified non-static member function
 489   /// (void foo() &&).
 490   unsigned isRValueReference() const {
 491     return (getUnsignedField(13) & FlagRValueReference) != 0;
 492   }
 493
 494   unsigned isOptimized() const;
 495
 496   /// Verify - Verify that a subprogram descriptor is well formed.
 497   bool Verify() const;
 498
 499   /// describes - Return true if this subprogram provides debugging
 500   /// information for the function F.
 501   bool describes(const Function *F);
 502
 503   Function *getFunction() const { return getFunctionField(15); }
 504   void replaceFunction(Function *F) { replaceFunctionField(15, F); }
 505   DIArray getTemplateParams() const { return getFieldAs<DIArray>(16); }
 506   DISubprogram getFunctionDeclaration() const {
 507     return getFieldAs<DISubprogram>(17);
 508   }
 509   MDNode *getVariablesNodes() const;
 510   DIArray getVariables() const;
 511
 512   /// getScopeLineNumber - Get the beginning of the scope of the
 513   /// function, not necessarily where the name of the program
 514   /// starts.
 515   unsigned getScopeLineNumber() const { return getUnsignedField(19); }
 516 };
 517
 518 /// DILexicalBlock - This is a wrapper for a lexical block.
 519 class DILexicalBlock : public DIScope {
 520 public:
 521   explicit DILexicalBlock(const MDNode *N = 0) : DIScope(N) {}
 522   DIScope getContext() const { return getFieldAs<DIScope>(2); }
 523   unsigned getLineNumber() const { return getUnsignedField(3); }
 524   unsigned getColumnNumber() const { return getUnsignedField(4); }
 525   unsigned getDiscriminator() const { return getUnsignedField(5); }
 526   bool Verify() const;
 527 };
 528
 529 /// DILexicalBlockFile - This is a wrapper for a lexical block with
 530 /// a filename change.
 531 class DILexicalBlockFile : public DIScope {
 532 public:
 533   explicit DILexicalBlockFile(const MDNode *N = 0) : DIScope(N) {}
 534   DIScope getContext() const {
 535     if (getScope().isSubprogram())
 536       return getScope();
 537     return getScope().getContext();
 538   }
 539   unsigned getLineNumber() const { return getScope().getLineNumber(); }
 540   unsigned getColumnNumber() const { return getScope().getColumnNumber(); }
 541   DILexicalBlock getScope() const { return getFieldAs<DILexicalBlock>(2); }
 542   bool Verify() const;
 543 };
 544
 545 /// DINameSpace - A wrapper for a C++ style name space.
 546 class DINameSpace : public DIScope {
 547   friend class DIDescriptor;
 548   void printInternal(raw_ostream &OS) const;
 549
 550 public:
 551   explicit DINameSpace(const MDNode *N = 0) : DIScope(N) {}
 552   DIScope getContext() const { return getFieldAs<DIScope>(2); }
 553   StringRef getName() const { return getStringField(3); }
 554   unsigned getLineNumber() const { return getUnsignedField(4); }
 555   bool Verify() const;
 556 };
 557
 558 /// DIUnspecifiedParameter - This is a wrapper for unspecified parameters.
 559 class DIUnspecifiedParameter : public DIDescriptor {
 560 public:
 561   explicit DIUnspecifiedParameter(const MDNode *N = 0) : DIDescriptor(N) {}
 562   bool Verify() const;
 563 };
 564
 565 /// DITemplateTypeParameter - This is a wrapper for template type parameter.
 566 class DITemplateTypeParameter : public DIDescriptor {
 567 public:
 568   explicit DITemplateTypeParameter(const MDNode *N = 0) : DIDescriptor(N) {}
 569
 570   DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(1); }
 571   StringRef getName() const { return getStringField(2); }
 572   DITypeRef getType() const { return getFieldAs<DITypeRef>(3); }
 573   StringRef getFilename() const { return getFieldAs<DIFile>(4).getFilename(); }
 574   StringRef getDirectory() const {
 575     return getFieldAs<DIFile>(4).getDirectory();
 576   }
 577   unsigned getLineNumber() const { return getUnsignedField(5); }
 578   unsigned getColumnNumber() const { return getUnsignedField(6); }
 579   bool Verify() const;
 580 };
 581
 582 /// DITemplateValueParameter - This is a wrapper for template value parameter.
 583 class DITemplateValueParameter : public DIDescriptor {
 584 public:
 585   explicit DITemplateValueParameter(const MDNode *N = 0) : DIDescriptor(N) {}
 586
 587   DIScopeRef getContext() const { return getFieldAs<DIScopeRef>(1); }
 588   StringRef getName() const { return getStringField(2); }
 589   DITypeRef getType() const { return getFieldAs<DITypeRef>(3); }
 590   Value *getValue() const;
 591   StringRef getFilename() const { return getFieldAs<DIFile>(5).getFilename(); }
 592   StringRef getDirectory() const {
 593     return getFieldAs<DIFile>(5).getDirectory();
 594   }
 595   unsigned getLineNumber() const { return getUnsignedField(6); }
 596   unsigned getColumnNumber() const { return getUnsignedField(7); }
 597   bool Verify() const;
 598 };
 599
 600 /// DIGlobalVariable - This is a wrapper for a global variable.
 601 class DIGlobalVariable : public DIDescriptor {
 602   friend class DIDescriptor;
 603   void printInternal(raw_ostream &OS) const;
 604
 605 public:
 606   explicit DIGlobalVariable(const MDNode *N = 0) : DIDescriptor(N) {}
 607
 608   DIScope getContext() const { return getFieldAs<DIScope>(2); }
 609   StringRef getName() const { return getStringField(3); }
 610   StringRef getDisplayName() const { return getStringField(4); }
 611   StringRef getLinkageName() const { return getStringField(5); }
 612   StringRef getFilename() const { return getFieldAs<DIFile>(6).getFilename(); }
 613   StringRef getDirectory() const {
 614     return getFieldAs<DIFile>(6).getDirectory();
 615   }
 616
 617   unsigned getLineNumber() const { return getUnsignedField(7); }
 618   DIType getType() const { return getFieldAs<DIType>(8); }
 619   unsigned isLocalToUnit() const { return getUnsignedField(9); }
 620   unsigned isDefinition() const { return getUnsignedField(10); }
 621
 622   GlobalVariable *getGlobal() const { return getGlobalVariableField(11); }
 623   Constant *getConstant() const { return getConstantField(11); }
 624   DIDerivedType getStaticDataMemberDeclaration() const {
 625     return getFieldAs<DIDerivedType>(12);
 626   }
 627
 628   /// Verify - Verify that a global variable descriptor is well formed.
 629   bool Verify() const;
 630 };
 631
 632 /// DIVariable - This is a wrapper for a variable (e.g. parameter, local,
 633 /// global etc).
 634 class DIVariable : public DIDescriptor {
 635   friend class DIDescriptor;
 636   void printInternal(raw_ostream &OS) const;
 637
 638 public:
 639   explicit DIVariable(const MDNode *N = 0) : DIDescriptor(N) {}
 640
 641   DIScope getContext() const { return getFieldAs<DIScope>(1); }
 642   StringRef getName() const { return getStringField(2); }
 643   DIFile getFile() const { return getFieldAs<DIFile>(3); }
 644   unsigned getLineNumber() const { return (getUnsignedField(4) << 8) >> 8; }
 645   unsigned getArgNumber() const {
 646     unsigned L = getUnsignedField(4);
 647     return L >> 24;
 648   }
 649   DIType getType() const { return getFieldAs<DIType>(5); }
 650
 651   /// isArtificial - Return true if this variable is marked as "artificial".
 652   bool isArtificial() const {
 653     return (getUnsignedField(6) & FlagArtificial) != 0;
 654   }
 655
 656   bool isObjectPointer() const {
 657     return (getUnsignedField(6) & FlagObjectPointer) != 0;
 658   }
 659
 660   /// \brief Return true if this variable is represented as a pointer.
 661   bool isIndirect() const {
 662     return (getUnsignedField(6) & FlagIndirectVariable) != 0;
 663   }
 664
 665   /// getInlinedAt - If this variable is inlined then return inline location.
 666   MDNode *getInlinedAt() const;
 667
 668   /// Verify - Verify that a variable descriptor is well formed.
 669   bool Verify() const;
 670
 671   /// HasComplexAddr - Return true if the variable has a complex address.
 672   bool hasComplexAddress() const { return getNumAddrElements() > 0; }
 673
 674   unsigned getNumAddrElements() const;
 675
 676   uint64_t getAddrElement(unsigned Idx) const {
 677     return getUInt64Field(Idx + 8);
 678   }
 679
 680   /// isBlockByrefVariable - Return true if the variable was declared as
 681   /// a "__block" variable (Apple Blocks).
 682   bool isBlockByrefVariable() const { return getType().isBlockByrefStruct(); }
 683
 684   /// isInlinedFnArgument - Return true if this variable provides debugging
 685   /// information for an inlined function arguments.
 686   bool isInlinedFnArgument(const Function *CurFn);
 687
 688   void printExtendedName(raw_ostream &OS) const;
 689 };
 690
 691 /// DILocation - This object holds location information. This object
 692 /// is not associated with any DWARF tag.
 693 class DILocation : public DIDescriptor {
 694 public:
 695   explicit DILocation(const MDNode *N) : DIDescriptor(N) {}
 696
 697   unsigned getLineNumber() const { return getUnsignedField(0); }
 698   unsigned getColumnNumber() const { return getUnsignedField(1); }
 699   DIScope getScope() const { return getFieldAs<DIScope>(2); }
 700   DILocation getOrigLocation() const { return getFieldAs<DILocation>(3); }
 701   StringRef getFilename() const { return getScope().getFilename(); }
 702   StringRef getDirectory() const { return getScope().getDirectory(); }
 703   bool Verify() const;
 704   bool atSameLineAs(const DILocation &Other) const {
 705     return (getLineNumber() == Other.getLineNumber() &&
 706             getFilename() == Other.getFilename());
 707   }
 708   /// getDiscriminator - DWARF discriminators are used to distinguish
 709   /// identical file locations for instructions that are on different
 710   /// basic blocks. If two instructions are inside the same lexical block
 711   /// and are in different basic blocks, we create a new lexical block
 712   /// with identical location as the original but with a different
 713   /// discriminator value (lib/Transforms/Util/AddDiscriminators.cpp
 714   /// for details).
 715   unsigned getDiscriminator() const {
 716     // Since discriminators are associated with lexical blocks, make
 717     // sure this location is a lexical block before retrieving its
 718     // value.
 719     return getScope().isLexicalBlock()
 720                ? getFieldAs<DILexicalBlock>(2).getDiscriminator()
 721                : 0;
 722   }
 723   unsigned computeNewDiscriminator(LLVMContext &Ctx);
 724   DILocation copyWithNewScope(LLVMContext &Ctx, DILexicalBlock NewScope);
 725 };
 726
 727 class DIObjCProperty : public DIDescriptor {
 728   friend class DIDescriptor;
 729   void printInternal(raw_ostream &OS) const;
 730
 731 public:
 732   explicit DIObjCProperty(const MDNode *N) : DIDescriptor(N) {}
 733
 734   StringRef getObjCPropertyName() const { return getStringField(1); }
 735   DIFile getFile() const { return getFieldAs<DIFile>(2); }
 736   unsigned getLineNumber() const { return getUnsignedField(3); }
 737
 738   StringRef getObjCPropertyGetterName() const { return getStringField(4); }
 739   StringRef getObjCPropertySetterName() const { return getStringField(5); }
 740   bool isReadOnlyObjCProperty() const {
 741     return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_readonly) != 0;
 742   }
 743   bool isReadWriteObjCProperty() const {
 744     return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_readwrite) != 0;
 745   }
 746   bool isAssignObjCProperty() const {
 747     return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_assign) != 0;
 748   }
 749   bool isRetainObjCProperty() const {
 750     return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_retain) != 0;
 751   }
 752   bool isCopyObjCProperty() const {
 753     return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_copy) != 0;
 754   }
 755   bool isNonAtomicObjCProperty() const {
 756     return (getUnsignedField(6) & dwarf::DW_APPLE_PROPERTY_nonatomic) != 0;
 757   }
 758
 759   DIType getType() const { return getFieldAs<DIType>(7); }
 760
 761   /// Verify - Verify that a derived type descriptor is well formed.
 762   bool Verify() const;
 763 };
 764
 765 /// \brief An imported module (C++ using directive or similar).
 766 class DIImportedEntity : public DIDescriptor {
 767   friend class DIDescriptor;
 768   void printInternal(raw_ostream &OS) const;
 769
 770 public:
 771   explicit DIImportedEntity(const MDNode *N) : DIDescriptor(N) {}
 772   DIScope getContext() const { return getFieldAs<DIScope>(1); }
 773   DIDescriptor getEntity() const { return getFieldAs<DIDescriptor>(2); }
 774   unsigned getLineNumber() const { return getUnsignedField(3); }
 775   StringRef getName() const { return getStringField(4); }
 776   bool Verify() const;
 777 };
 778
 779 /// getDISubprogram - Find subprogram that is enclosing this scope.
 780 DISubprogram getDISubprogram(const MDNode *Scope);
 781
 782 /// getDICompositeType - Find underlying composite type.
 783 DICompositeType getDICompositeType(DIType T);
 784
 785 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
 786 /// to hold function specific information.
 787 NamedMDNode *getOrInsertFnSpecificMDNode(Module &M, DISubprogram SP);
 788
 789 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
 790 /// suitable to hold function specific information.
 791 NamedMDNode *getFnSpecificMDNode(const Module &M, DISubprogram SP);
 792
 793 /// createInlinedVariable - Create a new inlined variable based on current
 794 /// variable.
 795 /// @param DV            Current Variable.
 796 /// @param InlinedScope  Location at current variable is inlined.
 797 DIVariable createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
 798                                  LLVMContext &VMContext);
 799
 800 /// cleanseInlinedVariable - Remove inlined scope from the variable.
 801 DIVariable cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext);
 802
 803 /// Construct DITypeIdentifierMap by going through retained types of each CU.
 804 DITypeIdentifierMap generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes);
 805
 806 /// Strip debug info in the module if it exists.
 807 /// To do this, we remove all calls to the debugger intrinsics and any named
 808 /// metadata for debugging. We also remove debug locations for instructions.
 809 /// Return true if module is modified.
 810 bool StripDebugInfo(Module &M);
 811
 812 /// Return Debug Info Metadata Version by checking module flags.
 813 unsigned getDebugMetadataVersionFromModule(const Module &M);
 814
 815 /// DebugInfoFinder tries to list all debug info MDNodes used in a module. To
 816 /// list debug info MDNodes used by an instruction, DebugInfoFinder uses
 817 /// processDeclare, processValue and processLocation to handle DbgDeclareInst,
 818 /// DbgValueInst and DbgLoc attached to instructions. processModule will go
 819 /// through all DICompileUnits in llvm.dbg.cu and list debug info MDNodes
 820 /// used by the CUs.
 821 class DebugInfoFinder {
 822 public:
 823   DebugInfoFinder() : TypeMapInitialized(false) {}
 824
 825   /// processModule - Process entire module and collect debug info
 826   /// anchors.
 827   void processModule(const Module &M);
 828
 829   /// processDeclare - Process DbgDeclareInst.
 830   void processDeclare(const Module &M, const DbgDeclareInst *DDI);
 831   /// Process DbgValueInst.
 832   void processValue(const Module &M, const DbgValueInst *DVI);
 833   /// processLocation - Process DILocation.
 834   void processLocation(const Module &M, DILocation Loc);
 835
 836   /// Clear all lists.
 837   void reset();
 838
 839 private:
 840   /// Initialize TypeIdentifierMap.
 841   void InitializeTypeMap(const Module &M);
 842
 843   /// processType - Process DIType.
 844   void processType(DIType DT);
 845
 846   /// processLexicalBlock - Process DILexicalBlock.
 847   void processLexicalBlock(DILexicalBlock LB);
 848
 849   /// processSubprogram - Process DISubprogram.
 850   void processSubprogram(DISubprogram SP);
 851
 852   void processScope(DIScope Scope);
 853
 854   /// addCompileUnit - Add compile unit into CUs.
 855   bool addCompileUnit(DICompileUnit CU);
 856
 857   /// addGlobalVariable - Add global variable into GVs.
 858   bool addGlobalVariable(DIGlobalVariable DIG);
 859
 860   // addSubprogram - Add subprogram into SPs.
 861   bool addSubprogram(DISubprogram SP);
 862
 863   /// addType - Add type into Tys.
 864   bool addType(DIType DT);
 865
 866   bool addScope(DIScope Scope);
 867
 868 public:
 869   typedef SmallVectorImpl<MDNode *>::const_iterator iterator;
 870   iterator compile_unit_begin() const { return CUs.begin(); }
 871   iterator compile_unit_end() const { return CUs.end(); }
 872   iterator subprogram_begin() const { return SPs.begin(); }
 873   iterator subprogram_end() const { return SPs.end(); }
 874   iterator global_variable_begin() const { return GVs.begin(); }
 875   iterator global_variable_end() const { return GVs.end(); }
 876   iterator type_begin() const { return TYs.begin(); }
 877   iterator type_end() const { return TYs.end(); }
 878   iterator scope_begin() const { return Scopes.begin(); }
 879   iterator scope_end() const { return Scopes.end(); }
 880
 881   unsigned compile_unit_count() const { return CUs.size(); }
 882   unsigned global_variable_count() const { return GVs.size(); }
 883   unsigned subprogram_count() const { return SPs.size(); }
 884   unsigned type_count() const { return TYs.size(); }
 885   unsigned scope_count() const { return Scopes.size(); }
 886
 887 private:
 888   SmallVector<MDNode *, 8> CUs;    // Compile Units
 889   SmallVector<MDNode *, 8> SPs;    // Subprograms
 890   SmallVector<MDNode *, 8> GVs;    // Global Variables;
 891   SmallVector<MDNode *, 8> TYs;    // Types
 892   SmallVector<MDNode *, 8> Scopes; // Scopes
 893   SmallPtrSet<MDNode *, 64> NodesSeen;
 894   DITypeIdentifierMap TypeIdentifierMap;
 895   /// Specify if TypeIdentifierMap is initialized.
 896   bool TypeMapInitialized;
 897 };
 898 } // end namespace llvm
 899
 900 #endif