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 StringRef DIScope::getFilename() const {
 696   if (!DbgNode)
 697     return StringRef();
 698   return ::getStringField(getNodeField(DbgNode, 1), 0);
 699 }
 700
 701 StringRef DIScope::getDirectory() const {
 702   if (!DbgNode)
 703     return StringRef();
 704   return ::getStringField(getNodeField(DbgNode, 1), 1);
 705 }
 706
 707 DIArray DICompileUnit::getEnumTypes() const {
 708   if (!DbgNode || DbgNode->getNumOperands() < 13)
 709     return DIArray();
 710
 711   return DIArray(getNodeField(DbgNode, 7));
 712 }
 713
 714 DIArray DICompileUnit::getRetainedTypes() const {
 715   if (!DbgNode || DbgNode->getNumOperands() < 13)
 716     return DIArray();
 717
 718   return DIArray(getNodeField(DbgNode, 8));
 719 }
 720
 721 DIArray DICompileUnit::getSubprograms() const {
 722   if (!DbgNode || DbgNode->getNumOperands() < 13)
 723     return DIArray();
 724
 725   return DIArray(getNodeField(DbgNode, 9));
 726 }
 727
 728
 729 DIArray DICompileUnit::getGlobalVariables() const {
 730   if (!DbgNode || DbgNode->getNumOperands() < 13)
 731     return DIArray();
 732
 733   return DIArray(getNodeField(DbgNode, 10));
 734 }
 735
 736 DIArray DICompileUnit::getImportedEntities() const {
 737   if (!DbgNode || DbgNode->getNumOperands() < 13)
 738     return DIArray();
 739
 740   return DIArray(getNodeField(DbgNode, 11));
 741 }
 742
 743 /// fixupSubprogramName - Replace contains special characters used
 744 /// in a typical Objective-C names with '.' in a given string.
 745 static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
 746   StringRef FName =
 747       Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
 748   FName = Function::getRealLinkageName(FName);
 749
 750   StringRef Prefix("llvm.dbg.lv.");
 751   Out.reserve(FName.size() + Prefix.size());
 752   Out.append(Prefix.begin(), Prefix.end());
 753
 754   bool isObjCLike = false;
 755   for (size_t i = 0, e = FName.size(); i < e; ++i) {
 756     char C = FName[i];
 757     if (C == '[')
 758       isObjCLike = true;
 759
 760     if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
 761                        C == '+' || C == '(' || C == ')'))
 762       Out.push_back('.');
 763     else
 764       Out.push_back(C);
 765   }
 766 }
 767
 768 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
 769 /// suitable to hold function specific information.
 770 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
 771   SmallString<32> Name;
 772   fixupSubprogramName(Fn, Name);
 773   return M.getNamedMetadata(Name.str());
 774 }
 775
 776 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
 777 /// to hold function specific information.
 778 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
 779   SmallString<32> Name;
 780   fixupSubprogramName(Fn, Name);
 781   return M.getOrInsertNamedMetadata(Name.str());
 782 }
 783
 784 /// createInlinedVariable - Create a new inlined variable based on current
 785 /// variable.
 786 /// @param DV            Current Variable.
 787 /// @param InlinedScope  Location at current variable is inlined.
 788 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
 789                                        LLVMContext &VMContext) {
 790   SmallVector<Value *, 16> Elts;
 791   // Insert inlined scope as 7th element.
 792   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
 793     i == 7 ? Elts.push_back(InlinedScope) :
 794              Elts.push_back(DV->getOperand(i));
 795   return DIVariable(MDNode::get(VMContext, Elts));
 796 }
 797
 798 /// cleanseInlinedVariable - Remove inlined scope from the variable.
 799 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
 800   SmallVector<Value *, 16> Elts;
 801   // Insert inlined scope as 7th element.
 802   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
 803     i == 7 ?
 804       Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
 805       Elts.push_back(DV->getOperand(i));
 806   return DIVariable(MDNode::get(VMContext, Elts));
 807 }
 808
 809 /// getDISubprogram - Find subprogram that is enclosing this scope.
 810 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
 811   DIDescriptor D(Scope);
 812   if (D.isSubprogram())
 813     return DISubprogram(Scope);
 814
 815   if (D.isLexicalBlockFile())
 816     return getDISubprogram(DILexicalBlockFile(Scope).getContext());
 817
 818   if (D.isLexicalBlock())
 819     return getDISubprogram(DILexicalBlock(Scope).getContext());
 820
 821   return DISubprogram();
 822 }
 823
 824 /// getDICompositeType - Find underlying composite type.
 825 DICompositeType llvm::getDICompositeType(DIType T) {
 826   if (T.isCompositeType())
 827     return DICompositeType(T);
 828
 829   if (T.isDerivedType())
 830     return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
 831
 832   return DICompositeType();
 833 }
 834
 835 /// isSubprogramContext - Return true if Context is either a subprogram
 836 /// or another context nested inside a subprogram.
 837 bool llvm::isSubprogramContext(const MDNode *Context) {
 838   if (!Context)
 839     return false;
 840   DIDescriptor D(Context);
 841   if (D.isSubprogram())
 842     return true;
 843   if (D.isType())
 844     return isSubprogramContext(DIType(Context).getContext());
 845   return false;
 846 }
 847
 848 //===----------------------------------------------------------------------===//
 849 // DebugInfoFinder implementations.
 850 //===----------------------------------------------------------------------===//
 851
 852 void DebugInfoFinder::reset() {
 853   CUs.clear();
 854   SPs.clear();
 855   GVs.clear();
 856   TYs.clear();
 857   Scopes.clear();
 858   NodesSeen.clear();
 859 }
 860
 861 /// processModule - Process entire module and collect debug info.
 862 void DebugInfoFinder::processModule(const Module &M) {
 863   if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
 864     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
 865       DICompileUnit CU(CU_Nodes->getOperand(i));
 866       addCompileUnit(CU);
 867       DIArray GVs = CU.getGlobalVariables();
 868       for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
 869         DIGlobalVariable DIG(GVs.getElement(i));
 870         if (addGlobalVariable(DIG)) {
 871           processScope(DIG.getContext());
 872           processType(DIG.getType());
 873         }
 874       }
 875       DIArray SPs = CU.getSubprograms();
 876       for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
 877         processSubprogram(DISubprogram(SPs.getElement(i)));
 878       DIArray EnumTypes = CU.getEnumTypes();
 879       for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
 880         processType(DIType(EnumTypes.getElement(i)));
 881       DIArray RetainedTypes = CU.getRetainedTypes();
 882       for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
 883         processType(DIType(RetainedTypes.getElement(i)));
 884       // FIXME: We really shouldn't be bailing out after visiting just one CU
 885       return;
 886     }
 887   }
 888 }
 889
 890 /// processLocation - Process DILocation.
 891 void DebugInfoFinder::processLocation(DILocation Loc) {
 892   if (!Loc.Verify()) return;
 893   DIDescriptor S(Loc.getScope());
 894   if (S.isCompileUnit())
 895     addCompileUnit(DICompileUnit(S));
 896   else if (S.isSubprogram())
 897     processSubprogram(DISubprogram(S));
 898   else if (S.isLexicalBlock())
 899     processLexicalBlock(DILexicalBlock(S));
 900   else if (S.isLexicalBlockFile()) {
 901     DILexicalBlockFile DBF = DILexicalBlockFile(S);
 902     processLexicalBlock(DILexicalBlock(DBF.getScope()));
 903   }
 904   processLocation(Loc.getOrigLocation());
 905 }
 906
 907 /// processType - Process DIType.
 908 void DebugInfoFinder::processType(DIType DT) {
 909   if (!addType(DT))
 910     return;
 911   processScope(DT.getContext());
 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 void DebugInfoFinder::processScope(DIScope Scope) {
 930   if (Scope.isType()) {
 931     DIType Ty(Scope);
 932     processType(Ty);
 933     return;
 934   }
 935   if (Scope.isCompileUnit()) {
 936     addCompileUnit(DICompileUnit(Scope));
 937     return;
 938   }
 939   if (Scope.isSubprogram()) {
 940     processSubprogram(DISubprogram(Scope));
 941     return;
 942   }
 943   if (!addScope(Scope))
 944     return;
 945   if (Scope.isLexicalBlock()) {
 946     DILexicalBlock LB(Scope);
 947     processScope(LB.getContext());
 948   } else if (Scope.isLexicalBlockFile()) {
 949     DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
 950     processScope(LBF.getScope());
 951   } else if (Scope.isNameSpace()) {
 952     DINameSpace NS(Scope);
 953     processScope(NS.getContext());
 954   }
 955 }
 956
 957 /// processLexicalBlock
 958 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
 959   DIScope Context = LB.getContext();
 960   if (Context.isLexicalBlock())
 961     return processLexicalBlock(DILexicalBlock(Context));
 962   else if (Context.isLexicalBlockFile()) {
 963     DILexicalBlockFile DBF = DILexicalBlockFile(Context);
 964     return processLexicalBlock(DILexicalBlock(DBF.getScope()));
 965   }
 966   else
 967     return processSubprogram(DISubprogram(Context));
 968 }
 969
 970 /// processSubprogram - Process DISubprogram.
 971 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
 972   if (!addSubprogram(SP))
 973     return;
 974   processScope(SP.getContext());
 975   processType(SP.getType());
 976 }
 977
 978 /// processDeclare - Process DbgDeclareInst.
 979 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
 980   MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
 981   if (!N) return;
 982
 983   DIDescriptor DV(N);
 984   if (!DV.isVariable())
 985     return;
 986
 987   if (!NodesSeen.insert(DV))
 988     return;
 989   processScope(DIVariable(N).getContext());
 990   processType(DIVariable(N).getType());
 991 }
 992
 993 void DebugInfoFinder::processValue(const DbgValueInst *DVI) {
 994   MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
 995   if (!N) return;
 996
 997   DIDescriptor DV(N);
 998   if (!DV.isVariable())
 999     return;
1000
1001   if (!NodesSeen.insert(DV))
1002     return;
1003   processScope(DIVariable(N).getContext());
1004   processType(DIVariable(N).getType());
1005 }
1006
1007 /// addType - Add type into Tys.
1008 bool DebugInfoFinder::addType(DIType DT) {
1009   if (!DT.isValid())
1010     return false;
1011
1012   if (!NodesSeen.insert(DT))
1013     return false;
1014
1015   TYs.push_back(DT);
1016   return true;
1017 }
1018
1019 /// addCompileUnit - Add compile unit into CUs.
1020 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1021   if (!CU.Verify())
1022     return false;
1023
1024   if (!NodesSeen.insert(CU))
1025     return false;
1026
1027   CUs.push_back(CU);
1028   return true;
1029 }
1030
1031 /// addGlobalVariable - Add global variable into GVs.
1032 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1033   if (!DIDescriptor(DIG).isGlobalVariable())
1034     return false;
1035
1036   if (!NodesSeen.insert(DIG))
1037     return false;
1038
1039   GVs.push_back(DIG);
1040   return true;
1041 }
1042
1043 // addSubprogram - Add subprgoram into SPs.
1044 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1045   if (!DIDescriptor(SP).isSubprogram())
1046     return false;
1047
1048   if (!NodesSeen.insert(SP))
1049     return false;
1050
1051   SPs.push_back(SP);
1052   return true;
1053 }
1054
1055 bool DebugInfoFinder::addScope(DIScope Scope) {
1056   if (!Scope)
1057     return false;
1058   if (!NodesSeen.insert(Scope))
1059     return false;
1060   Scopes.push_back(Scope);
1061   return true;
1062 }
1063
1064 //===----------------------------------------------------------------------===//
1065 // DIDescriptor: dump routines for all descriptors.
1066 //===----------------------------------------------------------------------===//
1067
1068 /// dump - Print descriptor to dbgs() with a newline.
1069 void DIDescriptor::dump() const {
1070   print(dbgs()); dbgs() << '\n';
1071 }
1072
1073 /// print - Print descriptor.
1074 void DIDescriptor::print(raw_ostream &OS) const {
1075   if (!DbgNode) return;
1076
1077   if (const char *Tag = dwarf::TagString(getTag()))
1078     OS << "[ " << Tag << " ]";
1079
1080   if (this->isSubrange()) {
1081     DISubrange(DbgNode).printInternal(OS);
1082   } else if (this->isCompileUnit()) {
1083     DICompileUnit(DbgNode).printInternal(OS);
1084   } else if (this->isFile()) {
1085     DIFile(DbgNode).printInternal(OS);
1086   } else if (this->isEnumerator()) {
1087     DIEnumerator(DbgNode).printInternal(OS);
1088   } else if (this->isBasicType()) {
1089     DIType(DbgNode).printInternal(OS);
1090   } else if (this->isDerivedType()) {
1091     DIDerivedType(DbgNode).printInternal(OS);
1092   } else if (this->isCompositeType()) {
1093     DICompositeType(DbgNode).printInternal(OS);
1094   } else if (this->isSubprogram()) {
1095     DISubprogram(DbgNode).printInternal(OS);
1096   } else if (this->isGlobalVariable()) {
1097     DIGlobalVariable(DbgNode).printInternal(OS);
1098   } else if (this->isVariable()) {
1099     DIVariable(DbgNode).printInternal(OS);
1100   } else if (this->isObjCProperty()) {
1101     DIObjCProperty(DbgNode).printInternal(OS);
1102   } else if (this->isNameSpace()) {
1103     DINameSpace(DbgNode).printInternal(OS);
1104   } else if (this->isScope()) {
1105     DIScope(DbgNode).printInternal(OS);
1106   }
1107 }
1108
1109 void DISubrange::printInternal(raw_ostream &OS) const {
1110   int64_t Count = getCount();
1111   if (Count != -1)
1112     OS << " [" << getLo() << ", " << Count - 1 << ']';
1113   else
1114     OS << " [unbounded]";
1115 }
1116
1117 void DIScope::printInternal(raw_ostream &OS) const {
1118   OS << " [" << getDirectory() << "/" << getFilename() << ']';
1119 }
1120
1121 void DICompileUnit::printInternal(raw_ostream &OS) const {
1122   DIScope::printInternal(OS);
1123   OS << " [";
1124   unsigned Lang = getLanguage();
1125   if (const char *LangStr = dwarf::LanguageString(Lang))
1126     OS << LangStr;
1127   else
1128     (OS << "lang 0x").write_hex(Lang);
1129   OS << ']';
1130 }
1131
1132 void DIEnumerator::printInternal(raw_ostream &OS) const {
1133   OS << " [" << getName() << " :: " << getEnumValue() << ']';
1134 }
1135
1136 void DIType::printInternal(raw_ostream &OS) const {
1137   if (!DbgNode) return;
1138
1139   StringRef Res = getName();
1140   if (!Res.empty())
1141     OS << " [" << Res << "]";
1142
1143   // TODO: Print context?
1144
1145   OS << " [line " << getLineNumber()
1146      << ", size " << getSizeInBits()
1147      << ", align " << getAlignInBits()
1148      << ", offset " << getOffsetInBits();
1149   if (isBasicType())
1150     if (const char *Enc =
1151         dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1152       OS << ", enc " << Enc;
1153   OS << "]";
1154
1155   if (isPrivate())
1156     OS << " [private]";
1157   else if (isProtected())
1158     OS << " [protected]";
1159
1160   if (isArtificial())
1161     OS << " [artificial]";
1162
1163   if (isForwardDecl())
1164     OS << " [decl]";
1165   else if (getTag() == dwarf::DW_TAG_structure_type ||
1166            getTag() == dwarf::DW_TAG_union_type ||
1167            getTag() == dwarf::DW_TAG_enumeration_type ||
1168            getTag() == dwarf::DW_TAG_class_type)
1169     OS << " [def]";
1170   if (isVector())
1171     OS << " [vector]";
1172   if (isStaticMember())
1173     OS << " [static]";
1174 }
1175
1176 void DIDerivedType::printInternal(raw_ostream &OS) const {
1177   DIType::printInternal(OS);
1178   OS << " [from " << getTypeDerivedFrom().getName() << ']';
1179 }
1180
1181 void DICompositeType::printInternal(raw_ostream &OS) const {
1182   DIType::printInternal(OS);
1183   DIArray A = getTypeArray();
1184   OS << " [" << A.getNumElements() << " elements]";
1185 }
1186
1187 void DINameSpace::printInternal(raw_ostream &OS) const {
1188   StringRef Name = getName();
1189   if (!Name.empty())
1190     OS << " [" << Name << ']';
1191
1192   OS << " [line " << getLineNumber() << ']';
1193 }
1194
1195 void DISubprogram::printInternal(raw_ostream &OS) const {
1196   // TODO : Print context
1197   OS << " [line " << getLineNumber() << ']';
1198
1199   if (isLocalToUnit())
1200     OS << " [local]";
1201
1202   if (isDefinition())
1203     OS << " [def]";
1204
1205   if (getScopeLineNumber() != getLineNumber())
1206     OS << " [scope " << getScopeLineNumber() << "]";
1207
1208   if (isPrivate())
1209     OS << " [private]";
1210   else if (isProtected())
1211     OS << " [protected]";
1212
1213   StringRef Res = getName();
1214   if (!Res.empty())
1215     OS << " [" << Res << ']';
1216 }
1217
1218 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1219   StringRef Res = getName();
1220   if (!Res.empty())
1221     OS << " [" << Res << ']';
1222
1223   OS << " [line " << getLineNumber() << ']';
1224
1225   // TODO : Print context
1226
1227   if (isLocalToUnit())
1228     OS << " [local]";
1229
1230   if (isDefinition())
1231     OS << " [def]";
1232 }
1233
1234 void DIVariable::printInternal(raw_ostream &OS) const {
1235   StringRef Res = getName();
1236   if (!Res.empty())
1237     OS << " [" << Res << ']';
1238
1239   OS << " [line " << getLineNumber() << ']';
1240 }
1241
1242 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1243   StringRef Name = getObjCPropertyName();
1244   if (!Name.empty())
1245     OS << " [" << Name << ']';
1246
1247   OS << " [line " << getLineNumber()
1248      << ", properties " << getUnsignedField(6) << ']';
1249 }
1250
1251 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1252                           const LLVMContext &Ctx) {
1253   if (!DL.isUnknown()) {          // Print source line info.
1254     DIScope Scope(DL.getScope(Ctx));
1255     assert(Scope.isScope() &&
1256       "Scope of a DebugLoc should be a DIScope.");
1257     // Omit the directory, because it's likely to be long and uninteresting.
1258     CommentOS << Scope.getFilename();
1259     CommentOS << ':' << DL.getLine();
1260     if (DL.getCol() != 0)
1261       CommentOS << ':' << DL.getCol();
1262     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1263     if (!InlinedAtDL.isUnknown()) {
1264       CommentOS << " @[ ";
1265       printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1266       CommentOS << " ]";
1267     }
1268   }
1269 }
1270
1271 void DIVariable::printExtendedName(raw_ostream &OS) const {
1272   const LLVMContext &Ctx = DbgNode->getContext();
1273   StringRef Res = getName();
1274   if (!Res.empty())
1275     OS << Res << "," << getLineNumber();
1276   if (MDNode *InlinedAt = getInlinedAt()) {
1277     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1278     if (!InlinedAtDL.isUnknown()) {
1279       OS << " @[";
1280       printDebugLoc(InlinedAtDL, OS, Ctx);
1281       OS << "]";
1282     }
1283   }
1284 }