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<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 a type descriptor is well formed.
 381 bool DIType::Verify() const {
 382   if (!DbgNode)
 383     return false;
 384   if (getContext() && !getContext().Verify())
 385     return false;
 386   unsigned Tag = getTag();
 387   if (!isBasicType() && Tag != dwarf::DW_TAG_const_type &&
 388       Tag != dwarf::DW_TAG_volatile_type && Tag != dwarf::DW_TAG_pointer_type &&
 389       Tag != dwarf::DW_TAG_reference_type && Tag != dwarf::DW_TAG_restrict_type
 390       && Tag != dwarf::DW_TAG_vector_type && Tag != dwarf::DW_TAG_array_type
 391       && Tag != dwarf::DW_TAG_enumeration_type
 392       && Tag != dwarf::DW_TAG_subroutine_type
 393       && getFilename().empty())
 394     return false;
 395   return true;
 396 }
 397
 398 /// Verify - Verify that a basic type descriptor is well formed.
 399 bool DIBasicType::Verify() const {
 400   return isBasicType();
 401 }
 402
 403 /// Verify - Verify that a derived type descriptor is well formed.
 404 bool DIDerivedType::Verify() const {
 405   return isDerivedType();
 406 }
 407
 408 /// Verify - Verify that a composite type descriptor is well formed.
 409 bool DICompositeType::Verify() const {
 410   if (!DbgNode)
 411     return false;
 412   if (getContext() && !getContext().Verify())
 413     return false;
 414
 415   return true;
 416 }
 417
 418 /// Verify - Verify that a subprogram descriptor is well formed.
 419 bool DISubprogram::Verify() const {
 420   if (!DbgNode)
 421     return false;
 422
 423   if (getContext() && !getContext().Verify())
 424     return false;
 425
 426   DICompositeType Ty = getType();
 427   if (!Ty.Verify())
 428     return false;
 429   return true;
 430 }
 431
 432 /// Verify - Verify that a global variable descriptor is well formed.
 433 bool DIGlobalVariable::Verify() const {
 434   if (!DbgNode)
 435     return false;
 436
 437   if (getDisplayName().empty())
 438     return false;
 439
 440   if (getContext() && !getContext().Verify())
 441     return false;
 442
 443   DIType Ty = getType();
 444   if (!Ty.Verify())
 445     return false;
 446
 447   if (!getGlobal() && !getConstant())
 448     return false;
 449
 450   return true;
 451 }
 452
 453 /// Verify - Verify that a variable descriptor is well formed.
 454 bool DIVariable::Verify() const {
 455   if (!DbgNode)
 456     return false;
 457
 458   if (getContext() && !getContext().Verify())
 459     return false;
 460
 461   DIType Ty = getType();
 462   if (!Ty.Verify())
 463     return false;
 464
 465   return true;
 466 }
 467
 468 /// Verify - Verify that a location descriptor is well formed.
 469 bool DILocation::Verify() const {
 470   if (!DbgNode)
 471     return false;
 472
 473   return DbgNode->getNumOperands() == 4;
 474 }
 475
 476 /// Verify - Verify that a namespace descriptor is well formed.
 477 bool DINameSpace::Verify() const {
 478   if (!DbgNode)
 479     return false;
 480   if (getName().empty())
 481     return false;
 482   return true;
 483 }
 484
 485 /// getOriginalTypeSize - If this type is derived from a base type then
 486 /// return base type size.
 487 uint64_t DIDerivedType::getOriginalTypeSize() const {
 488   unsigned Tag = getTag();
 489
 490   if (Tag == dwarf::DW_TAG_member || Tag == dwarf::DW_TAG_typedef ||
 491       Tag == dwarf::DW_TAG_const_type || Tag == dwarf::DW_TAG_volatile_type ||
 492       Tag == dwarf::DW_TAG_restrict_type) {
 493     DIType BaseType = getTypeDerivedFrom();
 494     // If this type is not derived from any type then take conservative
 495     // approach.
 496     if (!BaseType.isValid())
 497       return getSizeInBits();
 498     // If this is a derived type, go ahead and get the base type, unless
 499     // it's a reference then it's just the size of the field. Pointer types
 500     // have no need of this since they're a different type of qualification
 501     // on the type.
 502     if (BaseType.getTag() == dwarf::DW_TAG_reference_type)
 503       return getSizeInBits();
 504     else if (BaseType.isDerivedType())
 505       return DIDerivedType(BaseType).getOriginalTypeSize();
 506     else
 507       return BaseType.getSizeInBits();
 508   }
 509
 510   return getSizeInBits();
 511 }
 512
 513 /// getObjCProperty - Return property node, if this ivar is associated with one.
 514 MDNode *DIDerivedType::getObjCProperty() const {
 515   if (getVersion() <= LLVMDebugVersion11 || DbgNode->getNumOperands() <= 10)
 516     return NULL;
 517   return dyn_cast_or_null<MDNode>(DbgNode->getOperand(10));
 518 }
 519
 520 /// isInlinedFnArgument - Return true if this variable provides debugging
 521 /// information for an inlined function arguments.
 522 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
 523   assert(CurFn && "Invalid function");
 524   if (!getContext().isSubprogram())
 525     return false;
 526   // This variable is not inlined function argument if its scope
 527   // does not describe current function.
 528   return !(DISubprogram(getContext()).describes(CurFn));
 529 }
 530
 531 /// describes - Return true if this subprogram provides debugging
 532 /// information for the function F.
 533 bool DISubprogram::describes(const Function *F) {
 534   assert(F && "Invalid function");
 535   if (F == getFunction())
 536     return true;
 537   StringRef Name = getLinkageName();
 538   if (Name.empty())
 539     Name = getName();
 540   if (F->getName() == Name)
 541     return true;
 542   return false;
 543 }
 544
 545 unsigned DISubprogram::isOptimized() const {
 546   assert (DbgNode && "Invalid subprogram descriptor!");
 547   if (DbgNode->getNumOperands() == 16)
 548     return getUnsignedField(15);
 549   return 0;
 550 }
 551
 552 MDNode *DISubprogram::getVariablesNodes() const {
 553   if (!DbgNode || DbgNode->getNumOperands() <= 19)
 554     return NULL;
 555   if (MDNode *Temp = dyn_cast_or_null<MDNode>(DbgNode->getOperand(19)))
 556     return dyn_cast_or_null<MDNode>(Temp->getOperand(0));
 557   return NULL;
 558 }
 559
 560 DIArray DISubprogram::getVariables() const {
 561   if (!DbgNode || DbgNode->getNumOperands() <= 19)
 562     return DIArray();
 563   if (MDNode *T = dyn_cast_or_null<MDNode>(DbgNode->getOperand(19)))
 564     if (MDNode *A = dyn_cast_or_null<MDNode>(T->getOperand(0)))
 565       return DIArray(A);
 566   return DIArray();
 567 }
 568
 569 StringRef DIScope::getFilename() const {
 570   if (!DbgNode)
 571     return StringRef();
 572   if (isLexicalBlockFile())
 573     return DILexicalBlockFile(DbgNode).getFilename();
 574   if (isLexicalBlock())
 575     return DILexicalBlock(DbgNode).getFilename();
 576   if (isSubprogram())
 577     return DISubprogram(DbgNode).getFilename();
 578   if (isCompileUnit())
 579     return DICompileUnit(DbgNode).getFilename();
 580   if (isNameSpace())
 581     return DINameSpace(DbgNode).getFilename();
 582   if (isType())
 583     return DIType(DbgNode).getFilename();
 584   if (isFile())
 585     return DIFile(DbgNode).getFilename();
 586   llvm_unreachable("Invalid DIScope!");
 587 }
 588
 589 StringRef DIScope::getDirectory() const {
 590   if (!DbgNode)
 591     return StringRef();
 592   if (isLexicalBlockFile())
 593     return DILexicalBlockFile(DbgNode).getDirectory();
 594   if (isLexicalBlock())
 595     return DILexicalBlock(DbgNode).getDirectory();
 596   if (isSubprogram())
 597     return DISubprogram(DbgNode).getDirectory();
 598   if (isCompileUnit())
 599     return DICompileUnit(DbgNode).getDirectory();
 600   if (isNameSpace())
 601     return DINameSpace(DbgNode).getDirectory();
 602   if (isType())
 603     return DIType(DbgNode).getDirectory();
 604   if (isFile())
 605     return DIFile(DbgNode).getDirectory();
 606   llvm_unreachable("Invalid DIScope!");
 607 }
 608
 609 DIArray DICompileUnit::getEnumTypes() const {
 610   if (!DbgNode || DbgNode->getNumOperands() < 14)
 611     return DIArray();
 612
 613   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(10)))
 614     if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
 615       return DIArray(A);
 616   return DIArray();
 617 }
 618
 619 DIArray DICompileUnit::getRetainedTypes() const {
 620   if (!DbgNode || DbgNode->getNumOperands() < 14)
 621     return DIArray();
 622
 623   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(11)))
 624     if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
 625       return DIArray(A);
 626   return DIArray();
 627 }
 628
 629 DIArray DICompileUnit::getSubprograms() const {
 630   if (!DbgNode || DbgNode->getNumOperands() < 14)
 631     return DIArray();
 632
 633   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(12)))
 634     if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
 635       return DIArray(A);
 636   return DIArray();
 637 }
 638
 639
 640 DIArray DICompileUnit::getGlobalVariables() const {
 641   if (!DbgNode || DbgNode->getNumOperands() < 14)
 642     return DIArray();
 643
 644   if (MDNode *N = dyn_cast_or_null<MDNode>(DbgNode->getOperand(13)))
 645     if (MDNode *A = dyn_cast_or_null<MDNode>(N->getOperand(0)))
 646       return DIArray(A);
 647   return DIArray();
 648 }
 649
 650 //===----------------------------------------------------------------------===//
 651 // DIDescriptor: vtable anchors for all descriptors.
 652 //===----------------------------------------------------------------------===//
 653
 654 void DIScope::anchor() { }
 655
 656 void DICompileUnit::anchor() { }
 657
 658 void DIFile::anchor() { }
 659
 660 void DIType::anchor() { }
 661
 662 void DIBasicType::anchor() { }
 663
 664 void DIDerivedType::anchor() { }
 665
 666 void DICompositeType::anchor() { }
 667
 668 void DISubprogram::anchor() { }
 669
 670 void DILexicalBlock::anchor() { }
 671
 672 void DINameSpace::anchor() { }
 673
 674 void DILexicalBlockFile::anchor() { }
 675
 676 //===----------------------------------------------------------------------===//
 677 // DIDescriptor: dump routines for all descriptors.
 678 //===----------------------------------------------------------------------===//
 679
 680
 681 /// print - Print descriptor.
 682 void DIDescriptor::print(raw_ostream &OS) const {
 683   OS << "[" << dwarf::TagString(getTag()) << "] ";
 684   OS.write_hex((intptr_t) &*DbgNode) << ']';
 685 }
 686
 687 /// print - Print compile unit.
 688 void DICompileUnit::print(raw_ostream &OS) const {
 689   if (getLanguage())
 690     OS << " [" << dwarf::LanguageString(getLanguage()) << "] ";
 691
 692   OS << " [" << getDirectory() << "/" << getFilename() << "]";
 693 }
 694
 695 /// print - Print type.
 696 void DIType::print(raw_ostream &OS) const {
 697   if (!DbgNode) return;
 698
 699   StringRef Res = getName();
 700   if (!Res.empty())
 701     OS << " [" << Res << "] ";
 702
 703   unsigned Tag = getTag();
 704   OS << " [" << dwarf::TagString(Tag) << "] ";
 705
 706   // TODO : Print context
 707   OS << " ["
 708          << "line " << getLineNumber() << ", "
 709          << getSizeInBits() << " bits, "
 710          << getAlignInBits() << " bit alignment, "
 711          << getOffsetInBits() << " bit offset"
 712          << "] ";
 713
 714   if (isPrivate())
 715     OS << " [private] ";
 716   else if (isProtected())
 717     OS << " [protected] ";
 718
 719   if (isForwardDecl())
 720     OS << " [fwd] ";
 721
 722   if (isBasicType())
 723     DIBasicType(DbgNode).print(OS);
 724   else if (isDerivedType())
 725     DIDerivedType(DbgNode).print(OS);
 726   else if (isCompositeType())
 727     DICompositeType(DbgNode).print(OS);
 728   else {
 729     OS << "Invalid DIType\n";
 730     return;
 731   }
 732
 733   OS << "\n";
 734 }
 735
 736 /// print - Print basic type.
 737 void DIBasicType::print(raw_ostream &OS) const {
 738   OS << " [" << dwarf::AttributeEncodingString(getEncoding()) << "] ";
 739 }
 740
 741 /// print - Print derived type.
 742 void DIDerivedType::print(raw_ostream &OS) const {
 743   OS << "\n\t Derived From: "; getTypeDerivedFrom().print(OS);
 744 }
 745
 746 /// print - Print composite type.
 747 void DICompositeType::print(raw_ostream &OS) const {
 748   DIArray A = getTypeArray();
 749   OS << " [" << A.getNumElements() << " elements]";
 750 }
 751
 752 /// print - Print subprogram.
 753 void DISubprogram::print(raw_ostream &OS) const {
 754   StringRef Res = getName();
 755   if (!Res.empty())
 756     OS << " [" << Res << "] ";
 757
 758   unsigned Tag = getTag();
 759   OS << " [" << dwarf::TagString(Tag) << "] ";
 760
 761   // TODO : Print context
 762   OS << " [" << getLineNumber() << "] ";
 763
 764   if (isLocalToUnit())
 765     OS << " [local] ";
 766
 767   if (isDefinition())
 768     OS << " [def] ";
 769
 770   OS << "\n";
 771 }
 772
 773 /// print - Print global variable.
 774 void DIGlobalVariable::print(raw_ostream &OS) const {
 775   OS << " [";
 776   StringRef Res = getName();
 777   if (!Res.empty())
 778     OS << " [" << Res << "] ";
 779
 780   unsigned Tag = getTag();
 781   OS << " [" << dwarf::TagString(Tag) << "] ";
 782
 783   // TODO : Print context
 784   OS << " [" << getLineNumber() << "] ";
 785
 786   if (isLocalToUnit())
 787     OS << " [local] ";
 788
 789   if (isDefinition())
 790     OS << " [def] ";
 791
 792   if (isGlobalVariable())
 793     DIGlobalVariable(DbgNode).print(OS);
 794   OS << "]\n";
 795 }
 796
 797 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
 798                           const LLVMContext &Ctx) {
 799   if (!DL.isUnknown()) {          // Print source line info.
 800     DIScope Scope(DL.getScope(Ctx));
 801     // Omit the directory, because it's likely to be long and uninteresting.
 802     if (Scope.Verify())
 803       CommentOS << Scope.getFilename();
 804     else
 805       CommentOS << "<unknown>";
 806     CommentOS << ':' << DL.getLine();
 807     if (DL.getCol() != 0)
 808       CommentOS << ':' << DL.getCol();
 809     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(DL.getInlinedAt(Ctx));
 810     if (!InlinedAtDL.isUnknown()) {
 811       CommentOS << " @[ ";
 812       printDebugLoc(InlinedAtDL, CommentOS, Ctx);
 813       CommentOS << " ]";
 814     }
 815   }
 816 }
 817
 818 void DIVariable::printExtendedName(raw_ostream &OS) const {
 819   const LLVMContext &Ctx = DbgNode->getContext();
 820   StringRef Res = getName();
 821   if (!Res.empty())
 822     OS << Res << "," << getLineNumber();
 823   if (MDNode *InlinedAt = getInlinedAt()) {
 824     DebugLoc InlinedAtDL = DebugLoc::getFromDILocation(InlinedAt);
 825     if (!InlinedAtDL.isUnknown()) {
 826       OS << " @[";
 827       printDebugLoc(InlinedAtDL, OS, Ctx);
 828       OS << "]";
 829     }
 830   }
 831 }
 832
 833 /// print - Print variable.
 834 void DIVariable::print(raw_ostream &OS) const {
 835   StringRef Res = getName();
 836   if (!Res.empty())
 837     OS << " [" << Res << "] ";
 838
 839   OS << " [" << getLineNumber() << "] ";
 840   getType().print(OS);
 841   OS << "\n";
 842
 843   // FIXME: Dump complex addresses
 844 }
 845
 846 /// dump - Print descriptor to dbgs() with a newline.
 847 void DIDescriptor::dump() const {
 848   print(dbgs()); dbgs() << '\n';
 849 }
 850
 851 /// dump - Print compile unit to dbgs() with a newline.
 852 void DICompileUnit::dump() const {
 853   print(dbgs()); dbgs() << '\n';
 854 }
 855
 856 /// dump - Print type to dbgs() with a newline.
 857 void DIType::dump() const {
 858   print(dbgs()); dbgs() << '\n';
 859 }
 860
 861 /// dump - Print basic type to dbgs() with a newline.
 862 void DIBasicType::dump() const {
 863   print(dbgs()); dbgs() << '\n';
 864 }
 865
 866 /// dump - Print derived type to dbgs() with a newline.
 867 void DIDerivedType::dump() const {
 868   print(dbgs()); dbgs() << '\n';
 869 }
 870
 871 /// dump - Print composite type to dbgs() with a newline.
 872 void DICompositeType::dump() const {
 873   print(dbgs()); dbgs() << '\n';
 874 }
 875
 876 /// dump - Print subprogram to dbgs() with a newline.
 877 void DISubprogram::dump() const {
 878   print(dbgs()); dbgs() << '\n';
 879 }
 880
 881 /// dump - Print global variable.
 882 void DIGlobalVariable::dump() const {
 883   print(dbgs()); dbgs() << '\n';
 884 }
 885
 886 /// dump - Print variable.
 887 void DIVariable::dump() const {
 888   print(dbgs()); dbgs() << '\n';
 889 }
 890
 891 /// fixupObjcLikeName - Replace contains special characters used
 892 /// in a typical Objective-C names with '.' in a given string.
 893 static void fixupObjcLikeName(StringRef Str, SmallVectorImpl<char> &Out) {
 894   bool isObjCLike = false;
 895   for (size_t i = 0, e = Str.size(); i < e; ++i) {
 896     char C = Str[i];
 897     if (C == '[')
 898       isObjCLike = true;
 899
 900     if (isObjCLike && (C == '[' || C == ']' || C == ' ' || C == ':' ||
 901                        C == '+' || C == '(' || C == ')'))
 902       Out.push_back('.');
 903     else
 904       Out.push_back(C);
 905   }
 906 }
 907
 908 /// getFnSpecificMDNode - Return a NameMDNode, if available, that is
 909 /// suitable to hold function specific information.
 910 NamedMDNode *llvm::getFnSpecificMDNode(const Module &M, DISubprogram Fn) {
 911   SmallString<32> Name = StringRef("llvm.dbg.lv.");
 912   StringRef FName = "fn";
 913   if (Fn.getFunction())
 914     FName = Fn.getFunction()->getName();
 915   else
 916     FName = Fn.getName();
 917   char One = '\1';
 918   if (FName.startswith(StringRef(&One, 1)))
 919     FName = FName.substr(1);
 920   fixupObjcLikeName(FName, Name);
 921   return M.getNamedMetadata(Name.str());
 922 }
 923
 924 /// getOrInsertFnSpecificMDNode - Return a NameMDNode that is suitable
 925 /// to hold function specific information.
 926 NamedMDNode *llvm::getOrInsertFnSpecificMDNode(Module &M, DISubprogram Fn) {
 927   SmallString<32> Name = StringRef("llvm.dbg.lv.");
 928   StringRef FName = "fn";
 929   if (Fn.getFunction())
 930     FName = Fn.getFunction()->getName();
 931   else
 932     FName = Fn.getName();
 933   char One = '\1';
 934   if (FName.startswith(StringRef(&One, 1)))
 935     FName = FName.substr(1);
 936   fixupObjcLikeName(FName, Name);
 937
 938   return M.getOrInsertNamedMetadata(Name.str());
 939 }
 940
 941 /// createInlinedVariable - Create a new inlined variable based on current
 942 /// variable.
 943 /// @param DV            Current Variable.
 944 /// @param InlinedScope  Location at current variable is inlined.
 945 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
 946                                        LLVMContext &VMContext) {
 947   SmallVector<Value *, 16> Elts;
 948   // Insert inlined scope as 7th element.
 949   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
 950     i == 7 ? Elts.push_back(InlinedScope) :
 951              Elts.push_back(DV->getOperand(i));
 952   return DIVariable(MDNode::get(VMContext, Elts));
 953 }
 954
 955 /// cleanseInlinedVariable - Remove inlined scope from the variable.
 956 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
 957   SmallVector<Value *, 16> Elts;
 958   // Insert inlined scope as 7th element.
 959   for (unsigned i = 0, e = DV->getNumOperands(); i != e; ++i)
 960     i == 7 ?
 961       Elts.push_back(llvm::Constant::getNullValue(Type::getInt32Ty(VMContext))):
 962       Elts.push_back(DV->getOperand(i));
 963   return DIVariable(MDNode::get(VMContext, Elts));
 964 }
 965
 966 //===----------------------------------------------------------------------===//
 967 // DebugInfoFinder implementations.
 968 //===----------------------------------------------------------------------===//
 969
 970 /// processModule - Process entire module and collect debug info.
 971 void DebugInfoFinder::processModule(Module &M) {
 972   if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
 973     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
 974       DICompileUnit CU(CU_Nodes->getOperand(i));
 975       addCompileUnit(CU);
 976       if (CU.getVersion() > LLVMDebugVersion10) {
 977         DIArray GVs = CU.getGlobalVariables();
 978         for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
 979           DIGlobalVariable DIG(GVs.getElement(i));
 980           if (addGlobalVariable(DIG))
 981             processType(DIG.getType());
 982         }
 983         DIArray SPs = CU.getSubprograms();
 984         for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
 985           processSubprogram(DISubprogram(SPs.getElement(i)));
 986         DIArray EnumTypes = CU.getEnumTypes();
 987         for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
 988           processType(DIType(EnumTypes.getElement(i)));
 989         DIArray RetainedTypes = CU.getRetainedTypes();
 990         for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
 991           processType(DIType(RetainedTypes.getElement(i)));
 992         return;
 993       }
 994     }
 995   }
 996
 997   for (Module::iterator I = M.begin(), E = M.end(); I != E; ++I)
 998     for (Function::iterator FI = (*I).begin(), FE = (*I).end(); FI != FE; ++FI)
 999       for (BasicBlock::iterator BI = (*FI).begin(), BE = (*FI).end(); BI != BE;
1000            ++BI) {
1001         if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(BI))
1002           processDeclare(DDI);
1003
1004         DebugLoc Loc = BI->getDebugLoc();
1005         if (Loc.isUnknown())
1006           continue;
1007
1008         LLVMContext &Ctx = BI->getContext();
1009         DIDescriptor Scope(Loc.getScope(Ctx));
1010
1011         if (Scope.isCompileUnit())
1012           addCompileUnit(DICompileUnit(Scope));
1013         else if (Scope.isSubprogram())
1014           processSubprogram(DISubprogram(Scope));
1015         else if (Scope.isLexicalBlockFile()) {
1016           DILexicalBlockFile DBF = DILexicalBlockFile(Scope);
1017           processLexicalBlock(DILexicalBlock(DBF.getScope()));
1018         }
1019         else if (Scope.isLexicalBlock())
1020           processLexicalBlock(DILexicalBlock(Scope));
1021
1022         if (MDNode *IA = Loc.getInlinedAt(Ctx))
1023           processLocation(DILocation(IA));
1024       }
1025
1026   if (NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.gv")) {
1027     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1028       DIGlobalVariable DIG(cast<MDNode>(NMD->getOperand(i)));
1029       if (addGlobalVariable(DIG)) {
1030         if (DIG.getVersion() <= LLVMDebugVersion10)
1031           addCompileUnit(DIG.getCompileUnit());
1032         processType(DIG.getType());
1033       }
1034     }
1035   }
1036
1037   if (NamedMDNode *NMD = M.getNamedMetadata("llvm.dbg.sp"))
1038     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
1039       processSubprogram(DISubprogram(NMD->getOperand(i)));
1040 }
1041
1042 /// processLocation - Process DILocation.
1043 void DebugInfoFinder::processLocation(DILocation Loc) {
1044   if (!Loc.Verify()) return;
1045   DIDescriptor S(Loc.getScope());
1046   if (S.isCompileUnit())
1047     addCompileUnit(DICompileUnit(S));
1048   else if (S.isSubprogram())
1049     processSubprogram(DISubprogram(S));
1050   else if (S.isLexicalBlock())
1051     processLexicalBlock(DILexicalBlock(S));
1052   else if (S.isLexicalBlockFile()) {
1053     DILexicalBlockFile DBF = DILexicalBlockFile(S);
1054     processLexicalBlock(DILexicalBlock(DBF.getScope()));
1055   }
1056   processLocation(Loc.getOrigLocation());
1057 }
1058
1059 /// processType - Process DIType.
1060 void DebugInfoFinder::processType(DIType DT) {
1061   if (!addType(DT))
1062     return;
1063   if (DT.getVersion() <= LLVMDebugVersion10)
1064     addCompileUnit(DT.getCompileUnit());
1065   if (DT.isCompositeType()) {
1066     DICompositeType DCT(DT);
1067     processType(DCT.getTypeDerivedFrom());
1068     DIArray DA = DCT.getTypeArray();
1069     for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
1070       DIDescriptor D = DA.getElement(i);
1071       if (D.isType())
1072         processType(DIType(D));
1073       else if (D.isSubprogram())
1074         processSubprogram(DISubprogram(D));
1075     }
1076   } else if (DT.isDerivedType()) {
1077     DIDerivedType DDT(DT);
1078     processType(DDT.getTypeDerivedFrom());
1079   }
1080 }
1081
1082 /// processLexicalBlock
1083 void DebugInfoFinder::processLexicalBlock(DILexicalBlock LB) {
1084   DIScope Context = LB.getContext();
1085   if (Context.isLexicalBlock())
1086     return processLexicalBlock(DILexicalBlock(Context));
1087   else if (Context.isLexicalBlockFile()) {
1088     DILexicalBlockFile DBF = DILexicalBlockFile(Context);
1089     return processLexicalBlock(DILexicalBlock(DBF.getScope()));
1090   }
1091   else
1092     return processSubprogram(DISubprogram(Context));
1093 }
1094
1095 /// processSubprogram - Process DISubprogram.
1096 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
1097   if (!addSubprogram(SP))
1098     return;
1099   if (SP.getVersion() <= LLVMDebugVersion10)
1100     addCompileUnit(SP.getCompileUnit());
1101   processType(SP.getType());
1102 }
1103
1104 /// processDeclare - Process DbgDeclareInst.
1105 void DebugInfoFinder::processDeclare(DbgDeclareInst *DDI) {
1106   MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
1107   if (!N) return;
1108
1109   DIDescriptor DV(N);
1110   if (!DV.isVariable())
1111     return;
1112
1113   if (!NodesSeen.insert(DV))
1114     return;
1115   if (DIVariable(N).getVersion() <= LLVMDebugVersion10)
1116     addCompileUnit(DIVariable(N).getCompileUnit());
1117   processType(DIVariable(N).getType());
1118 }
1119
1120 /// addType - Add type into Tys.
1121 bool DebugInfoFinder::addType(DIType DT) {
1122   if (!DT.isValid())
1123     return false;
1124
1125   if (!NodesSeen.insert(DT))
1126     return false;
1127
1128   TYs.push_back(DT);
1129   return true;
1130 }
1131
1132 /// addCompileUnit - Add compile unit into CUs.
1133 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
1134   if (!CU.Verify())
1135     return false;
1136
1137   if (!NodesSeen.insert(CU))
1138     return false;
1139
1140   CUs.push_back(CU);
1141   return true;
1142 }
1143
1144 /// addGlobalVariable - Add global variable into GVs.
1145 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
1146   if (!DIDescriptor(DIG).isGlobalVariable())
1147     return false;
1148
1149   if (!NodesSeen.insert(DIG))
1150     return false;
1151
1152   GVs.push_back(DIG);
1153   return true;
1154 }
1155
1156 // addSubprogram - Add subprgoram into SPs.
1157 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
1158   if (!DIDescriptor(SP).isSubprogram())
1159     return false;
1160
1161   if (!NodesSeen.insert(SP))
1162     return false;
1163
1164   SPs.push_back(SP);
1165   return true;
1166 }
1167
1168 /// getDISubprogram - Find subprogram that is enclosing this scope.
1169 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
1170   DIDescriptor D(Scope);
1171   if (D.isSubprogram())
1172     return DISubprogram(Scope);
1173
1174   if (D.isLexicalBlockFile())
1175     return getDISubprogram(DILexicalBlockFile(Scope).getContext());
1176
1177   if (D.isLexicalBlock())
1178     return getDISubprogram(DILexicalBlock(Scope).getContext());
1179
1180   return DISubprogram();
1181 }
1182
1183 /// getDICompositeType - Find underlying composite type.
1184 DICompositeType llvm::getDICompositeType(DIType T) {
1185   if (T.isCompositeType())
1186     return DICompositeType(T);
1187
1188   if (T.isDerivedType())
1189     return getDICompositeType(DIDerivedType(T).getTypeDerivedFrom());
1190
1191   return DICompositeType();
1192 }
1193
1194 /// isSubprogramContext - Return true if Context is either a subprogram
1195 /// or another context nested inside a subprogram.
1196 bool llvm::isSubprogramContext(const MDNode *Context) {
1197   if (!Context)
1198     return false;
1199   DIDescriptor D(Context);
1200   if (D.isSubprogram())
1201     return true;
1202   if (D.isType())
1203     return isSubprogramContext(DIType(Context).getContext());
1204   return false;
1205 }
1206