lib/IR/DebugInfo.cpp

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