lib/Analysis/DebugInfo.cpp

   1 //===--- DebugInfo.cpp - Debug Information Helper Classes -----------------===//
   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 implements the helper classes used to build and interpret debug
  11 // information in LLVM IR form.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Analysis/DebugInfo.h"
  16 #include "llvm/Constants.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/Intrinsics.h"
  19 #include "llvm/IntrinsicInst.h"
  20 #include "llvm/Instructions.h"
  21 #include "llvm/LLVMContext.h"
  22 #include "llvm/Module.h"
  23 #include "llvm/Analysis/ValueTracking.h"
  24 #include "llvm/ADT/SmallPtrSet.h"
  25 #include "llvm/Support/Dwarf.h"
  26 #include "llvm/Support/DebugLoc.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 using namespace llvm;
  29 using namespace llvm::dwarf;
  30
  31 //===----------------------------------------------------------------------===//
  32 // DIDescriptor
  33 //===----------------------------------------------------------------------===//
  34
  35 /// ValidDebugInfo - Return true if V represents valid debug info value.
  36 /// FIXME : Add DIDescriptor.isValid()
  37 bool DIDescriptor::ValidDebugInfo(MDNode *N, CodeGenOpt::Level OptLevel) {
  38   if (!N)
  39     return false;
  40
  41   DIDescriptor DI(N);
  42
  43   // Check current version. Allow Version6 for now.
  44   unsigned Version = DI.getVersion();
  45   if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6)
  46     return false;
  47
  48   unsigned Tag = DI.getTag();
  49   switch (Tag) {
  50   case DW_TAG_variable:
  51     assert(DIVariable(N).Verify() && "Invalid DebugInfo value");
  52     break;
  53   case DW_TAG_compile_unit:
  54     assert(DICompileUnit(N).Verify() && "Invalid DebugInfo value");
  55     break;
  56   case DW_TAG_subprogram:
  57     assert(DISubprogram(N).Verify() && "Invalid DebugInfo value");
  58     break;
  59   case DW_TAG_lexical_block:
  60     // FIXME: This interfers with the quality of generated code during
  61     // optimization.
  62     if (OptLevel != CodeGenOpt::None)
  63       return false;
  64     // FALLTHROUGH
  65   default:
  66     break;
  67   }
  68
  69   return true;
  70 }
  71
  72 DIDescriptor::DIDescriptor(MDNode *N, unsigned RequiredTag) {
  73   DbgNode = N;
  74
  75   // If this is non-null, check to see if the Tag matches. If not, set to null.
  76   if (N && getTag() != RequiredTag) {
  77     DbgNode = 0;
  78   }
  79 }
  80
  81 const std::string &
  82 DIDescriptor::getStringField(unsigned Elt, std::string &Result) const {
  83   Result.clear();
  84   if (DbgNode == 0)
  85     return Result;
  86
  87   if (Elt < DbgNode->getNumElements())
  88     if (MDString *MDS = dyn_cast_or_null<MDString>(DbgNode->getElement(Elt))) {
  89       Result.assign(MDS->begin(), MDS->begin() + MDS->length());
  90       return Result;
  91     }
  92
  93   return Result;
  94 }
  95
  96 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
  97   if (DbgNode == 0)
  98     return 0;
  99
 100   if (Elt < DbgNode->getNumElements())
 101     if (ConstantInt *CI = dyn_cast<ConstantInt>(DbgNode->getElement(Elt)))
 102       return CI->getZExtValue();
 103
 104   return 0;
 105 }
 106
 107 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
 108   if (DbgNode == 0)
 109     return DIDescriptor();
 110
 111   if (Elt < DbgNode->getNumElements() && DbgNode->getElement(Elt))
 112     return DIDescriptor(dyn_cast<MDNode>(DbgNode->getElement(Elt)));
 113
 114   return DIDescriptor();
 115 }
 116
 117 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
 118   if (DbgNode == 0)
 119     return 0;
 120
 121   if (Elt < DbgNode->getNumElements())
 122       return dyn_cast<GlobalVariable>(DbgNode->getElement(Elt));
 123   return 0;
 124 }
 125
 126 //===----------------------------------------------------------------------===//
 127 // Predicates
 128 //===----------------------------------------------------------------------===//
 129
 130 /// isBasicType - Return true if the specified tag is legal for
 131 /// DIBasicType.
 132 bool DIDescriptor::isBasicType() const {
 133   assert (!isNull() && "Invalid descriptor!");
 134   unsigned Tag = getTag();
 135
 136   return Tag == dwarf::DW_TAG_base_type;
 137 }
 138
 139 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
 140 bool DIDescriptor::isDerivedType() const {
 141   assert (!isNull() && "Invalid descriptor!");
 142   unsigned Tag = getTag();
 143
 144   switch (Tag) {
 145   case dwarf::DW_TAG_typedef:
 146   case dwarf::DW_TAG_pointer_type:
 147   case dwarf::DW_TAG_reference_type:
 148   case dwarf::DW_TAG_const_type:
 149   case dwarf::DW_TAG_volatile_type:
 150   case dwarf::DW_TAG_restrict_type:
 151   case dwarf::DW_TAG_member:
 152   case dwarf::DW_TAG_inheritance:
 153     return true;
 154   default:
 155     // CompositeTypes are currently modelled as DerivedTypes.
 156     return isCompositeType();
 157   }
 158 }
 159
 160 /// isCompositeType - Return true if the specified tag is legal for
 161 /// DICompositeType.
 162 bool DIDescriptor::isCompositeType() const {
 163   assert (!isNull() && "Invalid descriptor!");
 164   unsigned Tag = getTag();
 165
 166   switch (Tag) {
 167   case dwarf::DW_TAG_array_type:
 168   case dwarf::DW_TAG_structure_type:
 169   case dwarf::DW_TAG_union_type:
 170   case dwarf::DW_TAG_enumeration_type:
 171   case dwarf::DW_TAG_vector_type:
 172   case dwarf::DW_TAG_subroutine_type:
 173   case dwarf::DW_TAG_class_type:
 174     return true;
 175   default:
 176     return false;
 177   }
 178 }
 179
 180 /// isVariable - Return true if the specified tag is legal for DIVariable.
 181 bool DIDescriptor::isVariable() const {
 182   assert (!isNull() && "Invalid descriptor!");
 183   unsigned Tag = getTag();
 184
 185   switch (Tag) {
 186   case dwarf::DW_TAG_auto_variable:
 187   case dwarf::DW_TAG_arg_variable:
 188   case dwarf::DW_TAG_return_variable:
 189     return true;
 190   default:
 191     return false;
 192   }
 193 }
 194
 195 /// isSubprogram - Return true if the specified tag is legal for
 196 /// DISubprogram.
 197 bool DIDescriptor::isSubprogram() const {
 198   assert (!isNull() && "Invalid descriptor!");
 199   unsigned Tag = getTag();
 200
 201   return Tag == dwarf::DW_TAG_subprogram;
 202 }
 203
 204 /// isGlobalVariable - Return true if the specified tag is legal for
 205 /// DIGlobalVariable.
 206 bool DIDescriptor::isGlobalVariable() const {
 207   assert (!isNull() && "Invalid descriptor!");
 208   unsigned Tag = getTag();
 209
 210   return Tag == dwarf::DW_TAG_variable;
 211 }
 212
 213 /// isScope - Return true if the specified tag is one of the scope
 214 /// related tag.
 215 bool DIDescriptor::isScope() const {
 216   assert (!isNull() && "Invalid descriptor!");
 217   unsigned Tag = getTag();
 218
 219   switch (Tag) {
 220     case dwarf::DW_TAG_compile_unit:
 221     case dwarf::DW_TAG_lexical_block:
 222     case dwarf::DW_TAG_subprogram:
 223       return true;
 224     default:
 225       break;
 226   }
 227   return false;
 228 }
 229
 230 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
 231 bool DIDescriptor::isCompileUnit() const {
 232   assert (!isNull() && "Invalid descriptor!");
 233   unsigned Tag = getTag();
 234
 235   return Tag == dwarf::DW_TAG_compile_unit;
 236 }
 237
 238 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
 239 bool DIDescriptor::isLexicalBlock() const {
 240   assert (!isNull() && "Invalid descriptor!");
 241   unsigned Tag = getTag();
 242
 243   return Tag == dwarf::DW_TAG_lexical_block;
 244 }
 245
 246 //===----------------------------------------------------------------------===//
 247 // Simple Descriptor Constructors and other Methods
 248 //===----------------------------------------------------------------------===//
 249
 250 DIType::DIType(MDNode *N) : DIDescriptor(N) {
 251   if (!N) return;
 252   if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
 253     DbgNode = 0;
 254   }
 255 }
 256
 257 unsigned DIArray::getNumElements() const {
 258   assert (DbgNode && "Invalid DIArray");
 259   return DbgNode->getNumElements();
 260 }
 261
 262 /// replaceAllUsesWith - Replace all uses of debug info referenced by
 263 /// this descriptor. After this completes, the current debug info value
 264 /// is erased.
 265 void DIDerivedType::replaceAllUsesWith(DIDescriptor &D) {
 266   if (isNull())
 267     return;
 268
 269   assert (!D.isNull() && "Can not replace with null");
 270   DbgNode->replaceAllUsesWith(D.getNode());
 271   delete DbgNode;
 272 }
 273
 274 /// Verify - Verify that a compile unit is well formed.
 275 bool DICompileUnit::Verify() const {
 276   if (isNull())
 277     return false;
 278   std::string Res;
 279   if (getFilename(Res).empty())
 280     return false;
 281   // It is possible that directory and produce string is empty.
 282   return true;
 283 }
 284
 285 /// Verify - Verify that a type descriptor is well formed.
 286 bool DIType::Verify() const {
 287   if (isNull())
 288     return false;
 289   if (getContext().isNull())
 290     return false;
 291
 292   DICompileUnit CU = getCompileUnit();
 293   if (!CU.isNull() && !CU.Verify())
 294     return false;
 295   return true;
 296 }
 297
 298 /// Verify - Verify that a composite type descriptor is well formed.
 299 bool DICompositeType::Verify() const {
 300   if (isNull())
 301     return false;
 302   if (getContext().isNull())
 303     return false;
 304
 305   DICompileUnit CU = getCompileUnit();
 306   if (!CU.isNull() && !CU.Verify())
 307     return false;
 308   return true;
 309 }
 310
 311 /// Verify - Verify that a subprogram descriptor is well formed.
 312 bool DISubprogram::Verify() const {
 313   if (isNull())
 314     return false;
 315
 316   if (getContext().isNull())
 317     return false;
 318
 319   DICompileUnit CU = getCompileUnit();
 320   if (!CU.Verify())
 321     return false;
 322
 323   DICompositeType Ty = getType();
 324   if (!Ty.isNull() && !Ty.Verify())
 325     return false;
 326   return true;
 327 }
 328
 329 /// Verify - Verify that a global variable descriptor is well formed.
 330 bool DIGlobalVariable::Verify() const {
 331   if (isNull())
 332     return false;
 333
 334   if (getContext().isNull())
 335     return false;
 336
 337   DICompileUnit CU = getCompileUnit();
 338   if (!CU.isNull() && !CU.Verify())
 339     return false;
 340
 341   DIType Ty = getType();
 342   if (!Ty.Verify())
 343     return false;
 344
 345   if (!getGlobal())
 346     return false;
 347
 348   return true;
 349 }
 350
 351 /// Verify - Verify that a variable descriptor is well formed.
 352 bool DIVariable::Verify() const {
 353   if (isNull())
 354     return false;
 355
 356   if (getContext().isNull())
 357     return false;
 358
 359   DIType Ty = getType();
 360   if (!Ty.Verify())
 361     return false;
 362
 363   return true;
 364 }
 365
 366 /// getOriginalTypeSize - If this type is derived from a base type then
 367 /// return base type size.
 368 uint64_t DIDerivedType::getOriginalTypeSize() const {
 369   if (getTag() != dwarf::DW_TAG_member)
 370     return getSizeInBits();
 371   DIType BT = getTypeDerivedFrom();
 372   if (BT.getTag() != dwarf::DW_TAG_base_type)
 373     return getSizeInBits();
 374   return BT.getSizeInBits();
 375 }
 376
 377 /// describes - Return true if this subprogram provides debugging
 378 /// information for the function F.
 379 bool DISubprogram::describes(const Function *F) {
 380   assert (F && "Invalid function");
 381   std::string Name;
 382   getLinkageName(Name);
 383   if (Name.empty())
 384     getName(Name);
 385   if (F->getName() == Name)
 386     return true;
 387   return false;
 388 }
 389
 390 //===----------------------------------------------------------------------===//
 391 // DIDescriptor: dump routines for all descriptors.
 392 //===----------------------------------------------------------------------===//
 393
 394
 395 /// dump - Print descriptor.
 396 void DIDescriptor::dump() const {
 397   errs() << "[" << dwarf::TagString(getTag()) << "] ";
 398   errs().write_hex((intptr_t)DbgNode) << ']';
 399 }
 400
 401 /// dump - Print compile unit.
 402 void DICompileUnit::dump() const {
 403   if (getLanguage())
 404     errs() << " [" << dwarf::LanguageString(getLanguage()) << "] ";
 405
 406   std::string Res1, Res2;
 407   errs() << " [" << getDirectory(Res1) << "/" << getFilename(Res2) << " ]";
 408 }
 409
 410 /// dump - Print type.
 411 void DIType::dump() const {
 412   if (isNull()) return;
 413
 414   std::string Res;
 415   if (!getName(Res).empty())
 416     errs() << " [" << Res << "] ";
 417
 418   unsigned Tag = getTag();
 419   errs() << " [" << dwarf::TagString(Tag) << "] ";
 420
 421   // TODO : Print context
 422   getCompileUnit().dump();
 423   errs() << " ["
 424          << getLineNumber() << ", "
 425          << getSizeInBits() << ", "
 426          << getAlignInBits() << ", "
 427          << getOffsetInBits()
 428          << "] ";
 429
 430   if (isPrivate())
 431     errs() << " [private] ";
 432   else if (isProtected())
 433     errs() << " [protected] ";
 434
 435   if (isForwardDecl())
 436     errs() << " [fwd] ";
 437
 438   if (isBasicType())
 439     DIBasicType(DbgNode).dump();
 440   else if (isDerivedType())
 441     DIDerivedType(DbgNode).dump();
 442   else if (isCompositeType())
 443     DICompositeType(DbgNode).dump();
 444   else {
 445     errs() << "Invalid DIType\n";
 446     return;
 447   }
 448
 449   errs() << "\n";
 450 }
 451
 452 /// dump - Print basic type.
 453 void DIBasicType::dump() const {
 454   errs() << " [" << dwarf::AttributeEncodingString(getEncoding()) << "] ";
 455 }
 456
 457 /// dump - Print derived type.
 458 void DIDerivedType::dump() const {
 459   errs() << "\n\t Derived From: "; getTypeDerivedFrom().dump();
 460 }
 461
 462 /// dump - Print composite type.
 463 void DICompositeType::dump() const {
 464   DIArray A = getTypeArray();
 465   if (A.isNull())
 466     return;
 467   errs() << " [" << A.getNumElements() << " elements]";
 468 }
 469
 470 /// dump - Print global.
 471 void DIGlobal::dump() const {
 472   std::string Res;
 473   if (!getName(Res).empty())
 474     errs() << " [" << Res << "] ";
 475
 476   unsigned Tag = getTag();
 477   errs() << " [" << dwarf::TagString(Tag) << "] ";
 478
 479   // TODO : Print context
 480   getCompileUnit().dump();
 481   errs() << " [" << getLineNumber() << "] ";
 482
 483   if (isLocalToUnit())
 484     errs() << " [local] ";
 485
 486   if (isDefinition())
 487     errs() << " [def] ";
 488
 489   if (isGlobalVariable())
 490     DIGlobalVariable(DbgNode).dump();
 491
 492   errs() << "\n";
 493 }
 494
 495 /// dump - Print subprogram.
 496 void DISubprogram::dump() const {
 497   DIGlobal::dump();
 498 }
 499
 500 /// dump - Print global variable.
 501 void DIGlobalVariable::dump() const {
 502   errs() << " [";
 503   getGlobal()->dump();
 504   errs() << "] ";
 505 }
 506
 507 /// dump - Print variable.
 508 void DIVariable::dump() const {
 509   std::string Res;
 510   if (!getName(Res).empty())
 511     errs() << " [" << Res << "] ";
 512
 513   getCompileUnit().dump();
 514   errs() << " [" << getLineNumber() << "] ";
 515   getType().dump();
 516   errs() << "\n";
 517 }
 518
 519 //===----------------------------------------------------------------------===//
 520 // DIFactory: Basic Helpers
 521 //===----------------------------------------------------------------------===//
 522
 523 DIFactory::DIFactory(Module &m)
 524   : M(m), VMContext(M.getContext()), StopPointFn(0), FuncStartFn(0),
 525     RegionStartFn(0), RegionEndFn(0),
 526     DeclareFn(0) {
 527   EmptyStructPtr = PointerType::getUnqual(StructType::get(VMContext));
 528 }
 529
 530 Constant *DIFactory::GetTagConstant(unsigned TAG) {
 531   assert((TAG & LLVMDebugVersionMask) == 0 &&
 532          "Tag too large for debug encoding!");
 533   return ConstantInt::get(Type::getInt32Ty(VMContext), TAG | LLVMDebugVersion);
 534 }
 535
 536 //===----------------------------------------------------------------------===//
 537 // DIFactory: Primary Constructors
 538 //===----------------------------------------------------------------------===//
 539
 540 /// GetOrCreateArray - Create an descriptor for an array of descriptors.
 541 /// This implicitly uniques the arrays created.
 542 DIArray DIFactory::GetOrCreateArray(DIDescriptor *Tys, unsigned NumTys) {
 543   SmallVector<Value*, 16> Elts;
 544
 545   if (NumTys == 0)
 546     Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)));
 547   else
 548     for (unsigned i = 0; i != NumTys; ++i)
 549       Elts.push_back(Tys[i].getNode());
 550
 551   return DIArray(MDNode::get(VMContext,Elts.data(), Elts.size()));
 552 }
 553
 554 /// GetOrCreateSubrange - Create a descriptor for a value range.  This
 555 /// implicitly uniques the values returned.
 556 DISubrange DIFactory::GetOrCreateSubrange(int64_t Lo, int64_t Hi) {
 557   Value *Elts[] = {
 558     GetTagConstant(dwarf::DW_TAG_subrange_type),
 559     ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
 560     ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
 561   };
 562
 563   return DISubrange(MDNode::get(VMContext, &Elts[0], 3));
 564 }
 565
 566
 567
 568 /// CreateCompileUnit - Create a new descriptor for the specified compile
 569 /// unit.  Note that this does not unique compile units within the module.
 570 DICompileUnit DIFactory::CreateCompileUnit(unsigned LangID,
 571                                            const std::string &Filename,
 572                                            const std::string &Directory,
 573                                            const std::string &Producer,
 574                                            bool isMain,
 575                                            bool isOptimized,
 576                                            const char *Flags,
 577                                            unsigned RunTimeVer) {
 578   Value *Elts[] = {
 579     GetTagConstant(dwarf::DW_TAG_compile_unit),
 580     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 581     ConstantInt::get(Type::getInt32Ty(VMContext), LangID),
 582     MDString::get(VMContext, Filename),
 583     MDString::get(VMContext, Directory),
 584     MDString::get(VMContext, Producer),
 585     ConstantInt::get(Type::getInt1Ty(VMContext), isMain),
 586     ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
 587     MDString::get(VMContext, Flags),
 588     ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer)
 589   };
 590
 591   return DICompileUnit(MDNode::get(VMContext, &Elts[0], 10));
 592 }
 593
 594 /// CreateEnumerator - Create a single enumerator value.
 595 DIEnumerator DIFactory::CreateEnumerator(const std::string &Name, uint64_t Val){
 596   Value *Elts[] = {
 597     GetTagConstant(dwarf::DW_TAG_enumerator),
 598     MDString::get(VMContext, Name),
 599     ConstantInt::get(Type::getInt64Ty(VMContext), Val)
 600   };
 601   return DIEnumerator(MDNode::get(VMContext, &Elts[0], 3));
 602 }
 603
 604
 605 /// CreateBasicType - Create a basic type like int, float, etc.
 606 DIBasicType DIFactory::CreateBasicType(DIDescriptor Context,
 607                                       const std::string &Name,
 608                                        DICompileUnit CompileUnit,
 609                                        unsigned LineNumber,
 610                                        uint64_t SizeInBits,
 611                                        uint64_t AlignInBits,
 612                                        uint64_t OffsetInBits, unsigned Flags,
 613                                        unsigned Encoding) {
 614   Value *Elts[] = {
 615     GetTagConstant(dwarf::DW_TAG_base_type),
 616     Context.getNode(),
 617     MDString::get(VMContext, Name),
 618     CompileUnit.getNode(),
 619     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 620     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 621     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 622     ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
 623     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 624     ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
 625   };
 626   return DIBasicType(MDNode::get(VMContext, &Elts[0], 10));
 627 }
 628
 629 /// CreateDerivedType - Create a derived type like const qualified type,
 630 /// pointer, typedef, etc.
 631 DIDerivedType DIFactory::CreateDerivedType(unsigned Tag,
 632                                            DIDescriptor Context,
 633                                            const std::string &Name,
 634                                            DICompileUnit CompileUnit,
 635                                            unsigned LineNumber,
 636                                            uint64_t SizeInBits,
 637                                            uint64_t AlignInBits,
 638                                            uint64_t OffsetInBits,
 639                                            unsigned Flags,
 640                                            DIType DerivedFrom) {
 641   Value *Elts[] = {
 642     GetTagConstant(Tag),
 643     Context.getNode(),
 644     MDString::get(VMContext, Name),
 645     CompileUnit.getNode(),
 646     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 647     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 648     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 649     ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
 650     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 651     DerivedFrom.getNode(),
 652   };
 653   return DIDerivedType(MDNode::get(VMContext, &Elts[0], 10));
 654 }
 655
 656 /// CreateCompositeType - Create a composite type like array, struct, etc.
 657 DICompositeType DIFactory::CreateCompositeType(unsigned Tag,
 658                                                DIDescriptor Context,
 659                                                const std::string &Name,
 660                                                DICompileUnit CompileUnit,
 661                                                unsigned LineNumber,
 662                                                uint64_t SizeInBits,
 663                                                uint64_t AlignInBits,
 664                                                uint64_t OffsetInBits,
 665                                                unsigned Flags,
 666                                                DIType DerivedFrom,
 667                                                DIArray Elements,
 668                                                unsigned RuntimeLang) {
 669
 670   Value *Elts[] = {
 671     GetTagConstant(Tag),
 672     Context.getNode(),
 673     MDString::get(VMContext, Name),
 674     CompileUnit.getNode(),
 675     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 676     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 677     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 678     ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
 679     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 680     DerivedFrom.getNode(),
 681     Elements.getNode(),
 682     ConstantInt::get(Type::getInt32Ty(VMContext), RuntimeLang)
 683   };
 684   return DICompositeType(MDNode::get(VMContext, &Elts[0], 12));
 685 }
 686
 687
 688 /// CreateSubprogram - Create a new descriptor for the specified subprogram.
 689 /// See comments in DISubprogram for descriptions of these fields.  This
 690 /// method does not unique the generated descriptors.
 691 DISubprogram DIFactory::CreateSubprogram(DIDescriptor Context,
 692                                          const std::string &Name,
 693                                          const std::string &DisplayName,
 694                                          const std::string &LinkageName,
 695                                          DICompileUnit CompileUnit,
 696                                          unsigned LineNo, DIType Type,
 697                                          bool isLocalToUnit,
 698                                          bool isDefinition) {
 699
 700   Value *Elts[] = {
 701     GetTagConstant(dwarf::DW_TAG_subprogram),
 702     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 703     Context.getNode(),
 704     MDString::get(VMContext, Name),
 705     MDString::get(VMContext, DisplayName),
 706     MDString::get(VMContext, LinkageName),
 707     CompileUnit.getNode(),
 708     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 709     Type.getNode(),
 710     ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
 711     ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition)
 712   };
 713   return DISubprogram(MDNode::get(VMContext, &Elts[0], 11));
 714 }
 715
 716 /// CreateGlobalVariable - Create a new descriptor for the specified global.
 717 DIGlobalVariable
 718 DIFactory::CreateGlobalVariable(DIDescriptor Context, const std::string &Name,
 719                                 const std::string &DisplayName,
 720                                 const std::string &LinkageName,
 721                                 DICompileUnit CompileUnit,
 722                                 unsigned LineNo, DIType Type,bool isLocalToUnit,
 723                                 bool isDefinition, llvm::GlobalVariable *Val) {
 724   Value *Elts[] = {
 725     GetTagConstant(dwarf::DW_TAG_variable),
 726     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 727     Context.getNode(),
 728     MDString::get(VMContext, Name),
 729     MDString::get(VMContext, DisplayName),
 730     MDString::get(VMContext, LinkageName),
 731     CompileUnit.getNode(),
 732     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 733     Type.getNode(),
 734     ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
 735     ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
 736     Val
 737   };
 738
 739   Value *const *Vs = &Elts[0];
 740   MDNode *Node = MDNode::get(VMContext,Vs, 12);
 741
 742   // Create a named metadata so that we do not lose this mdnode.
 743   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
 744   NMD->addElement(Node);
 745
 746   return DIGlobalVariable(Node);
 747 }
 748
 749
 750 /// CreateVariable - Create a new descriptor for the specified variable.
 751 DIVariable DIFactory::CreateVariable(unsigned Tag, DIDescriptor Context,
 752                                      const std::string &Name,
 753                                      DICompileUnit CompileUnit, unsigned LineNo,
 754                                      DIType Type) {
 755   Value *Elts[] = {
 756     GetTagConstant(Tag),
 757     Context.getNode(),
 758     MDString::get(VMContext, Name),
 759     CompileUnit.getNode(),
 760     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 761     Type.getNode(),
 762   };
 763   return DIVariable(MDNode::get(VMContext, &Elts[0], 6));
 764 }
 765
 766
 767 /// CreateBlock - This creates a descriptor for a lexical block with the
 768 /// specified parent VMContext.
 769 DILexicalBlock DIFactory::CreateLexicalBlock(DIDescriptor Context) {
 770   Value *Elts[] = {
 771     GetTagConstant(dwarf::DW_TAG_lexical_block),
 772     Context.getNode()
 773   };
 774   return DILexicalBlock(MDNode::get(VMContext, &Elts[0], 2));
 775 }
 776
 777
 778 //===----------------------------------------------------------------------===//
 779 // DIFactory: Routines for inserting code into a function
 780 //===----------------------------------------------------------------------===//
 781
 782 /// InsertStopPoint - Create a new llvm.dbg.stoppoint intrinsic invocation,
 783 /// inserting it at the end of the specified basic block.
 784 void DIFactory::InsertStopPoint(DICompileUnit CU, unsigned LineNo,
 785                                 unsigned ColNo, BasicBlock *BB) {
 786
 787   // Lazily construct llvm.dbg.stoppoint function.
 788   if (!StopPointFn)
 789     StopPointFn = llvm::Intrinsic::getDeclaration(&M,
 790                                               llvm::Intrinsic::dbg_stoppoint);
 791
 792   // Invoke llvm.dbg.stoppoint
 793   Value *Args[] = {
 794     ConstantInt::get(llvm::Type::getInt32Ty(VMContext), LineNo),
 795     ConstantInt::get(llvm::Type::getInt32Ty(VMContext), ColNo),
 796     CU.getNode()
 797   };
 798   CallInst::Create(StopPointFn, Args, Args+3, "", BB);
 799 }
 800
 801 /// InsertSubprogramStart - Create a new llvm.dbg.func.start intrinsic to
 802 /// mark the start of the specified subprogram.
 803 void DIFactory::InsertSubprogramStart(DISubprogram SP, BasicBlock *BB) {
 804   // Lazily construct llvm.dbg.func.start.
 805   if (!FuncStartFn)
 806     FuncStartFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_func_start);
 807
 808   // Call llvm.dbg.func.start which also implicitly sets a stoppoint.
 809   CallInst::Create(FuncStartFn, SP.getNode(), "", BB);
 810 }
 811
 812 /// InsertRegionStart - Insert a new llvm.dbg.region.start intrinsic call to
 813 /// mark the start of a region for the specified scoping descriptor.
 814 void DIFactory::InsertRegionStart(DIDescriptor D, BasicBlock *BB) {
 815   // Lazily construct llvm.dbg.region.start function.
 816   if (!RegionStartFn)
 817     RegionStartFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_region_start);
 818
 819   // Call llvm.dbg.func.start.
 820   CallInst::Create(RegionStartFn, D.getNode(), "", BB);
 821 }
 822
 823 /// InsertRegionEnd - Insert a new llvm.dbg.region.end intrinsic call to
 824 /// mark the end of a region for the specified scoping descriptor.
 825 void DIFactory::InsertRegionEnd(DIDescriptor D, BasicBlock *BB) {
 826   // Lazily construct llvm.dbg.region.end function.
 827   if (!RegionEndFn)
 828     RegionEndFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_region_end);
 829
 830   // Call llvm.dbg.region.end.
 831   CallInst::Create(RegionEndFn, D.getNode(), "", BB);
 832 }
 833
 834 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
 835 void DIFactory::InsertDeclare(Value *Storage, DIVariable D, BasicBlock *BB) {
 836   // Cast the storage to a {}* for the call to llvm.dbg.declare.
 837   Storage = new BitCastInst(Storage, EmptyStructPtr, "", BB);
 838
 839   if (!DeclareFn)
 840     DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
 841
 842   Value *Args[] = { Storage, D.getNode() };
 843   CallInst::Create(DeclareFn, Args, Args+2, "", BB);
 844 }
 845
 846
 847 //===----------------------------------------------------------------------===//
 848 // DebugInfoFinder implementations.
 849 //===----------------------------------------------------------------------===//
 850
 851 /// processModule - Process entire module and collect debug info.
 852 void DebugInfoFinder::processModule(Module &M) {
 853
 854
 855   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 856     for (Function::iterator FI = (*I).begin(), FE = (*I).end(); FI != FE; ++FI)
 857       for (BasicBlock::iterator BI = (*FI).begin(), BE = (*FI).end(); BI != BE;
 858            ++BI) {
 859         if (DbgStopPointInst *SPI = dyn_cast<DbgStopPointInst>(BI))
 860           processStopPoint(SPI);
 861         else if (DbgFuncStartInst *FSI = dyn_cast<DbgFuncStartInst>(BI))
 862           processFuncStart(FSI);
 863         else if (DbgRegionStartInst *DRS = dyn_cast<DbgRegionStartInst>(BI))
 864           processRegionStart(DRS);
 865         else if (DbgRegionEndInst *DRE = dyn_cast<DbgRegionEndInst>(BI))
 866           processRegionEnd(DRE);
 867         else if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
 868           processDeclare(DDI);
 869       }
 870
 871   NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.gv");
 872   if (!NMD)
 873     return;
 874
 875   for (unsigned i = 0, e = NMD->getNumElements(); i != e; ++i) {
 876     DIGlobalVariable DIG(cast<MDNode>(NMD->getElement(i)));
 877     if (addGlobalVariable(DIG)) {
 878       addCompileUnit(DIG.getCompileUnit());
 879       processType(DIG.getType());
 880     }
 881   }
 882 }
 883
 884 /// processType - Process DIType.
 885 void DebugInfoFinder::processType(DIType DT) {
 886   if (!addType(DT))
 887     return;
 888
 889   addCompileUnit(DT.getCompileUnit());
 890   if (DT.isCompositeType()) {
 891     DICompositeType DCT(DT.getNode());
 892     processType(DCT.getTypeDerivedFrom());
 893     DIArray DA = DCT.getTypeArray();
 894     if (!DA.isNull())
 895       for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
 896         DIDescriptor D = DA.getElement(i);
 897         DIType TypeE = DIType(D.getNode());
 898         if (!TypeE.isNull())
 899           processType(TypeE);
 900         else
 901           processSubprogram(DISubprogram(D.getNode()));
 902       }
 903   } else if (DT.isDerivedType()) {
 904     DIDerivedType DDT(DT.getNode());
 905     if (!DDT.isNull())
 906       processType(DDT.getTypeDerivedFrom());
 907   }
 908 }
 909
 910 /// processSubprogram - Process DISubprogram.
 911 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
 912   if (SP.isNull())
 913     return;
 914   if (!addSubprogram(SP))
 915     return;
 916   addCompileUnit(SP.getCompileUnit());
 917   processType(SP.getType());
 918 }
 919
 920 /// processStopPoint - Process DbgStopPointInst.
 921 void DebugInfoFinder::processStopPoint(DbgStopPointInst *SPI) {
 922   MDNode *Context = dyn_cast<MDNode>(SPI->getContext());
 923   addCompileUnit(DICompileUnit(Context));
 924 }
 925
 926 /// processFuncStart - Process DbgFuncStartInst.
 927 void DebugInfoFinder::processFuncStart(DbgFuncStartInst *FSI) {
 928   MDNode *SP = dyn_cast<MDNode>(FSI->getSubprogram());
 929   processSubprogram(DISubprogram(SP));
 930 }
 931
 932 /// processRegionStart - Process DbgRegionStart.
 933 void DebugInfoFinder::processRegionStart(DbgRegionStartInst *DRS) {
 934   MDNode *SP = dyn_cast<MDNode>(DRS->getContext());
 935   processSubprogram(DISubprogram(SP));
 936 }
 937
 938 /// processRegionEnd - Process DbgRegionEnd.
 939 void DebugInfoFinder::processRegionEnd(DbgRegionEndInst *DRE) {
 940   MDNode *SP = dyn_cast<MDNode>(DRE->getContext());
 941   processSubprogram(DISubprogram(SP));
 942 }
 943
 944 /// processDeclare - Process DbgDeclareInst.
 945 void DebugInfoFinder::processDeclare(DbgDeclareInst *DDI) {
 946   DIVariable DV(cast<MDNode>(DDI->getVariable()));
 947   if (DV.isNull())
 948     return;
 949
 950   if (!NodesSeen.insert(DV.getNode()))
 951     return;
 952
 953   addCompileUnit(DV.getCompileUnit());
 954   processType(DV.getType());
 955 }
 956
 957 /// addType - Add type into Tys.
 958 bool DebugInfoFinder::addType(DIType DT) {
 959   if (DT.isNull())
 960     return false;
 961
 962   if (!NodesSeen.insert(DT.getNode()))
 963     return false;
 964
 965   TYs.push_back(DT.getNode());
 966   return true;
 967 }
 968
 969 /// addCompileUnit - Add compile unit into CUs.
 970 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
 971   if (CU.isNull())
 972     return false;
 973
 974   if (!NodesSeen.insert(CU.getNode()))
 975     return false;
 976
 977   CUs.push_back(CU.getNode());
 978   return true;
 979 }
 980
 981 /// addGlobalVariable - Add global variable into GVs.
 982 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
 983   if (DIG.isNull())
 984     return false;
 985
 986   if (!NodesSeen.insert(DIG.getNode()))
 987     return false;
 988
 989   GVs.push_back(DIG.getNode());
 990   return true;
 991 }
 992
 993 // addSubprogram - Add subprgoram into SPs.
 994 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
 995   if (SP.isNull())
 996     return false;
 997
 998   if (!NodesSeen.insert(SP.getNode()))
 999     return false;
1000
1001   SPs.push_back(SP.getNode());
1002   return true;
1003 }
1004
1005 namespace llvm {
1006   /// findStopPoint - Find the stoppoint coressponding to this instruction, that
1007   /// is the stoppoint that dominates this instruction.
1008   const DbgStopPointInst *findStopPoint(const Instruction *Inst) {
1009     if (const DbgStopPointInst *DSI = dyn_cast<DbgStopPointInst>(Inst))
1010       return DSI;
1011
1012     const BasicBlock *BB = Inst->getParent();
1013     BasicBlock::const_iterator I = Inst, B;
1014     while (BB) {
1015       B = BB->begin();
1016
1017       // A BB consisting only of a terminator can't have a stoppoint.
1018       while (I != B) {
1019         --I;
1020         if (const DbgStopPointInst *DSI = dyn_cast<DbgStopPointInst>(I))
1021           return DSI;
1022       }
1023
1024       // This BB didn't have a stoppoint: if there is only one predecessor, look
1025       // for a stoppoint there. We could use getIDom(), but that would require
1026       // dominator info.
1027       BB = I->getParent()->getUniquePredecessor();
1028       if (BB)
1029         I = BB->getTerminator();
1030     }
1031
1032     return 0;
1033   }
1034
1035   /// findBBStopPoint - Find the stoppoint corresponding to first real
1036   /// (non-debug intrinsic) instruction in this Basic Block, and return the
1037   /// stoppoint for it.
1038   const DbgStopPointInst *findBBStopPoint(const BasicBlock *BB) {
1039     for(BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I)
1040       if (const DbgStopPointInst *DSI = dyn_cast<DbgStopPointInst>(I))
1041         return DSI;
1042
1043     // Fallback to looking for stoppoint of unique predecessor. Useful if this
1044     // BB contains no stoppoints, but unique predecessor does.
1045     BB = BB->getUniquePredecessor();
1046     if (BB)
1047       return findStopPoint(BB->getTerminator());
1048
1049     return 0;
1050   }
1051
1052   Value *findDbgGlobalDeclare(GlobalVariable *V) {
1053     const Module *M = V->getParent();
1054     NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv");
1055     if (!NMD)
1056       return 0;
1057
1058     for (unsigned i = 0, e = NMD->getNumElements(); i != e; ++i) {
1059       DIGlobalVariable DIG(cast_or_null<MDNode>(NMD->getElement(i)));
1060       if (DIG.isNull())
1061         continue;
1062       if (DIG.getGlobal() == V)
1063         return DIG.getNode();
1064     }
1065     return 0;
1066   }
1067
1068   /// Finds the llvm.dbg.declare intrinsic corresponding to this value if any.
1069   /// It looks through pointer casts too.
1070   const DbgDeclareInst *findDbgDeclare(const Value *V, bool stripCasts) {
1071     if (stripCasts) {
1072       V = V->stripPointerCasts();
1073
1074       // Look for the bitcast.
1075       for (Value::use_const_iterator I = V->use_begin(), E =V->use_end();
1076             I != E; ++I)
1077         if (isa<BitCastInst>(I))
1078           return findDbgDeclare(*I, false);
1079
1080       return 0;
1081     }
1082
1083     // Find llvm.dbg.declare among uses of the instruction.
1084     for (Value::use_const_iterator I = V->use_begin(), E =V->use_end();
1085           I != E; ++I)
1086       if (const DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(I))
1087         return DDI;
1088
1089     return 0;
1090   }
1091
1092   bool getLocationInfo(const Value *V, std::string &DisplayName,
1093                        std::string &Type, unsigned &LineNo, std::string &File,
1094                        std::string &Dir) {
1095     DICompileUnit Unit;
1096     DIType TypeD;
1097
1098     if (GlobalVariable *GV = dyn_cast<GlobalVariable>(const_cast<Value*>(V))) {
1099       Value *DIGV = findDbgGlobalDeclare(GV);
1100       if (!DIGV) return false;
1101       DIGlobalVariable Var(cast<MDNode>(DIGV));
1102
1103       Var.getDisplayName(DisplayName);
1104       LineNo = Var.getLineNumber();
1105       Unit = Var.getCompileUnit();
1106       TypeD = Var.getType();
1107     } else {
1108       const DbgDeclareInst *DDI = findDbgDeclare(V);
1109       if (!DDI) return false;
1110       DIVariable Var(cast<MDNode>(DDI->getVariable()));
1111
1112       Var.getName(DisplayName);
1113       LineNo = Var.getLineNumber();
1114       Unit = Var.getCompileUnit();
1115       TypeD = Var.getType();
1116     }
1117
1118     TypeD.getName(Type);
1119     Unit.getFilename(File);
1120     Unit.getDirectory(Dir);
1121     return true;
1122   }
1123
1124   /// isValidDebugInfoIntrinsic - Return true if SPI is a valid debug
1125   /// info intrinsic.
1126   bool isValidDebugInfoIntrinsic(DbgStopPointInst &SPI,
1127                                  CodeGenOpt::Level OptLev) {
1128     return DIDescriptor::ValidDebugInfo(SPI.getContext(), OptLev);
1129   }
1130
1131   /// isValidDebugInfoIntrinsic - Return true if FSI is a valid debug
1132   /// info intrinsic.
1133   bool isValidDebugInfoIntrinsic(DbgFuncStartInst &FSI,
1134                                  CodeGenOpt::Level OptLev) {
1135     return DIDescriptor::ValidDebugInfo(FSI.getSubprogram(), OptLev);
1136   }
1137
1138   /// isValidDebugInfoIntrinsic - Return true if RSI is a valid debug
1139   /// info intrinsic.
1140   bool isValidDebugInfoIntrinsic(DbgRegionStartInst &RSI,
1141                                  CodeGenOpt::Level OptLev) {
1142     return DIDescriptor::ValidDebugInfo(RSI.getContext(), OptLev);
1143   }
1144
1145   /// isValidDebugInfoIntrinsic - Return true if REI is a valid debug
1146   /// info intrinsic.
1147   bool isValidDebugInfoIntrinsic(DbgRegionEndInst &REI,
1148                                  CodeGenOpt::Level OptLev) {
1149     return DIDescriptor::ValidDebugInfo(REI.getContext(), OptLev);
1150   }
1151
1152
1153   /// isValidDebugInfoIntrinsic - Return true if DI is a valid debug
1154   /// info intrinsic.
1155   bool isValidDebugInfoIntrinsic(DbgDeclareInst &DI,
1156                                  CodeGenOpt::Level OptLev) {
1157     return DIDescriptor::ValidDebugInfo(DI.getVariable(), OptLev);
1158   }
1159
1160   /// ExtractDebugLocation - Extract debug location information
1161   /// from llvm.dbg.stoppoint intrinsic.
1162   DebugLoc ExtractDebugLocation(DbgStopPointInst &SPI,
1163                                 DebugLocTracker &DebugLocInfo) {
1164     DebugLoc DL;
1165     Value *Context = SPI.getContext();
1166
1167     // If this location is already tracked then use it.
1168     DebugLocTuple Tuple(cast<MDNode>(Context), SPI.getLine(),
1169                         SPI.getColumn());
1170     DenseMap<DebugLocTuple, unsigned>::iterator II
1171       = DebugLocInfo.DebugIdMap.find(Tuple);
1172     if (II != DebugLocInfo.DebugIdMap.end())
1173       return DebugLoc::get(II->second);
1174
1175     // Add a new location entry.
1176     unsigned Id = DebugLocInfo.DebugLocations.size();
1177     DebugLocInfo.DebugLocations.push_back(Tuple);
1178     DebugLocInfo.DebugIdMap[Tuple] = Id;
1179
1180     return DebugLoc::get(Id);
1181   }
1182
1183   /// ExtractDebugLocation - Extract debug location information
1184   /// from llvm.dbg.func_start intrinsic.
1185   DebugLoc ExtractDebugLocation(DbgFuncStartInst &FSI,
1186                                 DebugLocTracker &DebugLocInfo) {
1187     DebugLoc DL;
1188     Value *SP = FSI.getSubprogram();
1189
1190     DISubprogram Subprogram(cast<MDNode>(SP));
1191     unsigned Line = Subprogram.getLineNumber();
1192     DICompileUnit CU(Subprogram.getCompileUnit());
1193
1194     // If this location is already tracked then use it.
1195     DebugLocTuple Tuple(CU.getNode(), Line, /* Column */ 0);
1196     DenseMap<DebugLocTuple, unsigned>::iterator II
1197       = DebugLocInfo.DebugIdMap.find(Tuple);
1198     if (II != DebugLocInfo.DebugIdMap.end())
1199       return DebugLoc::get(II->second);
1200
1201     // Add a new location entry.
1202     unsigned Id = DebugLocInfo.DebugLocations.size();
1203     DebugLocInfo.DebugLocations.push_back(Tuple);
1204     DebugLocInfo.DebugIdMap[Tuple] = Id;
1205
1206     return DebugLoc::get(Id);
1207   }
1208
1209   /// isInlinedFnStart - Return true if FSI is starting an inlined function.
1210   bool isInlinedFnStart(DbgFuncStartInst &FSI, const Function *CurrentFn) {
1211     DISubprogram Subprogram(cast<MDNode>(FSI.getSubprogram()));
1212     if (Subprogram.describes(CurrentFn))
1213       return false;
1214
1215     return true;
1216   }
1217
1218   /// isInlinedFnEnd - Return true if REI is ending an inlined function.
1219   bool isInlinedFnEnd(DbgRegionEndInst &REI, const Function *CurrentFn) {
1220     DISubprogram Subprogram(cast<MDNode>(REI.getContext()));
1221     if (Subprogram.isNull() || Subprogram.describes(CurrentFn))
1222       return false;
1223
1224     return true;
1225   }
1226 }