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