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