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