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