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