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