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