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