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