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