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() == 3);
 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() > 3);
 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_APPLE_property.
 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       getFilename().empty())
 460     return false;
 461   return true;
 462 }
 463
 464 /// Verify - Verify that a basic type descriptor is well formed.
 465 bool DIBasicType::Verify() const {
 466   return isBasicType() && DbgNode->getNumOperands() == 10;
 467 }
 468
 469 /// Verify - Verify that a derived type descriptor is well formed.
 470 bool DIDerivedType::Verify() const {
 471   return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
 472          DbgNode->getNumOperands() <= 14;
 473 }
 474
 475 /// Verify - Verify that a composite type descriptor is well formed.
 476 bool DICompositeType::Verify() const {
 477   if (!isCompositeType())
 478     return false;
 479   if (getContext() && !getContext().Verify())
 480     return false;
 481
 482   return DbgNode->getNumOperands() >= 10 && DbgNode->getNumOperands() <= 14;
 483 }
 484
 485 /// Verify - Verify that a subprogram descriptor is well formed.
 486 bool DISubprogram::Verify() const {
 487   if (!isSubprogram())
 488     return false;
 489
 490   if (getContext() && !getContext().Verify())
 491     return false;
 492
 493   DICompositeType Ty = getType();
 494   if (!Ty.Verify())
 495     return false;
 496   return DbgNode->getNumOperands() == 20;
 497 }
 498
 499 /// Verify - Verify that a global variable descriptor is well formed.
 500 bool DIGlobalVariable::Verify() const {
 501   if (!isGlobalVariable())
 502     return false;
 503
 504   if (getDisplayName().empty())
 505     return false;
 506
 507   if (getContext() && !getContext().Verify())
 508     return false;
 509
 510   DIType Ty = getType();
 511   if (!Ty.Verify())
 512     return false;
 513
 514   if (!getGlobal() && !getConstant())
 515     return false;
 516
 517   return DbgNode->getNumOperands() == 13;
 518 }
 519
 520 /// Verify - Verify that a variable descriptor is well formed.
 521 bool DIVariable::Verify() const {
 522   if (!isVariable())
 523     return false;
 524
 525   if (getContext() && !getContext().Verify())
 526     return false;
 527
 528   DIType Ty = getType();
 529   if (!Ty.Verify())
 530     return false;
 531
 532   return DbgNode->getNumOperands() >= 8;
 533 }
 534
 535 /// Verify - Verify that a location descriptor is well formed.
 536 bool DILocation::Verify() const {
 537   if (!DbgNode)
 538     return false;
 539
 540   return DbgNode->getNumOperands() == 4;
 541 }
 542
 543 /// Verify - Verify that a namespace descriptor is well formed.
 544 bool DINameSpace::Verify() const {
 545   if (!isNameSpace())
 546     return false;
 547   return DbgNode->getNumOperands() == 5;
 548 }
 549
 550 /// \brief Retrieve the MDNode for the directory/file pair.
 551 MDNode *DIFile::getFileNode() const {
 552   return const_cast<MDNode*>(getNodeField(DbgNode, 1));
 553 }
 554
 555 /// \brief Verify that the file descriptor is well formed.
 556 bool DIFile::Verify() const {
 557   return isFile() && DbgNode->getNumOperands() == 2;
 558 }
 559
 560 /// \brief Verify that the enumerator descriptor is well formed.
 561 bool DIEnumerator::Verify() const {
 562   return isEnumerator() && DbgNode->getNumOperands() == 3;
 563 }
 564
 565 /// \brief Verify that the subrange descriptor is well formed.
 566 bool DISubrange::Verify() const {
 567   return isSubrange() && DbgNode->getNumOperands() == 3;
 568 }
 569
 570 /// \brief Verify that the lexical block descriptor is well formed.
 571 bool DILexicalBlock::Verify() const {
 572   return isLexicalBlock() && DbgNode->getNumOperands() == 6;
 573 }
 574
 575 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
 576 bool DILexicalBlockFile::Verify() const {
 577   return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
 578 }
 579
 580 /// \brief Verify that the template type parameter descriptor is well formed.
 581 bool DITemplateTypeParameter::Verify() const {
 582   return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
 583 }
 584
 585 /// \brief Verify that the template value parameter descriptor is well formed.
 586 bool DITemplateValueParameter::Verify() const {
 587   return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
 588 }
 589
 590 /// \brief Verify that the imported module descriptor is well formed.
 591 bool DIImportedModule::Verify() const {
 592   return isImportedModule() && DbgNode->getNumOperands() == 4;
 593 }
 594
 595 /// getOriginalTypeSize - If this type is derived from a base type then
 596 /// return base type size.
 597 uint64_t DIDerivedType::getOriginalTypeSize() const {
 598   unsigned Tag = getTag();
 599
 600   if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
 601       Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
 602       Tag != dwarf::DW_TAG_restrict_type)
 603     return getSizeInBits();
 604
 605   DIType BaseType = getTypeDerivedFrom();
 606
 607   // If this type is not derived from any type then take conservative approach.
 608   if (!BaseType.isValid())
 609     return getSizeInBits();
 610
 611   // If this is a derived type, go ahead and get the base type, unless it's a
 612   // reference then it's just the size of the field. Pointer types have no need
 613   // of this since they're a different type of qualification on the type.
 614   if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
 615       BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
 616     return getSizeInBits();
 617
 618   if (BaseType.isDerivedType())
 619     return DIDerivedType(BaseType).getOriginalTypeSize();
 620
 621   return BaseType.getSizeInBits();
 622 }
 623
 624 /// getObjCProperty - Return property node, if this ivar is associated with one.
 625 MDNode *DIDerivedType::getObjCProperty() const {
 626   if (DbgNode->getNumOperands() <= 10)
 627     return NULL;
 628   return dyn_cast_or_null<MDNode>(DbgNode->getOperand(10));
 629 }
 630
 631 /// \brief Set the array of member DITypes.
 632 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
 633   assert((!TParams || DbgNode->getNumOperands() == 14) &&
 634          "If you're setting the template parameters this should include a slot "
 635          "for that!");
 636   TrackingVH<MDNode> N(*this);
 637   N->replaceOperandWith(10, Elements);
 638   if (TParams)
 639     N->replaceOperandWith(13, TParams);
 640   DbgNode = N;
 641 }
 642
 643 /// \brief Set the containing type.
 644 void DICompositeType::setContainingType(DICompositeType ContainingType) {
 645   TrackingVH<MDNode> N(*this);
 646   N->replaceOperandWith(12, ContainingType);
 647   DbgNode = N;
 648 }
 649
 650 /// isInlinedFnArgument - Return true if this variable provides debugging
 651 /// information for an inlined function arguments.
 652 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
 653   assert(CurFn && "Invalid function");
 654   if (!getContext().isSubprogram())
 655     return false;
 656   // This variable is not inlined function argument if its scope
 657   // does not describe current function.
 658   return !DISubprogram(getContext()).describes(CurFn);
 659 }
 660
 661 /// describes - Return true if this subprogram provides debugging
 662 /// information for the function F.
 663 bool DISubprogram::describes(const Function *F) {
 664   assert(F && "Invalid function");
 665   if (F == getFunction())
 666     return true;
 667   StringRef Name = getLinkageName();
 668   if (Name.empty())
 669     Name = getName();
 670   if (F->getName() == Name)
 671     return true;
 672   return false;
 673 }
 674
 675 unsigned DISubprogram::isOptimized() const {
 676   assert (DbgNode && "Invalid subprogram descriptor!");
 677   if (DbgNode->getNumOperands() == 15)
 678     return getUnsignedField(14);
 679   return 0;
 680 }
 681
 682 MDNode *DISubprogram::getVariablesNodes() const {
 683   if (!DbgNode || DbgNode->getNumOperands() <= 18)
 684     return NULL;
 685   return dyn_cast_or_null<MDNode>(DbgNode->getOperand(18));
 686 }
 687
 688 DIArray DISubprogram::getVariables() const {
 689   if (!DbgNode || DbgNode->getNumOperands() <= 18)
 690     return DIArray();
 691   if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(18)))
 692     return DIArray(T);
 693   return DIArray();
 694 }
 695
 696 StringRef DIScope::getFilename() const {
 697   if (!DbgNode)
 698     return StringRef();
 699   return ::getStringField(getNodeField(DbgNode, 1), 0);
 700 }
 701
 702 StringRef DIScope::getDirectory() const {
 703   if (!DbgNode)
 704     return StringRef();
 705   return ::getStringField(getNodeField(DbgNode, 1), 1);
 706 }
 707
 708 DIArray DICompileUnit::getEnumTypes() const {
 709   if (!DbgNode || DbgNode->getNumOperands() < 13)
 710     return DIArray();
 711
 712   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(7)))
 713     return DIArray(N);
 714   return DIArray();
 715 }
 716
 717 DIArray DICompileUnit::getRetainedTypes() const {
 718   if (!DbgNode || DbgNode->getNumOperands() < 13)
 719     return DIArray();
 720
 721   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(8)))
 722     return DIArray(N);
 723   return DIArray();
 724 }
 725
 726 DIArray DICompileUnit::getSubprograms() const {
 727   if (!DbgNode || DbgNode->getNumOperands() < 13)
 728     return DIArray();
 729
 730   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(9)))
 731     return DIArray(N);
 732   return DIArray();
 733 }
 734
 735
 736 DIArray DICompileUnit::getGlobalVariables() const {
 737   if (!DbgNode || DbgNode->getNumOperands() < 13)
 738     return DIArray();
 739
 740   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
 741     return DIArray(N);
 742   return DIArray();
 743 }
 744
 745 DIArray DICompileUnit::getImportedModules() const {
 746   if (!DbgNode || DbgNode->getNumOperands() < 13)
 747     return DIArray();
 748
 749   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
 750     return DIArray(N);
 751   return DIArray();
 752 }
 753
 754 /// fixupObjcLikeName - Replace contains special characters used
 755 /// in a typical Objective-C names with '.' in a given string.
 756 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
 757   bool isObjCLike = false;
 758   for (size_t i = 0, e = Str.size(); i < e; ++i) {
 759     char C = Str[i];
 760     if (C == '[')
 761       isObjCLike = true;
 762
 763     if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
 764                        C == '+' || C == '(' || C == ')'))
 765       Out.push_back('.');
 766     else
 767       Out.push_back(C);
 768   }
 769 }
 770
 771 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
 772 /// suitable to hold function specific information.
 773 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
 774   SmallString<32> Name = StringRef("llvm.dbg.lv.");
 775   StringRef FName = "fn";
 776   if (Fn.getFunction())
 777     FName = Fn.getFunction()->getName();
 778   else
 779     FName = Fn.getName();
 780   char One = '\1';
 781   if (FName.startswith(StringRef(&One, 1)))
 782     FName = FName.substr(1);
 783   fixupObjcLikeName(FName, Name);
 784   return M.getNamedMetadata(Name.str());
 785 }
 786
 787 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
 788 /// to hold function specific information.
 789 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
 790   SmallString<32> Name = StringRef("llvm.dbg.lv.");
 791   StringRef FName = "fn";
 792   if (Fn.getFunction())
 793     FName = Fn.getFunction()->getName();
 794   else
 795     FName = Fn.getName();
 796   char One = '\1';
 797   if (FName.startswith(StringRef(&One, 1)))
 798     FName = FName.substr(1);
 799   fixupObjcLikeName(FName, Name);
 800
 801   return M.getOrInsertNamedMetadata(Name.str());
 802 }
 803
 804 /// createInlinedVariable - Create a new inlined variable based on current
 805 /// variable.
 806 /// @param DV            Current Variable.
 807 /// @param InlinedScope  Location at current variable is inlined.
 808 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
 809                                        LLVMContext &VMContext) {
 810   SmallVector<Value *, 16> Elts;
 811   // Insert inlined scope as 7th element.
 812   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
 813     i == 7 ? Elts.push_back(InlinedScope) :
 814              Elts.push_back(DV->getOperand(i));
 815   return DIVariable(MDNode::get(VMContext, Elts));
 816 }
 817
 818 /// cleanseInlinedVariable - Remove inlined scope from the variable.
 819 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
 820   SmallVector<Value *, 16> Elts;
 821   // Insert inlined scope as 7th element.
 822   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
 823     i == 7 ?
 824       Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
 825       Elts.push_back(DV->getOperand(i));
 826   return DIVariable(MDNode::get(VMContext, Elts));
 827 }
 828
 829 /// getDISubprogram - Find subprogram that is enclosing this scope.
 830 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
 831   DIDescriptor D(Scope);
 832   if (D.isSubprogram())
 833     return DISubprogram(Scope);
 834
 835   if (D.isLexicalBlockFile())
 836     return getDISubprogram(DILexicalBlockFile(Scope).getContext());
 837
 838   if (D.isLexicalBlock())
 839     return getDISubprogram(DILexicalBlock(Scope).getContext());
 840
 841   return DISubprogram();
 842 }
 843
 844 /// getDICompositeType - Find underlying composite type.
 845 DICompositeType llvm::getDICompositeType(DIType T) {
 846   if (T.isCompositeType())
 847     return DICompositeType(T);
 848
 849   if (T.isDerivedType())
 850     return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
 851
 852   return DICompositeType();
 853 }
 854
 855 /// isSubprogramContext - Return true if Context is either a subprogram
 856 /// or another context nested inside a subprogram.
 857 bool llvm::isSubprogramContext(const MDNode *Context) {
 858   if (!Context)
 859     return false;
 860   DIDescriptor D(Context);
 861   if (D.isSubprogram())
 862     return true;
 863   if (D.isType())
 864     return isSubprogramContext(DIType(Context).getContext());
 865   return false;
 866 }
 867
 868 //===----------------------------------------------------------------------===//
 869 // DebugInfoFinder implementations.
 870 //===----------------------------------------------------------------------===//
 871
 872 /// processModule - Process entire module and collect debug info.
 873 void DebugInfoFinder::processModule(const Module &M) {
 874   if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
 875     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
 876       DICompileUnit CU(CU_Nodes->getOperand(i));
 877       addCompileUnit(CU);
 878       DIArray GVs = CU.getGlobalVariables();
 879       for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
 880         DIGlobalVariable DIG(GVs.getElement(i));
 881         if (addGlobalVariable(DIG))
 882           processType(DIG.getType());
 883       }
 884       DIArray SPs = CU.getSubprograms();
 885       for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
 886         processSubprogram(DISubprogram(SPs.getElement(i)));
 887       DIArray EnumTypes = CU.getEnumTypes();
 888       for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
 889         processType(DIType(EnumTypes.getElement(i)));
 890       DIArray RetainedTypes = CU.getRetainedTypes();
 891       for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
 892         processType(DIType(RetainedTypes.getElement(i)));
 893       // FIXME: We really shouldn't be bailing out after visiting just one CU
 894       return;
 895     }
 896   }
 897 }
 898
 899 /// processLocation - Process DILocation.
 900 void DebugInfoFinder::processLocation(DILocation Loc) {
 901   if (!Loc.Verify()) return;
 902   DIDescriptor S(Loc.getScope());
 903   if (S.isCompileUnit())
 904     addCompileUnit(DICompileUnit(S));
 905   else if (S.isSubprogram())
 906     processSubprogram(DISubprogram(S));
 907   else if (S.isLexicalBlock())
 908     processLexicalBlock(DILexicalBlock(S));
 909   else if (S.isLexicalBlockFile()) {
 910     DILexicalBlockFile DBF = DILexicalBlockFile(S);
 911     processLexicalBlock(DILexicalBlock(DBF.getScope()));
 912   }
 913   processLocation(Loc.getOrigLocation());
 914 }
 915
 916 /// processType - Process DIType.
 917 void DebugInfoFinder::processType(DIType DT) {
 918   if (!addType(DT))
 919     return;
 920   if (DT.isCompositeType()) {
 921     DICompositeType DCT(DT);
 922     processType(DCT.getTypeDerivedFrom());
 923     DIArray DA = DCT.getTypeArray();
 924     for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
 925       DIDescriptor D = DA.getElement(i);
 926       if (D.isType())
 927         processType(DIType(D));
 928       else if (D.isSubprogram())
 929         processSubprogram(DISubprogram(D));
 930     }
 931   } else if (DT.isDerivedType()) {
 932     DIDerivedType DDT(DT);
 933     processType(DDT.getTypeDerivedFrom());
 934   }
 935 }
 936
 937 /// processLexicalBlock
 938 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
 939   DIScope Context = LB.getContext();
 940   if (Context.isLexicalBlock())
 941     return processLexicalBlock(DILexicalBlock(Context));
 942   else if (Context.isLexicalBlockFile()) {
 943     DILexicalBlockFile DBF = DILexicalBlockFile(Context);
 944     return processLexicalBlock(DILexicalBlock(DBF.getScope()));
 945   }
 946   else
 947     return processSubprogram(DISubprogram(Context));
 948 }
 949
 950 /// processSubprogram - Process DISubprogram.
 951 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
 952   if (!addSubprogram(SP))
 953     return;
 954   processType(SP.getType());
 955 }
 956
 957 /// processDeclare - Process DbgDeclareInst.
 958 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
 959   MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
 960   if (!N) return;
 961
 962   DIDescriptor DV(N);
 963   if (!DV.isVariable())
 964     return;
 965
 966   if (!NodesSeen.insert(DV))
 967     return;
 968   processType(DIVariable(N).getType());
 969 }
 970
 971 /// addType - Add type into Tys.
 972 bool DebugInfoFinder::addType(DIType DT) {
 973   if (!DT.isValid())
 974     return false;
 975
 976   if (!NodesSeen.insert(DT))
 977     return false;
 978
 979   TYs.push_back(DT);
 980   return true;
 981 }
 982
 983 /// addCompileUnit - Add compile unit into CUs.
 984 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
 985   if (!CU.Verify())
 986     return false;
 987
 988   if (!NodesSeen.insert(CU))
 989     return false;
 990
 991   CUs.push_back(CU);
 992   return true;
 993 }
 994
 995 /// addGlobalVariable - Add global variable into GVs.
 996 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
 997   if (!DIDescriptor(DIG).isGlobalVariable())
 998     return false;
 999
1000   if (!NodesSeen.insert(DIG))
1001     return false;
1002
1003   GVs.push_back(DIG);
1004   return true;
1005 }
1006
1007 // addSubprogram - Add subprgoram into SPs.
1008 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1009   if (!DIDescriptor(SP).isSubprogram())
1010     return false;
1011
1012   if (!NodesSeen.insert(SP))
1013     return false;
1014
1015   SPs.push_back(SP);
1016   return true;
1017 }
1018
1019 //===----------------------------------------------------------------------===//
1020 // DIDescriptor: dump routines for all descriptors.
1021 //===----------------------------------------------------------------------===//
1022
1023 /// dump - Print descriptor to dbgs() with a newline.
1024 void DIDescriptor::dump() const {
1025   print(dbgs()); dbgs() << '\n';
1026 }
1027
1028 /// print - Print descriptor.
1029 void DIDescriptor::print(raw_ostream &OS) const {
1030   if (!DbgNode) return;
1031
1032   if (const char *Tag = dwarf::TagString(getTag()))
1033     OS << "[ " << Tag << " ]";
1034
1035   if (this->isSubrange()) {
1036     DISubrange(DbgNode).printInternal(OS);
1037   } else if (this->isCompileUnit()) {
1038     DICompileUnit(DbgNode).printInternal(OS);
1039   } else if (this->isFile()) {
1040     DIFile(DbgNode).printInternal(OS);
1041   } else if (this->isEnumerator()) {
1042     DIEnumerator(DbgNode).printInternal(OS);
1043   } else if (this->isBasicType()) {
1044     DIType(DbgNode).printInternal(OS);
1045   } else if (this->isDerivedType()) {
1046     DIDerivedType(DbgNode).printInternal(OS);
1047   } else if (this->isCompositeType()) {
1048     DICompositeType(DbgNode).printInternal(OS);
1049   } else if (this->isSubprogram()) {
1050     DISubprogram(DbgNode).printInternal(OS);
1051   } else if (this->isGlobalVariable()) {
1052     DIGlobalVariable(DbgNode).printInternal(OS);
1053   } else if (this->isVariable()) {
1054     DIVariable(DbgNode).printInternal(OS);
1055   } else if (this->isObjCProperty()) {
1056     DIObjCProperty(DbgNode).printInternal(OS);
1057   } else if (this->isNameSpace()) {
1058     DINameSpace(DbgNode).printInternal(OS);
1059   } else if (this->isScope()) {
1060     DIScope(DbgNode).printInternal(OS);
1061   }
1062 }
1063
1064 void DISubrange::printInternal(raw_ostream &OS) const {
1065   int64_t Count = getCount();
1066   if (Count != -1)
1067     OS << " [" << getLo() << ", " << Count - 1 << ']';
1068   else
1069     OS << " [unbounded]";
1070 }
1071
1072 void DIScope::printInternal(raw_ostream &OS) const {
1073   OS << " [" << getDirectory() << "/" << getFilename() << ']';
1074 }
1075
1076 void DICompileUnit::printInternal(raw_ostream &OS) const {
1077   DIScope::printInternal(OS);
1078   OS << " [";
1079   unsigned Lang = getLanguage();
1080   if (const char *LangStr = dwarf::LanguageString(Lang))
1081     OS << LangStr;
1082   else
1083     (OS << "lang 0x").write_hex(Lang);
1084   OS << ']';
1085 }
1086
1087 void DIEnumerator::printInternal(raw_ostream &OS) const {
1088   OS << " [" << getName() << " :: " << getEnumValue() << ']';
1089 }
1090
1091 void DIType::printInternal(raw_ostream &OS) const {
1092   if (!DbgNode) return;
1093
1094   StringRef Res = getName();
1095   if (!Res.empty())
1096     OS << " [" << Res << "]";
1097
1098   // TODO: Print context?
1099
1100   OS << " [line " << getLineNumber()
1101      << ", size " << getSizeInBits()
1102      << ", align " << getAlignInBits()
1103      << ", offset " << getOffsetInBits();
1104   if (isBasicType())
1105     if (const char *Enc =
1106         dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1107       OS << ", enc " << Enc;
1108   OS << "]";
1109
1110   if (isPrivate())
1111     OS << " [private]";
1112   else if (isProtected())
1113     OS << " [protected]";
1114
1115   if (isArtificial())
1116     OS << " [artificial]";
1117
1118   if (isForwardDecl())
1119     OS << " [fwd]";
1120   if (isVector())
1121     OS << " [vector]";
1122   if (isStaticMember())
1123     OS << " [static]";
1124 }
1125
1126 void DIDerivedType::printInternal(raw_ostream &OS) const {
1127   DIType::printInternal(OS);
1128   OS << " [from " << getTypeDerivedFrom().getName() << ']';
1129 }
1130
1131 void DICompositeType::printInternal(raw_ostream &OS) const {
1132   DIType::printInternal(OS);
1133   DIArray A = getTypeArray();
1134   OS << " [" << A.getNumElements() << " elements]";
1135 }
1136
1137 void DINameSpace::printInternal(raw_ostream &OS) const {
1138   StringRef Name = getName();
1139   if (!Name.empty())
1140     OS << " [" << Name << ']';
1141
1142   OS << " [line " << getLineNumber() << ']';
1143 }
1144
1145 void DISubprogram::printInternal(raw_ostream &OS) const {
1146   // TODO : Print context
1147   OS << " [line " << getLineNumber() << ']';
1148
1149   if (isLocalToUnit())
1150     OS << " [local]";
1151
1152   if (isDefinition())
1153     OS << " [def]";
1154
1155   if (getScopeLineNumber() != getLineNumber())
1156     OS << " [scope " << getScopeLineNumber() << "]";
1157
1158   if (isPrivate())
1159     OS << " [private]";
1160   else if (isProtected())
1161     OS << " [protected]";
1162
1163   StringRef Res = getName();
1164   if (!Res.empty())
1165     OS << " [" << Res << ']';
1166 }
1167
1168 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1169   StringRef Res = getName();
1170   if (!Res.empty())
1171     OS << " [" << Res << ']';
1172
1173   OS << " [line " << getLineNumber() << ']';
1174
1175   // TODO : Print context
1176
1177   if (isLocalToUnit())
1178     OS << " [local]";
1179
1180   if (isDefinition())
1181     OS << " [def]";
1182 }
1183
1184 void DIVariable::printInternal(raw_ostream &OS) const {
1185   StringRef Res = getName();
1186   if (!Res.empty())
1187     OS << " [" << Res << ']';
1188
1189   OS << " [line " << getLineNumber() << ']';
1190 }
1191
1192 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1193   StringRef Name = getObjCPropertyName();
1194   if (!Name.empty())
1195     OS << " [" << Name << ']';
1196
1197   OS << " [line " << getLineNumber()
1198      << ", properties " << getUnsignedField(6) << ']';
1199 }
1200
1201 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1202                           const LLVMContext &Ctx) {
1203   if (!DL.isUnknown()) {          // Print source line info.
1204     DIScope Scope(DL.getScope(Ctx));
1205     // Omit the directory, because it's likely to be long and uninteresting.
1206     if (Scope.Verify())
1207       CommentOS << Scope.getFilename();
1208     else
1209       CommentOS << "<unknown>";
1210     CommentOS << ':' << DL.getLine();
1211     if (DL.getCol() != 0)
1212       CommentOS << ':' << DL.getCol();
1213     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1214     if (!InlinedAtDL.isUnknown()) {
1215       CommentOS << " @[ ";
1216       printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1217       CommentOS << " ]";
1218     }
1219   }
1220 }
1221
1222 void DIVariable::printExtendedName(raw_ostream &OS) const {
1223   const LLVMContext &Ctx = DbgNode->getContext();
1224   StringRef Res = getName();
1225   if (!Res.empty())
1226     OS << Res << "," << getLineNumber();
1227   if (MDNode *InlinedAt = getInlinedAt()) {
1228     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1229     if (!InlinedAtDL.isUnknown()) {
1230       OS << " @[";
1231       printDebugLoc(InlinedAtDL, OS, Ctx);
1232       OS << "]";
1233     }
1234   }
1235 }