xref: /freebsd/contrib/llvm-project/llvm/lib/IR/DebugInfo.cpp (revision cfd6422a5217410fbd66f7a7a8a64d9d85e61229) 
1 //===- DebugInfo.cpp - Debug Information Helper Classes -------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the helper classes used to build and interpret debug
10 // information in LLVM IR form.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm-c/DebugInfo.h"
15 #include "llvm/ADT/DenseMap.h"
16 #include "llvm/ADT/DenseSet.h"
17 #include "llvm/ADT/None.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SmallPtrSet.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringRef.h"
22 #include "llvm/IR/BasicBlock.h"
23 #include "llvm/IR/Constants.h"
24 #include "llvm/IR/DebugInfoMetadata.h"
25 #include "llvm/IR/DebugLoc.h"
26 #include "llvm/IR/DebugInfo.h"
27 #include "llvm/IR/DIBuilder.h"
28 #include "llvm/IR/Function.h"
29 #include "llvm/IR/GVMaterializer.h"
30 #include "llvm/IR/Instruction.h"
31 #include "llvm/IR/IntrinsicInst.h"
32 #include "llvm/IR/LLVMContext.h"
33 #include "llvm/IR/Metadata.h"
34 #include "llvm/IR/Module.h"
35 #include "llvm/Support/Casting.h"
36 #include <algorithm>
37 #include <cassert>
38 #include <utility>
39 
40 using namespace llvm;
41 using namespace llvm::dwarf;
42 
43 DISubprogram *llvm::getDISubprogram(const MDNode *Scope) {
44   if (auto *LocalScope = dyn_cast_or_null<DILocalScope>(Scope))
45     return LocalScope->getSubprogram();
46   return nullptr;
47 }
48 
49 //===----------------------------------------------------------------------===//
50 // DebugInfoFinder implementations.
51 //===----------------------------------------------------------------------===//
52 
53 void DebugInfoFinder::reset() {
54   CUs.clear();
55   SPs.clear();
56   GVs.clear();
57   TYs.clear();
58   Scopes.clear();
59   NodesSeen.clear();
60 }
61 
62 void DebugInfoFinder::processModule(const Module &M) {
63   for (auto *CU : M.debug_compile_units())
64     processCompileUnit(CU);
65   for (auto &F : M.functions()) {
66     if (auto *SP = cast_or_null<DISubprogram>(F.getSubprogram()))
67       processSubprogram(SP);
68     // There could be subprograms from inlined functions referenced from
69     // instructions only. Walk the function to find them.
70     for (const BasicBlock &BB : F)
71       for (const Instruction &I : BB)
72         processInstruction(M, I);
73   }
74 }
75 
76 void DebugInfoFinder::processCompileUnit(DICompileUnit *CU) {
77   if (!addCompileUnit(CU))
78     return;
79   for (auto DIG : CU->getGlobalVariables()) {
80     if (!addGlobalVariable(DIG))
81       continue;
82     auto *GV = DIG->getVariable();
83     processScope(GV->getScope());
84     processType(GV->getType());
85   }
86   for (auto *ET : CU->getEnumTypes())
87     processType(ET);
88   for (auto *RT : CU->getRetainedTypes())
89     if (auto *T = dyn_cast<DIType>(RT))
90       processType(T);
91     else
92       processSubprogram(cast<DISubprogram>(RT));
93   for (auto *Import : CU->getImportedEntities()) {
94     auto *Entity = Import->getEntity();
95     if (auto *T = dyn_cast<DIType>(Entity))
96       processType(T);
97     else if (auto *SP = dyn_cast<DISubprogram>(Entity))
98       processSubprogram(SP);
99     else if (auto *NS = dyn_cast<DINamespace>(Entity))
100       processScope(NS->getScope());
101     else if (auto *M = dyn_cast<DIModule>(Entity))
102       processScope(M->getScope());
103   }
104 }
105 
106 void DebugInfoFinder::processInstruction(const Module &M,
107                                          const Instruction &I) {
108   if (auto *DVI = dyn_cast<DbgVariableIntrinsic>(&I))
109     processVariable(M, *DVI);
110 
111   if (auto DbgLoc = I.getDebugLoc())
112     processLocation(M, DbgLoc.get());
113 }
114 
115 void DebugInfoFinder::processLocation(const Module &M, const DILocation *Loc) {
116   if (!Loc)
117     return;
118   processScope(Loc->getScope());
119   processLocation(M, Loc->getInlinedAt());
120 }
121 
122 void DebugInfoFinder::processType(DIType *DT) {
123   if (!addType(DT))
124     return;
125   processScope(DT->getScope());
126   if (auto *ST = dyn_cast<DISubroutineType>(DT)) {
127     for (DIType *Ref : ST->getTypeArray())
128       processType(Ref);
129     return;
130   }
131   if (auto *DCT = dyn_cast<DICompositeType>(DT)) {
132     processType(DCT->getBaseType());
133     for (Metadata *D : DCT->getElements()) {
134       if (auto *T = dyn_cast<DIType>(D))
135         processType(T);
136       else if (auto *SP = dyn_cast<DISubprogram>(D))
137         processSubprogram(SP);
138     }
139     return;
140   }
141   if (auto *DDT = dyn_cast<DIDerivedType>(DT)) {
142     processType(DDT->getBaseType());
143   }
144 }
145 
146 void DebugInfoFinder::processScope(DIScope *Scope) {
147   if (!Scope)
148     return;
149   if (auto *Ty = dyn_cast<DIType>(Scope)) {
150     processType(Ty);
151     return;
152   }
153   if (auto *CU = dyn_cast<DICompileUnit>(Scope)) {
154     addCompileUnit(CU);
155     return;
156   }
157   if (auto *SP = dyn_cast<DISubprogram>(Scope)) {
158     processSubprogram(SP);
159     return;
160   }
161   if (!addScope(Scope))
162     return;
163   if (auto *LB = dyn_cast<DILexicalBlockBase>(Scope)) {
164     processScope(LB->getScope());
165   } else if (auto *NS = dyn_cast<DINamespace>(Scope)) {
166     processScope(NS->getScope());
167   } else if (auto *M = dyn_cast<DIModule>(Scope)) {
168     processScope(M->getScope());
169   }
170 }
171 
172 void DebugInfoFinder::processSubprogram(DISubprogram *SP) {
173   if (!addSubprogram(SP))
174     return;
175   processScope(SP->getScope());
176   // Some of the users, e.g. CloneFunctionInto / CloneModule, need to set up a
177   // ValueMap containing identity mappings for all of the DICompileUnit's, not
178   // just DISubprogram's, referenced from anywhere within the Function being
179   // cloned prior to calling MapMetadata / RemapInstruction to avoid their
180   // duplication later as DICompileUnit's are also directly referenced by
181   // llvm.dbg.cu list. Thefore we need to collect DICompileUnit's here as well.
182   // Also, DICompileUnit's may reference DISubprogram's too and therefore need
183   // to be at least looked through.
184   processCompileUnit(SP->getUnit());
185   processType(SP->getType());
186   for (auto *Element : SP->getTemplateParams()) {
187     if (auto *TType = dyn_cast<DITemplateTypeParameter>(Element)) {
188       processType(TType->getType());
189     } else if (auto *TVal = dyn_cast<DITemplateValueParameter>(Element)) {
190       processType(TVal->getType());
191     }
192   }
193 }
194 
195 void DebugInfoFinder::processVariable(const Module &M,
196                                       const DbgVariableIntrinsic &DVI) {
197   auto *N = dyn_cast<MDNode>(DVI.getVariable());
198   if (!N)
199     return;
200 
201   auto *DV = dyn_cast<DILocalVariable>(N);
202   if (!DV)
203     return;
204 
205   if (!NodesSeen.insert(DV).second)
206     return;
207   processScope(DV->getScope());
208   processType(DV->getType());
209 }
210 
211 bool DebugInfoFinder::addType(DIType *DT) {
212   if (!DT)
213     return false;
214 
215   if (!NodesSeen.insert(DT).second)
216     return false;
217 
218   TYs.push_back(const_cast<DIType *>(DT));
219   return true;
220 }
221 
222 bool DebugInfoFinder::addCompileUnit(DICompileUnit *CU) {
223   if (!CU)
224     return false;
225   if (!NodesSeen.insert(CU).second)
226     return false;
227 
228   CUs.push_back(CU);
229   return true;
230 }
231 
232 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariableExpression *DIG) {
233   if (!NodesSeen.insert(DIG).second)
234     return false;
235 
236   GVs.push_back(DIG);
237   return true;
238 }
239 
240 bool DebugInfoFinder::addSubprogram(DISubprogram *SP) {
241   if (!SP)
242     return false;
243 
244   if (!NodesSeen.insert(SP).second)
245     return false;
246 
247   SPs.push_back(SP);
248   return true;
249 }
250 
251 bool DebugInfoFinder::addScope(DIScope *Scope) {
252   if (!Scope)
253     return false;
254   // FIXME: Ocaml binding generates a scope with no content, we treat it
255   // as null for now.
256   if (Scope->getNumOperands() == 0)
257     return false;
258   if (!NodesSeen.insert(Scope).second)
259     return false;
260   Scopes.push_back(Scope);
261   return true;
262 }
263 
264 static MDNode *updateLoopMetadataDebugLocationsImpl(
265     MDNode *OrigLoopID,
266     function_ref<DILocation *(const DILocation &)> Updater) {
267   assert(OrigLoopID && OrigLoopID->getNumOperands() > 0 &&
268          "Loop ID needs at least one operand");
269   assert(OrigLoopID && OrigLoopID->getOperand(0).get() == OrigLoopID &&
270          "Loop ID should refer to itself");
271 
272   // Save space for the self-referential LoopID.
273   SmallVector<Metadata *, 4> MDs = {nullptr};
274 
275   for (unsigned i = 1; i < OrigLoopID->getNumOperands(); ++i) {
276     Metadata *MD = OrigLoopID->getOperand(i);
277     if (DILocation *DL = dyn_cast<DILocation>(MD)) {
278       if (DILocation *NewDL = Updater(*DL))
279         MDs.push_back(NewDL);
280     } else
281       MDs.push_back(MD);
282   }
283 
284   MDNode *NewLoopID = MDNode::getDistinct(OrigLoopID->getContext(), MDs);
285   // Insert the self-referential LoopID.
286   NewLoopID->replaceOperandWith(0, NewLoopID);
287   return NewLoopID;
288 }
289 
290 void llvm::updateLoopMetadataDebugLocations(
291     Instruction &I, function_ref<DILocation *(const DILocation &)> Updater) {
292   MDNode *OrigLoopID = I.getMetadata(LLVMContext::MD_loop);
293   if (!OrigLoopID)
294     return;
295   MDNode *NewLoopID = updateLoopMetadataDebugLocationsImpl(OrigLoopID, Updater);
296   I.setMetadata(LLVMContext::MD_loop, NewLoopID);
297 }
298 
299 static MDNode *stripDebugLocFromLoopID(MDNode *N) {
300   assert(!N->operands().empty() && "Missing self reference?");
301 
302   // if there is no debug location, we do not have to rewrite this MDNode.
303   if (std::none_of(N->op_begin() + 1, N->op_end(), [](const MDOperand &Op) {
304         return isa<DILocation>(Op.get());
305       }))
306     return N;
307 
308   // If there is only the debug location without any actual loop metadata, we
309   // can remove the metadata.
310   if (std::none_of(N->op_begin() + 1, N->op_end(), [](const MDOperand &Op) {
311         return !isa<DILocation>(Op.get());
312       }))
313     return nullptr;
314 
315   auto dropDebugLoc = [](const DILocation &) -> DILocation * {
316     return nullptr;
317   };
318   return updateLoopMetadataDebugLocationsImpl(N, dropDebugLoc);
319 }
320 
321 bool llvm::stripDebugInfo(Function &F) {
322   bool Changed = false;
323   if (F.hasMetadata(LLVMContext::MD_dbg)) {
324     Changed = true;
325     F.setSubprogram(nullptr);
326   }
327 
328   DenseMap<MDNode*, MDNode*> LoopIDsMap;
329   for (BasicBlock &BB : F) {
330     for (auto II = BB.begin(), End = BB.end(); II != End;) {
331       Instruction &I = *II++; // We may delete the instruction, increment now.
332       if (isa<DbgInfoIntrinsic>(&I)) {
333         I.eraseFromParent();
334         Changed = true;
335         continue;
336       }
337       if (I.getDebugLoc()) {
338         Changed = true;
339         I.setDebugLoc(DebugLoc());
340       }
341     }
342 
343     auto *TermInst = BB.getTerminator();
344     if (!TermInst)
345       // This is invalid IR, but we may not have run the verifier yet
346       continue;
347     if (auto *LoopID = TermInst->getMetadata(LLVMContext::MD_loop)) {
348       auto *NewLoopID = LoopIDsMap.lookup(LoopID);
349       if (!NewLoopID)
350         NewLoopID = LoopIDsMap[LoopID] = stripDebugLocFromLoopID(LoopID);
351       if (NewLoopID != LoopID)
352         TermInst->setMetadata(LLVMContext::MD_loop, NewLoopID);
353     }
354   }
355   return Changed;
356 }
357 
358 bool llvm::StripDebugInfo(Module &M) {
359   bool Changed = false;
360 
361   for (Module::named_metadata_iterator NMI = M.named_metadata_begin(),
362          NME = M.named_metadata_end(); NMI != NME;) {
363     NamedMDNode *NMD = &*NMI;
364     ++NMI;
365 
366     // We're stripping debug info, and without them, coverage information
367     // doesn't quite make sense.
368     if (NMD->getName().startswith("llvm.dbg.") ||
369         NMD->getName() == "llvm.gcov") {
370       NMD->eraseFromParent();
371       Changed = true;
372     }
373   }
374 
375   for (Function &F : M)
376     Changed |= stripDebugInfo(F);
377 
378   for (auto &GV : M.globals()) {
379     Changed |= GV.eraseMetadata(LLVMContext::MD_dbg);
380   }
381 
382   if (GVMaterializer *Materializer = M.getMaterializer())
383     Materializer->setStripDebugInfo();
384 
385   return Changed;
386 }
387 
388 namespace {
389 
390 /// Helper class to downgrade -g metadata to -gline-tables-only metadata.
391 class DebugTypeInfoRemoval {
392   DenseMap<Metadata *, Metadata *> Replacements;
393 
394 public:
395   /// The (void)() type.
396   MDNode *EmptySubroutineType;
397 
398 private:
399   /// Remember what linkage name we originally had before stripping. If we end
400   /// up making two subprograms identical who originally had different linkage
401   /// names, then we need to make one of them distinct, to avoid them getting
402   /// uniqued. Maps the new node to the old linkage name.
403   DenseMap<DISubprogram *, StringRef> NewToLinkageName;
404 
405   // TODO: Remember the distinct subprogram we created for a given linkage name,
406   // so that we can continue to unique whenever possible. Map <newly created
407   // node, old linkage name> to the first (possibly distinct) mdsubprogram
408   // created for that combination. This is not strictly needed for correctness,
409   // but can cut down on the number of MDNodes and let us diff cleanly with the
410   // output of -gline-tables-only.
411 
412 public:
413   DebugTypeInfoRemoval(LLVMContext &C)
414       : EmptySubroutineType(DISubroutineType::get(C, DINode::FlagZero, 0,
415                                                   MDNode::get(C, {}))) {}
416 
417   Metadata *map(Metadata *M) {
418     if (!M)
419       return nullptr;
420     auto Replacement = Replacements.find(M);
421     if (Replacement != Replacements.end())
422       return Replacement->second;
423 
424     return M;
425   }
426   MDNode *mapNode(Metadata *N) { return dyn_cast_or_null<MDNode>(map(N)); }
427 
428   /// Recursively remap N and all its referenced children. Does a DF post-order
429   /// traversal, so as to remap bottoms up.
430   void traverseAndRemap(MDNode *N) { traverse(N); }
431 
432 private:
433   // Create a new DISubprogram, to replace the one given.
434   DISubprogram *getReplacementSubprogram(DISubprogram *MDS) {
435     auto *FileAndScope = cast_or_null<DIFile>(map(MDS->getFile()));
436     StringRef LinkageName = MDS->getName().empty() ? MDS->getLinkageName() : "";
437     DISubprogram *Declaration = nullptr;
438     auto *Type = cast_or_null<DISubroutineType>(map(MDS->getType()));
439     DIType *ContainingType =
440         cast_or_null<DIType>(map(MDS->getContainingType()));
441     auto *Unit = cast_or_null<DICompileUnit>(map(MDS->getUnit()));
442     auto Variables = nullptr;
443     auto TemplateParams = nullptr;
444 
445     // Make a distinct DISubprogram, for situations that warrent it.
446     auto distinctMDSubprogram = [&]() {
447       return DISubprogram::getDistinct(
448           MDS->getContext(), FileAndScope, MDS->getName(), LinkageName,
449           FileAndScope, MDS->getLine(), Type, MDS->getScopeLine(),
450           ContainingType, MDS->getVirtualIndex(), MDS->getThisAdjustment(),
451           MDS->getFlags(), MDS->getSPFlags(), Unit, TemplateParams, Declaration,
452           Variables);
453     };
454 
455     if (MDS->isDistinct())
456       return distinctMDSubprogram();
457 
458     auto *NewMDS = DISubprogram::get(
459         MDS->getContext(), FileAndScope, MDS->getName(), LinkageName,
460         FileAndScope, MDS->getLine(), Type, MDS->getScopeLine(), ContainingType,
461         MDS->getVirtualIndex(), MDS->getThisAdjustment(), MDS->getFlags(),
462         MDS->getSPFlags(), Unit, TemplateParams, Declaration, Variables);
463 
464     StringRef OldLinkageName = MDS->getLinkageName();
465 
466     // See if we need to make a distinct one.
467     auto OrigLinkage = NewToLinkageName.find(NewMDS);
468     if (OrigLinkage != NewToLinkageName.end()) {
469       if (OrigLinkage->second == OldLinkageName)
470         // We're good.
471         return NewMDS;
472 
473       // Otherwise, need to make a distinct one.
474       // TODO: Query the map to see if we already have one.
475       return distinctMDSubprogram();
476     }
477 
478     NewToLinkageName.insert({NewMDS, MDS->getLinkageName()});
479     return NewMDS;
480   }
481 
482   /// Create a new compile unit, to replace the one given
483   DICompileUnit *getReplacementCU(DICompileUnit *CU) {
484     // Drop skeleton CUs.
485     if (CU->getDWOId())
486       return nullptr;
487 
488     auto *File = cast_or_null<DIFile>(map(CU->getFile()));
489     MDTuple *EnumTypes = nullptr;
490     MDTuple *RetainedTypes = nullptr;
491     MDTuple *GlobalVariables = nullptr;
492     MDTuple *ImportedEntities = nullptr;
493     return DICompileUnit::getDistinct(
494         CU->getContext(), CU->getSourceLanguage(), File, CU->getProducer(),
495         CU->isOptimized(), CU->getFlags(), CU->getRuntimeVersion(),
496         CU->getSplitDebugFilename(), DICompileUnit::LineTablesOnly, EnumTypes,
497         RetainedTypes, GlobalVariables, ImportedEntities, CU->getMacros(),
498         CU->getDWOId(), CU->getSplitDebugInlining(),
499         CU->getDebugInfoForProfiling(), CU->getNameTableKind(),
500         CU->getRangesBaseAddress(), CU->getSysRoot(), CU->getSDK());
501   }
502 
503   DILocation *getReplacementMDLocation(DILocation *MLD) {
504     auto *Scope = map(MLD->getScope());
505     auto *InlinedAt = map(MLD->getInlinedAt());
506     if (MLD->isDistinct())
507       return DILocation::getDistinct(MLD->getContext(), MLD->getLine(),
508                                      MLD->getColumn(), Scope, InlinedAt);
509     return DILocation::get(MLD->getContext(), MLD->getLine(), MLD->getColumn(),
510                            Scope, InlinedAt);
511   }
512 
513   /// Create a new generic MDNode, to replace the one given
514   MDNode *getReplacementMDNode(MDNode *N) {
515     SmallVector<Metadata *, 8> Ops;
516     Ops.reserve(N->getNumOperands());
517     for (auto &I : N->operands())
518       if (I)
519         Ops.push_back(map(I));
520     auto *Ret = MDNode::get(N->getContext(), Ops);
521     return Ret;
522   }
523 
524   /// Attempt to re-map N to a newly created node.
525   void remap(MDNode *N) {
526     if (Replacements.count(N))
527       return;
528 
529     auto doRemap = [&](MDNode *N) -> MDNode * {
530       if (!N)
531         return nullptr;
532       if (auto *MDSub = dyn_cast<DISubprogram>(N)) {
533         remap(MDSub->getUnit());
534         return getReplacementSubprogram(MDSub);
535       }
536       if (isa<DISubroutineType>(N))
537         return EmptySubroutineType;
538       if (auto *CU = dyn_cast<DICompileUnit>(N))
539         return getReplacementCU(CU);
540       if (isa<DIFile>(N))
541         return N;
542       if (auto *MDLB = dyn_cast<DILexicalBlockBase>(N))
543         // Remap to our referenced scope (recursively).
544         return mapNode(MDLB->getScope());
545       if (auto *MLD = dyn_cast<DILocation>(N))
546         return getReplacementMDLocation(MLD);
547 
548       // Otherwise, if we see these, just drop them now. Not strictly necessary,
549       // but this speeds things up a little.
550       if (isa<DINode>(N))
551         return nullptr;
552 
553       return getReplacementMDNode(N);
554     };
555     Replacements[N] = doRemap(N);
556   }
557 
558   /// Do the remapping traversal.
559   void traverse(MDNode *);
560 };
561 
562 } // end anonymous namespace
563 
564 void DebugTypeInfoRemoval::traverse(MDNode *N) {
565   if (!N || Replacements.count(N))
566     return;
567 
568   // To avoid cycles, as well as for efficiency sake, we will sometimes prune
569   // parts of the graph.
570   auto prune = [](MDNode *Parent, MDNode *Child) {
571     if (auto *MDS = dyn_cast<DISubprogram>(Parent))
572       return Child == MDS->getRetainedNodes().get();
573     return false;
574   };
575 
576   SmallVector<MDNode *, 16> ToVisit;
577   DenseSet<MDNode *> Opened;
578 
579   // Visit each node starting at N in post order, and map them.
580   ToVisit.push_back(N);
581   while (!ToVisit.empty()) {
582     auto *N = ToVisit.back();
583     if (!Opened.insert(N).second) {
584       // Close it.
585       remap(N);
586       ToVisit.pop_back();
587       continue;
588     }
589     for (auto &I : N->operands())
590       if (auto *MDN = dyn_cast_or_null<MDNode>(I))
591         if (!Opened.count(MDN) && !Replacements.count(MDN) && !prune(N, MDN) &&
592             !isa<DICompileUnit>(MDN))
593           ToVisit.push_back(MDN);
594   }
595 }
596 
597 bool llvm::stripNonLineTableDebugInfo(Module &M) {
598   bool Changed = false;
599 
600   // First off, delete the debug intrinsics.
601   auto RemoveUses = [&](StringRef Name) {
602     if (auto *DbgVal = M.getFunction(Name)) {
603       while (!DbgVal->use_empty())
604         cast<Instruction>(DbgVal->user_back())->eraseFromParent();
605       DbgVal->eraseFromParent();
606       Changed = true;
607     }
608   };
609   RemoveUses("llvm.dbg.addr");
610   RemoveUses("llvm.dbg.declare");
611   RemoveUses("llvm.dbg.label");
612   RemoveUses("llvm.dbg.value");
613 
614   // Delete non-CU debug info named metadata nodes.
615   for (auto NMI = M.named_metadata_begin(), NME = M.named_metadata_end();
616        NMI != NME;) {
617     NamedMDNode *NMD = &*NMI;
618     ++NMI;
619     // Specifically keep dbg.cu around.
620     if (NMD->getName() == "llvm.dbg.cu")
621       continue;
622   }
623 
624   // Drop all dbg attachments from global variables.
625   for (auto &GV : M.globals())
626     GV.eraseMetadata(LLVMContext::MD_dbg);
627 
628   DebugTypeInfoRemoval Mapper(M.getContext());
629   auto remap = [&](MDNode *Node) -> MDNode * {
630     if (!Node)
631       return nullptr;
632     Mapper.traverseAndRemap(Node);
633     auto *NewNode = Mapper.mapNode(Node);
634     Changed |= Node != NewNode;
635     Node = NewNode;
636     return NewNode;
637   };
638 
639   // Rewrite the DebugLocs to be equivalent to what
640   // -gline-tables-only would have created.
641   for (auto &F : M) {
642     if (auto *SP = F.getSubprogram()) {
643       Mapper.traverseAndRemap(SP);
644       auto *NewSP = cast<DISubprogram>(Mapper.mapNode(SP));
645       Changed |= SP != NewSP;
646       F.setSubprogram(NewSP);
647     }
648     for (auto &BB : F) {
649       for (auto &I : BB) {
650         auto remapDebugLoc = [&](const DebugLoc &DL) -> DebugLoc {
651           auto *Scope = DL.getScope();
652           MDNode *InlinedAt = DL.getInlinedAt();
653           Scope = remap(Scope);
654           InlinedAt = remap(InlinedAt);
655           return DebugLoc::get(DL.getLine(), DL.getCol(), Scope, InlinedAt);
656         };
657 
658         if (I.getDebugLoc() != DebugLoc())
659           I.setDebugLoc(remapDebugLoc(I.getDebugLoc()));
660 
661         // Remap DILocations in llvm.loop attachments.
662         updateLoopMetadataDebugLocations(I, [&](const DILocation &Loc) {
663           return remapDebugLoc(&Loc).get();
664         });
665       }
666     }
667   }
668 
669   // Create a new llvm.dbg.cu, which is equivalent to the one
670   // -gline-tables-only would have created.
671   for (auto &NMD : M.getNamedMDList()) {
672     SmallVector<MDNode *, 8> Ops;
673     for (MDNode *Op : NMD.operands())
674       Ops.push_back(remap(Op));
675 
676     if (!Changed)
677       continue;
678 
679     NMD.clearOperands();
680     for (auto *Op : Ops)
681       if (Op)
682         NMD.addOperand(Op);
683   }
684   return Changed;
685 }
686 
687 unsigned llvm::getDebugMetadataVersionFromModule(const Module &M) {
688   if (auto *Val = mdconst::dyn_extract_or_null<ConstantInt>(
689           M.getModuleFlag("Debug Info Version")))
690     return Val->getZExtValue();
691   return 0;
692 }
693 
694 void Instruction::applyMergedLocation(const DILocation *LocA,
695                                       const DILocation *LocB) {
696   setDebugLoc(DILocation::getMergedLocation(LocA, LocB));
697 }
698 
699 //===----------------------------------------------------------------------===//
700 // LLVM C API implementations.
701 //===----------------------------------------------------------------------===//
702 
703 static unsigned map_from_llvmDWARFsourcelanguage(LLVMDWARFSourceLanguage lang) {
704   switch (lang) {
705 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR)                 \
706   case LLVMDWARFSourceLanguage##NAME:                                          \
707     return ID;
708 #include "llvm/BinaryFormat/Dwarf.def"
709 #undef HANDLE_DW_LANG
710   }
711   llvm_unreachable("Unhandled Tag");
712 }
713 
714 template <typename DIT> DIT *unwrapDI(LLVMMetadataRef Ref) {
715   return (DIT *)(Ref ? unwrap<MDNode>(Ref) : nullptr);
716 }
717 
718 static DINode::DIFlags map_from_llvmDIFlags(LLVMDIFlags Flags) {
719   return static_cast<DINode::DIFlags>(Flags);
720 }
721 
722 static LLVMDIFlags map_to_llvmDIFlags(DINode::DIFlags Flags) {
723   return static_cast<LLVMDIFlags>(Flags);
724 }
725 
726 static DISubprogram::DISPFlags
727 pack_into_DISPFlags(bool IsLocalToUnit, bool IsDefinition, bool IsOptimized) {
728   return DISubprogram::toSPFlags(IsLocalToUnit, IsDefinition, IsOptimized);
729 }
730 
731 unsigned LLVMDebugMetadataVersion() {
732   return DEBUG_METADATA_VERSION;
733 }
734 
735 LLVMDIBuilderRef LLVMCreateDIBuilderDisallowUnresolved(LLVMModuleRef M) {
736   return wrap(new DIBuilder(*unwrap(M), false));
737 }
738 
739 LLVMDIBuilderRef LLVMCreateDIBuilder(LLVMModuleRef M) {
740   return wrap(new DIBuilder(*unwrap(M)));
741 }
742 
743 unsigned LLVMGetModuleDebugMetadataVersion(LLVMModuleRef M) {
744   return getDebugMetadataVersionFromModule(*unwrap(M));
745 }
746 
747 LLVMBool LLVMStripModuleDebugInfo(LLVMModuleRef M) {
748   return StripDebugInfo(*unwrap(M));
749 }
750 
751 void LLVMDisposeDIBuilder(LLVMDIBuilderRef Builder) {
752   delete unwrap(Builder);
753 }
754 
755 void LLVMDIBuilderFinalize(LLVMDIBuilderRef Builder) {
756   unwrap(Builder)->finalize();
757 }
758 
759 LLVMMetadataRef LLVMDIBuilderCreateCompileUnit(
760     LLVMDIBuilderRef Builder, LLVMDWARFSourceLanguage Lang,
761     LLVMMetadataRef FileRef, const char *Producer, size_t ProducerLen,
762     LLVMBool isOptimized, const char *Flags, size_t FlagsLen,
763     unsigned RuntimeVer, const char *SplitName, size_t SplitNameLen,
764     LLVMDWARFEmissionKind Kind, unsigned DWOId, LLVMBool SplitDebugInlining,
765     LLVMBool DebugInfoForProfiling, const char *SysRoot, size_t SysRootLen,
766     const char *SDK, size_t SDKLen) {
767   auto File = unwrapDI<DIFile>(FileRef);
768 
769   return wrap(unwrap(Builder)->createCompileUnit(
770       map_from_llvmDWARFsourcelanguage(Lang), File,
771       StringRef(Producer, ProducerLen), isOptimized, StringRef(Flags, FlagsLen),
772       RuntimeVer, StringRef(SplitName, SplitNameLen),
773       static_cast<DICompileUnit::DebugEmissionKind>(Kind), DWOId,
774       SplitDebugInlining, DebugInfoForProfiling,
775       DICompileUnit::DebugNameTableKind::Default, false,
776       StringRef(SysRoot, SysRootLen), StringRef(SDK, SDKLen)));
777 }
778 
779 LLVMMetadataRef
780 LLVMDIBuilderCreateFile(LLVMDIBuilderRef Builder, const char *Filename,
781                         size_t FilenameLen, const char *Directory,
782                         size_t DirectoryLen) {
783   return wrap(unwrap(Builder)->createFile(StringRef(Filename, FilenameLen),
784                                           StringRef(Directory, DirectoryLen)));
785 }
786 
787 LLVMMetadataRef
788 LLVMDIBuilderCreateModule(LLVMDIBuilderRef Builder, LLVMMetadataRef ParentScope,
789                           const char *Name, size_t NameLen,
790                           const char *ConfigMacros, size_t ConfigMacrosLen,
791                           const char *IncludePath, size_t IncludePathLen,
792                           const char *APINotesFile, size_t APINotesFileLen) {
793   return wrap(unwrap(Builder)->createModule(
794       unwrapDI<DIScope>(ParentScope), StringRef(Name, NameLen),
795       StringRef(ConfigMacros, ConfigMacrosLen),
796       StringRef(IncludePath, IncludePathLen),
797       StringRef(APINotesFile, APINotesFileLen)));
798 }
799 
800 LLVMMetadataRef LLVMDIBuilderCreateNameSpace(LLVMDIBuilderRef Builder,
801                                              LLVMMetadataRef ParentScope,
802                                              const char *Name, size_t NameLen,
803                                              LLVMBool ExportSymbols) {
804   return wrap(unwrap(Builder)->createNameSpace(
805       unwrapDI<DIScope>(ParentScope), StringRef(Name, NameLen), ExportSymbols));
806 }
807 
808 LLVMMetadataRef LLVMDIBuilderCreateFunction(
809     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
810     size_t NameLen, const char *LinkageName, size_t LinkageNameLen,
811     LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty,
812     LLVMBool IsLocalToUnit, LLVMBool IsDefinition,
813     unsigned ScopeLine, LLVMDIFlags Flags, LLVMBool IsOptimized) {
814   return wrap(unwrap(Builder)->createFunction(
815       unwrapDI<DIScope>(Scope), {Name, NameLen}, {LinkageName, LinkageNameLen},
816       unwrapDI<DIFile>(File), LineNo, unwrapDI<DISubroutineType>(Ty), ScopeLine,
817       map_from_llvmDIFlags(Flags),
818       pack_into_DISPFlags(IsLocalToUnit, IsDefinition, IsOptimized), nullptr,
819       nullptr, nullptr));
820 }
821 
822 
823 LLVMMetadataRef LLVMDIBuilderCreateLexicalBlock(
824     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope,
825     LLVMMetadataRef File, unsigned Line, unsigned Col) {
826   return wrap(unwrap(Builder)->createLexicalBlock(unwrapDI<DIScope>(Scope),
827                                                   unwrapDI<DIFile>(File),
828                                                   Line, Col));
829 }
830 
831 LLVMMetadataRef
832 LLVMDIBuilderCreateLexicalBlockFile(LLVMDIBuilderRef Builder,
833                                     LLVMMetadataRef Scope,
834                                     LLVMMetadataRef File,
835                                     unsigned Discriminator) {
836   return wrap(unwrap(Builder)->createLexicalBlockFile(unwrapDI<DIScope>(Scope),
837                                                       unwrapDI<DIFile>(File),
838                                                       Discriminator));
839 }
840 
841 LLVMMetadataRef
842 LLVMDIBuilderCreateImportedModuleFromNamespace(LLVMDIBuilderRef Builder,
843                                                LLVMMetadataRef Scope,
844                                                LLVMMetadataRef NS,
845                                                LLVMMetadataRef File,
846                                                unsigned Line) {
847   return wrap(unwrap(Builder)->createImportedModule(unwrapDI<DIScope>(Scope),
848                                                     unwrapDI<DINamespace>(NS),
849                                                     unwrapDI<DIFile>(File),
850                                                     Line));
851 }
852 
853 LLVMMetadataRef
854 LLVMDIBuilderCreateImportedModuleFromAlias(LLVMDIBuilderRef Builder,
855                                            LLVMMetadataRef Scope,
856                                            LLVMMetadataRef ImportedEntity,
857                                            LLVMMetadataRef File,
858                                            unsigned Line) {
859   return wrap(unwrap(Builder)->createImportedModule(
860                   unwrapDI<DIScope>(Scope),
861                   unwrapDI<DIImportedEntity>(ImportedEntity),
862                   unwrapDI<DIFile>(File), Line));
863 }
864 
865 LLVMMetadataRef
866 LLVMDIBuilderCreateImportedModuleFromModule(LLVMDIBuilderRef Builder,
867                                             LLVMMetadataRef Scope,
868                                             LLVMMetadataRef M,
869                                             LLVMMetadataRef File,
870                                             unsigned Line) {
871   return wrap(unwrap(Builder)->createImportedModule(unwrapDI<DIScope>(Scope),
872                                                     unwrapDI<DIModule>(M),
873                                                     unwrapDI<DIFile>(File),
874                                                     Line));
875 }
876 
877 LLVMMetadataRef
878 LLVMDIBuilderCreateImportedDeclaration(LLVMDIBuilderRef Builder,
879                                        LLVMMetadataRef Scope,
880                                        LLVMMetadataRef Decl,
881                                        LLVMMetadataRef File,
882                                        unsigned Line,
883                                        const char *Name, size_t NameLen) {
884   return wrap(unwrap(Builder)->createImportedDeclaration(
885                   unwrapDI<DIScope>(Scope),
886                   unwrapDI<DINode>(Decl),
887                   unwrapDI<DIFile>(File), Line, {Name, NameLen}));
888 }
889 
890 LLVMMetadataRef
891 LLVMDIBuilderCreateDebugLocation(LLVMContextRef Ctx, unsigned Line,
892                                  unsigned Column, LLVMMetadataRef Scope,
893                                  LLVMMetadataRef InlinedAt) {
894   return wrap(DILocation::get(*unwrap(Ctx), Line, Column, unwrap(Scope),
895                               unwrap(InlinedAt)));
896 }
897 
898 unsigned LLVMDILocationGetLine(LLVMMetadataRef Location) {
899   return unwrapDI<DILocation>(Location)->getLine();
900 }
901 
902 unsigned LLVMDILocationGetColumn(LLVMMetadataRef Location) {
903   return unwrapDI<DILocation>(Location)->getColumn();
904 }
905 
906 LLVMMetadataRef LLVMDILocationGetScope(LLVMMetadataRef Location) {
907   return wrap(unwrapDI<DILocation>(Location)->getScope());
908 }
909 
910 LLVMMetadataRef LLVMDILocationGetInlinedAt(LLVMMetadataRef Location) {
911   return wrap(unwrapDI<DILocation>(Location)->getInlinedAt());
912 }
913 
914 LLVMMetadataRef LLVMDIScopeGetFile(LLVMMetadataRef Scope) {
915   return wrap(unwrapDI<DIScope>(Scope)->getFile());
916 }
917 
918 const char *LLVMDIFileGetDirectory(LLVMMetadataRef File, unsigned *Len) {
919   auto Dir = unwrapDI<DIFile>(File)->getDirectory();
920   *Len = Dir.size();
921   return Dir.data();
922 }
923 
924 const char *LLVMDIFileGetFilename(LLVMMetadataRef File, unsigned *Len) {
925   auto Name = unwrapDI<DIFile>(File)->getFilename();
926   *Len = Name.size();
927   return Name.data();
928 }
929 
930 const char *LLVMDIFileGetSource(LLVMMetadataRef File, unsigned *Len) {
931   if (auto Src = unwrapDI<DIFile>(File)->getSource()) {
932     *Len = Src->size();
933     return Src->data();
934   }
935   *Len = 0;
936   return "";
937 }
938 
939 LLVMMetadataRef LLVMDIBuilderCreateMacro(LLVMDIBuilderRef Builder,
940                                          LLVMMetadataRef ParentMacroFile,
941                                          unsigned Line,
942                                          LLVMDWARFMacinfoRecordType RecordType,
943                                          const char *Name, size_t NameLen,
944                                          const char *Value, size_t ValueLen) {
945   return wrap(
946       unwrap(Builder)->createMacro(unwrapDI<DIMacroFile>(ParentMacroFile), Line,
947                                    static_cast<MacinfoRecordType>(RecordType),
948                                    {Name, NameLen}, {Value, ValueLen}));
949 }
950 
951 LLVMMetadataRef
952 LLVMDIBuilderCreateTempMacroFile(LLVMDIBuilderRef Builder,
953                                  LLVMMetadataRef ParentMacroFile, unsigned Line,
954                                  LLVMMetadataRef File) {
955   return wrap(unwrap(Builder)->createTempMacroFile(
956       unwrapDI<DIMacroFile>(ParentMacroFile), Line, unwrapDI<DIFile>(File)));
957 }
958 
959 LLVMMetadataRef LLVMDIBuilderCreateEnumerator(LLVMDIBuilderRef Builder,
960                                               const char *Name, size_t NameLen,
961                                               int64_t Value,
962                                               LLVMBool IsUnsigned) {
963   return wrap(unwrap(Builder)->createEnumerator({Name, NameLen}, Value,
964                                                 IsUnsigned != 0));
965 }
966 
967 LLVMMetadataRef LLVMDIBuilderCreateEnumerationType(
968   LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
969   size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
970   uint64_t SizeInBits, uint32_t AlignInBits, LLVMMetadataRef *Elements,
971   unsigned NumElements, LLVMMetadataRef ClassTy) {
972 auto Elts = unwrap(Builder)->getOrCreateArray({unwrap(Elements),
973                                                NumElements});
974 return wrap(unwrap(Builder)->createEnumerationType(
975     unwrapDI<DIScope>(Scope), {Name, NameLen}, unwrapDI<DIFile>(File),
976     LineNumber, SizeInBits, AlignInBits, Elts, unwrapDI<DIType>(ClassTy)));
977 }
978 
979 LLVMMetadataRef LLVMDIBuilderCreateUnionType(
980   LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
981   size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
982   uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags,
983   LLVMMetadataRef *Elements, unsigned NumElements, unsigned RunTimeLang,
984   const char *UniqueId, size_t UniqueIdLen) {
985   auto Elts = unwrap(Builder)->getOrCreateArray({unwrap(Elements),
986                                                  NumElements});
987   return wrap(unwrap(Builder)->createUnionType(
988      unwrapDI<DIScope>(Scope), {Name, NameLen}, unwrapDI<DIFile>(File),
989      LineNumber, SizeInBits, AlignInBits, map_from_llvmDIFlags(Flags),
990      Elts, RunTimeLang, {UniqueId, UniqueIdLen}));
991 }
992 
993 
994 LLVMMetadataRef
995 LLVMDIBuilderCreateArrayType(LLVMDIBuilderRef Builder, uint64_t Size,
996                              uint32_t AlignInBits, LLVMMetadataRef Ty,
997                              LLVMMetadataRef *Subscripts,
998                              unsigned NumSubscripts) {
999   auto Subs = unwrap(Builder)->getOrCreateArray({unwrap(Subscripts),
1000                                                  NumSubscripts});
1001   return wrap(unwrap(Builder)->createArrayType(Size, AlignInBits,
1002                                                unwrapDI<DIType>(Ty), Subs));
1003 }
1004 
1005 LLVMMetadataRef
1006 LLVMDIBuilderCreateVectorType(LLVMDIBuilderRef Builder, uint64_t Size,
1007                               uint32_t AlignInBits, LLVMMetadataRef Ty,
1008                               LLVMMetadataRef *Subscripts,
1009                               unsigned NumSubscripts) {
1010   auto Subs = unwrap(Builder)->getOrCreateArray({unwrap(Subscripts),
1011                                                  NumSubscripts});
1012   return wrap(unwrap(Builder)->createVectorType(Size, AlignInBits,
1013                                                 unwrapDI<DIType>(Ty), Subs));
1014 }
1015 
1016 LLVMMetadataRef
1017 LLVMDIBuilderCreateBasicType(LLVMDIBuilderRef Builder, const char *Name,
1018                              size_t NameLen, uint64_t SizeInBits,
1019                              LLVMDWARFTypeEncoding Encoding,
1020                              LLVMDIFlags Flags) {
1021   return wrap(unwrap(Builder)->createBasicType({Name, NameLen},
1022                                                SizeInBits, Encoding,
1023                                                map_from_llvmDIFlags(Flags)));
1024 }
1025 
1026 LLVMMetadataRef LLVMDIBuilderCreatePointerType(
1027     LLVMDIBuilderRef Builder, LLVMMetadataRef PointeeTy,
1028     uint64_t SizeInBits, uint32_t AlignInBits, unsigned AddressSpace,
1029     const char *Name, size_t NameLen) {
1030   return wrap(unwrap(Builder)->createPointerType(unwrapDI<DIType>(PointeeTy),
1031                                          SizeInBits, AlignInBits,
1032                                          AddressSpace, {Name, NameLen}));
1033 }
1034 
1035 LLVMMetadataRef LLVMDIBuilderCreateStructType(
1036     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1037     size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
1038     uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags,
1039     LLVMMetadataRef DerivedFrom, LLVMMetadataRef *Elements,
1040     unsigned NumElements, unsigned RunTimeLang, LLVMMetadataRef VTableHolder,
1041     const char *UniqueId, size_t UniqueIdLen) {
1042   auto Elts = unwrap(Builder)->getOrCreateArray({unwrap(Elements),
1043                                                  NumElements});
1044   return wrap(unwrap(Builder)->createStructType(
1045       unwrapDI<DIScope>(Scope), {Name, NameLen}, unwrapDI<DIFile>(File),
1046       LineNumber, SizeInBits, AlignInBits, map_from_llvmDIFlags(Flags),
1047       unwrapDI<DIType>(DerivedFrom), Elts, RunTimeLang,
1048       unwrapDI<DIType>(VTableHolder), {UniqueId, UniqueIdLen}));
1049 }
1050 
1051 LLVMMetadataRef LLVMDIBuilderCreateMemberType(
1052     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1053     size_t NameLen, LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
1054     uint32_t AlignInBits, uint64_t OffsetInBits, LLVMDIFlags Flags,
1055     LLVMMetadataRef Ty) {
1056   return wrap(unwrap(Builder)->createMemberType(unwrapDI<DIScope>(Scope),
1057       {Name, NameLen}, unwrapDI<DIFile>(File), LineNo, SizeInBits, AlignInBits,
1058       OffsetInBits, map_from_llvmDIFlags(Flags), unwrapDI<DIType>(Ty)));
1059 }
1060 
1061 LLVMMetadataRef
1062 LLVMDIBuilderCreateUnspecifiedType(LLVMDIBuilderRef Builder, const char *Name,
1063                                    size_t NameLen) {
1064   return wrap(unwrap(Builder)->createUnspecifiedType({Name, NameLen}));
1065 }
1066 
1067 LLVMMetadataRef
1068 LLVMDIBuilderCreateStaticMemberType(
1069     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1070     size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
1071     LLVMMetadataRef Type, LLVMDIFlags Flags, LLVMValueRef ConstantVal,
1072     uint32_t AlignInBits) {
1073   return wrap(unwrap(Builder)->createStaticMemberType(
1074                   unwrapDI<DIScope>(Scope), {Name, NameLen},
1075                   unwrapDI<DIFile>(File), LineNumber, unwrapDI<DIType>(Type),
1076                   map_from_llvmDIFlags(Flags), unwrap<Constant>(ConstantVal),
1077                   AlignInBits));
1078 }
1079 
1080 LLVMMetadataRef
1081 LLVMDIBuilderCreateObjCIVar(LLVMDIBuilderRef Builder,
1082                             const char *Name, size_t NameLen,
1083                             LLVMMetadataRef File, unsigned LineNo,
1084                             uint64_t SizeInBits, uint32_t AlignInBits,
1085                             uint64_t OffsetInBits, LLVMDIFlags Flags,
1086                             LLVMMetadataRef Ty, LLVMMetadataRef PropertyNode) {
1087   return wrap(unwrap(Builder)->createObjCIVar(
1088                   {Name, NameLen}, unwrapDI<DIFile>(File), LineNo,
1089                   SizeInBits, AlignInBits, OffsetInBits,
1090                   map_from_llvmDIFlags(Flags), unwrapDI<DIType>(Ty),
1091                   unwrapDI<MDNode>(PropertyNode)));
1092 }
1093 
1094 LLVMMetadataRef
1095 LLVMDIBuilderCreateObjCProperty(LLVMDIBuilderRef Builder,
1096                                 const char *Name, size_t NameLen,
1097                                 LLVMMetadataRef File, unsigned LineNo,
1098                                 const char *GetterName, size_t GetterNameLen,
1099                                 const char *SetterName, size_t SetterNameLen,
1100                                 unsigned PropertyAttributes,
1101                                 LLVMMetadataRef Ty) {
1102   return wrap(unwrap(Builder)->createObjCProperty(
1103                   {Name, NameLen}, unwrapDI<DIFile>(File), LineNo,
1104                   {GetterName, GetterNameLen}, {SetterName, SetterNameLen},
1105                   PropertyAttributes, unwrapDI<DIType>(Ty)));
1106 }
1107 
1108 LLVMMetadataRef
1109 LLVMDIBuilderCreateObjectPointerType(LLVMDIBuilderRef Builder,
1110                                      LLVMMetadataRef Type) {
1111   return wrap(unwrap(Builder)->createObjectPointerType(unwrapDI<DIType>(Type)));
1112 }
1113 
1114 LLVMMetadataRef
1115 LLVMDIBuilderCreateTypedef(LLVMDIBuilderRef Builder, LLVMMetadataRef Type,
1116                            const char *Name, size_t NameLen,
1117                            LLVMMetadataRef File, unsigned LineNo,
1118                            LLVMMetadataRef Scope, uint32_t AlignInBits) {
1119   return wrap(unwrap(Builder)->createTypedef(
1120       unwrapDI<DIType>(Type), {Name, NameLen}, unwrapDI<DIFile>(File), LineNo,
1121       unwrapDI<DIScope>(Scope), AlignInBits));
1122 }
1123 
1124 LLVMMetadataRef
1125 LLVMDIBuilderCreateInheritance(LLVMDIBuilderRef Builder,
1126                                LLVMMetadataRef Ty, LLVMMetadataRef BaseTy,
1127                                uint64_t BaseOffset, uint32_t VBPtrOffset,
1128                                LLVMDIFlags Flags) {
1129   return wrap(unwrap(Builder)->createInheritance(
1130                   unwrapDI<DIType>(Ty), unwrapDI<DIType>(BaseTy),
1131                   BaseOffset, VBPtrOffset, map_from_llvmDIFlags(Flags)));
1132 }
1133 
1134 LLVMMetadataRef
1135 LLVMDIBuilderCreateForwardDecl(
1136     LLVMDIBuilderRef Builder, unsigned Tag, const char *Name,
1137     size_t NameLen, LLVMMetadataRef Scope, LLVMMetadataRef File, unsigned Line,
1138     unsigned RuntimeLang, uint64_t SizeInBits, uint32_t AlignInBits,
1139     const char *UniqueIdentifier, size_t UniqueIdentifierLen) {
1140   return wrap(unwrap(Builder)->createForwardDecl(
1141                   Tag, {Name, NameLen}, unwrapDI<DIScope>(Scope),
1142                   unwrapDI<DIFile>(File), Line, RuntimeLang, SizeInBits,
1143                   AlignInBits, {UniqueIdentifier, UniqueIdentifierLen}));
1144 }
1145 
1146 LLVMMetadataRef
1147 LLVMDIBuilderCreateReplaceableCompositeType(
1148     LLVMDIBuilderRef Builder, unsigned Tag, const char *Name,
1149     size_t NameLen, LLVMMetadataRef Scope, LLVMMetadataRef File, unsigned Line,
1150     unsigned RuntimeLang, uint64_t SizeInBits, uint32_t AlignInBits,
1151     LLVMDIFlags Flags, const char *UniqueIdentifier,
1152     size_t UniqueIdentifierLen) {
1153   return wrap(unwrap(Builder)->createReplaceableCompositeType(
1154                   Tag, {Name, NameLen}, unwrapDI<DIScope>(Scope),
1155                   unwrapDI<DIFile>(File), Line, RuntimeLang, SizeInBits,
1156                   AlignInBits, map_from_llvmDIFlags(Flags),
1157                   {UniqueIdentifier, UniqueIdentifierLen}));
1158 }
1159 
1160 LLVMMetadataRef
1161 LLVMDIBuilderCreateQualifiedType(LLVMDIBuilderRef Builder, unsigned Tag,
1162                                  LLVMMetadataRef Type) {
1163   return wrap(unwrap(Builder)->createQualifiedType(Tag,
1164                                                    unwrapDI<DIType>(Type)));
1165 }
1166 
1167 LLVMMetadataRef
1168 LLVMDIBuilderCreateReferenceType(LLVMDIBuilderRef Builder, unsigned Tag,
1169                                  LLVMMetadataRef Type) {
1170   return wrap(unwrap(Builder)->createReferenceType(Tag,
1171                                                    unwrapDI<DIType>(Type)));
1172 }
1173 
1174 LLVMMetadataRef
1175 LLVMDIBuilderCreateNullPtrType(LLVMDIBuilderRef Builder) {
1176   return wrap(unwrap(Builder)->createNullPtrType());
1177 }
1178 
1179 LLVMMetadataRef
1180 LLVMDIBuilderCreateMemberPointerType(LLVMDIBuilderRef Builder,
1181                                      LLVMMetadataRef PointeeType,
1182                                      LLVMMetadataRef ClassType,
1183                                      uint64_t SizeInBits,
1184                                      uint32_t AlignInBits,
1185                                      LLVMDIFlags Flags) {
1186   return wrap(unwrap(Builder)->createMemberPointerType(
1187                   unwrapDI<DIType>(PointeeType),
1188                   unwrapDI<DIType>(ClassType), AlignInBits, SizeInBits,
1189                   map_from_llvmDIFlags(Flags)));
1190 }
1191 
1192 LLVMMetadataRef
1193 LLVMDIBuilderCreateBitFieldMemberType(LLVMDIBuilderRef Builder,
1194                                       LLVMMetadataRef Scope,
1195                                       const char *Name, size_t NameLen,
1196                                       LLVMMetadataRef File, unsigned LineNumber,
1197                                       uint64_t SizeInBits,
1198                                       uint64_t OffsetInBits,
1199                                       uint64_t StorageOffsetInBits,
1200                                       LLVMDIFlags Flags, LLVMMetadataRef Type) {
1201   return wrap(unwrap(Builder)->createBitFieldMemberType(
1202                   unwrapDI<DIScope>(Scope), {Name, NameLen},
1203                   unwrapDI<DIFile>(File), LineNumber,
1204                   SizeInBits, OffsetInBits, StorageOffsetInBits,
1205                   map_from_llvmDIFlags(Flags), unwrapDI<DIType>(Type)));
1206 }
1207 
1208 LLVMMetadataRef LLVMDIBuilderCreateClassType(LLVMDIBuilderRef Builder,
1209     LLVMMetadataRef Scope, const char *Name, size_t NameLen,
1210     LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
1211     uint32_t AlignInBits, uint64_t OffsetInBits, LLVMDIFlags Flags,
1212     LLVMMetadataRef DerivedFrom,
1213     LLVMMetadataRef *Elements, unsigned NumElements,
1214     LLVMMetadataRef VTableHolder, LLVMMetadataRef TemplateParamsNode,
1215     const char *UniqueIdentifier, size_t UniqueIdentifierLen) {
1216   auto Elts = unwrap(Builder)->getOrCreateArray({unwrap(Elements),
1217                                                  NumElements});
1218   return wrap(unwrap(Builder)->createClassType(
1219                   unwrapDI<DIScope>(Scope), {Name, NameLen},
1220                   unwrapDI<DIFile>(File), LineNumber,
1221                   SizeInBits, AlignInBits, OffsetInBits,
1222                   map_from_llvmDIFlags(Flags), unwrapDI<DIType>(DerivedFrom),
1223                   Elts, unwrapDI<DIType>(VTableHolder),
1224                   unwrapDI<MDNode>(TemplateParamsNode),
1225                   {UniqueIdentifier, UniqueIdentifierLen}));
1226 }
1227 
1228 LLVMMetadataRef
1229 LLVMDIBuilderCreateArtificialType(LLVMDIBuilderRef Builder,
1230                                   LLVMMetadataRef Type) {
1231   return wrap(unwrap(Builder)->createArtificialType(unwrapDI<DIType>(Type)));
1232 }
1233 
1234 const char *LLVMDITypeGetName(LLVMMetadataRef DType, size_t *Length) {
1235   StringRef Str = unwrap<DIType>(DType)->getName();
1236   *Length = Str.size();
1237   return Str.data();
1238 }
1239 
1240 uint64_t LLVMDITypeGetSizeInBits(LLVMMetadataRef DType) {
1241   return unwrapDI<DIType>(DType)->getSizeInBits();
1242 }
1243 
1244 uint64_t LLVMDITypeGetOffsetInBits(LLVMMetadataRef DType) {
1245   return unwrapDI<DIType>(DType)->getOffsetInBits();
1246 }
1247 
1248 uint32_t LLVMDITypeGetAlignInBits(LLVMMetadataRef DType) {
1249   return unwrapDI<DIType>(DType)->getAlignInBits();
1250 }
1251 
1252 unsigned LLVMDITypeGetLine(LLVMMetadataRef DType) {
1253   return unwrapDI<DIType>(DType)->getLine();
1254 }
1255 
1256 LLVMDIFlags LLVMDITypeGetFlags(LLVMMetadataRef DType) {
1257   return map_to_llvmDIFlags(unwrapDI<DIType>(DType)->getFlags());
1258 }
1259 
1260 LLVMMetadataRef LLVMDIBuilderGetOrCreateTypeArray(LLVMDIBuilderRef Builder,
1261                                                   LLVMMetadataRef *Types,
1262                                                   size_t Length) {
1263   return wrap(
1264       unwrap(Builder)->getOrCreateTypeArray({unwrap(Types), Length}).get());
1265 }
1266 
1267 LLVMMetadataRef
1268 LLVMDIBuilderCreateSubroutineType(LLVMDIBuilderRef Builder,
1269                                   LLVMMetadataRef File,
1270                                   LLVMMetadataRef *ParameterTypes,
1271                                   unsigned NumParameterTypes,
1272                                   LLVMDIFlags Flags) {
1273   auto Elts = unwrap(Builder)->getOrCreateTypeArray({unwrap(ParameterTypes),
1274                                                      NumParameterTypes});
1275   return wrap(unwrap(Builder)->createSubroutineType(
1276     Elts, map_from_llvmDIFlags(Flags)));
1277 }
1278 
1279 LLVMMetadataRef LLVMDIBuilderCreateExpression(LLVMDIBuilderRef Builder,
1280                                               int64_t *Addr, size_t Length) {
1281   return wrap(unwrap(Builder)->createExpression(ArrayRef<int64_t>(Addr,
1282                                                                   Length)));
1283 }
1284 
1285 LLVMMetadataRef
1286 LLVMDIBuilderCreateConstantValueExpression(LLVMDIBuilderRef Builder,
1287                                            int64_t Value) {
1288   return wrap(unwrap(Builder)->createConstantValueExpression(Value));
1289 }
1290 
1291 LLVMMetadataRef LLVMDIBuilderCreateGlobalVariableExpression(
1292     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1293     size_t NameLen, const char *Linkage, size_t LinkLen, LLVMMetadataRef File,
1294     unsigned LineNo, LLVMMetadataRef Ty, LLVMBool LocalToUnit,
1295     LLVMMetadataRef Expr, LLVMMetadataRef Decl, uint32_t AlignInBits) {
1296   return wrap(unwrap(Builder)->createGlobalVariableExpression(
1297       unwrapDI<DIScope>(Scope), {Name, NameLen}, {Linkage, LinkLen},
1298       unwrapDI<DIFile>(File), LineNo, unwrapDI<DIType>(Ty), LocalToUnit,
1299       true, unwrap<DIExpression>(Expr), unwrapDI<MDNode>(Decl),
1300       nullptr, AlignInBits));
1301 }
1302 
1303 LLVMMetadataRef LLVMDIGlobalVariableExpressionGetVariable(LLVMMetadataRef GVE) {
1304   return wrap(unwrapDI<DIGlobalVariableExpression>(GVE)->getVariable());
1305 }
1306 
1307 LLVMMetadataRef LLVMDIGlobalVariableExpressionGetExpression(
1308     LLVMMetadataRef GVE) {
1309   return wrap(unwrapDI<DIGlobalVariableExpression>(GVE)->getExpression());
1310 }
1311 
1312 LLVMMetadataRef LLVMDIVariableGetFile(LLVMMetadataRef Var) {
1313   return wrap(unwrapDI<DIVariable>(Var)->getFile());
1314 }
1315 
1316 LLVMMetadataRef LLVMDIVariableGetScope(LLVMMetadataRef Var) {
1317   return wrap(unwrapDI<DIVariable>(Var)->getScope());
1318 }
1319 
1320 unsigned LLVMDIVariableGetLine(LLVMMetadataRef Var) {
1321   return unwrapDI<DIVariable>(Var)->getLine();
1322 }
1323 
1324 LLVMMetadataRef LLVMTemporaryMDNode(LLVMContextRef Ctx, LLVMMetadataRef *Data,
1325                                     size_t Count) {
1326   return wrap(
1327       MDTuple::getTemporary(*unwrap(Ctx), {unwrap(Data), Count}).release());
1328 }
1329 
1330 void LLVMDisposeTemporaryMDNode(LLVMMetadataRef TempNode) {
1331   MDNode::deleteTemporary(unwrapDI<MDNode>(TempNode));
1332 }
1333 
1334 void LLVMMetadataReplaceAllUsesWith(LLVMMetadataRef TargetMetadata,
1335                                     LLVMMetadataRef Replacement) {
1336   auto *Node = unwrapDI<MDNode>(TargetMetadata);
1337   Node->replaceAllUsesWith(unwrap<Metadata>(Replacement));
1338   MDNode::deleteTemporary(Node);
1339 }
1340 
1341 LLVMMetadataRef LLVMDIBuilderCreateTempGlobalVariableFwdDecl(
1342     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1343     size_t NameLen, const char *Linkage, size_t LnkLen, LLVMMetadataRef File,
1344     unsigned LineNo, LLVMMetadataRef Ty, LLVMBool LocalToUnit,
1345     LLVMMetadataRef Decl, uint32_t AlignInBits) {
1346   return wrap(unwrap(Builder)->createTempGlobalVariableFwdDecl(
1347       unwrapDI<DIScope>(Scope), {Name, NameLen}, {Linkage, LnkLen},
1348       unwrapDI<DIFile>(File), LineNo, unwrapDI<DIType>(Ty), LocalToUnit,
1349       unwrapDI<MDNode>(Decl), nullptr, AlignInBits));
1350 }
1351 
1352 LLVMValueRef
1353 LLVMDIBuilderInsertDeclareBefore(LLVMDIBuilderRef Builder, LLVMValueRef Storage,
1354                                  LLVMMetadataRef VarInfo, LLVMMetadataRef Expr,
1355                                  LLVMMetadataRef DL, LLVMValueRef Instr) {
1356   return wrap(unwrap(Builder)->insertDeclare(
1357                   unwrap(Storage), unwrap<DILocalVariable>(VarInfo),
1358                   unwrap<DIExpression>(Expr), unwrap<DILocation>(DL),
1359                   unwrap<Instruction>(Instr)));
1360 }
1361 
1362 LLVMValueRef LLVMDIBuilderInsertDeclareAtEnd(
1363     LLVMDIBuilderRef Builder, LLVMValueRef Storage, LLVMMetadataRef VarInfo,
1364     LLVMMetadataRef Expr, LLVMMetadataRef DL, LLVMBasicBlockRef Block) {
1365   return wrap(unwrap(Builder)->insertDeclare(
1366                   unwrap(Storage), unwrap<DILocalVariable>(VarInfo),
1367                   unwrap<DIExpression>(Expr), unwrap<DILocation>(DL),
1368                   unwrap(Block)));
1369 }
1370 
1371 LLVMValueRef LLVMDIBuilderInsertDbgValueBefore(LLVMDIBuilderRef Builder,
1372                                                LLVMValueRef Val,
1373                                                LLVMMetadataRef VarInfo,
1374                                                LLVMMetadataRef Expr,
1375                                                LLVMMetadataRef DebugLoc,
1376                                                LLVMValueRef Instr) {
1377   return wrap(unwrap(Builder)->insertDbgValueIntrinsic(
1378                   unwrap(Val), unwrap<DILocalVariable>(VarInfo),
1379                   unwrap<DIExpression>(Expr), unwrap<DILocation>(DebugLoc),
1380                   unwrap<Instruction>(Instr)));
1381 }
1382 
1383 LLVMValueRef LLVMDIBuilderInsertDbgValueAtEnd(LLVMDIBuilderRef Builder,
1384                                               LLVMValueRef Val,
1385                                               LLVMMetadataRef VarInfo,
1386                                               LLVMMetadataRef Expr,
1387                                               LLVMMetadataRef DebugLoc,
1388                                               LLVMBasicBlockRef Block) {
1389   return wrap(unwrap(Builder)->insertDbgValueIntrinsic(
1390                   unwrap(Val), unwrap<DILocalVariable>(VarInfo),
1391                   unwrap<DIExpression>(Expr), unwrap<DILocation>(DebugLoc),
1392                   unwrap(Block)));
1393 }
1394 
1395 LLVMMetadataRef LLVMDIBuilderCreateAutoVariable(
1396     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1397     size_t NameLen, LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty,
1398     LLVMBool AlwaysPreserve, LLVMDIFlags Flags, uint32_t AlignInBits) {
1399   return wrap(unwrap(Builder)->createAutoVariable(
1400                   unwrap<DIScope>(Scope), {Name, NameLen}, unwrap<DIFile>(File),
1401                   LineNo, unwrap<DIType>(Ty), AlwaysPreserve,
1402                   map_from_llvmDIFlags(Flags), AlignInBits));
1403 }
1404 
1405 LLVMMetadataRef LLVMDIBuilderCreateParameterVariable(
1406     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1407     size_t NameLen, unsigned ArgNo, LLVMMetadataRef File, unsigned LineNo,
1408     LLVMMetadataRef Ty, LLVMBool AlwaysPreserve, LLVMDIFlags Flags) {
1409   return wrap(unwrap(Builder)->createParameterVariable(
1410                   unwrap<DIScope>(Scope), {Name, NameLen}, ArgNo, unwrap<DIFile>(File),
1411                   LineNo, unwrap<DIType>(Ty), AlwaysPreserve,
1412                   map_from_llvmDIFlags(Flags)));
1413 }
1414 
1415 LLVMMetadataRef LLVMDIBuilderGetOrCreateSubrange(LLVMDIBuilderRef Builder,
1416                                                  int64_t Lo, int64_t Count) {
1417   return wrap(unwrap(Builder)->getOrCreateSubrange(Lo, Count));
1418 }
1419 
1420 LLVMMetadataRef LLVMDIBuilderGetOrCreateArray(LLVMDIBuilderRef Builder,
1421                                               LLVMMetadataRef *Data,
1422                                               size_t Length) {
1423   Metadata **DataValue = unwrap(Data);
1424   return wrap(unwrap(Builder)->getOrCreateArray({DataValue, Length}).get());
1425 }
1426 
1427 LLVMMetadataRef LLVMGetSubprogram(LLVMValueRef Func) {
1428   return wrap(unwrap<Function>(Func)->getSubprogram());
1429 }
1430 
1431 void LLVMSetSubprogram(LLVMValueRef Func, LLVMMetadataRef SP) {
1432   unwrap<Function>(Func)->setSubprogram(unwrap<DISubprogram>(SP));
1433 }
1434 
1435 unsigned LLVMDISubprogramGetLine(LLVMMetadataRef Subprogram) {
1436   return unwrapDI<DISubprogram>(Subprogram)->getLine();
1437 }
1438 
1439 LLVMMetadataRef LLVMInstructionGetDebugLoc(LLVMValueRef Inst) {
1440   return wrap(unwrap<Instruction>(Inst)->getDebugLoc().getAsMDNode());
1441 }
1442 
1443 void LLVMInstructionSetDebugLoc(LLVMValueRef Inst, LLVMMetadataRef Loc) {
1444   if (Loc)
1445     unwrap<Instruction>(Inst)->setDebugLoc(DebugLoc(unwrap<MDNode>(Loc)));
1446   else
1447     unwrap<Instruction>(Inst)->setDebugLoc(DebugLoc());
1448 }
1449 
1450 LLVMMetadataKind LLVMGetMetadataKind(LLVMMetadataRef Metadata) {
1451   switch(unwrap(Metadata)->getMetadataID()) {
1452 #define HANDLE_METADATA_LEAF(CLASS) \
1453   case Metadata::CLASS##Kind: \
1454     return (LLVMMetadataKind)LLVM##CLASS##MetadataKind;
1455 #include "llvm/IR/Metadata.def"
1456   default:
1457     return (LLVMMetadataKind)LLVMGenericDINodeMetadataKind;
1458   }
1459 }
1460