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