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