lib/IR/DebugInfo.cpp

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