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