lib/VMCore/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/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/Module.h"
  22 #include "llvm/Analysis/ValueTracking.h"
  23 #include "llvm/ADT/SmallPtrSet.h"
  24 #include "llvm/ADT/SmallString.h"
  25 #include "llvm/ADT/STLExtras.h"
  26 #include "llvm/Support/Debug.h"
  27 #include "llvm/Support/Dwarf.h"
  28 #include "llvm/Support/raw_ostream.h"
  29 using namespace llvm;
  30 using namespace llvm::dwarf;
  31
  32 //===----------------------------------------------------------------------===//
  33 // DIDescriptor
  34 //===----------------------------------------------------------------------===//
  35
  36 DIDescriptor::DIDescriptor(const DIFile F) : DbgNode(F.DbgNode) {
  37 }
  38
  39 DIDescriptor::DIDescriptor(const DISubprogram F) : DbgNode(F.DbgNode) {
  40 }
  41
  42 DIDescriptor::DIDescriptor(const DILexicalBlockFile F) : DbgNode(F.DbgNode) {
  43 }
  44
  45 DIDescriptor::DIDescriptor(const DILexicalBlock F) : DbgNode(F.DbgNode) {
  46 }
  47
  48 DIDescriptor::DIDescriptor(const DIVariable F) : DbgNode(F.DbgNode) {
  49 }
  50
  51 DIDescriptor::DIDescriptor(const DIType F) : DbgNode(F.DbgNode) {
  52 }
  53
  54 StringRef
  55 DIDescriptor::getStringField(unsigned Elt) const {
  56   if (DbgNode == 0)
  57     return StringRef();
  58
  59   if (Elt < DbgNode->getNumOperands())
  60     if (MDString *MDS = dyn_cast_or_null<MDString>(DbgNode->getOperand(Elt)))
  61       return MDS->getString();
  62
  63   return StringRef();
  64 }
  65
  66 uint64_t DIDescriptor::getUInt64Field(unsigned Elt) const {
  67   if (DbgNode == 0)
  68     return 0;
  69
  70   if (Elt < DbgNode->getNumOperands())
  71     if (ConstantInt *CI
  72         = dyn_cast_or_null<ConstantInt>(DbgNode->getOperand(Elt)))
  73       return CI->getZExtValue();
  74
  75   return 0;
  76 }
  77
  78 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
  79   if (DbgNode == 0)
  80     return DIDescriptor();
  81
  82   if (Elt < DbgNode->getNumOperands())
  83     return
  84       DIDescriptor(dyn_cast_or_null<const MDNode>(DbgNode->getOperand(Elt)));
  85   return DIDescriptor();
  86 }
  87
  88 GlobalVariable *DIDescriptor::getGlobalVariableField(unsigned Elt) const {
  89   if (DbgNode == 0)
  90     return 0;
  91
  92   if (Elt < DbgNode->getNumOperands())
  93       return dyn_cast_or_null<GlobalVariable>(DbgNode->getOperand(Elt));
  94   return 0;
  95 }
  96
  97 Constant *DIDescriptor::getConstantField(unsigned Elt) const {
  98   if (DbgNode == 0)
  99     return 0;
 100
 101   if (Elt < DbgNode->getNumOperands())
 102       return dyn_cast_or_null<Constant>(DbgNode->getOperand(Elt));
 103   return 0;
 104 }
 105
 106 Function *DIDescriptor::getFunctionField(unsigned Elt) const {
 107   if (DbgNode == 0)
 108     return 0;
 109
 110   if (Elt < DbgNode->getNumOperands())
 111       return dyn_cast_or_null<Function>(DbgNode->getOperand(Elt));
 112   return 0;
 113 }
 114
 115 void DIDescriptor::replaceFunctionField(unsigned Elt, Function *F) {
 116   if (DbgNode == 0)
 117     return;
 118
 119   if (Elt < DbgNode->getNumOperands()) {
 120     MDNode *Node = const_cast<MDNode*>(DbgNode);
 121     Node->replaceOperandWith(Elt, F);
 122   }
 123 }
 124
 125 unsigned DIVariable::getNumAddrElements() const {
 126   if (getVersion() <= LLVMDebugVersion8)
 127     return DbgNode->getNumOperands()-6;
 128   if (getVersion() == LLVMDebugVersion9)
 129     return DbgNode->getNumOperands()-7;
 130   return DbgNode->getNumOperands()-8;
 131 }
 132
 133 /// getInlinedAt - If this variable is inlined then return inline location.
 134 MDNode *DIVariable::getInlinedAt() const {
 135   if (getVersion() <= LLVMDebugVersion9)
 136     return NULL;
 137   return dyn_cast_or_null<MDNode>(DbgNode->getOperand(7));
 138 }
 139
 140 //===----------------------------------------------------------------------===//
 141 // Predicates
 142 //===----------------------------------------------------------------------===//
 143
 144 /// isBasicType - Return true if the specified tag is legal for
 145 /// DIBasicType.
 146 bool DIDescriptor::isBasicType() const {
 147   if (!DbgNode) return false;
 148   switch (getTag()) {
 149   case dwarf::DW_TAG_base_type:
 150   case dwarf::DW_TAG_unspecified_type:
 151     return true;
 152   default:
 153     return false;
 154   }
 155 }
 156
 157 /// isDerivedType - Return true if the specified tag is legal for DIDerivedType.
 158 bool DIDescriptor::isDerivedType() const {
 159   if (!DbgNode) return false;
 160   switch (getTag()) {
 161   case dwarf::DW_TAG_typedef:
 162   case dwarf::DW_TAG_pointer_type:
 163   case dwarf::DW_TAG_reference_type:
 164   case dwarf::DW_TAG_rvalue_reference_type:
 165   case dwarf::DW_TAG_const_type:
 166   case dwarf::DW_TAG_volatile_type:
 167   case dwarf::DW_TAG_restrict_type:
 168   case dwarf::DW_TAG_member:
 169   case dwarf::DW_TAG_inheritance:
 170   case dwarf::DW_TAG_friend:
 171     return true;
 172   default:
 173     // CompositeTypes are currently modelled as DerivedTypes.
 174     return isCompositeType();
 175   }
 176 }
 177
 178 /// isCompositeType - Return true if the specified tag is legal for
 179 /// DICompositeType.
 180 bool DIDescriptor::isCompositeType() const {
 181   if (!DbgNode) return false;
 182   switch (getTag()) {
 183   case dwarf::DW_TAG_array_type:
 184   case dwarf::DW_TAG_structure_type:
 185   case dwarf::DW_TAG_union_type:
 186   case dwarf::DW_TAG_enumeration_type:
 187   case dwarf::DW_TAG_vector_type:
 188   case dwarf::DW_TAG_subroutine_type:
 189   case dwarf::DW_TAG_class_type:
 190     return true;
 191   default:
 192     return false;
 193   }
 194 }
 195
 196 /// isVariable - Return true if the specified tag is legal for DIVariable.
 197 bool DIDescriptor::isVariable() const {
 198   if (!DbgNode) return false;
 199   switch (getTag()) {
 200   case dwarf::DW_TAG_auto_variable:
 201   case dwarf::DW_TAG_arg_variable:
 202   case dwarf::DW_TAG_return_variable:
 203     return true;
 204   default:
 205     return false;
 206   }
 207 }
 208
 209 /// isType - Return true if the specified tag is legal for DIType.
 210 bool DIDescriptor::isType() const {
 211   return isBasicType() || isCompositeType() || isDerivedType();
 212 }
 213
 214 /// isSubprogram - Return true if the specified tag is legal for
 215 /// DISubprogram.
 216 bool DIDescriptor::isSubprogram() const {
 217   return DbgNode && getTag() == dwarf::DW_TAG_subprogram;
 218 }
 219
 220 /// isGlobalVariable - Return true if the specified tag is legal for
 221 /// DIGlobalVariable.
 222 bool DIDescriptor::isGlobalVariable() const {
 223   return DbgNode && (getTag() == dwarf::DW_TAG_variable ||
 224                      getTag() == dwarf::DW_TAG_constant);
 225 }
 226
 227 /// isGlobal - Return true if the specified tag is legal for DIGlobal.
 228 bool DIDescriptor::isGlobal() const {
 229   return isGlobalVariable();
 230 }
 231
 232 /// isUnspecifiedParmeter - Return true if the specified tag is
 233 /// DW_TAG_unspecified_parameters.
 234 bool DIDescriptor::isUnspecifiedParameter() const {
 235   return DbgNode && getTag() == dwarf::DW_TAG_unspecified_parameters;
 236 }
 237
 238 /// isScope - Return true if the specified tag is one of the scope
 239 /// related tag.
 240 bool DIDescriptor::isScope() const {
 241   if (!DbgNode) return false;
 242   switch (getTag()) {
 243   case dwarf::DW_TAG_compile_unit:
 244   case dwarf::DW_TAG_lexical_block:
 245   case dwarf::DW_TAG_subprogram:
 246   case dwarf::DW_TAG_namespace:
 247     return true;
 248   default:
 249     break;
 250   }
 251   return false;
 252 }
 253
 254 /// isTemplateTypeParameter - Return true if the specified tag is
 255 /// DW_TAG_template_type_parameter.
 256 bool DIDescriptor::isTemplateTypeParameter() const {
 257   return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
 258 }
 259
 260 /// isTemplateValueParameter - Return true if the specified tag is
 261 /// DW_TAG_template_value_parameter.
 262 bool DIDescriptor::isTemplateValueParameter() const {
 263   return DbgNode && getTag() == dwarf::DW_TAG_template_value_parameter;
 264 }
 265
 266 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
 267 bool DIDescriptor::isCompileUnit() const {
 268   return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
 269 }
 270
 271 /// isFile - Return true if the specified tag is DW_TAG_file_type.
 272 bool DIDescriptor::isFile() const {
 273   return DbgNode && getTag() == dwarf::DW_TAG_file_type;
 274 }
 275
 276 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
 277 bool DIDescriptor::isNameSpace() const {
 278   return DbgNode && getTag() == dwarf::DW_TAG_namespace;
 279 }
 280
 281 /// isLexicalBlockFile - Return true if the specified descriptor is a
 282 /// lexical block with an extra file.
 283 bool DIDescriptor::isLexicalBlockFile() const {
 284   return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
 285     (DbgNode->getNumOperands() == 3);
 286 }
 287
 288 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
 289 bool DIDescriptor::isLexicalBlock() const {
 290   return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
 291     (DbgNode->getNumOperands() > 3);
 292 }
 293
 294 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
 295 bool DIDescriptor::isSubrange() const {
 296   return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
 297 }
 298
 299 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
 300 bool DIDescriptor::isEnumerator() const {
 301   return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
 302 }
 303
 304 /// isObjCProperty - Return true if the specified tag is DW_TAG
 305 bool DIDescriptor::isObjCProperty() const {
 306   return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
 307 }
 308 //===----------------------------------------------------------------------===//
 309 // Simple Descriptor Constructors and other Methods
 310 //===----------------------------------------------------------------------===//
 311
 312 DIType::DIType(const MDNode *N) : DIScope(N) {
 313   if (!N) return;
 314   if (!isBasicType() && !isDerivedType() && !isCompositeType()) {
 315     DbgNode = 0;
 316   }
 317 }
 318
 319 unsigned DIArray::getNumElements() const {
 320   if (!DbgNode)
 321     return 0;
 322   return DbgNode->getNumOperands();
 323 }
 324
 325 /// replaceAllUsesWith - Replace all uses of debug info referenced by
 326 /// this descriptor.
 327 void DIType::replaceAllUsesWith(DIDescriptor &D) {
 328   if (!DbgNode)
 329     return;
 330
 331   // Since we use a TrackingVH for the node, its easy for clients to manufacture
 332   // legitimate situations where they want to replaceAllUsesWith() on something
 333   // which, due to uniquing, has merged with the source. We shield clients from
 334   // this detail by allowing a value to be replaced with replaceAllUsesWith()
 335   // itself.
 336   if (DbgNode != D) {
 337     MDNode *Node = const_cast<MDNode*>(DbgNode);
 338     const MDNode *DN = D;
 339     const Value *V = cast_or_null<Value>(DN);
 340     Node->replaceAllUsesWith(const_cast<Value*>(V));
 341     MDNode::deleteTemporary(Node);
 342   }
 343 }
 344
 345 /// replaceAllUsesWith - Replace all uses of debug info referenced by
 346 /// this descriptor.
 347 void DIType::replaceAllUsesWith(MDNode *D) {
 348   if (!DbgNode)
 349     return;
 350
 351   // Since we use a TrackingVH for the node, its easy for clients to manufacture
 352   // legitimate situations where they want to replaceAllUsesWith() on something
 353   // which, due to uniquing, has merged with the source. We shield clients from
 354   // this detail by allowing a value to be replaced with replaceAllUsesWith()
 355   // itself.
 356   if (DbgNode != D) {
 357     MDNode *Node = const_cast<MDNode*>(DbgNode);
 358     const MDNode *DN = D;
 359     const Value *V = cast_or_null<Value>(DN);
 360     Node->replaceAllUsesWith(const_cast<Value*>(V));
 361     MDNode::deleteTemporary(Node);
 362   }
 363 }
 364
 365 /// isUnsignedDIType - Return true if type encoding is unsigned.
 366 bool DIType::isUnsignedDIType() {
 367   DIDerivedType DTy(DbgNode);
 368   if (DTy.Verify())
 369     return DTy.getTypeDerivedFrom().isUnsignedDIType();
 370
 371   DIBasicType BTy(DbgNode);
 372   if (BTy.Verify()) {
 373     unsigned Encoding = BTy.getEncoding();
 374     if (Encoding == dwarf::DW_ATE_unsigned ||
 375         Encoding == dwarf::DW_ATE_unsigned_char)
 376       return true;
 377   }
 378   return false;
 379 }
 380
 381 /// Verify - Verify that a compile unit is well formed.
 382 bool DICompileUnit::Verify() const {
 383   if (!DbgNode)
 384     return false;
 385   StringRef N = getFilename();
 386   if (N.empty())
 387     return false;
 388   // It is possible that directory and produce string is empty.
 389   return true;
 390 }
 391
 392 /// Verify - Verify that an ObjC property is well formed.
 393 bool DIObjCProperty::Verify() const {
 394   if (!DbgNode)
 395     return false;
 396   unsigned Tag = getTag();
 397   if (Tag != dwarf::DW_TAG_APPLE_property) return false;
 398   DIType Ty = getType();
 399   if (!Ty.Verify()) return false;
 400
 401   // Don't worry about the rest of the strings for now.
 402   return true;
 403 }
 404
 405 /// Verify - Verify that a type descriptor is well formed.
 406 bool DIType::Verify() const {
 407   if (!DbgNode)
 408     return false;
 409   if (getContext() && !getContext().Verify())
 410     return false;
 411   unsigned Tag = getTag();
 412   if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
 413       Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
 414       Tag != dwarf::DW_TAG_reference_type &&
 415       Tag != dwarf::DW_TAG_rvalue_reference_type &&
 416       Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_vector_type &&
 417       Tag != dwarf::DW_TAG_array_type &&
 418       Tag != dwarf::DW_TAG_enumeration_type &&
 419       Tag != dwarf::DW_TAG_subroutine_type &&
 420       getFilename().empty())
 421     return false;
 422   return true;
 423 }
 424
 425 /// Verify - Verify that a basic type descriptor is well formed.
 426 bool DIBasicType::Verify() const {
 427   return isBasicType();
 428 }
 429
 430 /// Verify - Verify that a derived type descriptor is well formed.
 431 bool DIDerivedType::Verify() const {
 432   return isDerivedType();
 433 }
 434
 435 /// Verify - Verify that a composite type descriptor is well formed.
 436 bool DICompositeType::Verify() const {
 437   if (!DbgNode)
 438     return false;
 439   if (getContext() && !getContext().Verify())
 440     return false;
 441
 442   return true;
 443 }
 444
 445 /// Verify - Verify that a subprogram descriptor is well formed.
 446 bool DISubprogram::Verify() const {
 447   if (!DbgNode)
 448     return false;
 449
 450   if (getContext() && !getContext().Verify())
 451     return false;
 452
 453   DICompositeType Ty = getType();
 454   if (!Ty.Verify())
 455     return false;
 456   return true;
 457 }
 458
 459 /// Verify - Verify that a global variable descriptor is well formed.
 460 bool DIGlobalVariable::Verify() const {
 461   if (!DbgNode)
 462     return false;
 463
 464   if (getDisplayName().empty())
 465     return false;
 466
 467   if (getContext() && !getContext().Verify())
 468     return false;
 469
 470   DIType Ty = getType();
 471   if (!Ty.Verify())
 472     return false;
 473
 474   if (!getGlobal() && !getConstant())
 475     return false;
 476
 477   return true;
 478 }
 479
 480 /// Verify - Verify that a variable descriptor is well formed.
 481 bool DIVariable::Verify() const {
 482   if (!DbgNode)
 483     return false;
 484
 485   if (getContext() && !getContext().Verify())
 486     return false;
 487
 488   DIType Ty = getType();
 489   if (!Ty.Verify())
 490     return false;
 491
 492   return true;
 493 }
 494
 495 /// Verify - Verify that a location descriptor is well formed.
 496 bool DILocation::Verify() const {
 497   if (!DbgNode)
 498     return false;
 499
 500   return DbgNode->getNumOperands() == 4;
 501 }
 502
 503 /// Verify - Verify that a namespace descriptor is well formed.
 504 bool DINameSpace::Verify() const {
 505   if (!DbgNode)
 506     return false;
 507   if (getName().empty())
 508     return false;
 509   return true;
 510 }
 511
 512 /// getOriginalTypeSize - If this type is derived from a base type then
 513 /// return base type size.
 514 uint64_t DIDerivedType::getOriginalTypeSize() const {
 515   unsigned Tag = getTag();
 516
 517   if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
 518       Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
 519       Tag != dwarf::DW_TAG_restrict_type)
 520     return getSizeInBits();
 521
 522   DIType BaseType = getTypeDerivedFrom();
 523
 524   // If this type is not derived from any type then take conservative approach.
 525   if (!BaseType.isValid())
 526     return getSizeInBits();
 527
 528   // If this is a derived type, go ahead and get the base type, unless it's a
 529   // reference then it's just the size of the field. Pointer types have no need
 530   // of this since they're a different type of qualification on the type.
 531   if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
 532       BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
 533     return getSizeInBits();
 534
 535   if (BaseType.isDerivedType())
 536     return DIDerivedType(BaseType).getOriginalTypeSize();
 537
 538   return BaseType.getSizeInBits();
 539 }
 540
 541 /// getObjCProperty - Return property node, if this ivar is associated with one.
 542 MDNode *DIDerivedType::getObjCProperty() const {
 543   if (getVersion() <= LLVMDebugVersion11 || DbgNode->getNumOperands() <= 10)
 544     return NULL;
 545   return dyn_cast_or_null<MDNode>(DbgNode->getOperand(10));
 546 }
 547
 548 /// isInlinedFnArgument - Return true if this variable provides debugging
 549 /// information for an inlined function arguments.
 550 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
 551   assert(CurFn && "Invalid function");
 552   if (!getContext().isSubprogram())
 553     return false;
 554   // This variable is not inlined function argument if its scope
 555   // does not describe current function.
 556   return !DISubprogram(getContext()).describes(CurFn);
 557 }
 558
 559 /// describes - Return true if this subprogram provides debugging
 560 /// information for the function F.
 561 bool DISubprogram::describes(const Function *F) {
 562   assert(F && "Invalid function");
 563   if (F == getFunction())
 564     return true;
 565   StringRef Name = getLinkageName();
 566   if (Name.empty())
 567     Name = getName();
 568   if (F->getName() == Name)
 569     return true;
 570   return false;
 571 }
 572
 573 unsigned DISubprogram::isOptimized() const {
 574   assert (DbgNode && "Invalid subprogram descriptor!");
 575   if (DbgNode->getNumOperands() == 16)
 576     return getUnsignedField(15);
 577   return 0;
 578 }
 579
 580 MDNode *DISubprogram::getVariablesNodes() const {
 581   if (!DbgNode || DbgNode->getNumOperands() <= 19)
 582     return NULL;
 583   if (MDNode *Temp = dyn_cast_or_null<MDNode>(DbgNode->getOperand(19)))
 584     return dyn_cast_or_null<MDNode>(Temp->getOperand(0));
 585   return NULL;
 586 }
 587
 588 DIArray DISubprogram::getVariables() const {
 589   if (!DbgNode || DbgNode->getNumOperands() <= 19)
 590     return DIArray();
 591   if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(19)))
 592     if (MDNode *A = dyn_cast_or_null<MDNode>(T->getOperand(0)))
 593       return DIArray(A);
 594   return DIArray();
 595 }
 596
 597 StringRef DIScope::getFilename() const {
 598   if (!DbgNode)
 599     return StringRef();
 600   if (isLexicalBlockFile())
 601     return DILexicalBlockFile(DbgNode).getFilename();
 602   if (isLexicalBlock())
 603     return DILexicalBlock(DbgNode).getFilename();
 604   if (isSubprogram())
 605     return DISubprogram(DbgNode).getFilename();
 606   if (isCompileUnit())
 607     return DICompileUnit(DbgNode).getFilename();
 608   if (isNameSpace())
 609     return DINameSpace(DbgNode).getFilename();
 610   if (isType())
 611     return DIType(DbgNode).getFilename();
 612   if (isFile())
 613     return DIFile(DbgNode).getFilename();
 614   llvm_unreachable("Invalid DIScope!");
 615 }
 616
 617 StringRef DIScope::getDirectory() const {
 618   if (!DbgNode)
 619     return StringRef();
 620   if (isLexicalBlockFile())
 621     return DILexicalBlockFile(DbgNode).getDirectory();
 622   if (isLexicalBlock())
 623     return DILexicalBlock(DbgNode).getDirectory();
 624   if (isSubprogram())
 625     return DISubprogram(DbgNode).getDirectory();
 626   if (isCompileUnit())
 627     return DICompileUnit(DbgNode).getDirectory();
 628   if (isNameSpace())
 629     return DINameSpace(DbgNode).getDirectory();
 630   if (isType())
 631     return DIType(DbgNode).getDirectory();
 632   if (isFile())
 633     return DIFile(DbgNode).getDirectory();
 634   llvm_unreachable("Invalid DIScope!");
 635 }
 636
 637 DIArray DICompileUnit::getEnumTypes() const {
 638   if (!DbgNode || DbgNode->getNumOperands() < 14)
 639     return DIArray();
 640
 641   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
 642     if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
 643       return DIArray(A);
 644   return DIArray();
 645 }
 646
 647 DIArray DICompileUnit::getRetainedTypes() const {
 648   if (!DbgNode || DbgNode->getNumOperands() < 14)
 649     return DIArray();
 650
 651   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
 652     if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
 653       return DIArray(A);
 654   return DIArray();
 655 }
 656
 657 DIArray DICompileUnit::getSubprograms() const {
 658   if (!DbgNode || DbgNode->getNumOperands() < 14)
 659     return DIArray();
 660
 661   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(12)))
 662     if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
 663       return DIArray(A);
 664   return DIArray();
 665 }
 666
 667
 668 DIArray DICompileUnit::getGlobalVariables() const {
 669   if (!DbgNode || DbgNode->getNumOperands() < 14)
 670     return DIArray();
 671
 672   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(13)))
 673     if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
 674       return DIArray(A);
 675   return DIArray();
 676 }
 677
 678 /// fixupObjcLikeName - Replace contains special characters used
 679 /// in a typical Objective-C names with '.' in a given string.
 680 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
 681   bool isObjCLike = false;
 682   for (size_t i = 0, e = Str.size(); i < e; ++i) {
 683     char C = Str[i];
 684     if (C == '[')
 685       isObjCLike = true;
 686
 687     if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
 688                        C == '+' || C == '(' || C == ')'))
 689       Out.push_back('.');
 690     else
 691       Out.push_back(C);
 692   }
 693 }
 694
 695 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
 696 /// suitable to hold function specific information.
 697 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
 698   SmallString<32> Name = StringRef("llvm.dbg.lv.");
 699   StringRef FName = "fn";
 700   if (Fn.getFunction())
 701     FName = Fn.getFunction()->getName();
 702   else
 703     FName = Fn.getName();
 704   char One = '\1';
 705   if (FName.startswith(StringRef(&One, 1)))
 706     FName = FName.substr(1);
 707   fixupObjcLikeName(FName, Name);
 708   return M.getNamedMetadata(Name.str());
 709 }
 710
 711 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
 712 /// to hold function specific information.
 713 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
 714   SmallString<32> Name = StringRef("llvm.dbg.lv.");
 715   StringRef FName = "fn";
 716   if (Fn.getFunction())
 717     FName = Fn.getFunction()->getName();
 718   else
 719     FName = Fn.getName();
 720   char One = '\1';
 721   if (FName.startswith(StringRef(&One, 1)))
 722     FName = FName.substr(1);
 723   fixupObjcLikeName(FName, Name);
 724
 725   return M.getOrInsertNamedMetadata(Name.str());
 726 }
 727
 728 /// createInlinedVariable - Create a new inlined variable based on current
 729 /// variable.
 730 /// @param DV            Current Variable.
 731 /// @param InlinedScope  Location at current variable is inlined.
 732 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
 733                                        LLVMContext &VMContext) {
 734   SmallVector<Value *, 16> Elts;
 735   // Insert inlined scope as 7th element.
 736   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
 737     i == 7 ? Elts.push_back(InlinedScope) :
 738              Elts.push_back(DV->getOperand(i));
 739   return DIVariable(MDNode::get(VMContext, Elts));
 740 }
 741
 742 /// cleanseInlinedVariable - Remove inlined scope from the variable.
 743 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
 744   SmallVector<Value *, 16> Elts;
 745   // Insert inlined scope as 7th element.
 746   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
 747     i == 7 ?
 748       Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
 749       Elts.push_back(DV->getOperand(i));
 750   return DIVariable(MDNode::get(VMContext, Elts));
 751 }
 752
 753 /// getDISubprogram - Find subprogram that is enclosing this scope.
 754 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
 755   DIDescriptor D(Scope);
 756   if (D.isSubprogram())
 757     return DISubprogram(Scope);
 758
 759   if (D.isLexicalBlockFile())
 760     return getDISubprogram(DILexicalBlockFile(Scope).getContext());
 761
 762   if (D.isLexicalBlock())
 763     return getDISubprogram(DILexicalBlock(Scope).getContext());
 764
 765   return DISubprogram();
 766 }
 767
 768 /// getDICompositeType - Find underlying composite type.
 769 DICompositeType llvm::getDICompositeType(DIType T) {
 770   if (T.isCompositeType())
 771     return DICompositeType(T);
 772
 773   if (T.isDerivedType())
 774     return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
 775
 776   return DICompositeType();
 777 }
 778
 779 /// isSubprogramContext - Return true if Context is either a subprogram
 780 /// or another context nested inside a subprogram.
 781 bool llvm::isSubprogramContext(const MDNode *Context) {
 782   if (!Context)
 783     return false;
 784   DIDescriptor D(Context);
 785   if (D.isSubprogram())
 786     return true;
 787   if (D.isType())
 788     return isSubprogramContext(DIType(Context).getContext());
 789   return false;
 790 }
 791
 792 //===----------------------------------------------------------------------===//
 793 // DebugInfoFinder implementations.
 794 //===----------------------------------------------------------------------===//
 795
 796 /// processModule - Process entire module and collect debug info.
 797 void DebugInfoFinder::processModule(const Module &M) {
 798   if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
 799     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
 800       DICompileUnit CU(CU_Nodes->getOperand(i));
 801       addCompileUnit(CU);
 802       if (CU.getVersion() > LLVMDebugVersion10) {
 803         DIArray GVs = CU.getGlobalVariables();
 804         for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
 805           DIGlobalVariable DIG(GVs.getElement(i));
 806           if (addGlobalVariable(DIG))
 807             processType(DIG.getType());
 808         }
 809         DIArray SPs = CU.getSubprograms();
 810         for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
 811           processSubprogram(DISubprogram(SPs.getElement(i)));
 812         DIArray EnumTypes = CU.getEnumTypes();
 813         for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
 814           processType(DIType(EnumTypes.getElement(i)));
 815         DIArray RetainedTypes = CU.getRetainedTypes();
 816         for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
 817           processType(DIType(RetainedTypes.getElement(i)));
 818         return;
 819       }
 820     }
 821   }
 822
 823   for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
 824     for (Function::const_iterator FI = (*I).begin(), FE = (*I).end();
 825          FI != FE; ++FI)
 826       for (BasicBlock::const_iterator BI = (*FI).begin(), BE = (*FI).end();
 827            BI != BE; ++BI) {
 828         if (const DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
 829           processDeclare(DDI);
 830
 831         DebugLoc Loc = BI->getDebugLoc();
 832         if (Loc.isUnknown())
 833           continue;
 834
 835         LLVMContext &Ctx = BI->getContext();
 836         DIDescriptor Scope(Loc.getScope(Ctx));
 837
 838         if (Scope.isCompileUnit())
 839           addCompileUnit(DICompileUnit(Scope));
 840         else if (Scope.isSubprogram())
 841           processSubprogram(DISubprogram(Scope));
 842         else if (Scope.isLexicalBlockFile()) {
 843           DILexicalBlockFile DBF = DILexicalBlockFile(Scope);
 844           processLexicalBlock(DILexicalBlock(DBF.getScope()));
 845         }
 846         else if (Scope.isLexicalBlock())
 847           processLexicalBlock(DILexicalBlock(Scope));
 848
 849         if (MDNode *IA = Loc.getInlinedAt(Ctx))
 850           processLocation(DILocation(IA));
 851       }
 852
 853   if (NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.gv")) {
 854     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
 855       DIGlobalVariable DIG(cast<MDNode>(NMD->getOperand(i)));
 856       if (addGlobalVariable(DIG)) {
 857         if (DIG.getVersion() <= LLVMDebugVersion10)
 858           addCompileUnit(DIG.getCompileUnit());
 859         processType(DIG.getType());
 860       }
 861     }
 862   }
 863
 864   if (NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.sp"))
 865     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
 866       processSubprogram(DISubprogram(NMD->getOperand(i)));
 867 }
 868
 869 /// processLocation - Process DILocation.
 870 void DebugInfoFinder::processLocation(DILocation Loc) {
 871   if (!Loc.Verify()) return;
 872   DIDescriptor S(Loc.getScope());
 873   if (S.isCompileUnit())
 874     addCompileUnit(DICompileUnit(S));
 875   else if (S.isSubprogram())
 876     processSubprogram(DISubprogram(S));
 877   else if (S.isLexicalBlock())
 878     processLexicalBlock(DILexicalBlock(S));
 879   else if (S.isLexicalBlockFile()) {
 880     DILexicalBlockFile DBF = DILexicalBlockFile(S);
 881     processLexicalBlock(DILexicalBlock(DBF.getScope()));
 882   }
 883   processLocation(Loc.getOrigLocation());
 884 }
 885
 886 /// processType - Process DIType.
 887 void DebugInfoFinder::processType(DIType DT) {
 888   if (!addType(DT))
 889     return;
 890   if (DT.getVersion() <= LLVMDebugVersion10)
 891     addCompileUnit(DT.getCompileUnit());
 892   if (DT.isCompositeType()) {
 893     DICompositeType DCT(DT);
 894     processType(DCT.getTypeDerivedFrom());
 895     DIArray DA = DCT.getTypeArray();
 896     for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
 897       DIDescriptor D = DA.getElement(i);
 898       if (D.isType())
 899         processType(DIType(D));
 900       else if (D.isSubprogram())
 901         processSubprogram(DISubprogram(D));
 902     }
 903   } else if (DT.isDerivedType()) {
 904     DIDerivedType DDT(DT);
 905     processType(DDT.getTypeDerivedFrom());
 906   }
 907 }
 908
 909 /// processLexicalBlock
 910 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
 911   DIScope Context = LB.getContext();
 912   if (Context.isLexicalBlock())
 913     return processLexicalBlock(DILexicalBlock(Context));
 914   else if (Context.isLexicalBlockFile()) {
 915     DILexicalBlockFile DBF = DILexicalBlockFile(Context);
 916     return processLexicalBlock(DILexicalBlock(DBF.getScope()));
 917   }
 918   else
 919     return processSubprogram(DISubprogram(Context));
 920 }
 921
 922 /// processSubprogram - Process DISubprogram.
 923 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
 924   if (!addSubprogram(SP))
 925     return;
 926   if (SP.getVersion() <= LLVMDebugVersion10)
 927     addCompileUnit(SP.getCompileUnit());
 928   processType(SP.getType());
 929 }
 930
 931 /// processDeclare - Process DbgDeclareInst.
 932 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
 933   MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
 934   if (!N) return;
 935
 936   DIDescriptor DV(N);
 937   if (!DV.isVariable())
 938     return;
 939
 940   if (!NodesSeen.insert(DV))
 941     return;
 942   if (DIVariable(N).getVersion() <= LLVMDebugVersion10)
 943     addCompileUnit(DIVariable(N).getCompileUnit());
 944   processType(DIVariable(N).getType());
 945 }
 946
 947 /// addType - Add type into Tys.
 948 bool DebugInfoFinder::addType(DIType DT) {
 949   if (!DT.isValid())
 950     return false;
 951
 952   if (!NodesSeen.insert(DT))
 953     return false;
 954
 955   TYs.push_back(DT);
 956   return true;
 957 }
 958
 959 /// addCompileUnit - Add compile unit into CUs.
 960 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
 961   if (!CU.Verify())
 962     return false;
 963
 964   if (!NodesSeen.insert(CU))
 965     return false;
 966
 967   CUs.push_back(CU);
 968   return true;
 969 }
 970
 971 /// addGlobalVariable - Add global variable into GVs.
 972 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
 973   if (!DIDescriptor(DIG).isGlobalVariable())
 974     return false;
 975
 976   if (!NodesSeen.insert(DIG))
 977     return false;
 978
 979   GVs.push_back(DIG);
 980   return true;
 981 }
 982
 983 // addSubprogram - Add subprgoram into SPs.
 984 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
 985   if (!DIDescriptor(SP).isSubprogram())
 986     return false;
 987
 988   if (!NodesSeen.insert(SP))
 989     return false;
 990
 991   SPs.push_back(SP);
 992   return true;
 993 }
 994
 995 //===----------------------------------------------------------------------===//
 996 // DIDescriptor: dump routines for all descriptors.
 997 //===----------------------------------------------------------------------===//
 998
 999 /// dump - Print descriptor to dbgs() with a newline.
1000 void DIDescriptor::dump() const {
1001   print(dbgs()); dbgs() << '\n';
1002 }
1003
1004 /// print - Print descriptor.
1005 void DIDescriptor::print(raw_ostream &OS) const {
1006   if (!DbgNode) return;
1007
1008   if (const char *Tag = dwarf::TagString(getTag()))
1009     OS << "[ " << Tag << " ]";
1010
1011   if (this->isSubrange()) {
1012     DISubrange(DbgNode).printInternal(OS);
1013   } else if (this->isCompileUnit()) {
1014     DICompileUnit(DbgNode).printInternal(OS);
1015   } else if (this->isFile()) {
1016     DIFile(DbgNode).printInternal(OS);
1017   } else if (this->isEnumerator()) {
1018     DIEnumerator(DbgNode).printInternal(OS);
1019   } else if (this->isBasicType()) {
1020     DIType(DbgNode).printInternal(OS);
1021   } else if (this->isDerivedType()) {
1022     DIDerivedType(DbgNode).printInternal(OS);
1023   } else if (this->isCompositeType()) {
1024     DICompositeType(DbgNode).printInternal(OS);
1025   } else if (this->isSubprogram()) {
1026     DISubprogram(DbgNode).printInternal(OS);
1027   } else if (this->isGlobalVariable()) {
1028     DIGlobalVariable(DbgNode).printInternal(OS);
1029   } else if (this->isVariable()) {
1030     DIVariable(DbgNode).printInternal(OS);
1031   } else if (this->isObjCProperty()) {
1032     DIObjCProperty(DbgNode).printInternal(OS);
1033   } else if (this->isScope()) {
1034     DIScope(DbgNode).printInternal(OS);
1035   }
1036 }
1037
1038 void DISubrange::printInternal(raw_ostream &OS) const {
1039   OS << " [" << getLo() << ", " << getHi() << ']';
1040 }
1041
1042 void DIScope::printInternal(raw_ostream &OS) const {
1043   OS << " [" << getDirectory() << "/" << getFilename() << ']';
1044 }
1045
1046 void DICompileUnit::printInternal(raw_ostream &OS) const {
1047   DIScope::printInternal(OS);
1048   if (unsigned Lang = getLanguage())
1049     OS << " [" << dwarf::LanguageString(Lang) << ']';
1050 }
1051
1052 void DIEnumerator::printInternal(raw_ostream &OS) const {
1053   OS << " [" << getName() << " :: " << getEnumValue() << ']';
1054 }
1055
1056 void DIType::printInternal(raw_ostream &OS) const {
1057   if (!DbgNode) return;
1058
1059   StringRef Res = getName();
1060   if (!Res.empty())
1061     OS << " [" << Res << "]";
1062
1063   // TODO: Print context?
1064
1065   OS << " [line " << getLineNumber()
1066      << ", size " << getSizeInBits()
1067      << ", align " << getAlignInBits()
1068      << ", offset " << getOffsetInBits();
1069   if (isBasicType())
1070     if (const char *Enc =
1071         dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1072       OS << ", enc " << Enc;
1073   OS << "]";
1074
1075   if (isPrivate())
1076     OS << " [private]";
1077   else if (isProtected())
1078     OS << " [protected]";
1079
1080   if (isForwardDecl())
1081     OS << " [fwd]";
1082 }
1083
1084 void DIDerivedType::printInternal(raw_ostream &OS) const {
1085   DIType::printInternal(OS);
1086   OS << " [from " << getTypeDerivedFrom().getName() << ']';
1087 }
1088
1089 void DICompositeType::printInternal(raw_ostream &OS) const {
1090   DIType::printInternal(OS);
1091   DIArray A = getTypeArray();
1092   OS << " [" << A.getNumElements() << " elements]";
1093 }
1094
1095 void DISubprogram::printInternal(raw_ostream &OS) const {
1096   // TODO : Print context
1097   OS << " [line " << getLineNumber() << ']';
1098
1099   if (isLocalToUnit())
1100     OS << " [local]";
1101
1102   if (isDefinition())
1103     OS << " [def]";
1104
1105   if (getScopeLineNumber() != getLineNumber())
1106     OS << " [scope " << getScopeLineNumber() << "]";
1107
1108   StringRef Res = getName();
1109   if (!Res.empty())
1110     OS << " [" << Res << ']';
1111 }
1112
1113 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1114   StringRef Res = getName();
1115   if (!Res.empty())
1116     OS << " [" << Res << ']';
1117
1118   OS << " [line " << getLineNumber() << ']';
1119
1120   // TODO : Print context
1121
1122   if (isLocalToUnit())
1123     OS << " [local]";
1124
1125   if (isDefinition())
1126     OS << " [def]";
1127 }
1128
1129 void DIVariable::printInternal(raw_ostream &OS) const {
1130   StringRef Res = getName();
1131   if (!Res.empty())
1132     OS << " [" << Res << ']';
1133
1134   OS << " [line " << getLineNumber() << ']';
1135 }
1136
1137 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1138   StringRef Name = getObjCPropertyName();
1139   if (!Name.empty())
1140     OS << " [" << Name << ']';
1141
1142   OS << " [line " << getLineNumber()
1143      << ", properties " << getUnsignedField(6) << ']';
1144 }
1145
1146 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1147                           const LLVMContext &Ctx) {
1148   if (!DL.isUnknown()) {          // Print source line info.
1149     DIScope Scope(DL.getScope(Ctx));
1150     // Omit the directory, because it's likely to be long and uninteresting.
1151     if (Scope.Verify())
1152       CommentOS << Scope.getFilename();
1153     else
1154       CommentOS << "<unknown>";
1155     CommentOS << ':' << DL.getLine();
1156     if (DL.getCol() != 0)
1157       CommentOS << ':' << DL.getCol();
1158     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1159     if (!InlinedAtDL.isUnknown()) {
1160       CommentOS << " @[ ";
1161       printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1162       CommentOS << " ]";
1163     }
1164   }
1165 }
1166
1167 void DIVariable::printExtendedName(raw_ostream &OS) const {
1168   const LLVMContext &Ctx = DbgNode->getContext();
1169   StringRef Res = getName();
1170   if (!Res.empty())
1171     OS << Res << "," << getLineNumber();
1172   if (MDNode *InlinedAt = getInlinedAt()) {
1173     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1174     if (!InlinedAtDL.isUnknown()) {
1175       OS << " @[";
1176       printDebugLoc(InlinedAtDL, OS, Ctx);
1177       OS << "]";
1178     }
1179   }
1180 }