1 //===--- DIBuilder.cpp - Debug Information Builder ------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the DIBuilder.
12 //===----------------------------------------------------------------------===//
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"
24 using namespace llvm::dwarf;
28 /// \brief Whether there are any fields yet.
30 /// Note that this is not equivalent to \c Chars.empty(), since \a concat()
31 /// may have been called already with an empty string.
33 SmallVector<char, 256> Chars;
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)) {}
41 template <class Twineable> HeaderBuilder &concat(Twineable &&X) {
46 Twine(X).toVector(Chars);
50 MDString *get(LLVMContext &Context) const {
51 return MDString::get(Context, StringRef(Chars.begin(), Chars.size()));
54 static HeaderBuilder get(unsigned Tag) {
55 return HeaderBuilder().concat("0x" + Twine::utohexstr(Tag));
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) {}
66 void DIBuilder::trackIfUnresolved(MDNode *N) {
72 assert(AllowUnresolvedNodes && "Cannot handle unresolved nodes");
73 UnresolvedNodes.emplace_back(N);
76 void DIBuilder::finalize() {
77 TempEnumTypes->replaceAllUsesWith(MDTuple::get(VMContext, AllEnumTypes));
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));
90 MDSubprogramArray 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 DebugNodeArray AV = getOrCreateArray(Variables);
97 TempMDTuple(Temp)->replaceAllUsesWith(AV.get());
101 TempGVs->replaceAllUsesWith(MDTuple::get(VMContext, AllGVs));
103 TempImportedModules->replaceAllUsesWith(MDTuple::get(
104 VMContext, SmallVector<Metadata *, 16>(AllImportedModules.begin(),
105 AllImportedModules.end())));
107 // Now that all temp nodes have been replaced or deleted, resolve remaining
109 for (const auto &N : UnresolvedNodes)
110 if (N && !N->isResolved())
112 UnresolvedNodes.clear();
114 // Can't handle unresolved nodes anymore.
115 AllowUnresolvedNodes = false;
118 /// If N is compile unit return NULL otherwise return N.
119 static MDScope *getNonCompileUnitScope(MDScope *N) {
120 if (!N || isa<MDCompileUnit>(N))
122 return cast<MDScope>(N);
125 MDCompileUnit *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) {
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");
136 // TODO: Once we make MDCompileUnit 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);
144 // TODO: Switch to getDistinct(). We never want to merge compile units based
146 MDCompileUnit *CUNode = MDCompileUnit::get(
147 VMContext, Lang, MDFile::get(VMContext, Filename, Directory), Producer,
148 isOptimized, Flags, RunTimeVer, SplitName, Kind, TempEnumTypes.get(),
149 TempRetainTypes.get(), TempSubprograms.get(), TempGVs.get(),
150 TempImportedModules.get());
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.
158 NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu");
159 NMD->addOperand(CUNode);
162 trackIfUnresolved(CUNode);
166 static MDImportedEntity*
167 createImportedModule(LLVMContext &C, dwarf::Tag Tag, MDScope* Context,
168 Metadata *NS, unsigned Line, StringRef Name,
169 SmallVectorImpl<TrackingMDNodeRef> &AllImportedModules) {
171 MDImportedEntity::get(C, Tag, Context, DebugNodeRef(NS), Line, Name);
172 AllImportedModules.emplace_back(M);
176 MDImportedEntity* DIBuilder::createImportedModule(MDScope* Context,
179 return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_module,
180 Context, NS, Line, StringRef(), AllImportedModules);
183 MDImportedEntity* DIBuilder::createImportedModule(MDScope* Context,
184 MDImportedEntity* NS,
186 return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_module,
187 Context, NS, Line, StringRef(), AllImportedModules);
190 MDImportedEntity *DIBuilder::createImportedDeclaration(MDScope *Context,
194 // Make sure to use the unique identifier based metadata reference for
195 // types that have one.
196 return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_declaration,
197 Context, DebugNodeRef::get(Decl), Line, Name,
201 MDFile* DIBuilder::createFile(StringRef Filename, StringRef Directory) {
202 return MDFile::get(VMContext, Filename, Directory);
205 MDEnumerator *DIBuilder::createEnumerator(StringRef Name, int64_t Val) {
206 assert(!Name.empty() && "Unable to create enumerator without name");
207 return MDEnumerator::get(VMContext, Val, Name);
210 MDBasicType *DIBuilder::createUnspecifiedType(StringRef Name) {
211 assert(!Name.empty() && "Unable to create type without name");
212 return MDBasicType::get(VMContext, dwarf::DW_TAG_unspecified_type, Name);
215 MDBasicType *DIBuilder::createNullPtrType() {
216 return createUnspecifiedType("decltype(nullptr)");
219 MDBasicType *DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
220 uint64_t AlignInBits,
222 assert(!Name.empty() && "Unable to create type without name");
223 return MDBasicType::get(VMContext, dwarf::DW_TAG_base_type, Name, SizeInBits,
224 AlignInBits, Encoding);
227 MDDerivedType *DIBuilder::createQualifiedType(unsigned Tag, MDType *FromTy) {
228 return MDDerivedType::get(VMContext, Tag, "", nullptr, 0, nullptr,
229 MDTypeRef::get(FromTy), 0, 0, 0, 0);
232 MDDerivedType *DIBuilder::createPointerType(MDType *PointeeTy,
234 uint64_t AlignInBits,
236 // FIXME: Why is there a name here?
237 return MDDerivedType::get(VMContext, dwarf::DW_TAG_pointer_type, Name,
238 nullptr, 0, nullptr, MDTypeRef::get(PointeeTy),
239 SizeInBits, AlignInBits, 0, 0);
242 MDDerivedType *DIBuilder::createMemberPointerType(MDType *PointeeTy,
245 uint64_t AlignInBits) {
246 return MDDerivedType::get(VMContext, dwarf::DW_TAG_ptr_to_member_type, "",
247 nullptr, 0, nullptr, MDTypeRef::get(PointeeTy),
248 SizeInBits, AlignInBits, 0, 0, MDTypeRef::get(Base));
251 MDDerivedType *DIBuilder::createReferenceType(unsigned Tag, MDType *RTy) {
252 assert(RTy && "Unable to create reference type");
253 return MDDerivedType::get(VMContext, Tag, "", nullptr, 0, nullptr,
254 MDTypeRef::get(RTy), 0, 0, 0, 0);
257 MDDerivedType *DIBuilder::createTypedef(MDType *Ty, StringRef Name,
258 MDFile *File, unsigned LineNo,
260 return MDDerivedType::get(VMContext, dwarf::DW_TAG_typedef, Name, File,
262 MDScopeRef::get(getNonCompileUnitScope(Context)),
263 MDTypeRef::get(Ty), 0, 0, 0, 0);
266 MDDerivedType *DIBuilder::createFriend(MDType *Ty, MDType *FriendTy) {
267 assert(Ty && "Invalid type!");
268 assert(FriendTy && "Invalid friend type!");
269 return MDDerivedType::get(VMContext, dwarf::DW_TAG_friend, "", nullptr, 0,
270 MDTypeRef::get(Ty), MDTypeRef::get(FriendTy), 0, 0,
274 MDDerivedType *DIBuilder::createInheritance(MDType *Ty, MDType *BaseTy,
277 assert(Ty && "Unable to create inheritance");
278 return MDDerivedType::get(VMContext, dwarf::DW_TAG_inheritance, "", nullptr,
279 0, MDTypeRef::get(Ty), MDTypeRef::get(BaseTy), 0, 0,
283 MDDerivedType *DIBuilder::createMemberType(MDScope *Scope, StringRef Name,
284 MDFile *File, unsigned LineNumber,
286 uint64_t AlignInBits,
287 uint64_t OffsetInBits,
288 unsigned Flags, MDType *Ty) {
289 return MDDerivedType::get(
290 VMContext, dwarf::DW_TAG_member, Name, File, LineNumber,
291 MDScopeRef::get(getNonCompileUnitScope(Scope)), MDTypeRef::get(Ty),
292 SizeInBits, AlignInBits, OffsetInBits, Flags);
295 static ConstantAsMetadata *getConstantOrNull(Constant *C) {
297 return ConstantAsMetadata::get(C);
301 MDDerivedType *DIBuilder::createStaticMemberType(MDScope *Scope, StringRef Name,
304 MDType *Ty, unsigned Flags,
305 llvm::Constant *Val) {
306 Flags |= DebugNode::FlagStaticMember;
307 return MDDerivedType::get(
308 VMContext, dwarf::DW_TAG_member, Name, File, LineNumber,
309 MDScopeRef::get(getNonCompileUnitScope(Scope)), MDTypeRef::get(Ty), 0, 0,
310 0, Flags, getConstantOrNull(Val));
313 MDDerivedType *DIBuilder::createObjCIVar(StringRef Name, MDFile *File,
316 uint64_t AlignInBits,
317 uint64_t OffsetInBits, unsigned Flags,
318 MDType *Ty, MDNode *PropertyNode) {
319 return MDDerivedType::get(
320 VMContext, dwarf::DW_TAG_member, Name, File, LineNumber,
321 MDScopeRef::get(getNonCompileUnitScope(File)), MDTypeRef::get(Ty),
322 SizeInBits, AlignInBits, OffsetInBits, Flags, PropertyNode);
326 DIBuilder::createObjCProperty(StringRef Name, MDFile *File, unsigned LineNumber,
327 StringRef GetterName, StringRef SetterName,
328 unsigned PropertyAttributes, MDType *Ty) {
329 return MDObjCProperty::get(VMContext, Name, File, LineNumber, GetterName,
330 SetterName, PropertyAttributes, Ty);
333 MDTemplateTypeParameter *
334 DIBuilder::createTemplateTypeParameter(MDScope *Context, StringRef Name,
336 assert((!Context || isa<MDCompileUnit>(Context)) && "Expected compile unit");
337 return MDTemplateTypeParameter::get(VMContext, Name, MDTypeRef::get(Ty));
340 static MDTemplateValueParameter *
341 createTemplateValueParameterHelper(LLVMContext &VMContext, unsigned Tag,
342 MDScope *Context, StringRef Name, MDType *Ty,
344 assert((!Context || isa<MDCompileUnit>(Context)) && "Expected compile unit");
345 return MDTemplateValueParameter::get(VMContext, Tag, Name, MDTypeRef::get(Ty),
349 MDTemplateValueParameter *
350 DIBuilder::createTemplateValueParameter(MDScope *Context, StringRef Name,
351 MDType *Ty, Constant *Val) {
352 return createTemplateValueParameterHelper(
353 VMContext, dwarf::DW_TAG_template_value_parameter, Context, Name, Ty,
354 getConstantOrNull(Val));
357 MDTemplateValueParameter *
358 DIBuilder::createTemplateTemplateParameter(MDScope *Context, StringRef Name,
359 MDType *Ty, StringRef Val) {
360 return createTemplateValueParameterHelper(
361 VMContext, dwarf::DW_TAG_GNU_template_template_param, Context, Name, Ty,
362 MDString::get(VMContext, Val));
365 MDTemplateValueParameter *
366 DIBuilder::createTemplateParameterPack(MDScope *Context, StringRef Name,
367 MDType *Ty, DebugNodeArray Val) {
368 return createTemplateValueParameterHelper(
369 VMContext, dwarf::DW_TAG_GNU_template_parameter_pack, Context, Name, Ty,
373 MDCompositeType *DIBuilder::createClassType(
374 MDScope *Context, StringRef Name, MDFile *File, unsigned LineNumber,
375 uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
376 unsigned Flags, MDType *DerivedFrom, DebugNodeArray Elements,
377 MDType *VTableHolder, MDNode *TemplateParams, StringRef UniqueIdentifier) {
378 assert((!Context || isa<MDScope>(Context)) &&
379 "createClassType should be called with a valid Context");
381 auto *R = MDCompositeType::get(
382 VMContext, dwarf::DW_TAG_structure_type, Name, File, LineNumber,
383 MDScopeRef::get(getNonCompileUnitScope(Context)),
384 MDTypeRef::get(DerivedFrom), SizeInBits, AlignInBits, OffsetInBits, Flags,
385 Elements, 0, MDTypeRef::get(VTableHolder),
386 cast_or_null<MDTuple>(TemplateParams), UniqueIdentifier);
387 if (!UniqueIdentifier.empty())
389 trackIfUnresolved(R);
393 MDCompositeType *DIBuilder::createStructType(
394 MDScope *Context, StringRef Name, MDFile *File, unsigned LineNumber,
395 uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags,
396 MDType *DerivedFrom, DebugNodeArray Elements, unsigned RunTimeLang,
397 MDType *VTableHolder, StringRef UniqueIdentifier) {
398 auto *R = MDCompositeType::get(
399 VMContext, dwarf::DW_TAG_structure_type, Name, File, LineNumber,
400 MDScopeRef::get(getNonCompileUnitScope(Context)),
401 MDTypeRef::get(DerivedFrom), SizeInBits, AlignInBits, 0, Flags, Elements,
402 RunTimeLang, MDTypeRef::get(VTableHolder), nullptr, UniqueIdentifier);
403 if (!UniqueIdentifier.empty())
405 trackIfUnresolved(R);
409 MDCompositeType *DIBuilder::createUnionType(
410 MDScope *Scope, StringRef Name, MDFile *File, unsigned LineNumber,
411 uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags,
412 DebugNodeArray Elements, unsigned RunTimeLang, StringRef UniqueIdentifier) {
413 auto *R = MDCompositeType::get(
414 VMContext, dwarf::DW_TAG_union_type, Name, File, LineNumber,
415 MDScopeRef::get(getNonCompileUnitScope(Scope)), nullptr, SizeInBits,
416 AlignInBits, 0, Flags, Elements, RunTimeLang, nullptr, nullptr,
418 if (!UniqueIdentifier.empty())
420 trackIfUnresolved(R);
424 MDSubroutineType *DIBuilder::createSubroutineType(MDFile *File,
425 MDTypeRefArray ParameterTypes,
427 return MDSubroutineType::get(VMContext, Flags, ParameterTypes);
430 MDCompositeType *DIBuilder::createEnumerationType(
431 MDScope *Scope, StringRef Name, MDFile *File, unsigned LineNumber,
432 uint64_t SizeInBits, uint64_t AlignInBits, DebugNodeArray Elements,
433 MDType *UnderlyingType, StringRef UniqueIdentifier) {
434 auto *CTy = MDCompositeType::get(
435 VMContext, dwarf::DW_TAG_enumeration_type, Name, File, LineNumber,
436 MDScopeRef::get(getNonCompileUnitScope(Scope)),
437 MDTypeRef::get(UnderlyingType), SizeInBits, AlignInBits, 0, 0, Elements,
438 0, nullptr, nullptr, UniqueIdentifier);
439 AllEnumTypes.push_back(CTy);
440 if (!UniqueIdentifier.empty())
442 trackIfUnresolved(CTy);
446 MDCompositeType *DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
448 DebugNodeArray Subscripts) {
449 auto *R = MDCompositeType::get(VMContext, dwarf::DW_TAG_array_type, "",
450 nullptr, 0, nullptr, MDTypeRef::get(Ty), Size,
451 AlignInBits, 0, 0, Subscripts, 0, nullptr);
452 trackIfUnresolved(R);
456 MDCompositeType *DIBuilder::createVectorType(uint64_t Size,
457 uint64_t AlignInBits, MDType *Ty,
458 DebugNodeArray Subscripts) {
460 MDCompositeType::get(VMContext, dwarf::DW_TAG_array_type, "", nullptr, 0,
461 nullptr, MDTypeRef::get(Ty), Size, AlignInBits, 0,
462 DebugNode::FlagVector, Subscripts, 0, nullptr);
463 trackIfUnresolved(R);
467 static MDType *createTypeWithFlags(LLVMContext &Context, MDType *Ty,
468 unsigned FlagsToSet) {
469 auto NewTy = Ty->clone();
470 NewTy->setFlags(NewTy->getFlags() | FlagsToSet);
471 return MDNode::replaceWithUniqued(std::move(NewTy));
474 MDType *DIBuilder::createArtificialType(MDType *Ty) {
475 // FIXME: Restrict this to the nodes where it's valid.
476 if (Ty->isArtificial())
478 return createTypeWithFlags(VMContext, Ty, DebugNode::FlagArtificial);
481 MDType *DIBuilder::createObjectPointerType(MDType *Ty) {
482 // FIXME: Restrict this to the nodes where it's valid.
483 if (Ty->isObjectPointer())
485 unsigned Flags = DebugNode::FlagObjectPointer | DebugNode::FlagArtificial;
486 return createTypeWithFlags(VMContext, Ty, Flags);
489 void DIBuilder::retainType(MDType *T) {
490 assert(T && "Expected non-null type");
491 AllRetainTypes.emplace_back(T);
494 MDBasicType *DIBuilder::createUnspecifiedParameter() { return nullptr; }
497 DIBuilder::createForwardDecl(unsigned Tag, StringRef Name, MDScope * Scope,
498 MDFile* 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 = MDCompositeType::get(
504 VMContext, Tag, Name, F, Line,
505 MDScopeRef::get(getNonCompileUnitScope(Scope)), nullptr, SizeInBits,
506 AlignInBits, 0, DebugNode::FlagFwdDecl, nullptr, RuntimeLang, nullptr,
507 nullptr, UniqueIdentifier);
508 if (!UniqueIdentifier.empty())
510 trackIfUnresolved(RetTy);
514 MDCompositeType* DIBuilder::createReplaceableCompositeType(
515 unsigned Tag, StringRef Name, MDScope * Scope, MDFile* F, unsigned Line,
516 unsigned RuntimeLang, uint64_t SizeInBits, uint64_t AlignInBits,
517 unsigned Flags, StringRef UniqueIdentifier) {
518 auto *RetTy = MDCompositeType::getTemporary(
519 VMContext, Tag, Name, F, Line,
520 MDScopeRef::get(getNonCompileUnitScope(Scope)), nullptr,
521 SizeInBits, AlignInBits, 0, Flags, nullptr, RuntimeLang,
522 nullptr, nullptr, UniqueIdentifier).release();
523 if (!UniqueIdentifier.empty())
525 trackIfUnresolved(RetTy);
529 DebugNodeArray DIBuilder::getOrCreateArray(ArrayRef<Metadata *> Elements) {
530 return MDTuple::get(VMContext, Elements);
533 MDTypeRefArray DIBuilder::getOrCreateTypeArray(ArrayRef<Metadata *> Elements) {
534 SmallVector<llvm::Metadata *, 16> Elts;
535 for (unsigned i = 0, e = Elements.size(); i != e; ++i) {
536 if (Elements[i] && isa<MDNode>(Elements[i]))
537 Elts.push_back(MDTypeRef::get(cast<MDType>(Elements[i])));
539 Elts.push_back(Elements[i]);
541 return MDTypeRefArray(MDNode::get(VMContext, Elts));
544 MDSubrange *DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
545 return MDSubrange::get(VMContext, Count, Lo);
548 static void checkGlobalVariableScope(MDScope * Context) {
551 dyn_cast_or_null<MDCompositeType>(getNonCompileUnitScope(Context)))
552 assert(CT->getIdentifier().empty() &&
553 "Context of a global variable should not be a type with identifier");
557 MDGlobalVariable *DIBuilder::createGlobalVariable(
558 MDScope *Context, StringRef Name, StringRef LinkageName, MDFile *F,
559 unsigned LineNumber, MDType *Ty, bool isLocalToUnit, Constant *Val,
561 checkGlobalVariableScope(Context);
563 auto *N = MDGlobalVariable::get(VMContext, cast_or_null<MDScope>(Context),
564 Name, LinkageName, F, LineNumber,
565 MDTypeRef::get(Ty), isLocalToUnit, true, Val,
566 cast_or_null<MDDerivedType>(Decl));
571 MDGlobalVariable *DIBuilder::createTempGlobalVariableFwdDecl(
572 MDScope *Context, StringRef Name, StringRef LinkageName, MDFile *F,
573 unsigned LineNumber, MDType *Ty, bool isLocalToUnit, Constant *Val,
575 checkGlobalVariableScope(Context);
577 return MDGlobalVariable::getTemporary(
578 VMContext, cast_or_null<MDScope>(Context), Name, LinkageName, F,
579 LineNumber, MDTypeRef::get(Ty), isLocalToUnit, false, Val,
580 cast_or_null<MDDerivedType>(Decl))
584 MDLocalVariable *DIBuilder::createLocalVariable(
585 unsigned Tag, MDScope *Scope, StringRef Name, MDFile *File, unsigned LineNo,
586 MDType *Ty, bool AlwaysPreserve, unsigned Flags, unsigned ArgNo) {
587 // FIXME: Why getNonCompileUnitScope()?
588 // FIXME: Why is "!Context" okay here?
589 // FIXME: WHy doesn't this check for a subprogram or lexical block (AFAICT
590 // the only valid scopes)?
591 MDScope* Context = getNonCompileUnitScope(Scope);
593 auto *Node = MDLocalVariable::get(
594 VMContext, Tag, cast_or_null<MDLocalScope>(Context), Name, File, LineNo,
595 MDTypeRef::get(Ty), ArgNo, Flags);
596 if (AlwaysPreserve) {
597 // The optimizer may remove local variable. If there is an interest
598 // to preserve variable info in such situation then stash it in a
600 MDSubprogram *Fn = getDISubprogram(Scope);
601 assert(Fn && "Missing subprogram for local variable");
602 PreservedVariables[Fn].emplace_back(Node);
607 MDExpression* DIBuilder::createExpression(ArrayRef<uint64_t> Addr) {
608 return MDExpression::get(VMContext, Addr);
611 MDExpression* DIBuilder::createExpression(ArrayRef<int64_t> Signed) {
612 // TODO: Remove the callers of this signed version and delete.
613 SmallVector<uint64_t, 8> Addr(Signed.begin(), Signed.end());
614 return createExpression(Addr);
617 MDExpression* DIBuilder::createBitPieceExpression(unsigned OffsetInBytes,
618 unsigned SizeInBytes) {
619 uint64_t Addr[] = {dwarf::DW_OP_bit_piece, OffsetInBytes, SizeInBytes};
620 return MDExpression::get(VMContext, Addr);
623 MDSubprogram *DIBuilder::createFunction(MDScopeRef Context, StringRef Name,
624 StringRef LinkageName, MDFile *File,
625 unsigned LineNo, MDSubroutineType *Ty,
626 bool isLocalToUnit, bool isDefinition,
627 unsigned ScopeLine, unsigned Flags,
628 bool isOptimized, Function *Fn,
629 MDNode *TParams, MDNode *Decl) {
630 // dragonegg does not generate identifier for types, so using an empty map
631 // to resolve the context should be fine.
632 DITypeIdentifierMap EmptyMap;
633 return createFunction(Context.resolve(EmptyMap), Name, LinkageName, File,
634 LineNo, Ty, isLocalToUnit, isDefinition, ScopeLine,
635 Flags, isOptimized, Fn, TParams, Decl);
638 MDSubprogram* DIBuilder::createFunction(MDScope * Context, StringRef Name,
639 StringRef LinkageName, MDFile* File,
640 unsigned LineNo, MDSubroutineType* Ty,
641 bool isLocalToUnit, bool isDefinition,
642 unsigned ScopeLine, unsigned Flags,
643 bool isOptimized, Function *Fn,
644 MDNode *TParams, MDNode *Decl) {
645 assert(Ty->getTag() == dwarf::DW_TAG_subroutine_type &&
646 "function types should be subroutines");
647 auto *Node = MDSubprogram::get(
648 VMContext, MDScopeRef::get(getNonCompileUnitScope(Context)), Name,
649 LinkageName, File, LineNo, Ty,
650 isLocalToUnit, isDefinition, ScopeLine, nullptr, 0, 0, Flags, isOptimized,
651 Fn, cast_or_null<MDTuple>(TParams), cast_or_null<MDSubprogram>(Decl),
652 MDTuple::getTemporary(VMContext, None).release());
655 AllSubprograms.push_back(Node);
656 trackIfUnresolved(Node);
661 DIBuilder::createTempFunctionFwdDecl(MDScope * Context, StringRef Name,
662 StringRef LinkageName, MDFile* File,
663 unsigned LineNo, MDSubroutineType* Ty,
664 bool isLocalToUnit, bool isDefinition,
665 unsigned ScopeLine, unsigned Flags,
666 bool isOptimized, Function *Fn,
667 MDNode *TParams, MDNode *Decl) {
668 return MDSubprogram::getTemporary(
669 VMContext, MDScopeRef::get(getNonCompileUnitScope(Context)), Name,
670 LinkageName, File, LineNo, Ty,
671 isLocalToUnit, isDefinition, ScopeLine, nullptr, 0, 0, Flags,
672 isOptimized, Fn, cast_or_null<MDTuple>(TParams),
673 cast_or_null<MDSubprogram>(Decl), nullptr).release();
677 DIBuilder::createMethod(MDScope *Context, StringRef Name, StringRef LinkageName,
678 MDFile *F, unsigned LineNo, MDSubroutineType *Ty,
679 bool isLocalToUnit, bool isDefinition, unsigned VK,
680 unsigned VIndex, MDType *VTableHolder, unsigned Flags,
681 bool isOptimized, Function *Fn, MDNode *TParam) {
682 assert(Ty->getTag() == dwarf::DW_TAG_subroutine_type &&
683 "function types should be subroutines");
684 assert(getNonCompileUnitScope(Context) &&
685 "Methods should have both a Context and a context that isn't "
686 "the compile unit.");
687 // FIXME: Do we want to use different scope/lines?
688 auto *SP = MDSubprogram::get(
689 VMContext, MDScopeRef::get(cast<MDScope>(Context)), Name, LinkageName, F,
690 LineNo, Ty, isLocalToUnit, isDefinition, LineNo,
691 MDTypeRef::get(VTableHolder), VK, VIndex, Flags, isOptimized, Fn,
692 cast_or_null<MDTuple>(TParam), nullptr, nullptr);
695 AllSubprograms.push_back(SP);
696 trackIfUnresolved(SP);
700 MDNamespace* DIBuilder::createNameSpace(MDScope * Scope, StringRef Name,
701 MDFile* File, unsigned LineNo) {
702 return MDNamespace::get(VMContext, getNonCompileUnitScope(Scope), File, Name,
706 MDLexicalBlockFile* DIBuilder::createLexicalBlockFile(MDScope * Scope,
708 unsigned Discriminator) {
709 return MDLexicalBlockFile::get(VMContext, Scope, File, Discriminator);
712 MDLexicalBlock* DIBuilder::createLexicalBlock(MDScope * Scope, MDFile* File,
713 unsigned Line, unsigned Col) {
714 // Make these distinct, to avoid merging two lexical blocks on the same
716 return MDLexicalBlock::getDistinct(VMContext, getNonCompileUnitScope(Scope),
720 static Value *getDbgIntrinsicValueImpl(LLVMContext &VMContext, Value *V) {
721 assert(V && "no value passed to dbg intrinsic");
722 return MetadataAsValue::get(VMContext, ValueAsMetadata::get(V));
725 static Instruction *withDebugLoc(Instruction *I, const MDLocation *DL) {
726 I->setDebugLoc(const_cast<MDLocation *>(DL));
730 Instruction *DIBuilder::insertDeclare(Value *Storage, MDLocalVariable* VarInfo,
731 MDExpression* Expr, const MDLocation *DL,
732 Instruction *InsertBefore) {
733 assert(VarInfo && "empty or invalid MDLocalVariable* passed to dbg.declare");
734 assert(DL && "Expected debug loc");
735 assert(DL->getScope()->getSubprogram() ==
736 VarInfo->getScope()->getSubprogram() &&
737 "Expected matching subprograms");
739 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
741 trackIfUnresolved(VarInfo);
742 trackIfUnresolved(Expr);
743 Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, Storage),
744 MetadataAsValue::get(VMContext, VarInfo),
745 MetadataAsValue::get(VMContext, Expr)};
746 return withDebugLoc(CallInst::Create(DeclareFn, Args, "", InsertBefore), DL);
749 Instruction *DIBuilder::insertDeclare(Value *Storage, MDLocalVariable* VarInfo,
750 MDExpression* Expr, const MDLocation *DL,
751 BasicBlock *InsertAtEnd) {
752 assert(VarInfo && "empty or invalid MDLocalVariable* passed to dbg.declare");
753 assert(DL && "Expected debug loc");
754 assert(DL->getScope()->getSubprogram() ==
755 VarInfo->getScope()->getSubprogram() &&
756 "Expected matching subprograms");
758 DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
760 trackIfUnresolved(VarInfo);
761 trackIfUnresolved(Expr);
762 Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, Storage),
763 MetadataAsValue::get(VMContext, VarInfo),
764 MetadataAsValue::get(VMContext, Expr)};
766 // If this block already has a terminator then insert this intrinsic
767 // before the terminator.
768 if (TerminatorInst *T = InsertAtEnd->getTerminator())
769 return withDebugLoc(CallInst::Create(DeclareFn, Args, "", T), DL);
770 return withDebugLoc(CallInst::Create(DeclareFn, Args, "", InsertAtEnd), DL);
773 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
774 MDLocalVariable* VarInfo,
776 const MDLocation *DL,
777 Instruction *InsertBefore) {
778 assert(V && "no value passed to dbg.value");
779 assert(VarInfo && "empty or invalid MDLocalVariable* passed to dbg.value");
780 assert(DL && "Expected debug loc");
781 assert(DL->getScope()->getSubprogram() ==
782 VarInfo->getScope()->getSubprogram() &&
783 "Expected matching subprograms");
785 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
787 trackIfUnresolved(VarInfo);
788 trackIfUnresolved(Expr);
789 Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, V),
790 ConstantInt::get(Type::getInt64Ty(VMContext), Offset),
791 MetadataAsValue::get(VMContext, VarInfo),
792 MetadataAsValue::get(VMContext, Expr)};
793 return withDebugLoc(CallInst::Create(ValueFn, Args, "", InsertBefore), DL);
796 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
797 MDLocalVariable* VarInfo,
799 const MDLocation *DL,
800 BasicBlock *InsertAtEnd) {
801 assert(V && "no value passed to dbg.value");
802 assert(VarInfo && "empty or invalid MDLocalVariable* passed to dbg.value");
803 assert(DL && "Expected debug loc");
804 assert(DL->getScope()->getSubprogram() ==
805 VarInfo->getScope()->getSubprogram() &&
806 "Expected matching subprograms");
808 ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
810 trackIfUnresolved(VarInfo);
811 trackIfUnresolved(Expr);
812 Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, V),
813 ConstantInt::get(Type::getInt64Ty(VMContext), Offset),
814 MetadataAsValue::get(VMContext, VarInfo),
815 MetadataAsValue::get(VMContext, Expr)};
817 return withDebugLoc(CallInst::Create(ValueFn, Args, "", InsertAtEnd), DL);
820 void DIBuilder::replaceVTableHolder(MDCompositeType* &T, MDCompositeType* VTableHolder) {
822 TypedTrackingMDRef<MDCompositeType> N(T);
823 N->replaceVTableHolder(MDTypeRef::get(VTableHolder));
827 // If this didn't create a self-reference, just return.
828 if (T != VTableHolder)
831 // Look for unresolved operands. T will drop RAUW support, orphaning any
832 // cycles underneath it.
834 for (const MDOperand &O : T->operands())
835 if (auto *N = dyn_cast_or_null<MDNode>(O))
836 trackIfUnresolved(N);
839 void DIBuilder::replaceArrays(MDCompositeType *&T, DebugNodeArray Elements,
840 DebugNodeArray TParams) {
842 TypedTrackingMDRef<MDCompositeType> N(T);
844 N->replaceElements(Elements);
846 N->replaceTemplateParams(MDTemplateParameterArray(TParams));
850 // If T isn't resolved, there's no problem.
851 if (!T->isResolved())
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
858 trackIfUnresolved(Elements.get());
860 trackIfUnresolved(TParams.get());