1 //===--- DIBuilder.cpp - Debug Information Builder ------------------------===// 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 DIBuilder. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "llvm/IR/DIBuilder.h" 15 #include "llvm/ADT/STLExtras.h" 16 #include "llvm/IR/Constants.h" 17 #include "llvm/IR/DebugInfo.h" 18 #include "llvm/IR/IntrinsicInst.h" 19 #include "llvm/IR/Module.h" 20 #include "llvm/Support/Debug.h" 21 #include "llvm/Support/Dwarf.h" 22 23 using namespace llvm; 24 using namespace llvm::dwarf; 25 26 namespace { 27 class HeaderBuilder { 28 /// \brief Whether there are any fields yet. 29 /// 30 /// Note that this is not equivalent to \c Chars.empty(), since \a concat() 31 /// may have been called already with an empty string. 32 bool IsEmpty; 33 SmallVector<char, 256> Chars; 34 35 public: 36 HeaderBuilder() : IsEmpty(true) {} 37 HeaderBuilder(const HeaderBuilder &X) : IsEmpty(X.IsEmpty), Chars(X.Chars) {} 38 HeaderBuilder(HeaderBuilder &&X) 39 : IsEmpty(X.IsEmpty), Chars(std::move(X.Chars)) {} 40 41 template <class Twineable> HeaderBuilder &concat(Twineable &&X) { 42 if (IsEmpty) 43 IsEmpty = false; 44 else 45 Chars.push_back(0); 46 Twine(X).toVector(Chars); 47 return *this; 48 } 49 50 MDString *get(LLVMContext &Context) const { 51 return MDString::get(Context, StringRef(Chars.begin(), Chars.size())); 52 } 53 54 static HeaderBuilder get(unsigned Tag) { 55 return HeaderBuilder().concat("0x" + Twine::utohexstr(Tag)); 56 } 57 }; 58 } 59 60 DIBuilder::DIBuilder(Module &m, bool AllowUnresolvedNodes) 61 : M(m), VMContext(M.getContext()), CUNode(nullptr), 62 DeclareFn(nullptr), ValueFn(nullptr), 63 AllowUnresolvedNodes(AllowUnresolvedNodes) {} 64 65 void DIBuilder::trackIfUnresolved(MDNode *N) { 66 if (!N) 67 return; 68 if (N->isResolved()) 69 return; 70 71 assert(AllowUnresolvedNodes && "Cannot handle unresolved nodes"); 72 UnresolvedNodes.emplace_back(N); 73 } 74 75 void DIBuilder::finalize() { 76 if (!CUNode) { 77 assert(!AllowUnresolvedNodes && 78 "creating type nodes without a CU is not supported"); 79 return; 80 } 81 82 CUNode->replaceEnumTypes(MDTuple::get(VMContext, AllEnumTypes)); 83 84 SmallVector<Metadata *, 16> RetainValues; 85 // Declarations and definitions of the same type may be retained. Some 86 // clients RAUW these pairs, leaving duplicates in the retained types 87 // list. Use a set to remove the duplicates while we transform the 88 // TrackingVHs back into Values. 89 SmallPtrSet<Metadata *, 16> RetainSet; 90 for (unsigned I = 0, E = AllRetainTypes.size(); I < E; I++) 91 if (RetainSet.insert(AllRetainTypes[I]).second) 92 RetainValues.push_back(AllRetainTypes[I]); 93 94 if (!RetainValues.empty()) 95 CUNode->replaceRetainedTypes(MDTuple::get(VMContext, RetainValues)); 96 97 DISubprogramArray SPs = MDTuple::get(VMContext, AllSubprograms); 98 if (!AllSubprograms.empty()) 99 CUNode->replaceSubprograms(SPs.get()); 100 101 for (auto *SP : SPs) { 102 if (MDTuple *Temp = SP->getVariables().get()) { 103 const auto &PV = PreservedVariables.lookup(SP); 104 SmallVector<Metadata *, 4> Variables(PV.begin(), PV.end()); 105 DINodeArray AV = getOrCreateArray(Variables); 106 TempMDTuple(Temp)->replaceAllUsesWith(AV.get()); 107 } 108 } 109 110 if (!AllGVs.empty()) 111 CUNode->replaceGlobalVariables(MDTuple::get(VMContext, AllGVs)); 112 113 if (!AllImportedModules.empty()) 114 CUNode->replaceImportedEntities(MDTuple::get( 115 VMContext, SmallVector<Metadata *, 16>(AllImportedModules.begin(), 116 AllImportedModules.end()))); 117 118 // Now that all temp nodes have been replaced or deleted, resolve remaining 119 // cycles. 120 for (const auto &N : UnresolvedNodes) 121 if (N && !N->isResolved()) 122 N->resolveCycles(); 123 UnresolvedNodes.clear(); 124 125 // Can't handle unresolved nodes anymore. 126 AllowUnresolvedNodes = false; 127 } 128 129 /// If N is compile unit return NULL otherwise return N. 130 static DIScope *getNonCompileUnitScope(DIScope *N) { 131 if (!N || isa<DICompileUnit>(N)) 132 return nullptr; 133 return cast<DIScope>(N); 134 } 135 136 DICompileUnit *DIBuilder::createCompileUnit( 137 unsigned Lang, StringRef Filename, StringRef Directory, StringRef Producer, 138 bool isOptimized, StringRef Flags, unsigned RunTimeVer, StringRef SplitName, 139 DebugEmissionKind Kind, uint64_t DWOId, bool EmitDebugInfo) { 140 141 assert(((Lang <= dwarf::DW_LANG_Fortran08 && Lang >= dwarf::DW_LANG_C89) || 142 (Lang <= dwarf::DW_LANG_hi_user && Lang >= dwarf::DW_LANG_lo_user)) && 143 "Invalid Language tag"); 144 assert(!Filename.empty() && 145 "Unable to create compile unit without filename"); 146 147 assert(!CUNode && "Can only make one compile unit per DIBuilder instance"); 148 CUNode = DICompileUnit::getDistinct( 149 VMContext, Lang, DIFile::get(VMContext, Filename, Directory), Producer, 150 isOptimized, Flags, RunTimeVer, SplitName, Kind, nullptr, 151 nullptr, nullptr, nullptr, nullptr, DWOId); 152 153 // Create a named metadata so that it is easier to find cu in a module. 154 // Note that we only generate this when the caller wants to actually 155 // emit debug information. When we are only interested in tracking 156 // source line locations throughout the backend, we prevent codegen from 157 // emitting debug info in the final output by not generating llvm.dbg.cu. 158 if (EmitDebugInfo) { 159 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu"); 160 NMD->addOperand(CUNode); 161 } 162 163 trackIfUnresolved(CUNode); 164 return CUNode; 165 } 166 167 static DIImportedEntity * 168 createImportedModule(LLVMContext &C, dwarf::Tag Tag, DIScope *Context, 169 Metadata *NS, unsigned Line, StringRef Name, 170 SmallVectorImpl<TrackingMDNodeRef> &AllImportedModules) { 171 auto *M = DIImportedEntity::get(C, Tag, Context, DINodeRef(NS), Line, Name); 172 AllImportedModules.emplace_back(M); 173 return M; 174 } 175 176 DIImportedEntity *DIBuilder::createImportedModule(DIScope *Context, 177 DINamespace *NS, 178 unsigned Line) { 179 return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_module, 180 Context, NS, Line, StringRef(), AllImportedModules); 181 } 182 183 DIImportedEntity *DIBuilder::createImportedModule(DIScope *Context, 184 DIImportedEntity *NS, 185 unsigned Line) { 186 return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_module, 187 Context, NS, Line, StringRef(), AllImportedModules); 188 } 189 190 DIImportedEntity *DIBuilder::createImportedModule(DIScope *Context, DIModule *M, 191 unsigned Line) { 192 return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_module, 193 Context, M, Line, StringRef(), AllImportedModules); 194 } 195 196 DIImportedEntity *DIBuilder::createImportedDeclaration(DIScope *Context, 197 DINode *Decl, 198 unsigned Line, 199 StringRef Name) { 200 // Make sure to use the unique identifier based metadata reference for 201 // types that have one. 202 return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_declaration, 203 Context, DINodeRef::get(Decl), Line, Name, 204 AllImportedModules); 205 } 206 207 DIFile *DIBuilder::createFile(StringRef Filename, StringRef Directory) { 208 return DIFile::get(VMContext, Filename, Directory); 209 } 210 211 DIEnumerator *DIBuilder::createEnumerator(StringRef Name, int64_t Val) { 212 assert(!Name.empty() && "Unable to create enumerator without name"); 213 return DIEnumerator::get(VMContext, Val, Name); 214 } 215 216 DIBasicType *DIBuilder::createUnspecifiedType(StringRef Name) { 217 assert(!Name.empty() && "Unable to create type without name"); 218 return DIBasicType::get(VMContext, dwarf::DW_TAG_unspecified_type, Name); 219 } 220 221 DIBasicType *DIBuilder::createNullPtrType() { 222 return createUnspecifiedType("decltype(nullptr)"); 223 } 224 225 DIBasicType *DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits, 226 uint64_t AlignInBits, 227 unsigned Encoding) { 228 assert(!Name.empty() && "Unable to create type without name"); 229 return DIBasicType::get(VMContext, dwarf::DW_TAG_base_type, Name, SizeInBits, 230 AlignInBits, Encoding); 231 } 232 233 DIDerivedType *DIBuilder::createQualifiedType(unsigned Tag, DIType *FromTy) { 234 return DIDerivedType::get(VMContext, Tag, "", nullptr, 0, nullptr, 235 DITypeRef::get(FromTy), 0, 0, 0, 0); 236 } 237 238 DIDerivedType *DIBuilder::createPointerType(DIType *PointeeTy, 239 uint64_t SizeInBits, 240 uint64_t AlignInBits, 241 StringRef Name) { 242 // FIXME: Why is there a name here? 243 return DIDerivedType::get(VMContext, dwarf::DW_TAG_pointer_type, Name, 244 nullptr, 0, nullptr, DITypeRef::get(PointeeTy), 245 SizeInBits, AlignInBits, 0, 0); 246 } 247 248 DIDerivedType *DIBuilder::createMemberPointerType(DIType *PointeeTy, 249 DIType *Base, 250 uint64_t SizeInBits, 251 uint64_t AlignInBits) { 252 return DIDerivedType::get(VMContext, dwarf::DW_TAG_ptr_to_member_type, "", 253 nullptr, 0, nullptr, DITypeRef::get(PointeeTy), 254 SizeInBits, AlignInBits, 0, 0, 255 DITypeRef::get(Base)); 256 } 257 258 DIDerivedType *DIBuilder::createReferenceType(unsigned Tag, DIType *RTy) { 259 assert(RTy && "Unable to create reference type"); 260 return DIDerivedType::get(VMContext, Tag, "", nullptr, 0, nullptr, 261 DITypeRef::get(RTy), 0, 0, 0, 0); 262 } 263 264 DIDerivedType *DIBuilder::createTypedef(DIType *Ty, StringRef Name, 265 DIFile *File, unsigned LineNo, 266 DIScope *Context) { 267 return DIDerivedType::get(VMContext, dwarf::DW_TAG_typedef, Name, File, 268 LineNo, 269 DIScopeRef::get(getNonCompileUnitScope(Context)), 270 DITypeRef::get(Ty), 0, 0, 0, 0); 271 } 272 273 DIDerivedType *DIBuilder::createFriend(DIType *Ty, DIType *FriendTy) { 274 assert(Ty && "Invalid type!"); 275 assert(FriendTy && "Invalid friend type!"); 276 return DIDerivedType::get(VMContext, dwarf::DW_TAG_friend, "", nullptr, 0, 277 DITypeRef::get(Ty), DITypeRef::get(FriendTy), 0, 0, 278 0, 0); 279 } 280 281 DIDerivedType *DIBuilder::createInheritance(DIType *Ty, DIType *BaseTy, 282 uint64_t BaseOffset, 283 unsigned Flags) { 284 assert(Ty && "Unable to create inheritance"); 285 return DIDerivedType::get(VMContext, dwarf::DW_TAG_inheritance, "", nullptr, 286 0, DITypeRef::get(Ty), DITypeRef::get(BaseTy), 0, 0, 287 BaseOffset, Flags); 288 } 289 290 DIDerivedType *DIBuilder::createMemberType(DIScope *Scope, StringRef Name, 291 DIFile *File, unsigned LineNumber, 292 uint64_t SizeInBits, 293 uint64_t AlignInBits, 294 uint64_t OffsetInBits, 295 unsigned Flags, DIType *Ty) { 296 return DIDerivedType::get( 297 VMContext, dwarf::DW_TAG_member, Name, File, LineNumber, 298 DIScopeRef::get(getNonCompileUnitScope(Scope)), DITypeRef::get(Ty), 299 SizeInBits, AlignInBits, OffsetInBits, Flags); 300 } 301 302 static ConstantAsMetadata *getConstantOrNull(Constant *C) { 303 if (C) 304 return ConstantAsMetadata::get(C); 305 return nullptr; 306 } 307 308 DIDerivedType *DIBuilder::createStaticMemberType(DIScope *Scope, StringRef Name, 309 DIFile *File, 310 unsigned LineNumber, 311 DIType *Ty, unsigned Flags, 312 llvm::Constant *Val) { 313 Flags |= DINode::FlagStaticMember; 314 return DIDerivedType::get( 315 VMContext, dwarf::DW_TAG_member, Name, File, LineNumber, 316 DIScopeRef::get(getNonCompileUnitScope(Scope)), DITypeRef::get(Ty), 0, 0, 317 0, Flags, getConstantOrNull(Val)); 318 } 319 320 DIDerivedType *DIBuilder::createObjCIVar(StringRef Name, DIFile *File, 321 unsigned LineNumber, 322 uint64_t SizeInBits, 323 uint64_t AlignInBits, 324 uint64_t OffsetInBits, unsigned Flags, 325 DIType *Ty, MDNode *PropertyNode) { 326 return DIDerivedType::get( 327 VMContext, dwarf::DW_TAG_member, Name, File, LineNumber, 328 DIScopeRef::get(getNonCompileUnitScope(File)), DITypeRef::get(Ty), 329 SizeInBits, AlignInBits, OffsetInBits, Flags, PropertyNode); 330 } 331 332 DIObjCProperty * 333 DIBuilder::createObjCProperty(StringRef Name, DIFile *File, unsigned LineNumber, 334 StringRef GetterName, StringRef SetterName, 335 unsigned PropertyAttributes, DIType *Ty) { 336 return DIObjCProperty::get(VMContext, Name, File, LineNumber, GetterName, 337 SetterName, PropertyAttributes, 338 DITypeRef::get(Ty)); 339 } 340 341 DITemplateTypeParameter * 342 DIBuilder::createTemplateTypeParameter(DIScope *Context, StringRef Name, 343 DIType *Ty) { 344 assert((!Context || isa<DICompileUnit>(Context)) && "Expected compile unit"); 345 return DITemplateTypeParameter::get(VMContext, Name, DITypeRef::get(Ty)); 346 } 347 348 static DITemplateValueParameter * 349 createTemplateValueParameterHelper(LLVMContext &VMContext, unsigned Tag, 350 DIScope *Context, StringRef Name, DIType *Ty, 351 Metadata *MD) { 352 assert((!Context || isa<DICompileUnit>(Context)) && "Expected compile unit"); 353 return DITemplateValueParameter::get(VMContext, Tag, Name, DITypeRef::get(Ty), 354 MD); 355 } 356 357 DITemplateValueParameter * 358 DIBuilder::createTemplateValueParameter(DIScope *Context, StringRef Name, 359 DIType *Ty, Constant *Val) { 360 return createTemplateValueParameterHelper( 361 VMContext, dwarf::DW_TAG_template_value_parameter, Context, Name, Ty, 362 getConstantOrNull(Val)); 363 } 364 365 DITemplateValueParameter * 366 DIBuilder::createTemplateTemplateParameter(DIScope *Context, StringRef Name, 367 DIType *Ty, StringRef Val) { 368 return createTemplateValueParameterHelper( 369 VMContext, dwarf::DW_TAG_GNU_template_template_param, Context, Name, Ty, 370 MDString::get(VMContext, Val)); 371 } 372 373 DITemplateValueParameter * 374 DIBuilder::createTemplateParameterPack(DIScope *Context, StringRef Name, 375 DIType *Ty, DINodeArray Val) { 376 return createTemplateValueParameterHelper( 377 VMContext, dwarf::DW_TAG_GNU_template_parameter_pack, Context, Name, Ty, 378 Val.get()); 379 } 380 381 DICompositeType *DIBuilder::createClassType( 382 DIScope *Context, StringRef Name, DIFile *File, unsigned LineNumber, 383 uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits, 384 unsigned Flags, DIType *DerivedFrom, DINodeArray Elements, 385 DIType *VTableHolder, MDNode *TemplateParams, StringRef UniqueIdentifier) { 386 assert((!Context || isa<DIScope>(Context)) && 387 "createClassType should be called with a valid Context"); 388 389 auto *R = DICompositeType::get( 390 VMContext, dwarf::DW_TAG_structure_type, Name, File, LineNumber, 391 DIScopeRef::get(getNonCompileUnitScope(Context)), 392 DITypeRef::get(DerivedFrom), SizeInBits, AlignInBits, OffsetInBits, Flags, 393 Elements, 0, DITypeRef::get(VTableHolder), 394 cast_or_null<MDTuple>(TemplateParams), UniqueIdentifier); 395 if (!UniqueIdentifier.empty()) 396 retainType(R); 397 trackIfUnresolved(R); 398 return R; 399 } 400 401 DICompositeType *DIBuilder::createStructType( 402 DIScope *Context, StringRef Name, DIFile *File, unsigned LineNumber, 403 uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags, 404 DIType *DerivedFrom, DINodeArray Elements, unsigned RunTimeLang, 405 DIType *VTableHolder, StringRef UniqueIdentifier) { 406 auto *R = DICompositeType::get( 407 VMContext, dwarf::DW_TAG_structure_type, Name, File, LineNumber, 408 DIScopeRef::get(getNonCompileUnitScope(Context)), 409 DITypeRef::get(DerivedFrom), SizeInBits, AlignInBits, 0, Flags, Elements, 410 RunTimeLang, DITypeRef::get(VTableHolder), nullptr, UniqueIdentifier); 411 if (!UniqueIdentifier.empty()) 412 retainType(R); 413 trackIfUnresolved(R); 414 return R; 415 } 416 417 DICompositeType *DIBuilder::createUnionType( 418 DIScope *Scope, StringRef Name, DIFile *File, unsigned LineNumber, 419 uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags, 420 DINodeArray Elements, unsigned RunTimeLang, StringRef UniqueIdentifier) { 421 auto *R = DICompositeType::get( 422 VMContext, dwarf::DW_TAG_union_type, Name, File, LineNumber, 423 DIScopeRef::get(getNonCompileUnitScope(Scope)), nullptr, SizeInBits, 424 AlignInBits, 0, Flags, Elements, RunTimeLang, nullptr, nullptr, 425 UniqueIdentifier); 426 if (!UniqueIdentifier.empty()) 427 retainType(R); 428 trackIfUnresolved(R); 429 return R; 430 } 431 432 DISubroutineType *DIBuilder::createSubroutineType(DIFile *File, 433 DITypeRefArray ParameterTypes, 434 unsigned Flags) { 435 return DISubroutineType::get(VMContext, Flags, ParameterTypes); 436 } 437 438 DICompositeType *DIBuilder::createExternalTypeRef(unsigned Tag, DIFile *File, 439 StringRef UniqueIdentifier) { 440 assert(!UniqueIdentifier.empty() && "external type ref without uid"); 441 auto *CTy = 442 DICompositeType::get(VMContext, Tag, "", nullptr, 0, nullptr, nullptr, 0, 443 0, 0, DINode::FlagExternalTypeRef, nullptr, 0, 444 nullptr, nullptr, UniqueIdentifier); 445 // Types with unique IDs need to be in the type map. 446 retainType(CTy); 447 return CTy; 448 } 449 450 DICompositeType *DIBuilder::createEnumerationType( 451 DIScope *Scope, StringRef Name, DIFile *File, unsigned LineNumber, 452 uint64_t SizeInBits, uint64_t AlignInBits, DINodeArray Elements, 453 DIType *UnderlyingType, StringRef UniqueIdentifier) { 454 auto *CTy = DICompositeType::get( 455 VMContext, dwarf::DW_TAG_enumeration_type, Name, File, LineNumber, 456 DIScopeRef::get(getNonCompileUnitScope(Scope)), 457 DITypeRef::get(UnderlyingType), SizeInBits, AlignInBits, 0, 0, Elements, 458 0, nullptr, nullptr, UniqueIdentifier); 459 AllEnumTypes.push_back(CTy); 460 if (!UniqueIdentifier.empty()) 461 retainType(CTy); 462 trackIfUnresolved(CTy); 463 return CTy; 464 } 465 466 DICompositeType *DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits, 467 DIType *Ty, 468 DINodeArray Subscripts) { 469 auto *R = DICompositeType::get(VMContext, dwarf::DW_TAG_array_type, "", 470 nullptr, 0, nullptr, DITypeRef::get(Ty), Size, 471 AlignInBits, 0, 0, Subscripts, 0, nullptr); 472 trackIfUnresolved(R); 473 return R; 474 } 475 476 DICompositeType *DIBuilder::createVectorType(uint64_t Size, 477 uint64_t AlignInBits, DIType *Ty, 478 DINodeArray Subscripts) { 479 auto *R = 480 DICompositeType::get(VMContext, dwarf::DW_TAG_array_type, "", nullptr, 0, 481 nullptr, DITypeRef::get(Ty), Size, AlignInBits, 0, 482 DINode::FlagVector, Subscripts, 0, nullptr); 483 trackIfUnresolved(R); 484 return R; 485 } 486 487 static DIType *createTypeWithFlags(LLVMContext &Context, DIType *Ty, 488 unsigned FlagsToSet) { 489 auto NewTy = Ty->clone(); 490 NewTy->setFlags(NewTy->getFlags() | FlagsToSet); 491 return MDNode::replaceWithUniqued(std::move(NewTy)); 492 } 493 494 DIType *DIBuilder::createArtificialType(DIType *Ty) { 495 // FIXME: Restrict this to the nodes where it's valid. 496 if (Ty->isArtificial()) 497 return Ty; 498 return createTypeWithFlags(VMContext, Ty, DINode::FlagArtificial); 499 } 500 501 DIType *DIBuilder::createObjectPointerType(DIType *Ty) { 502 // FIXME: Restrict this to the nodes where it's valid. 503 if (Ty->isObjectPointer()) 504 return Ty; 505 unsigned Flags = DINode::FlagObjectPointer | DINode::FlagArtificial; 506 return createTypeWithFlags(VMContext, Ty, Flags); 507 } 508 509 void DIBuilder::retainType(DIType *T) { 510 assert(T && "Expected non-null type"); 511 AllRetainTypes.emplace_back(T); 512 } 513 514 DIBasicType *DIBuilder::createUnspecifiedParameter() { return nullptr; } 515 516 DICompositeType * 517 DIBuilder::createForwardDecl(unsigned Tag, StringRef Name, DIScope *Scope, 518 DIFile *F, unsigned Line, unsigned RuntimeLang, 519 uint64_t SizeInBits, uint64_t AlignInBits, 520 StringRef UniqueIdentifier) { 521 // FIXME: Define in terms of createReplaceableForwardDecl() by calling 522 // replaceWithUniqued(). 523 auto *RetTy = DICompositeType::get( 524 VMContext, Tag, Name, F, Line, 525 DIScopeRef::get(getNonCompileUnitScope(Scope)), nullptr, SizeInBits, 526 AlignInBits, 0, DINode::FlagFwdDecl, nullptr, RuntimeLang, nullptr, 527 nullptr, UniqueIdentifier); 528 if (!UniqueIdentifier.empty()) 529 retainType(RetTy); 530 trackIfUnresolved(RetTy); 531 return RetTy; 532 } 533 534 DICompositeType *DIBuilder::createReplaceableCompositeType( 535 unsigned Tag, StringRef Name, DIScope *Scope, DIFile *F, unsigned Line, 536 unsigned RuntimeLang, uint64_t SizeInBits, uint64_t AlignInBits, 537 unsigned Flags, StringRef UniqueIdentifier) { 538 auto *RetTy = DICompositeType::getTemporary( 539 VMContext, Tag, Name, F, Line, 540 DIScopeRef::get(getNonCompileUnitScope(Scope)), nullptr, 541 SizeInBits, AlignInBits, 0, Flags, nullptr, RuntimeLang, 542 nullptr, nullptr, UniqueIdentifier) 543 .release(); 544 if (!UniqueIdentifier.empty()) 545 retainType(RetTy); 546 trackIfUnresolved(RetTy); 547 return RetTy; 548 } 549 550 DINodeArray DIBuilder::getOrCreateArray(ArrayRef<Metadata *> Elements) { 551 return MDTuple::get(VMContext, Elements); 552 } 553 554 DITypeRefArray DIBuilder::getOrCreateTypeArray(ArrayRef<Metadata *> Elements) { 555 SmallVector<llvm::Metadata *, 16> Elts; 556 for (unsigned i = 0, e = Elements.size(); i != e; ++i) { 557 if (Elements[i] && isa<MDNode>(Elements[i])) 558 Elts.push_back(DITypeRef::get(cast<DIType>(Elements[i]))); 559 else 560 Elts.push_back(Elements[i]); 561 } 562 return DITypeRefArray(MDNode::get(VMContext, Elts)); 563 } 564 565 DISubrange *DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) { 566 return DISubrange::get(VMContext, Count, Lo); 567 } 568 569 static void checkGlobalVariableScope(DIScope *Context) { 570 #ifndef NDEBUG 571 if (auto *CT = 572 dyn_cast_or_null<DICompositeType>(getNonCompileUnitScope(Context))) 573 assert(CT->getIdentifier().empty() && 574 "Context of a global variable should not be a type with identifier"); 575 #endif 576 } 577 578 DIGlobalVariable *DIBuilder::createGlobalVariable( 579 DIScope *Context, StringRef Name, StringRef LinkageName, DIFile *F, 580 unsigned LineNumber, DIType *Ty, bool isLocalToUnit, Constant *Val, 581 MDNode *Decl) { 582 checkGlobalVariableScope(Context); 583 584 auto *N = DIGlobalVariable::get(VMContext, cast_or_null<DIScope>(Context), 585 Name, LinkageName, F, LineNumber, 586 DITypeRef::get(Ty), isLocalToUnit, true, Val, 587 cast_or_null<DIDerivedType>(Decl)); 588 AllGVs.push_back(N); 589 return N; 590 } 591 592 DIGlobalVariable *DIBuilder::createTempGlobalVariableFwdDecl( 593 DIScope *Context, StringRef Name, StringRef LinkageName, DIFile *F, 594 unsigned LineNumber, DIType *Ty, bool isLocalToUnit, Constant *Val, 595 MDNode *Decl) { 596 checkGlobalVariableScope(Context); 597 598 return DIGlobalVariable::getTemporary( 599 VMContext, cast_or_null<DIScope>(Context), Name, LinkageName, F, 600 LineNumber, DITypeRef::get(Ty), isLocalToUnit, false, Val, 601 cast_or_null<DIDerivedType>(Decl)) 602 .release(); 603 } 604 605 DILocalVariable *DIBuilder::createLocalVariable( 606 unsigned Tag, DIScope *Scope, StringRef Name, DIFile *File, unsigned LineNo, 607 DIType *Ty, bool AlwaysPreserve, unsigned Flags, unsigned ArgNo) { 608 // FIXME: Why getNonCompileUnitScope()? 609 // FIXME: Why is "!Context" okay here? 610 // FIXME: Why doesn't this check for a subprogram or lexical block (AFAICT 611 // the only valid scopes)? 612 DIScope *Context = getNonCompileUnitScope(Scope); 613 614 auto *Node = DILocalVariable::get( 615 VMContext, Tag, cast_or_null<DILocalScope>(Context), Name, File, LineNo, 616 DITypeRef::get(Ty), ArgNo, Flags); 617 if (AlwaysPreserve) { 618 // The optimizer may remove local variables. If there is an interest 619 // to preserve variable info in such situation then stash it in a 620 // named mdnode. 621 DISubprogram *Fn = getDISubprogram(Scope); 622 assert(Fn && "Missing subprogram for local variable"); 623 PreservedVariables[Fn].emplace_back(Node); 624 } 625 return Node; 626 } 627 628 DIExpression *DIBuilder::createExpression(ArrayRef<uint64_t> Addr) { 629 return DIExpression::get(VMContext, Addr); 630 } 631 632 DIExpression *DIBuilder::createExpression(ArrayRef<int64_t> Signed) { 633 // TODO: Remove the callers of this signed version and delete. 634 SmallVector<uint64_t, 8> Addr(Signed.begin(), Signed.end()); 635 return createExpression(Addr); 636 } 637 638 DIExpression *DIBuilder::createBitPieceExpression(unsigned OffsetInBytes, 639 unsigned SizeInBytes) { 640 uint64_t Addr[] = {dwarf::DW_OP_bit_piece, OffsetInBytes, SizeInBytes}; 641 return DIExpression::get(VMContext, Addr); 642 } 643 644 DISubprogram *DIBuilder::createFunction(DIScopeRef Context, StringRef Name, 645 StringRef LinkageName, DIFile *File, 646 unsigned LineNo, DISubroutineType *Ty, 647 bool isLocalToUnit, bool isDefinition, 648 unsigned ScopeLine, unsigned Flags, 649 bool isOptimized, Function *Fn, 650 MDNode *TParams, MDNode *Decl) { 651 // dragonegg does not generate identifier for types, so using an empty map 652 // to resolve the context should be fine. 653 DITypeIdentifierMap EmptyMap; 654 return createFunction(Context.resolve(EmptyMap), Name, LinkageName, File, 655 LineNo, Ty, isLocalToUnit, isDefinition, ScopeLine, 656 Flags, isOptimized, Fn, TParams, Decl); 657 } 658 659 DISubprogram *DIBuilder::createFunction(DIScope *Context, StringRef Name, 660 StringRef LinkageName, DIFile *File, 661 unsigned LineNo, DISubroutineType *Ty, 662 bool isLocalToUnit, bool isDefinition, 663 unsigned ScopeLine, unsigned Flags, 664 bool isOptimized, Function *Fn, 665 MDNode *TParams, MDNode *Decl) { 666 assert(Ty->getTag() == dwarf::DW_TAG_subroutine_type && 667 "function types should be subroutines"); 668 auto *Node = DISubprogram::get( 669 VMContext, DIScopeRef::get(getNonCompileUnitScope(Context)), Name, 670 LinkageName, File, LineNo, Ty, isLocalToUnit, isDefinition, ScopeLine, 671 nullptr, 0, 0, Flags, isOptimized, Fn, cast_or_null<MDTuple>(TParams), 672 cast_or_null<DISubprogram>(Decl), 673 MDTuple::getTemporary(VMContext, None).release()); 674 675 if (isDefinition) 676 AllSubprograms.push_back(Node); 677 trackIfUnresolved(Node); 678 return Node; 679 } 680 681 DISubprogram *DIBuilder::createTempFunctionFwdDecl( 682 DIScope *Context, StringRef Name, StringRef LinkageName, DIFile *File, 683 unsigned LineNo, DISubroutineType *Ty, bool isLocalToUnit, 684 bool isDefinition, unsigned ScopeLine, unsigned Flags, bool isOptimized, 685 Function *Fn, MDNode *TParams, MDNode *Decl) { 686 return DISubprogram::getTemporary( 687 VMContext, DIScopeRef::get(getNonCompileUnitScope(Context)), Name, 688 LinkageName, File, LineNo, Ty, isLocalToUnit, isDefinition, 689 ScopeLine, nullptr, 0, 0, Flags, isOptimized, Fn, 690 cast_or_null<MDTuple>(TParams), cast_or_null<DISubprogram>(Decl), 691 nullptr) 692 .release(); 693 } 694 695 DISubprogram * 696 DIBuilder::createMethod(DIScope *Context, StringRef Name, StringRef LinkageName, 697 DIFile *F, unsigned LineNo, DISubroutineType *Ty, 698 bool isLocalToUnit, bool isDefinition, unsigned VK, 699 unsigned VIndex, DIType *VTableHolder, unsigned Flags, 700 bool isOptimized, Function *Fn, MDNode *TParam) { 701 assert(Ty->getTag() == dwarf::DW_TAG_subroutine_type && 702 "function types should be subroutines"); 703 assert(getNonCompileUnitScope(Context) && 704 "Methods should have both a Context and a context that isn't " 705 "the compile unit."); 706 // FIXME: Do we want to use different scope/lines? 707 auto *SP = DISubprogram::get( 708 VMContext, DIScopeRef::get(cast<DIScope>(Context)), Name, LinkageName, F, 709 LineNo, Ty, isLocalToUnit, isDefinition, LineNo, 710 DITypeRef::get(VTableHolder), VK, VIndex, Flags, isOptimized, Fn, 711 cast_or_null<MDTuple>(TParam), nullptr, nullptr); 712 713 if (isDefinition) 714 AllSubprograms.push_back(SP); 715 trackIfUnresolved(SP); 716 return SP; 717 } 718 719 DINamespace *DIBuilder::createNameSpace(DIScope *Scope, StringRef Name, 720 DIFile *File, unsigned LineNo) { 721 return DINamespace::get(VMContext, getNonCompileUnitScope(Scope), File, Name, 722 LineNo); 723 } 724 725 DIModule *DIBuilder::createModule(DIScope *Scope, StringRef Name, 726 StringRef ConfigurationMacros, 727 StringRef IncludePath, 728 StringRef ISysRoot) { 729 return DIModule::get(VMContext, getNonCompileUnitScope(Scope), Name, 730 ConfigurationMacros, IncludePath, ISysRoot); 731 } 732 733 DILexicalBlockFile *DIBuilder::createLexicalBlockFile(DIScope *Scope, 734 DIFile *File, 735 unsigned Discriminator) { 736 return DILexicalBlockFile::get(VMContext, Scope, File, Discriminator); 737 } 738 739 DILexicalBlock *DIBuilder::createLexicalBlock(DIScope *Scope, DIFile *File, 740 unsigned Line, unsigned Col) { 741 // Make these distinct, to avoid merging two lexical blocks on the same 742 // file/line/column. 743 return DILexicalBlock::getDistinct(VMContext, getNonCompileUnitScope(Scope), 744 File, Line, Col); 745 } 746 747 static Value *getDbgIntrinsicValueImpl(LLVMContext &VMContext, Value *V) { 748 assert(V && "no value passed to dbg intrinsic"); 749 return MetadataAsValue::get(VMContext, ValueAsMetadata::get(V)); 750 } 751 752 static Instruction *withDebugLoc(Instruction *I, const DILocation *DL) { 753 I->setDebugLoc(const_cast<DILocation *>(DL)); 754 return I; 755 } 756 757 Instruction *DIBuilder::insertDeclare(Value *Storage, DILocalVariable *VarInfo, 758 DIExpression *Expr, const DILocation *DL, 759 Instruction *InsertBefore) { 760 assert(VarInfo && "empty or invalid DILocalVariable* passed to dbg.declare"); 761 assert(DL && "Expected debug loc"); 762 assert(DL->getScope()->getSubprogram() == 763 VarInfo->getScope()->getSubprogram() && 764 "Expected matching subprograms"); 765 if (!DeclareFn) 766 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare); 767 768 trackIfUnresolved(VarInfo); 769 trackIfUnresolved(Expr); 770 Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, Storage), 771 MetadataAsValue::get(VMContext, VarInfo), 772 MetadataAsValue::get(VMContext, Expr)}; 773 return withDebugLoc(CallInst::Create(DeclareFn, Args, "", InsertBefore), DL); 774 } 775 776 Instruction *DIBuilder::insertDeclare(Value *Storage, DILocalVariable *VarInfo, 777 DIExpression *Expr, const DILocation *DL, 778 BasicBlock *InsertAtEnd) { 779 assert(VarInfo && "empty or invalid DILocalVariable* passed to dbg.declare"); 780 assert(DL && "Expected debug loc"); 781 assert(DL->getScope()->getSubprogram() == 782 VarInfo->getScope()->getSubprogram() && 783 "Expected matching subprograms"); 784 if (!DeclareFn) 785 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare); 786 787 trackIfUnresolved(VarInfo); 788 trackIfUnresolved(Expr); 789 Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, Storage), 790 MetadataAsValue::get(VMContext, VarInfo), 791 MetadataAsValue::get(VMContext, Expr)}; 792 793 // If this block already has a terminator then insert this intrinsic 794 // before the terminator. 795 if (TerminatorInst *T = InsertAtEnd->getTerminator()) 796 return withDebugLoc(CallInst::Create(DeclareFn, Args, "", T), DL); 797 return withDebugLoc(CallInst::Create(DeclareFn, Args, "", InsertAtEnd), DL); 798 } 799 800 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset, 801 DILocalVariable *VarInfo, 802 DIExpression *Expr, 803 const DILocation *DL, 804 Instruction *InsertBefore) { 805 assert(V && "no value passed to dbg.value"); 806 assert(VarInfo && "empty or invalid DILocalVariable* passed to dbg.value"); 807 assert(DL && "Expected debug loc"); 808 assert(DL->getScope()->getSubprogram() == 809 VarInfo->getScope()->getSubprogram() && 810 "Expected matching subprograms"); 811 if (!ValueFn) 812 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value); 813 814 trackIfUnresolved(VarInfo); 815 trackIfUnresolved(Expr); 816 Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, V), 817 ConstantInt::get(Type::getInt64Ty(VMContext), Offset), 818 MetadataAsValue::get(VMContext, VarInfo), 819 MetadataAsValue::get(VMContext, Expr)}; 820 return withDebugLoc(CallInst::Create(ValueFn, Args, "", InsertBefore), DL); 821 } 822 823 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset, 824 DILocalVariable *VarInfo, 825 DIExpression *Expr, 826 const DILocation *DL, 827 BasicBlock *InsertAtEnd) { 828 assert(V && "no value passed to dbg.value"); 829 assert(VarInfo && "empty or invalid DILocalVariable* passed to dbg.value"); 830 assert(DL && "Expected debug loc"); 831 assert(DL->getScope()->getSubprogram() == 832 VarInfo->getScope()->getSubprogram() && 833 "Expected matching subprograms"); 834 if (!ValueFn) 835 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value); 836 837 trackIfUnresolved(VarInfo); 838 trackIfUnresolved(Expr); 839 Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, V), 840 ConstantInt::get(Type::getInt64Ty(VMContext), Offset), 841 MetadataAsValue::get(VMContext, VarInfo), 842 MetadataAsValue::get(VMContext, Expr)}; 843 844 return withDebugLoc(CallInst::Create(ValueFn, Args, "", InsertAtEnd), DL); 845 } 846 847 void DIBuilder::replaceVTableHolder(DICompositeType *&T, 848 DICompositeType *VTableHolder) { 849 { 850 TypedTrackingMDRef<DICompositeType> N(T); 851 N->replaceVTableHolder(DITypeRef::get(VTableHolder)); 852 T = N.get(); 853 } 854 855 // If this didn't create a self-reference, just return. 856 if (T != VTableHolder) 857 return; 858 859 // Look for unresolved operands. T will drop RAUW support, orphaning any 860 // cycles underneath it. 861 if (T->isResolved()) 862 for (const MDOperand &O : T->operands()) 863 if (auto *N = dyn_cast_or_null<MDNode>(O)) 864 trackIfUnresolved(N); 865 } 866 867 void DIBuilder::replaceArrays(DICompositeType *&T, DINodeArray Elements, 868 DINodeArray TParams) { 869 { 870 TypedTrackingMDRef<DICompositeType> N(T); 871 if (Elements) 872 N->replaceElements(Elements); 873 if (TParams) 874 N->replaceTemplateParams(DITemplateParameterArray(TParams)); 875 T = N.get(); 876 } 877 878 // If T isn't resolved, there's no problem. 879 if (!T->isResolved()) 880 return; 881 882 // If T is resolved, it may be due to a self-reference cycle. Track the 883 // arrays explicitly if they're unresolved, or else the cycles will be 884 // orphaned. 885 if (Elements) 886 trackIfUnresolved(Elements.get()); 887 if (TParams) 888 trackIfUnresolved(TParams.get()); 889 } 890