include/llvm/DebugInfo.h

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