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/Metadata.h"
  21 #include "llvm/Target/TargetMachine.h"
  22 #include "llvm/ADT/StringMap.h"
  23 #include "llvm/ADT/DenseMap.h"
  24 #include "llvm/ADT/SmallVector.h"
  25 #include "llvm/ADT/SmallPtrSet.h"
  26 #include "llvm/Support/Dwarf.h"
  27
  28 namespace llvm {
  29   class BasicBlock;
  30   class Constant;
  31   class Function;
  32   class GlobalVariable;
  33   class Module;
  34   class Type;
  35   class Value;
  36   struct DbgStopPointInst;
  37   struct DbgDeclareInst;
  38   struct DbgFuncStartInst;
  39   struct DbgRegionStartInst;
  40   struct DbgRegionEndInst;
  41   class DebugLoc;
  42   struct DebugLocTracker;
  43   class Instruction;
  44   class LLVMContext;
  45
  46   class DIDescriptor {
  47   protected:
  48     MDNode *DbgNode;
  49
  50     /// DIDescriptor constructor.  If the specified node is non-null, check
  51     /// to make sure that the tag in the descriptor matches 'RequiredTag'.  If
  52     /// not, the debug info is corrupt and we ignore it.
  53     DIDescriptor(MDNode *N, unsigned RequiredTag);
  54
  55     const std::string &getStringField(unsigned Elt, std::string &Result) const;
  56     unsigned getUnsignedField(unsigned Elt) const {
  57       return (unsigned)getUInt64Field(Elt);
  58     }
  59     uint64_t getUInt64Field(unsigned Elt) const;
  60     DIDescriptor getDescriptorField(unsigned Elt) const;
  61
  62     template <typename DescTy>
  63     DescTy getFieldAs(unsigned Elt) const {
  64       return DescTy(getDescriptorField(Elt).getNode());
  65     }
  66
  67     GlobalVariable *getGlobalVariableField(unsigned Elt) const;
  68
  69   public:
  70     explicit DIDescriptor() : DbgNode(0) {}
  71     explicit DIDescriptor(MDNode *N) : DbgNode(N) {}
  72
  73     bool isNull() const { return DbgNode == 0; }
  74
  75     MDNode *getNode() const { return DbgNode; }
  76
  77     unsigned getVersion() const {
  78       return getUnsignedField(0) & LLVMDebugVersionMask;
  79     }
  80
  81     unsigned getTag() const {
  82       return getUnsignedField(0) & ~LLVMDebugVersionMask;
  83     }
  84
  85     /// ValidDebugInfo - Return true if N represents valid debug info value.
  86     static bool ValidDebugInfo(MDNode *N, CodeGenOpt::Level OptLevel);
  87
  88     /// dump - print descriptor.
  89     void dump() const;
  90   };
  91
  92   /// DISubrange - This is used to represent ranges, for array bounds.
  93   class DISubrange : public DIDescriptor {
  94   public:
  95     explicit DISubrange(MDNode *N = 0)
  96       : DIDescriptor(N, dwarf::DW_TAG_subrange_type) {}
  97
  98     int64_t getLo() const { return (int64_t)getUInt64Field(1); }
  99     int64_t getHi() const { return (int64_t)getUInt64Field(2); }
 100   };
 101
 102   /// DIArray - This descriptor holds an array of descriptors.
 103   class DIArray : public DIDescriptor {
 104   public:
 105     explicit DIArray(MDNode *N = 0)
 106       : DIDescriptor(N) {}
 107
 108     unsigned getNumElements() const;
 109     DIDescriptor getElement(unsigned Idx) const {
 110       return getDescriptorField(Idx);
 111     }
 112   };
 113
 114   /// DICompileUnit - A wrapper for a compile unit.
 115   class DICompileUnit : public DIDescriptor {
 116   public:
 117     explicit DICompileUnit(MDNode *N = 0)
 118       : DIDescriptor(N, dwarf::DW_TAG_compile_unit) {}
 119
 120     unsigned getLanguage() const     { return getUnsignedField(2); }
 121     const std::string &getFilename(std::string &F) const {
 122       return getStringField(3, F);
 123     }
 124     const std::string &getDirectory(std::string &F) const {
 125       return getStringField(4, F);
 126     }
 127     const std::string &getProducer(std::string &F) const {
 128       return getStringField(5, F);
 129     }
 130
 131     /// isMain - Each input file is encoded as a separate compile unit in LLVM
 132     /// debugging information output. However, many target specific tool chains
 133     /// prefer to encode only one compile unit in an object file. In this
 134     /// situation, the LLVM code generator will include  debugging information
 135     /// entities in the compile unit that is marked as main compile unit. The
 136     /// code generator accepts maximum one main compile unit per module. If a
 137     /// module does not contain any main compile unit then the code generator
 138     /// will emit multiple compile units in the output object file.
 139
 140     bool isMain() const                { return getUnsignedField(6); }
 141     bool isOptimized() const           { return getUnsignedField(7); }
 142     const std::string &getFlags(std::string &F) const {
 143       return getStringField(8, F);
 144     }
 145     unsigned getRunTimeVersion() const { return getUnsignedField(9); }
 146
 147     /// Verify - Verify that a compile unit is well formed.
 148     bool Verify() const;
 149
 150     /// dump - print compile unit.
 151     void dump() const;
 152   };
 153
 154   /// DIEnumerator - A wrapper for an enumerator (e.g. X and Y in 'enum {X,Y}').
 155   /// FIXME: it seems strange that this doesn't have either a reference to the
 156   /// type/precision or a file/line pair for location info.
 157   class DIEnumerator : public DIDescriptor {
 158   public:
 159     explicit DIEnumerator(MDNode *N = 0)
 160       : DIDescriptor(N, dwarf::DW_TAG_enumerator) {}
 161
 162     const std::string &getName(std::string &F) const {
 163       return getStringField(1, F);
 164     }
 165     uint64_t getEnumValue() const { return getUInt64Field(2); }
 166   };
 167
 168   /// DIType - This is a wrapper for a type.
 169   /// FIXME: Types should be factored much better so that CV qualifiers and
 170   /// others do not require a huge and empty descriptor full of zeros.
 171   class DIType : public DIDescriptor {
 172   public:
 173     enum {
 174       FlagPrivate    = 1 << 0,
 175       FlagProtected  = 1 << 1,
 176       FlagFwdDecl    = 1 << 2,
 177       FlagAppleBlock = 1 << 3
 178     };
 179
 180   protected:
 181     DIType(MDNode *N, unsigned Tag)
 182       : DIDescriptor(N, Tag) {}
 183     // This ctor is used when the Tag has already been validated by a derived
 184     // ctor.
 185     DIType(MDNode *N, bool, bool) : DIDescriptor(N) {}
 186
 187   public:
 188     /// isDerivedType - Return true if the specified tag is legal for
 189     /// DIDerivedType.
 190     static bool isDerivedType(unsigned TAG);
 191
 192     /// isCompositeType - Return true if the specified tag is legal for
 193     /// DICompositeType.
 194     static bool isCompositeType(unsigned TAG);
 195
 196     /// isBasicType - Return true if the specified tag is legal for
 197     /// DIBasicType.
 198     static bool isBasicType(unsigned TAG) {
 199       return TAG == dwarf::DW_TAG_base_type;
 200     }
 201
 202     /// Verify - Verify that a type descriptor is well formed.
 203     bool Verify() const;
 204   public:
 205     explicit DIType(MDNode *N);
 206     explicit DIType() {}
 207     virtual ~DIType() {}
 208
 209     DIDescriptor getContext() const     { return getDescriptorField(1); }
 210     const std::string &getName(std::string &F) const {
 211       return getStringField(2, F);
 212     }
 213     DICompileUnit getCompileUnit() const{ return getFieldAs<DICompileUnit>(3); }
 214     unsigned getLineNumber() const      { return getUnsignedField(4); }
 215     uint64_t getSizeInBits() const      { return getUInt64Field(5); }
 216     uint64_t getAlignInBits() const     { return getUInt64Field(6); }
 217     // FIXME: Offset is only used for DW_TAG_member nodes.  Making every type
 218     // carry this is just plain insane.
 219     uint64_t getOffsetInBits() const    { return getUInt64Field(7); }
 220     unsigned getFlags() const           { return getUnsignedField(8); }
 221     bool isPrivate() const {
 222       return (getFlags() & FlagPrivate) != 0;
 223     }
 224     bool isProtected() const {
 225       return (getFlags() & FlagProtected) != 0;
 226     }
 227     bool isForwardDecl() const {
 228       return (getFlags() & FlagFwdDecl) != 0;
 229     }
 230     // isAppleBlock - Return true if this is the Apple Blocks extension.
 231     bool isAppleBlockExtension() const {
 232       return (getFlags() & FlagAppleBlock) != 0;
 233     }
 234
 235     /// dump - print type.
 236     void dump() const;
 237   };
 238
 239   /// DIBasicType - A basic type, like 'int' or 'float'.
 240   class DIBasicType : public DIType {
 241   public:
 242     explicit DIBasicType(MDNode *N = 0)
 243       : DIType(N, dwarf::DW_TAG_base_type) {}
 244
 245     unsigned getEncoding() const { return getUnsignedField(9); }
 246
 247     /// dump - print basic type.
 248     void dump() const;
 249   };
 250
 251   /// DIDerivedType - A simple derived type, like a const qualified type,
 252   /// a typedef, a pointer or reference, etc.
 253   class DIDerivedType : public DIType {
 254   protected:
 255     explicit DIDerivedType(MDNode *N, bool, bool)
 256       : DIType(N, true, true) {}
 257   public:
 258     explicit DIDerivedType(MDNode *N = 0)
 259       : DIType(N, true, true) {
 260       if (DbgNode && !isDerivedType(getTag()))
 261         DbgNode = 0;
 262     }
 263
 264     DIType getTypeDerivedFrom() const { return getFieldAs<DIType>(9); }
 265
 266     /// getOriginalTypeSize - If this type is derived from a base type then
 267     /// return base type size.
 268     uint64_t getOriginalTypeSize() const;
 269     /// dump - print derived type.
 270     void dump() const;
 271
 272     /// replaceAllUsesWith - Replace all uses of debug info referenced by
 273     /// this descriptor. After this completes, the current debug info value
 274     /// is erased.
 275     void replaceAllUsesWith(DIDescriptor &D);
 276   };
 277
 278   /// DICompositeType - This descriptor holds a type that can refer to multiple
 279   /// other types, like a function or struct.
 280   /// FIXME: Why is this a DIDerivedType??
 281   class DICompositeType : public DIDerivedType {
 282   public:
 283     explicit DICompositeType(MDNode *N = 0)
 284       : DIDerivedType(N, true, true) {
 285       if (N && !isCompositeType(getTag()))
 286         DbgNode = 0;
 287     }
 288
 289     DIArray getTypeArray() const { return getFieldAs<DIArray>(10); }
 290     unsigned getRunTimeLang() const { return getUnsignedField(11); }
 291
 292     /// Verify - Verify that a composite type descriptor is well formed.
 293     bool Verify() const;
 294
 295     /// dump - print composite type.
 296     void dump() const;
 297   };
 298
 299   /// DIGlobal - This is a common class for global variables and subprograms.
 300   class DIGlobal : public DIDescriptor {
 301   protected:
 302     explicit DIGlobal(MDNode *N, unsigned RequiredTag)
 303       : DIDescriptor(N, RequiredTag) {}
 304
 305     /// isSubprogram - Return true if the specified tag is legal for
 306     /// DISubprogram.
 307     static bool isSubprogram(unsigned TAG) {
 308       return TAG == dwarf::DW_TAG_subprogram;
 309     }
 310
 311     /// isGlobalVariable - Return true if the specified tag is legal for
 312     /// DIGlobalVariable.
 313     static bool isGlobalVariable(unsigned TAG) {
 314       return TAG == dwarf::DW_TAG_variable;
 315     }
 316
 317   public:
 318     virtual ~DIGlobal() {}
 319
 320     DIDescriptor getContext() const     { return getDescriptorField(2); }
 321     const std::string &getName(std::string &F) const {
 322       return getStringField(3, F);
 323     }
 324     const std::string &getDisplayName(std::string &F) const {
 325       return getStringField(4, F);
 326     }
 327     const std::string &getLinkageName(std::string &F) const {
 328       return getStringField(5, F);
 329     }
 330     DICompileUnit getCompileUnit() const{ return getFieldAs<DICompileUnit>(6); }
 331     unsigned getLineNumber() const      { return getUnsignedField(7); }
 332     DIType getType() const              { return getFieldAs<DIType>(8); }
 333
 334     /// isLocalToUnit - Return true if this subprogram is local to the current
 335     /// compile unit, like 'static' in C.
 336     unsigned isLocalToUnit() const      { return getUnsignedField(9); }
 337     unsigned isDefinition() const       { return getUnsignedField(10); }
 338
 339     /// dump - print global.
 340     void dump() const;
 341   };
 342
 343   /// DISubprogram - This is a wrapper for a subprogram (e.g. a function).
 344   class DISubprogram : public DIGlobal {
 345   public:
 346     explicit DISubprogram(MDNode *N = 0)
 347       : DIGlobal(N, dwarf::DW_TAG_subprogram) {}
 348
 349     DICompositeType getType() const { return getFieldAs<DICompositeType>(8); }
 350
 351     /// getReturnTypeName - Subprogram return types are encoded either as
 352     /// DIType or as DICompositeType.
 353     const std::string &getReturnTypeName(std::string &F) const {
 354       DICompositeType DCT(getFieldAs<DICompositeType>(8));
 355       if (!DCT.isNull()) {
 356         DIArray A = DCT.getTypeArray();
 357         DIType T(A.getElement(0).getNode());
 358         return T.getName(F);
 359       }
 360       DIType T(getFieldAs<DIType>(8));
 361       return T.getName(F);
 362     }
 363
 364     /// Verify - Verify that a subprogram descriptor is well formed.
 365     bool Verify() const;
 366
 367     /// dump - print subprogram.
 368     void dump() const;
 369
 370     /// describes - Return true if this subprogram provides debugging
 371     /// information for the function F.
 372     bool describes(const Function *F);
 373   };
 374
 375   /// DIGlobalVariable - This is a wrapper for a global variable.
 376   class DIGlobalVariable : public DIGlobal {
 377   public:
 378     explicit DIGlobalVariable(MDNode *N = 0)
 379       : DIGlobal(N, dwarf::DW_TAG_variable) {}
 380
 381     GlobalVariable *getGlobal() const { return getGlobalVariableField(11); }
 382
 383     /// Verify - Verify that a global variable descriptor is well formed.
 384     bool Verify() const;
 385
 386     /// dump - print global variable.
 387     void dump() const;
 388   };
 389
 390   /// DIVariable - This is a wrapper for a variable (e.g. parameter, local,
 391   /// global etc).
 392   class DIVariable : public DIDescriptor {
 393   public:
 394     explicit DIVariable(MDNode *N = 0)
 395       : DIDescriptor(N) {
 396       if (DbgNode && !isVariable(getTag()))
 397         DbgNode = 0;
 398     }
 399
 400     DIDescriptor getContext() const { return getDescriptorField(1); }
 401     const std::string &getName(std::string &F) const {
 402       return getStringField(2, F);
 403     }
 404     DICompileUnit getCompileUnit() const{ return getFieldAs<DICompileUnit>(3); }
 405     unsigned getLineNumber() const      { return getUnsignedField(4); }
 406     DIType getType() const              { return getFieldAs<DIType>(5); }
 407
 408     /// isVariable - Return true if the specified tag is legal for DIVariable.
 409     static bool isVariable(unsigned Tag);
 410
 411     /// Verify - Verify that a variable descriptor is well formed.
 412     bool Verify() const;
 413
 414     /// dump - print variable.
 415     void dump() const;
 416   };
 417
 418   /// DIBlock - This is a wrapper for a block (e.g. a function, scope, etc).
 419   class DIBlock : public DIDescriptor {
 420   public:
 421     explicit DIBlock(MDNode *N = 0)
 422       : DIDescriptor(N, dwarf::DW_TAG_lexical_block) {}
 423
 424     DIDescriptor getContext() const { return getDescriptorField(1); }
 425   };
 426
 427   /// DIFactory - This object assists with the construction of the various
 428   /// descriptors.
 429   class DIFactory {
 430     Module &M;
 431     LLVMContext& VMContext;
 432
 433     // Cached values for uniquing and faster lookups.
 434     const Type *EmptyStructPtr; // "{}*".
 435     Function *StopPointFn;   // llvm.dbg.stoppoint
 436     Function *FuncStartFn;   // llvm.dbg.func.start
 437     Function *RegionStartFn; // llvm.dbg.region.start
 438     Function *RegionEndFn;   // llvm.dbg.region.end
 439     Function *DeclareFn;     // llvm.dbg.declare
 440     StringMap<Constant*> StringCache;
 441     DenseMap<Constant*, DIDescriptor> SimpleConstantCache;
 442
 443     DIFactory(const DIFactory &);     // DO NOT IMPLEMENT
 444     void operator=(const DIFactory&); // DO NOT IMPLEMENT
 445   public:
 446     explicit DIFactory(Module &m);
 447
 448     /// GetOrCreateArray - Create an descriptor for an array of descriptors.
 449     /// This implicitly uniques the arrays created.
 450     DIArray GetOrCreateArray(DIDescriptor *Tys, unsigned NumTys);
 451
 452     /// GetOrCreateSubrange - Create a descriptor for a value range.  This
 453     /// implicitly uniques the values returned.
 454     DISubrange GetOrCreateSubrange(int64_t Lo, int64_t Hi);
 455
 456     /// CreateCompileUnit - Create a new descriptor for the specified compile
 457     /// unit.
 458     DICompileUnit CreateCompileUnit(unsigned LangID,
 459                                     const std::string &Filename,
 460                                     const std::string &Directory,
 461                                     const std::string &Producer,
 462                                     bool isMain = false,
 463                                     bool isOptimized = false,
 464                                     const char *Flags = "",
 465                                     unsigned RunTimeVer = 0);
 466
 467     /// CreateEnumerator - Create a single enumerator value.
 468     DIEnumerator CreateEnumerator(const std::string &Name, uint64_t Val);
 469
 470     /// CreateBasicType - Create a basic type like int, float, etc.
 471     DIBasicType CreateBasicType(DIDescriptor Context, const std::string &Name,
 472                                 DICompileUnit CompileUnit, unsigned LineNumber,
 473                                 uint64_t SizeInBits, uint64_t AlignInBits,
 474                                 uint64_t OffsetInBits, unsigned Flags,
 475                                 unsigned Encoding);
 476
 477     /// CreateDerivedType - Create a derived type like const qualified type,
 478     /// pointer, typedef, etc.
 479     DIDerivedType CreateDerivedType(unsigned Tag, DIDescriptor Context,
 480                                     const std::string &Name,
 481                                     DICompileUnit CompileUnit,
 482                                     unsigned LineNumber,
 483                                     uint64_t SizeInBits, uint64_t AlignInBits,
 484                                     uint64_t OffsetInBits, unsigned Flags,
 485                                     DIType DerivedFrom);
 486
 487     /// CreateCompositeType - Create a composite type like array, struct, etc.
 488     DICompositeType CreateCompositeType(unsigned Tag, DIDescriptor Context,
 489                                         const std::string &Name,
 490                                         DICompileUnit CompileUnit,
 491                                         unsigned LineNumber,
 492                                         uint64_t SizeInBits,
 493                                         uint64_t AlignInBits,
 494                                         uint64_t OffsetInBits, unsigned Flags,
 495                                         DIType DerivedFrom,
 496                                         DIArray Elements,
 497                                         unsigned RunTimeLang = 0);
 498
 499     /// CreateSubprogram - Create a new descriptor for the specified subprogram.
 500     /// See comments in DISubprogram for descriptions of these fields.
 501     DISubprogram CreateSubprogram(DIDescriptor Context, const std::string &Name,
 502                                   const std::string &DisplayName,
 503                                   const std::string &LinkageName,
 504                                   DICompileUnit CompileUnit, unsigned LineNo,
 505                                   DIType Type, bool isLocalToUnit,
 506                                   bool isDefinition);
 507
 508     /// CreateGlobalVariable - Create a new descriptor for the specified global.
 509     DIGlobalVariable
 510     CreateGlobalVariable(DIDescriptor Context, const std::string &Name,
 511                          const std::string &DisplayName,
 512                          const std::string &LinkageName,
 513                          DICompileUnit CompileUnit,
 514                          unsigned LineNo, DIType Type, bool isLocalToUnit,
 515                          bool isDefinition, llvm::GlobalVariable *GV);
 516
 517     /// CreateVariable - Create a new descriptor for the specified variable.
 518     DIVariable CreateVariable(unsigned Tag, DIDescriptor Context,
 519                               const std::string &Name,
 520                               DICompileUnit CompileUnit, unsigned LineNo,
 521                               DIType Type);
 522
 523     /// CreateBlock - This creates a descriptor for a lexical block with the
 524     /// specified parent context.
 525     DIBlock CreateBlock(DIDescriptor Context);
 526
 527     /// InsertStopPoint - Create a new llvm.dbg.stoppoint intrinsic invocation,
 528     /// inserting it at the end of the specified basic block.
 529     void InsertStopPoint(DICompileUnit CU, unsigned LineNo, unsigned ColNo,
 530                          BasicBlock *BB);
 531
 532     /// InsertSubprogramStart - Create a new llvm.dbg.func.start intrinsic to
 533     /// mark the start of the specified subprogram.
 534     void InsertSubprogramStart(DISubprogram SP, BasicBlock *BB);
 535
 536     /// InsertRegionStart - Insert a new llvm.dbg.region.start intrinsic call to
 537     /// mark the start of a region for the specified scoping descriptor.
 538     void InsertRegionStart(DIDescriptor D, BasicBlock *BB);
 539
 540     /// InsertRegionEnd - Insert a new llvm.dbg.region.end intrinsic call to
 541     /// mark the end of a region for the specified scoping descriptor.
 542     void InsertRegionEnd(DIDescriptor D, BasicBlock *BB);
 543
 544     /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
 545     void InsertDeclare(llvm::Value *Storage, DIVariable D, BasicBlock *BB);
 546
 547   private:
 548     Constant *GetTagConstant(unsigned TAG);
 549   };
 550
 551   /// Finds the stoppoint coressponding to this instruction, that is the
 552   /// stoppoint that dominates this instruction
 553   const DbgStopPointInst *findStopPoint(const Instruction *Inst);
 554
 555   /// Finds the stoppoint corresponding to first real (non-debug intrinsic)
 556   /// instruction in this Basic Block, and returns the stoppoint for it.
 557   const DbgStopPointInst *findBBStopPoint(const BasicBlock *BB);
 558
 559   /// Finds the dbg.declare intrinsic corresponding to this value if any.
 560   /// It looks through pointer casts too.
 561   const DbgDeclareInst *findDbgDeclare(const Value *V, bool stripCasts = true);
 562
 563   /// Find the debug info descriptor corresponding to this global variable.
 564   Value *findDbgGlobalDeclare(GlobalVariable *V);
 565
 566   bool getLocationInfo(const Value *V, std::string &DisplayName,
 567                        std::string &Type, unsigned &LineNo, std::string &File,
 568                        std::string &Dir);
 569
 570   /// isValidDebugInfoIntrinsic - Return true if SPI is a valid debug
 571   /// info intrinsic.
 572   bool isValidDebugInfoIntrinsic(DbgStopPointInst &SPI,
 573                                  CodeGenOpt::Level OptLev);
 574
 575   /// isValidDebugInfoIntrinsic - Return true if FSI is a valid debug
 576   /// info intrinsic.
 577   bool isValidDebugInfoIntrinsic(DbgFuncStartInst &FSI,
 578                                  CodeGenOpt::Level OptLev);
 579
 580   /// isValidDebugInfoIntrinsic - Return true if RSI is a valid debug
 581   /// info intrinsic.
 582   bool isValidDebugInfoIntrinsic(DbgRegionStartInst &RSI,
 583                                  CodeGenOpt::Level OptLev);
 584
 585   /// isValidDebugInfoIntrinsic - Return true if REI is a valid debug
 586   /// info intrinsic.
 587   bool isValidDebugInfoIntrinsic(DbgRegionEndInst &REI,
 588                                  CodeGenOpt::Level OptLev);
 589
 590   /// isValidDebugInfoIntrinsic - Return true if DI is a valid debug
 591   /// info intrinsic.
 592   bool isValidDebugInfoIntrinsic(DbgDeclareInst &DI,
 593                                  CodeGenOpt::Level OptLev);
 594
 595   /// ExtractDebugLocation - Extract debug location information
 596   /// from llvm.dbg.stoppoint intrinsic.
 597   DebugLoc ExtractDebugLocation(DbgStopPointInst &SPI,
 598                                 DebugLocTracker &DebugLocInfo);
 599
 600   /// ExtractDebugLocation - Extract debug location information
 601   /// from llvm.dbg.func_start intrinsic.
 602   DebugLoc ExtractDebugLocation(DbgFuncStartInst &FSI,
 603                                 DebugLocTracker &DebugLocInfo);
 604
 605   /// isInlinedFnStart - Return true if FSI is starting an inlined function.
 606   bool isInlinedFnStart(DbgFuncStartInst &FSI, const Function *CurrentFn);
 607
 608   /// isInlinedFnEnd - Return true if REI is ending an inlined function.
 609   bool isInlinedFnEnd(DbgRegionEndInst &REI, const Function *CurrentFn);
 610   /// DebugInfoFinder - This object collects DebugInfo from a module.
 611   class DebugInfoFinder {
 612
 613   public:
 614     /// processModule - Process entire module and collect debug info
 615     /// anchors.
 616     void processModule(Module &M);
 617
 618   private:
 619     /// processType - Process DIType.
 620     void processType(DIType DT);
 621
 622     /// processSubprogram - Enumberate DISubprogram.
 623     void processSubprogram(DISubprogram SP);
 624
 625     /// processStopPoint - Process DbgStopPointInst.
 626     void processStopPoint(DbgStopPointInst *SPI);
 627
 628     /// processFuncStart - Process DbgFuncStartInst.
 629     void processFuncStart(DbgFuncStartInst *FSI);
 630
 631     /// processRegionStart - Process DbgRegionStart.
 632     void processRegionStart(DbgRegionStartInst *DRS);
 633
 634     /// processRegionEnd - Process DbgRegionEnd.
 635     void processRegionEnd(DbgRegionEndInst *DRE);
 636
 637     /// processDeclare - Process DbgDeclareInst.
 638     void processDeclare(DbgDeclareInst *DDI);
 639
 640     /// addCompileUnit - Add compile unit into CUs.
 641     bool addCompileUnit(DICompileUnit CU);
 642
 643     /// addGlobalVariable - Add global variable into GVs.
 644     bool addGlobalVariable(DIGlobalVariable DIG);
 645
 646     // addSubprogram - Add subprgoram into SPs.
 647     bool addSubprogram(DISubprogram SP);
 648
 649     /// addType - Add type into Tys.
 650     bool addType(DIType DT);
 651
 652   public:
 653     typedef SmallVector<MDNode *, 8>::iterator iterator;
 654     iterator compile_unit_begin()    { return CUs.begin(); }
 655     iterator compile_unit_end()      { return CUs.end(); }
 656     iterator subprogram_begin()      { return SPs.begin(); }
 657     iterator subprogram_end()        { return SPs.end(); }
 658     iterator global_variable_begin() { return GVs.begin(); }
 659     iterator global_variable_end()   { return GVs.end(); }
 660     iterator type_begin()            { return TYs.begin(); }
 661     iterator type_end()              { return TYs.end(); }
 662
 663     unsigned compile_unit_count()    { return CUs.size(); }
 664     unsigned global_variable_count() { return GVs.size(); }
 665     unsigned subprogram_count()      { return SPs.size(); }
 666     unsigned type_count()            { return TYs.size(); }
 667
 668   private:
 669     SmallVector<MDNode *, 8> CUs;  // Compile Units
 670     SmallVector<MDNode *, 8> SPs;  // Subprograms
 671     SmallVector<MDNode *, 8> GVs;  // Global Variables;
 672     SmallVector<MDNode *, 8> TYs;  // Types
 673     SmallPtrSet<MDNode *, 64> NodesSeen;
 674   };
 675 } // end namespace llvm
 676
 677 #endif