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   case dwarf::DW_TAG_file_type:
 250     return true;
 251   default:
 252     break;
 253   }
 254   return isType();
 255 }
 256
 257 /// isTemplateTypeParameter - Return true if the specified tag is
 258 /// DW_TAG_template_type_parameter.
 259 bool DIDescriptor::isTemplateTypeParameter() const {
 260   return DbgNode && getTag() == dwarf::DW_TAG_template_type_parameter;
 261 }
 262
 263 /// isTemplateValueParameter - Return true if the specified tag is
 264 /// DW_TAG_template_value_parameter.
 265 bool DIDescriptor::isTemplateValueParameter() const {
 266   return DbgNode && (getTag() == dwarf::DW_TAG_template_value_parameter ||
 267                      getTag() == dwarf::DW_TAG_GNU_template_template_param ||
 268                      getTag() == dwarf::DW_TAG_GNU_template_parameter_pack);
 269 }
 270
 271 /// isCompileUnit - Return true if the specified tag is DW_TAG_compile_unit.
 272 bool DIDescriptor::isCompileUnit() const {
 273   return DbgNode && getTag() == dwarf::DW_TAG_compile_unit;
 274 }
 275
 276 /// isFile - Return true if the specified tag is DW_TAG_file_type.
 277 bool DIDescriptor::isFile() const {
 278   return DbgNode && getTag() == dwarf::DW_TAG_file_type;
 279 }
 280
 281 /// isNameSpace - Return true if the specified tag is DW_TAG_namespace.
 282 bool DIDescriptor::isNameSpace() const {
 283   return DbgNode && getTag() == dwarf::DW_TAG_namespace;
 284 }
 285
 286 /// isLexicalBlockFile - Return true if the specified descriptor is a
 287 /// lexical block with an extra file.
 288 bool DIDescriptor::isLexicalBlockFile() const {
 289   return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
 290     (DbgNode->getNumOperands() == 3);
 291 }
 292
 293 /// isLexicalBlock - Return true if the specified tag is DW_TAG_lexical_block.
 294 bool DIDescriptor::isLexicalBlock() const {
 295   return DbgNode && getTag() == dwarf::DW_TAG_lexical_block &&
 296     (DbgNode->getNumOperands() > 3);
 297 }
 298
 299 /// isSubrange - Return true if the specified tag is DW_TAG_subrange_type.
 300 bool DIDescriptor::isSubrange() const {
 301   return DbgNode && getTag() == dwarf::DW_TAG_subrange_type;
 302 }
 303
 304 /// isEnumerator - Return true if the specified tag is DW_TAG_enumerator.
 305 bool DIDescriptor::isEnumerator() const {
 306   return DbgNode && getTag() == dwarf::DW_TAG_enumerator;
 307 }
 308
 309 /// isObjCProperty - Return true if the specified tag is DW_TAG_APPLE_property.
 310 bool DIDescriptor::isObjCProperty() const {
 311   return DbgNode && getTag() == dwarf::DW_TAG_APPLE_property;
 312 }
 313
 314 /// \brief Return true if the specified tag is DW_TAG_imported_module or
 315 /// DW_TAG_imported_declaration.
 316 bool DIDescriptor::isImportedEntity() const {
 317   return DbgNode && (getTag() == dwarf::DW_TAG_imported_module ||
 318                      getTag() == dwarf::DW_TAG_imported_declaration);
 319 }
 320
 321 //===----------------------------------------------------------------------===//
 322 // Simple Descriptor Constructors and other Methods
 323 //===----------------------------------------------------------------------===//
 324
 325 unsigned DIArray::getNumElements() const {
 326   if (!DbgNode)
 327     return 0;
 328   return DbgNode->getNumOperands();
 329 }
 330
 331 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
 332 /// type with the one in the passed descriptor.
 333 void DIType::replaceAllUsesWith(DIDescriptor &D) {
 334
 335   assert(DbgNode && "Trying to replace an unverified type!");
 336
 337   // Since we use a TrackingVH for the node, its easy for clients to manufacture
 338   // legitimate situations where they want to replaceAllUsesWith() on something
 339   // which, due to uniquing, has merged with the source. We shield clients from
 340   // this detail by allowing a value to be replaced with replaceAllUsesWith()
 341   // itself.
 342   if (DbgNode != D) {
 343     MDNode *Node = const_cast<MDNode*>(DbgNode);
 344     const MDNode *DN = D;
 345     const Value *V = cast_or_null<Value>(DN);
 346     Node->replaceAllUsesWith(const_cast<Value*>(V));
 347     MDNode::deleteTemporary(Node);
 348   }
 349 }
 350
 351 /// replaceAllUsesWith - Replace all uses of the MDNode used by this
 352 /// type with the one in D.
 353 void DIType::replaceAllUsesWith(MDNode *D) {
 354
 355   assert(DbgNode && "Trying to replace an unverified type!");
 356
 357   // Since we use a TrackingVH for the node, its easy for clients to manufacture
 358   // legitimate situations where they want to replaceAllUsesWith() on something
 359   // which, due to uniquing, has merged with the source. We shield clients from
 360   // this detail by allowing a value to be replaced with replaceAllUsesWith()
 361   // itself.
 362   if (DbgNode != D) {
 363     MDNode *Node = const_cast<MDNode*>(DbgNode);
 364     const MDNode *DN = D;
 365     const Value *V = cast_or_null<Value>(DN);
 366     Node->replaceAllUsesWith(const_cast<Value*>(V));
 367     MDNode::deleteTemporary(Node);
 368   }
 369 }
 370
 371 /// isUnsignedDIType - Return true if type encoding is unsigned.
 372 bool DIType::isUnsignedDIType() {
 373   DIDerivedType DTy(DbgNode);
 374   if (DTy.Verify())
 375     return DTy.getTypeDerivedFrom().isUnsignedDIType();
 376
 377   DIBasicType BTy(DbgNode);
 378   if (BTy.Verify()) {
 379     unsigned Encoding = BTy.getEncoding();
 380     if (Encoding == dwarf::DW_ATE_unsigned ||
 381         Encoding == dwarf::DW_ATE_unsigned_char ||
 382         Encoding == dwarf::DW_ATE_boolean)
 383       return true;
 384   }
 385   return false;
 386 }
 387
 388 /// Verify - Verify that a compile unit is well formed.
 389 bool DICompileUnit::Verify() const {
 390   if (!isCompileUnit())
 391     return false;
 392
 393   // Don't bother verifying the compilation directory or producer string
 394   // as those could be empty.
 395   if (getFilename().empty())
 396     return false;
 397
 398   return DbgNode->getNumOperands() == 13;
 399 }
 400
 401 /// Verify - Verify that an ObjC property is well formed.
 402 bool DIObjCProperty::Verify() const {
 403   if (!isObjCProperty())
 404     return false;
 405
 406   // Don't worry about the rest of the strings for now.
 407   return DbgNode->getNumOperands() == 8;
 408 }
 409
 410 /// Check if a field at position Elt of a MDNode is a MDNode.
 411 /// We currently allow an empty string and an integer.
 412 /// But we don't allow a non-empty string in a MDNode field.
 413 static bool fieldIsMDNode(const MDNode *DbgNode, unsigned Elt) {
 414   // FIXME: This function should return true, if the field is null or the field
 415   // is indeed a MDNode: return !Fld || isa<MDNode>(Fld).
 416   Value *Fld = getField(DbgNode, Elt);
 417   if (Fld && isa<MDString>(Fld) &&
 418       !cast<MDString>(Fld)->getString().empty())
 419     return false;
 420   return true;
 421 }
 422
 423 /// Check if a field at position Elt of a MDNode is a MDString.
 424 static bool fieldIsMDString(const MDNode *DbgNode, unsigned Elt) {
 425   Value *Fld = getField(DbgNode, Elt);
 426   return !Fld || isa<MDString>(Fld);
 427 }
 428
 429 /// Check if a value can be a TypeRef.
 430 static bool isTypeRef(const Value *Val) {
 431   return !Val || isa<MDString>(Val) || isa<MDNode>(Val);
 432 }
 433
 434 /// Check if a field at position Elt of a MDNode can be a TypeRef.
 435 static bool fieldIsTypeRef(const MDNode *DbgNode, unsigned Elt) {
 436   Value *Fld = getField(DbgNode, Elt);
 437   return isTypeRef(Fld);
 438 }
 439
 440 /// Verify - Verify that a type descriptor is well formed.
 441 bool DIType::Verify() const {
 442   if (!isType())
 443     return false;
 444   // Make sure Context @ field 2 is MDNode.
 445   if (!fieldIsMDNode(DbgNode, 2))
 446     return false;
 447
 448   // FIXME: Sink this into the various subclass verifies.
 449   uint16_t Tag = getTag();
 450   if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
 451       Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
 452       Tag != dwarf::DW_TAG_ptr_to_member_type &&
 453       Tag != dwarf::DW_TAG_reference_type &&
 454       Tag != dwarf::DW_TAG_rvalue_reference_type &&
 455       Tag != dwarf::DW_TAG_restrict_type && Tag != dwarf::DW_TAG_array_type &&
 456       Tag != dwarf::DW_TAG_enumeration_type &&
 457       Tag != dwarf::DW_TAG_subroutine_type &&
 458       Tag != dwarf::DW_TAG_inheritance && Tag != dwarf::DW_TAG_friend &&
 459       getFilename().empty())
 460     return false;
 461   // DIType is abstract, it should be a BasicType, a DerivedType or
 462   // a CompositeType.
 463   if (isBasicType())
 464     DIBasicType(DbgNode).Verify();
 465   else if (isCompositeType())
 466     DICompositeType(DbgNode).Verify();
 467   else if (isDerivedType())
 468     DIDerivedType(DbgNode).Verify();
 469   else
 470     return false;
 471   return true;
 472 }
 473
 474 /// Verify - Verify that a basic type descriptor is well formed.
 475 bool DIBasicType::Verify() const {
 476   return isBasicType() && DbgNode->getNumOperands() == 10;
 477 }
 478
 479 /// Verify - Verify that a derived type descriptor is well formed.
 480 bool DIDerivedType::Verify() const {
 481   // Make sure DerivedFrom @ field 9 is MDNode.
 482   if (!fieldIsMDNode(DbgNode, 9))
 483     return false;
 484   if (getTag() == dwarf::DW_TAG_ptr_to_member_type)
 485     // Make sure ClassType @ field 10 is a TypeRef.
 486     if (!fieldIsTypeRef(DbgNode, 10))
 487       return false;
 488
 489   return isDerivedType() && DbgNode->getNumOperands() >= 10 &&
 490          DbgNode->getNumOperands() <= 14;
 491 }
 492
 493 /// Verify - Verify that a composite type descriptor is well formed.
 494 bool DICompositeType::Verify() const {
 495   if (!isCompositeType())
 496     return false;
 497
 498   // Make sure DerivedFrom @ field 9 and ContainingType @ field 12 are MDNodes.
 499   if (!fieldIsMDNode(DbgNode, 9))
 500     return false;
 501   if (!fieldIsTypeRef(DbgNode, 12))
 502     return false;
 503
 504   // Make sure the type identifier at field 14 is MDString, it can be null.
 505   if (!fieldIsMDString(DbgNode, 14))
 506     return false;
 507
 508   // If this is an array type verify that we have a DIType in the derived type
 509   // field as that's the type of our element.
 510   if (getTag() == dwarf::DW_TAG_array_type)
 511     if (!DIType(getTypeDerivedFrom()))
 512       return false;
 513
 514   return DbgNode->getNumOperands() == 15;
 515 }
 516
 517 /// Verify - Verify that a subprogram descriptor is well formed.
 518 bool DISubprogram::Verify() const {
 519   if (!isSubprogram())
 520     return false;
 521
 522   // Make sure context @ field 2 and type @ field 7 are MDNodes.
 523   if (!fieldIsMDNode(DbgNode, 2))
 524     return false;
 525   if (!fieldIsMDNode(DbgNode, 7))
 526     return false;
 527   // Containing type @ field 12.
 528   if (!fieldIsTypeRef(DbgNode, 12))
 529     return false;
 530   return DbgNode->getNumOperands() == 20;
 531 }
 532
 533 /// Verify - Verify that a global variable descriptor is well formed.
 534 bool DIGlobalVariable::Verify() const {
 535   if (!isGlobalVariable())
 536     return false;
 537
 538   if (getDisplayName().empty())
 539     return false;
 540   // Make sure context @ field 2 and type @ field 8 are MDNodes.
 541   if (!fieldIsMDNode(DbgNode, 2))
 542     return false;
 543   if (!fieldIsMDNode(DbgNode, 8))
 544     return false;
 545   // Make sure StaticDataMemberDeclaration @ field 12 is MDNode.
 546   if (!fieldIsMDNode(DbgNode, 12))
 547     return false;
 548
 549   return DbgNode->getNumOperands() == 13;
 550 }
 551
 552 /// Verify - Verify that a variable descriptor is well formed.
 553 bool DIVariable::Verify() const {
 554   if (!isVariable())
 555     return false;
 556
 557   // Make sure context @ field 1 and type @ field 5 are MDNodes.
 558   if (!fieldIsMDNode(DbgNode, 1))
 559     return false;
 560   if (!fieldIsMDNode(DbgNode, 5))
 561     return false;
 562   return DbgNode->getNumOperands() >= 8;
 563 }
 564
 565 /// Verify - Verify that a location descriptor is well formed.
 566 bool DILocation::Verify() const {
 567   if (!DbgNode)
 568     return false;
 569
 570   return DbgNode->getNumOperands() == 4;
 571 }
 572
 573 /// Verify - Verify that a namespace descriptor is well formed.
 574 bool DINameSpace::Verify() const {
 575   if (!isNameSpace())
 576     return false;
 577   return DbgNode->getNumOperands() == 5;
 578 }
 579
 580 /// \brief Retrieve the MDNode for the directory/file pair.
 581 MDNode *DIFile::getFileNode() const {
 582   return getNodeField(DbgNode, 1);
 583 }
 584
 585 /// \brief Verify that the file descriptor is well formed.
 586 bool DIFile::Verify() const {
 587   return isFile() && DbgNode->getNumOperands() == 2;
 588 }
 589
 590 /// \brief Verify that the enumerator descriptor is well formed.
 591 bool DIEnumerator::Verify() const {
 592   return isEnumerator() && DbgNode->getNumOperands() == 3;
 593 }
 594
 595 /// \brief Verify that the subrange descriptor is well formed.
 596 bool DISubrange::Verify() const {
 597   return isSubrange() && DbgNode->getNumOperands() == 3;
 598 }
 599
 600 /// \brief Verify that the lexical block descriptor is well formed.
 601 bool DILexicalBlock::Verify() const {
 602   return isLexicalBlock() && DbgNode->getNumOperands() == 6;
 603 }
 604
 605 /// \brief Verify that the file-scoped lexical block descriptor is well formed.
 606 bool DILexicalBlockFile::Verify() const {
 607   return isLexicalBlockFile() && DbgNode->getNumOperands() == 3;
 608 }
 609
 610 /// \brief Verify that the template type parameter descriptor is well formed.
 611 bool DITemplateTypeParameter::Verify() const {
 612   return isTemplateTypeParameter() && DbgNode->getNumOperands() == 7;
 613 }
 614
 615 /// \brief Verify that the template value parameter descriptor is well formed.
 616 bool DITemplateValueParameter::Verify() const {
 617   return isTemplateValueParameter() && DbgNode->getNumOperands() == 8;
 618 }
 619
 620 /// \brief Verify that the imported module descriptor is well formed.
 621 bool DIImportedEntity::Verify() const {
 622   return isImportedEntity() &&
 623          (DbgNode->getNumOperands() == 4 || DbgNode->getNumOperands() == 5);
 624 }
 625
 626 /// getOriginalTypeSize - If this type is derived from a base type then
 627 /// return base type size.
 628 uint64_t DIDerivedType::getOriginalTypeSize() const {
 629   uint16_t Tag = getTag();
 630
 631   if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
 632       Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
 633       Tag != dwarf::DW_TAG_restrict_type)
 634     return getSizeInBits();
 635
 636   DIType BaseType = getTypeDerivedFrom();
 637
 638   // If this type is not derived from any type then take conservative approach.
 639   if (!BaseType.isValid())
 640     return getSizeInBits();
 641
 642   // If this is a derived type, go ahead and get the base type, unless it's a
 643   // reference then it's just the size of the field. Pointer types have no need
 644   // of this since they're a different type of qualification on the type.
 645   if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
 646       BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
 647     return getSizeInBits();
 648
 649   if (BaseType.isDerivedType())
 650     return DIDerivedType(BaseType).getOriginalTypeSize();
 651
 652   return BaseType.getSizeInBits();
 653 }
 654
 655 /// getObjCProperty - Return property node, if this ivar is associated with one.
 656 MDNode *DIDerivedType::getObjCProperty() const {
 657   return getNodeField(DbgNode, 10);
 658 }
 659
 660 MDString *DICompositeType::getIdentifier() const {
 661   return cast_or_null<MDString>(getField(DbgNode, 14));
 662 }
 663
 664 #ifndef NDEBUG
 665 static void VerifySubsetOf(const MDNode *LHS, const MDNode *RHS) {
 666   for (unsigned i = 0; i != LHS->getNumOperands(); ++i) {
 667     // Skip the 'empty' list (that's a single i32 0, rather than truly empty).
 668     if (i == 0 && isa<ConstantInt>(LHS->getOperand(i)))
 669       continue;
 670     const MDNode *E = cast<MDNode>(LHS->getOperand(i));
 671     bool found = false;
 672     for (unsigned j = 0; !found && j != RHS->getNumOperands(); ++j)
 673       found = E == RHS->getOperand(j);
 674     assert(found && "Losing a member during member list replacement");
 675   }
 676 }
 677 #endif
 678
 679 /// \brief Set the array of member DITypes.
 680 void DICompositeType::setTypeArray(DIArray Elements, DIArray TParams) {
 681   assert((!TParams || DbgNode->getNumOperands() == 15) &&
 682          "If you're setting the template parameters this should include a slot "
 683          "for that!");
 684   TrackingVH<MDNode> N(*this);
 685   if (Elements) {
 686 #ifndef NDEBUG
 687     // Check that the new list of members contains all the old members as well.
 688     if (const MDNode *El = cast_or_null<MDNode>(N->getOperand(10)))
 689       VerifySubsetOf(El, Elements);
 690 #endif
 691     N->replaceOperandWith(10, Elements);
 692   }
 693   if (TParams)
 694     N->replaceOperandWith(13, TParams);
 695   DbgNode = N;
 696 }
 697
 698 void DICompositeType::addMember(DIDescriptor D) {
 699   SmallVector<llvm::Value *, 16> M;
 700   DIArray OrigM = getTypeArray();
 701   unsigned Elements = OrigM.getNumElements();
 702   if (Elements == 1 && !OrigM.getElement(0))
 703     Elements = 0;
 704   M.reserve(Elements + 1);
 705   for (unsigned i = 0; i != Elements; ++i)
 706     M.push_back(OrigM.getElement(i));
 707   M.push_back(D);
 708   setTypeArray(DIArray(MDNode::get(DbgNode->getContext(), M)));
 709 }
 710
 711 /// Generate a reference to this DIType. Uses the type identifier instead
 712 /// of the actual MDNode if possible, to help type uniquing.
 713 DITypeRef DIType::generateRef() {
 714   if (!isCompositeType())
 715     return DITypeRef(*this);
 716   DICompositeType DTy(DbgNode);
 717   if (!DTy.getIdentifier())
 718     return DITypeRef(*this);
 719   return DITypeRef(DTy.getIdentifier());
 720 }
 721
 722 /// \brief Set the containing type.
 723 void DICompositeType::setContainingType(DICompositeType ContainingType) {
 724   TrackingVH<MDNode> N(*this);
 725   N->replaceOperandWith(12, ContainingType.generateRef());
 726   DbgNode = N;
 727 }
 728
 729 /// isInlinedFnArgument - Return true if this variable provides debugging
 730 /// information for an inlined function arguments.
 731 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
 732   assert(CurFn && "Invalid function");
 733   if (!getContext().isSubprogram())
 734     return false;
 735   // This variable is not inlined function argument if its scope
 736   // does not describe current function.
 737   return !DISubprogram(getContext()).describes(CurFn);
 738 }
 739
 740 /// describes - Return true if this subprogram provides debugging
 741 /// information for the function F.
 742 bool DISubprogram::describes(const Function *F) {
 743   assert(F && "Invalid function");
 744   if (F == getFunction())
 745     return true;
 746   StringRef Name = getLinkageName();
 747   if (Name.empty())
 748     Name = getName();
 749   if (F->getName() == Name)
 750     return true;
 751   return false;
 752 }
 753
 754 unsigned DISubprogram::isOptimized() const {
 755   assert (DbgNode && "Invalid subprogram descriptor!");
 756   if (DbgNode->getNumOperands() == 15)
 757     return getUnsignedField(14);
 758   return 0;
 759 }
 760
 761 MDNode *DISubprogram::getVariablesNodes() const {
 762   return getNodeField(DbgNode, 18);
 763 }
 764
 765 DIArray DISubprogram::getVariables() const {
 766   return DIArray(getNodeField(DbgNode, 18));
 767 }
 768
 769 Value *DITemplateValueParameter::getValue() const {
 770   return getField(DbgNode, 4);
 771 }
 772
 773 // If the current node has a parent scope then return that,
 774 // else return an empty scope.
 775 DIScope DIScope::getContext() const {
 776
 777   if (isType())
 778     return DIType(DbgNode).getContext();
 779
 780   if (isSubprogram())
 781     return DISubprogram(DbgNode).getContext();
 782
 783   if (isLexicalBlock())
 784     return DILexicalBlock(DbgNode).getContext();
 785
 786   if (isLexicalBlockFile())
 787     return DILexicalBlockFile(DbgNode).getContext();
 788
 789   if (isNameSpace())
 790     return DINameSpace(DbgNode).getContext();
 791
 792   assert((isFile() || isCompileUnit()) && "Unhandled type of scope.");
 793   return DIScope();
 794 }
 795
 796 StringRef DIScope::getFilename() const {
 797   if (!DbgNode)
 798     return StringRef();
 799   return ::getStringField(getNodeField(DbgNode, 1), 0);
 800 }
 801
 802 StringRef DIScope::getDirectory() const {
 803   if (!DbgNode)
 804     return StringRef();
 805   return ::getStringField(getNodeField(DbgNode, 1), 1);
 806 }
 807
 808 DIArray DICompileUnit::getEnumTypes() const {
 809   if (!DbgNode || DbgNode->getNumOperands() < 13)
 810     return DIArray();
 811
 812   return DIArray(getNodeField(DbgNode, 7));
 813 }
 814
 815 DIArray DICompileUnit::getRetainedTypes() const {
 816   if (!DbgNode || DbgNode->getNumOperands() < 13)
 817     return DIArray();
 818
 819   return DIArray(getNodeField(DbgNode, 8));
 820 }
 821
 822 DIArray DICompileUnit::getSubprograms() const {
 823   if (!DbgNode || DbgNode->getNumOperands() < 13)
 824     return DIArray();
 825
 826   return DIArray(getNodeField(DbgNode, 9));
 827 }
 828
 829
 830 DIArray DICompileUnit::getGlobalVariables() const {
 831   if (!DbgNode || DbgNode->getNumOperands() < 13)
 832     return DIArray();
 833
 834   return DIArray(getNodeField(DbgNode, 10));
 835 }
 836
 837 DIArray DICompileUnit::getImportedEntities() const {
 838   if (!DbgNode || DbgNode->getNumOperands() < 13)
 839     return DIArray();
 840
 841   return DIArray(getNodeField(DbgNode, 11));
 842 }
 843
 844 /// fixupSubprogramName - Replace contains special characters used
 845 /// in a typical Objective-C names with '.' in a given string.
 846 static void fixupSubprogramName(DISubprogram Fn, SmallVectorImpl<char> &Out) {
 847   StringRef FName =
 848       Fn.getFunction() ? Fn.getFunction()->getName() : Fn.getName();
 849   FName = Function::getRealLinkageName(FName);
 850
 851   StringRef Prefix("llvm.dbg.lv.");
 852   Out.reserve(FName.size() + Prefix.size());
 853   Out.append(Prefix.begin(), Prefix.end());
 854
 855   bool isObjCLike = false;
 856   for (size_t i = 0, e = FName.size(); i < e; ++i) {
 857     char C = FName[i];
 858     if (C == '[')
 859       isObjCLike = true;
 860
 861     if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
 862                        C == '+' || C == '(' || C == ')'))
 863       Out.push_back('.');
 864     else
 865       Out.push_back(C);
 866   }
 867 }
 868
 869 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
 870 /// suitable to hold function specific information.
 871 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
 872   SmallString<32> Name;
 873   fixupSubprogramName(Fn, Name);
 874   return M.getNamedMetadata(Name.str());
 875 }
 876
 877 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
 878 /// to hold function specific information.
 879 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
 880   SmallString<32> Name;
 881   fixupSubprogramName(Fn, Name);
 882   return M.getOrInsertNamedMetadata(Name.str());
 883 }
 884
 885 /// createInlinedVariable - Create a new inlined variable based on current
 886 /// variable.
 887 /// @param DV            Current Variable.
 888 /// @param InlinedScope  Location at current variable is inlined.
 889 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
 890                                        LLVMContext &VMContext) {
 891   SmallVector<Value *, 16> Elts;
 892   // Insert inlined scope as 7th element.
 893   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
 894     i == 7 ? Elts.push_back(InlinedScope) :
 895              Elts.push_back(DV->getOperand(i));
 896   return DIVariable(MDNode::get(VMContext, Elts));
 897 }
 898
 899 /// cleanseInlinedVariable - Remove inlined scope from the variable.
 900 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
 901   SmallVector<Value *, 16> Elts;
 902   // Insert inlined scope as 7th element.
 903   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
 904     i == 7 ?
 905       Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext))):
 906       Elts.push_back(DV->getOperand(i));
 907   return DIVariable(MDNode::get(VMContext, Elts));
 908 }
 909
 910 /// getDISubprogram - Find subprogram that is enclosing this scope.
 911 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
 912   DIDescriptor D(Scope);
 913   if (D.isSubprogram())
 914     return DISubprogram(Scope);
 915
 916   if (D.isLexicalBlockFile())
 917     return getDISubprogram(DILexicalBlockFile(Scope).getContext());
 918
 919   if (D.isLexicalBlock())
 920     return getDISubprogram(DILexicalBlock(Scope).getContext());
 921
 922   return DISubprogram();
 923 }
 924
 925 /// getDICompositeType - Find underlying composite type.
 926 DICompositeType llvm::getDICompositeType(DIType T) {
 927   if (T.isCompositeType())
 928     return DICompositeType(T);
 929
 930   if (T.isDerivedType())
 931     return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
 932
 933   return DICompositeType();
 934 }
 935
 936 /// isSubprogramContext - Return true if Context is either a subprogram
 937 /// or another context nested inside a subprogram.
 938 bool llvm::isSubprogramContext(const MDNode *Context) {
 939   if (!Context)
 940     return false;
 941   DIDescriptor D(Context);
 942   if (D.isSubprogram())
 943     return true;
 944   if (D.isType())
 945     return isSubprogramContext(DIType(Context).getContext());
 946   return false;
 947 }
 948
 949 /// Update DITypeIdentifierMap by going through retained types of each CU.
 950 DITypeIdentifierMap llvm::generateDITypeIdentifierMap(
 951                               const NamedMDNode *CU_Nodes) {
 952   DITypeIdentifierMap Map;
 953   for (unsigned CUi = 0, CUe = CU_Nodes->getNumOperands(); CUi != CUe; ++CUi) {
 954     DICompileUnit CU(CU_Nodes->getOperand(CUi));
 955     DIArray Retain = CU.getRetainedTypes();
 956     for (unsigned Ti = 0, Te = Retain.getNumElements(); Ti != Te; ++Ti) {
 957       if (!Retain.getElement(Ti).isCompositeType())
 958         continue;
 959       DICompositeType Ty(Retain.getElement(Ti));
 960       if (MDString *TypeId = Ty.getIdentifier()) {
 961         // Definition has priority over declaration.
 962         // Try to insert (TypeId, Ty) to Map.
 963         std::pair<DITypeIdentifierMap::iterator, bool> P =
 964             Map.insert(std::make_pair(TypeId, Ty));
 965         // If TypeId already exists in Map and this is a definition, replace
 966         // whatever we had (declaration or definition) with the definition.
 967         if (!P.second && !Ty.isForwardDecl())
 968           P.first->second = Ty;
 969       }
 970     }
 971   }
 972   return Map;
 973 }
 974
 975 //===----------------------------------------------------------------------===//
 976 // DebugInfoFinder implementations.
 977 //===----------------------------------------------------------------------===//
 978
 979 void DebugInfoFinder::reset() {
 980   CUs.clear();
 981   SPs.clear();
 982   GVs.clear();
 983   TYs.clear();
 984   Scopes.clear();
 985   NodesSeen.clear();
 986 }
 987
 988 /// processModule - Process entire module and collect debug info.
 989 void DebugInfoFinder::processModule(const Module &M) {
 990   if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
 991     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
 992       DICompileUnit CU(CU_Nodes->getOperand(i));
 993       addCompileUnit(CU);
 994       DIArray GVs = CU.getGlobalVariables();
 995       for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
 996         DIGlobalVariable DIG(GVs.getElement(i));
 997         if (addGlobalVariable(DIG)) {
 998           processScope(DIG.getContext());
 999           processType(DIG.getType());
1000         }
1001       }
1002       DIArray SPs = CU.getSubprograms();
1003       for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
1004         processSubprogram(DISubprogram(SPs.getElement(i)));
1005       DIArray EnumTypes = CU.getEnumTypes();
1006       for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
1007         processType(DIType(EnumTypes.getElement(i)));
1008       DIArray RetainedTypes = CU.getRetainedTypes();
1009       for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
1010         processType(DIType(RetainedTypes.getElement(i)));
1011       DIArray Imports = CU.getImportedEntities();
1012       for (unsigned i = 0, e = Imports.getNumElements(); i != e; ++i) {
1013         DIImportedEntity Import = DIImportedEntity(
1014                                     Imports.getElement(i));
1015         DIDescriptor Entity = Import.getEntity();
1016         if (Entity.isType())
1017           processType(DIType(Entity));
1018         else if (Entity.isSubprogram())
1019           processSubprogram(DISubprogram(Entity));
1020         else if (Entity.isNameSpace())
1021           processScope(DINameSpace(Entity).getContext());
1022       }
1023       // FIXME: We really shouldn't be bailing out after visiting just one CU
1024       return;
1025     }
1026   }
1027 }
1028
1029 /// processLocation - Process DILocation.
1030 void DebugInfoFinder::processLocation(DILocation Loc) {
1031   if (!Loc) return;
1032   processScope(Loc.getScope());
1033   processLocation(Loc.getOrigLocation());
1034 }
1035
1036 /// processType - Process DIType.
1037 void DebugInfoFinder::processType(DIType DT) {
1038   if (!addType(DT))
1039     return;
1040   processScope(DT.getContext());
1041   if (DT.isCompositeType()) {
1042     DICompositeType DCT(DT);
1043     processType(DCT.getTypeDerivedFrom());
1044     DIArray DA = DCT.getTypeArray();
1045     for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1046       DIDescriptor D = DA.getElement(i);
1047       if (D.isType())
1048         processType(DIType(D));
1049       else if (D.isSubprogram())
1050         processSubprogram(DISubprogram(D));
1051     }
1052   } else if (DT.isDerivedType()) {
1053     DIDerivedType DDT(DT);
1054     processType(DDT.getTypeDerivedFrom());
1055   }
1056 }
1057
1058 void DebugInfoFinder::processScope(DIScope Scope) {
1059   if (Scope.isType()) {
1060     DIType Ty(Scope);
1061     processType(Ty);
1062     return;
1063   }
1064   if (Scope.isCompileUnit()) {
1065     addCompileUnit(DICompileUnit(Scope));
1066     return;
1067   }
1068   if (Scope.isSubprogram()) {
1069     processSubprogram(DISubprogram(Scope));
1070     return;
1071   }
1072   if (!addScope(Scope))
1073     return;
1074   if (Scope.isLexicalBlock()) {
1075     DILexicalBlock LB(Scope);
1076     processScope(LB.getContext());
1077   } else if (Scope.isLexicalBlockFile()) {
1078     DILexicalBlockFile LBF = DILexicalBlockFile(Scope);
1079     processScope(LBF.getScope());
1080   } else if (Scope.isNameSpace()) {
1081     DINameSpace NS(Scope);
1082     processScope(NS.getContext());
1083   }
1084 }
1085
1086 /// processLexicalBlock
1087 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
1088   DIScope Context = LB.getContext();
1089   if (Context.isLexicalBlock())
1090     return processLexicalBlock(DILexicalBlock(Context));
1091   else if (Context.isLexicalBlockFile()) {
1092     DILexicalBlockFile DBF = DILexicalBlockFile(Context);
1093     return processLexicalBlock(DILexicalBlock(DBF.getScope()));
1094   }
1095   else
1096     return processSubprogram(DISubprogram(Context));
1097 }
1098
1099 /// processSubprogram - Process DISubprogram.
1100 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
1101   if (!addSubprogram(SP))
1102     return;
1103   processScope(SP.getContext());
1104   processType(SP.getType());
1105   DIArray TParams = SP.getTemplateParams();
1106   for (unsigned I = 0, E = TParams.getNumElements(); I != E; ++I) {
1107     DIDescriptor Element = TParams.getElement(I);
1108     if (Element.isTemplateTypeParameter()) {
1109       DITemplateTypeParameter TType(Element);
1110       processScope(TType.getContext());
1111       processType(TType.getType());
1112     } else if (Element.isTemplateValueParameter()) {
1113       DITemplateValueParameter TVal(Element);
1114       processScope(TVal.getContext());
1115       processType(TVal.getType());
1116     }
1117   }
1118 }
1119
1120 /// processDeclare - Process DbgDeclareInst.
1121 void DebugInfoFinder::processDeclare(const DbgDeclareInst *DDI) {
1122   MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1123   if (!N) return;
1124
1125   DIDescriptor DV(N);
1126   if (!DV.isVariable())
1127     return;
1128
1129   if (!NodesSeen.insert(DV))
1130     return;
1131   processScope(DIVariable(N).getContext());
1132   processType(DIVariable(N).getType());
1133 }
1134
1135 void DebugInfoFinder::processValue(const DbgValueInst *DVI) {
1136   MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
1137   if (!N) return;
1138
1139   DIDescriptor DV(N);
1140   if (!DV.isVariable())
1141     return;
1142
1143   if (!NodesSeen.insert(DV))
1144     return;
1145   processScope(DIVariable(N).getContext());
1146   processType(DIVariable(N).getType());
1147 }
1148
1149 /// addType - Add type into Tys.
1150 bool DebugInfoFinder::addType(DIType DT) {
1151   if (!DT)
1152     return false;
1153
1154   if (!NodesSeen.insert(DT))
1155     return false;
1156
1157   TYs.push_back(DT);
1158   return true;
1159 }
1160
1161 /// addCompileUnit - Add compile unit into CUs.
1162 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1163   if (!CU)
1164     return false;
1165   if (!NodesSeen.insert(CU))
1166     return false;
1167
1168   CUs.push_back(CU);
1169   return true;
1170 }
1171
1172 /// addGlobalVariable - Add global variable into GVs.
1173 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1174   if (!DIG)
1175     return false;
1176
1177   if (!NodesSeen.insert(DIG))
1178     return false;
1179
1180   GVs.push_back(DIG);
1181   return true;
1182 }
1183
1184 // addSubprogram - Add subprgoram into SPs.
1185 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1186   if (!SP)
1187     return false;
1188
1189   if (!NodesSeen.insert(SP))
1190     return false;
1191
1192   SPs.push_back(SP);
1193   return true;
1194 }
1195
1196 bool DebugInfoFinder::addScope(DIScope Scope) {
1197   if (!Scope)
1198     return false;
1199   // FIXME: Ocaml binding generates a scope with no content, we treat it
1200   // as null for now.
1201   if (Scope->getNumOperands() == 0)
1202     return false;
1203   if (!NodesSeen.insert(Scope))
1204     return false;
1205   Scopes.push_back(Scope);
1206   return true;
1207 }
1208
1209 //===----------------------------------------------------------------------===//
1210 // DIDescriptor: dump routines for all descriptors.
1211 //===----------------------------------------------------------------------===//
1212
1213 /// dump - Print descriptor to dbgs() with a newline.
1214 void DIDescriptor::dump() const {
1215   print(dbgs()); dbgs() << '\n';
1216 }
1217
1218 /// print - Print descriptor.
1219 void DIDescriptor::print(raw_ostream &OS) const {
1220   if (!DbgNode) return;
1221
1222   if (const char *Tag = dwarf::TagString(getTag()))
1223     OS << "[ " << Tag << " ]";
1224
1225   if (this->isSubrange()) {
1226     DISubrange(DbgNode).printInternal(OS);
1227   } else if (this->isCompileUnit()) {
1228     DICompileUnit(DbgNode).printInternal(OS);
1229   } else if (this->isFile()) {
1230     DIFile(DbgNode).printInternal(OS);
1231   } else if (this->isEnumerator()) {
1232     DIEnumerator(DbgNode).printInternal(OS);
1233   } else if (this->isBasicType()) {
1234     DIType(DbgNode).printInternal(OS);
1235   } else if (this->isDerivedType()) {
1236     DIDerivedType(DbgNode).printInternal(OS);
1237   } else if (this->isCompositeType()) {
1238     DICompositeType(DbgNode).printInternal(OS);
1239   } else if (this->isSubprogram()) {
1240     DISubprogram(DbgNode).printInternal(OS);
1241   } else if (this->isGlobalVariable()) {
1242     DIGlobalVariable(DbgNode).printInternal(OS);
1243   } else if (this->isVariable()) {
1244     DIVariable(DbgNode).printInternal(OS);
1245   } else if (this->isObjCProperty()) {
1246     DIObjCProperty(DbgNode).printInternal(OS);
1247   } else if (this->isNameSpace()) {
1248     DINameSpace(DbgNode).printInternal(OS);
1249   } else if (this->isScope()) {
1250     DIScope(DbgNode).printInternal(OS);
1251   }
1252 }
1253
1254 void DISubrange::printInternal(raw_ostream &OS) const {
1255   int64_t Count = getCount();
1256   if (Count != -1)
1257     OS << " [" << getLo() << ", " << Count - 1 << ']';
1258   else
1259     OS << " [unbounded]";
1260 }
1261
1262 void DIScope::printInternal(raw_ostream &OS) const {
1263   OS << " [" << getDirectory() << "/" << getFilename() << ']';
1264 }
1265
1266 void DICompileUnit::printInternal(raw_ostream &OS) const {
1267   DIScope::printInternal(OS);
1268   OS << " [";
1269   unsigned Lang = getLanguage();
1270   if (const char *LangStr = dwarf::LanguageString(Lang))
1271     OS << LangStr;
1272   else
1273     (OS << "lang 0x").write_hex(Lang);
1274   OS << ']';
1275 }
1276
1277 void DIEnumerator::printInternal(raw_ostream &OS) const {
1278   OS << " [" << getName() << " :: " << getEnumValue() << ']';
1279 }
1280
1281 void DIType::printInternal(raw_ostream &OS) const {
1282   if (!DbgNode) return;
1283
1284   StringRef Res = getName();
1285   if (!Res.empty())
1286     OS << " [" << Res << "]";
1287
1288   // TODO: Print context?
1289
1290   OS << " [line " << getLineNumber()
1291      << ", size " << getSizeInBits()
1292      << ", align " << getAlignInBits()
1293      << ", offset " << getOffsetInBits();
1294   if (isBasicType())
1295     if (const char *Enc =
1296         dwarf::AttributeEncodingString(DIBasicType(DbgNode).getEncoding()))
1297       OS << ", enc " << Enc;
1298   OS << "]";
1299
1300   if (isPrivate())
1301     OS << " [private]";
1302   else if (isProtected())
1303     OS << " [protected]";
1304
1305   if (isArtificial())
1306     OS << " [artificial]";
1307
1308   if (isForwardDecl())
1309     OS << " [decl]";
1310   else if (getTag() == dwarf::DW_TAG_structure_type ||
1311            getTag() == dwarf::DW_TAG_union_type ||
1312            getTag() == dwarf::DW_TAG_enumeration_type ||
1313            getTag() == dwarf::DW_TAG_class_type)
1314     OS << " [def]";
1315   if (isVector())
1316     OS << " [vector]";
1317   if (isStaticMember())
1318     OS << " [static]";
1319 }
1320
1321 void DIDerivedType::printInternal(raw_ostream &OS) const {
1322   DIType::printInternal(OS);
1323   OS << " [from " << getTypeDerivedFrom().getName() << ']';
1324 }
1325
1326 void DICompositeType::printInternal(raw_ostream &OS) const {
1327   DIType::printInternal(OS);
1328   DIArray A = getTypeArray();
1329   OS << " [" << A.getNumElements() << " elements]";
1330 }
1331
1332 void DINameSpace::printInternal(raw_ostream &OS) const {
1333   StringRef Name = getName();
1334   if (!Name.empty())
1335     OS << " [" << Name << ']';
1336
1337   OS << " [line " << getLineNumber() << ']';
1338 }
1339
1340 void DISubprogram::printInternal(raw_ostream &OS) const {
1341   // TODO : Print context
1342   OS << " [line " << getLineNumber() << ']';
1343
1344   if (isLocalToUnit())
1345     OS << " [local]";
1346
1347   if (isDefinition())
1348     OS << " [def]";
1349
1350   if (getScopeLineNumber() != getLineNumber())
1351     OS << " [scope " << getScopeLineNumber() << "]";
1352
1353   if (isPrivate())
1354     OS << " [private]";
1355   else if (isProtected())
1356     OS << " [protected]";
1357
1358   StringRef Res = getName();
1359   if (!Res.empty())
1360     OS << " [" << Res << ']';
1361 }
1362
1363 void DIGlobalVariable::printInternal(raw_ostream &OS) const {
1364   StringRef Res = getName();
1365   if (!Res.empty())
1366     OS << " [" << Res << ']';
1367
1368   OS << " [line " << getLineNumber() << ']';
1369
1370   // TODO : Print context
1371
1372   if (isLocalToUnit())
1373     OS << " [local]";
1374
1375   if (isDefinition())
1376     OS << " [def]";
1377 }
1378
1379 void DIVariable::printInternal(raw_ostream &OS) const {
1380   StringRef Res = getName();
1381   if (!Res.empty())
1382     OS << " [" << Res << ']';
1383
1384   OS << " [line " << getLineNumber() << ']';
1385 }
1386
1387 void DIObjCProperty::printInternal(raw_ostream &OS) const {
1388   StringRef Name = getObjCPropertyName();
1389   if (!Name.empty())
1390     OS << " [" << Name << ']';
1391
1392   OS << " [line " << getLineNumber()
1393      << ", properties " << getUnsignedField(6) << ']';
1394 }
1395
1396 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
1397                           const LLVMContext &Ctx) {
1398   if (!DL.isUnknown()) {          // Print source line info.
1399     DIScope Scope(DL.getScope(Ctx));
1400     assert(Scope.isScope() &&
1401       "Scope of a DebugLoc should be a DIScope.");
1402     // Omit the directory, because it's likely to be long and uninteresting.
1403     CommentOS << Scope.getFilename();
1404     CommentOS << ':' << DL.getLine();
1405     if (DL.getCol() != 0)
1406       CommentOS << ':' << DL.getCol();
1407     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
1408     if (!InlinedAtDL.isUnknown()) {
1409       CommentOS << " @[ ";
1410       printDebugLoc(InlinedAtDL, CommentOS, Ctx);
1411       CommentOS << " ]";
1412     }
1413   }
1414 }
1415
1416 void DIVariable::printExtendedName(raw_ostream &OS) const {
1417   const LLVMContext &Ctx = DbgNode->getContext();
1418   StringRef Res = getName();
1419   if (!Res.empty())
1420     OS << Res << "," << getLineNumber();
1421   if (MDNode *InlinedAt = getInlinedAt()) {
1422     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
1423     if (!InlinedAtDL.isUnknown()) {
1424       OS << " @[";
1425       printDebugLoc(InlinedAtDL, OS, Ctx);
1426       OS << "]";
1427     }
1428   }
1429 }
1430
1431 DITypeRef::DITypeRef(const Value *V) : TypeVal(V) {
1432   assert(isTypeRef(V) && "DITypeRef should be a MDString or MDNode");
1433 }
1434
1435 /// Given a DITypeIdentifierMap, tries to find the corresponding
1436 /// DIType for a DITypeRef.
1437 DIType DITypeRef::resolve(const DITypeIdentifierMap &Map) const {
1438   if (!TypeVal)
1439     return NULL;
1440
1441   if (const MDNode *MD = dyn_cast<MDNode>(TypeVal)) {
1442     assert(DIType(MD).isType() &&
1443            "MDNode in DITypeRef should be a DIType.");
1444     return MD;
1445   }
1446
1447   const MDString *MS = cast<MDString>(TypeVal);
1448   // Find the corresponding MDNode.
1449   DITypeIdentifierMap::const_iterator Iter = Map.find(MS);
1450   assert(Iter != Map.end() && "Identifier not in the type map?");
1451   assert(DIType(Iter->second).isType() &&
1452          "MDNode in DITypeIdentifierMap should be a DIType.");
1453   return Iter->second;
1454 }
1455
1456 /// Specialize getFieldAs to handle fields that are references to DITypes.
1457 template <>
1458 DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const {
1459   return DITypeRef(getField(DbgNode, Elt));
1460 }