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