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 = [&](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 untyped MDNodes (e.g., llvm.loop).
662         SmallVector<std::pair<unsigned, MDNode *>, 2> MDs;
663         I.getAllMetadata(MDs);
664         for (auto Attachment : MDs)
665           if (auto *T = dyn_cast_or_null<MDTuple>(Attachment.second))
666             for (unsigned N = 0; N < T->getNumOperands(); ++N)
667               if (auto *Loc = dyn_cast_or_null<DILocation>(T->getOperand(N)))
668                 if (Loc != DebugLoc())
669                   T->replaceOperandWith(N, remapDebugLoc(Loc));
670       }
671     }
672   }
673 
674   // Create a new llvm.dbg.cu, which is equivalent to the one
675   // -gline-tables-only would have created.
676   for (auto &NMD : M.getNamedMDList()) {
677     SmallVector<MDNode *, 8> Ops;
678     for (MDNode *Op : NMD.operands())
679       Ops.push_back(remap(Op));
680 
681     if (!Changed)
682       continue;
683 
684     NMD.clearOperands();
685     for (auto *Op : Ops)
686       if (Op)
687         NMD.addOperand(Op);
688   }
689   return Changed;
690 }
691 
692 unsigned llvm::getDebugMetadataVersionFromModule(const Module &M) {
693   if (auto *Val = mdconst::dyn_extract_or_null<ConstantInt>(
694           M.getModuleFlag("Debug Info Version")))
695     return Val->getZExtValue();
696   return 0;
697 }
698 
699 void Instruction::applyMergedLocation(const DILocation *LocA,
700                                       const DILocation *LocB) {
701   setDebugLoc(DILocation::getMergedLocation(LocA, LocB));
702 }
703 
704 //===----------------------------------------------------------------------===//
705 // LLVM C API implementations.
706 //===----------------------------------------------------------------------===//
707 
708 static unsigned map_from_llvmDWARFsourcelanguage(LLVMDWARFSourceLanguage lang) {
709   switch (lang) {
710 #define HANDLE_DW_LANG(ID, NAME, LOWER_BOUND, VERSION, VENDOR)                 \
711   case LLVMDWARFSourceLanguage##NAME:                                          \
712     return ID;
713 #include "llvm/BinaryFormat/Dwarf.def"
714 #undef HANDLE_DW_LANG
715   }
716   llvm_unreachable("Unhandled Tag");
717 }
718 
719 template <typename DIT> DIT *unwrapDI(LLVMMetadataRef Ref) {
720   return (DIT *)(Ref ? unwrap<MDNode>(Ref) : nullptr);
721 }
722 
723 static DINode::DIFlags map_from_llvmDIFlags(LLVMDIFlags Flags) {
724   return static_cast<DINode::DIFlags>(Flags);
725 }
726 
727 static LLVMDIFlags map_to_llvmDIFlags(DINode::DIFlags Flags) {
728   return static_cast<LLVMDIFlags>(Flags);
729 }
730 
731 static DISubprogram::DISPFlags
732 pack_into_DISPFlags(bool IsLocalToUnit, bool IsDefinition, bool IsOptimized) {
733   return DISubprogram::toSPFlags(IsLocalToUnit, IsDefinition, IsOptimized);
734 }
735 
736 unsigned LLVMDebugMetadataVersion() {
737   return DEBUG_METADATA_VERSION;
738 }
739 
740 LLVMDIBuilderRef LLVMCreateDIBuilderDisallowUnresolved(LLVMModuleRef M) {
741   return wrap(new DIBuilder(*unwrap(M), false));
742 }
743 
744 LLVMDIBuilderRef LLVMCreateDIBuilder(LLVMModuleRef M) {
745   return wrap(new DIBuilder(*unwrap(M)));
746 }
747 
748 unsigned LLVMGetModuleDebugMetadataVersion(LLVMModuleRef M) {
749   return getDebugMetadataVersionFromModule(*unwrap(M));
750 }
751 
752 LLVMBool LLVMStripModuleDebugInfo(LLVMModuleRef M) {
753   return StripDebugInfo(*unwrap(M));
754 }
755 
756 void LLVMDisposeDIBuilder(LLVMDIBuilderRef Builder) {
757   delete unwrap(Builder);
758 }
759 
760 void LLVMDIBuilderFinalize(LLVMDIBuilderRef Builder) {
761   unwrap(Builder)->finalize();
762 }
763 
764 LLVMMetadataRef LLVMDIBuilderCreateCompileUnit(
765     LLVMDIBuilderRef Builder, LLVMDWARFSourceLanguage Lang,
766     LLVMMetadataRef FileRef, const char *Producer, size_t ProducerLen,
767     LLVMBool isOptimized, const char *Flags, size_t FlagsLen,
768     unsigned RuntimeVer, const char *SplitName, size_t SplitNameLen,
769     LLVMDWARFEmissionKind Kind, unsigned DWOId, LLVMBool SplitDebugInlining,
770     LLVMBool DebugInfoForProfiling, const char *SysRoot, size_t SysRootLen,
771     const char *SDK, size_t SDKLen) {
772   auto File = unwrapDI<DIFile>(FileRef);
773 
774   return wrap(unwrap(Builder)->createCompileUnit(
775       map_from_llvmDWARFsourcelanguage(Lang), File,
776       StringRef(Producer, ProducerLen), isOptimized, StringRef(Flags, FlagsLen),
777       RuntimeVer, StringRef(SplitName, SplitNameLen),
778       static_cast<DICompileUnit::DebugEmissionKind>(Kind), DWOId,
779       SplitDebugInlining, DebugInfoForProfiling,
780       DICompileUnit::DebugNameTableKind::Default, false,
781       StringRef(SysRoot, SysRootLen), StringRef(SDK, SDKLen)));
782 }
783 
784 LLVMMetadataRef
785 LLVMDIBuilderCreateFile(LLVMDIBuilderRef Builder, const char *Filename,
786                         size_t FilenameLen, const char *Directory,
787                         size_t DirectoryLen) {
788   return wrap(unwrap(Builder)->createFile(StringRef(Filename, FilenameLen),
789                                           StringRef(Directory, DirectoryLen)));
790 }
791 
792 LLVMMetadataRef
793 LLVMDIBuilderCreateModule(LLVMDIBuilderRef Builder, LLVMMetadataRef ParentScope,
794                           const char *Name, size_t NameLen,
795                           const char *ConfigMacros, size_t ConfigMacrosLen,
796                           const char *IncludePath, size_t IncludePathLen,
797                           const char *APINotesFile, size_t APINotesFileLen) {
798   return wrap(unwrap(Builder)->createModule(
799       unwrapDI<DIScope>(ParentScope), StringRef(Name, NameLen),
800       StringRef(ConfigMacros, ConfigMacrosLen),
801       StringRef(IncludePath, IncludePathLen),
802       StringRef(APINotesFile, APINotesFileLen)));
803 }
804 
805 LLVMMetadataRef LLVMDIBuilderCreateNameSpace(LLVMDIBuilderRef Builder,
806                                              LLVMMetadataRef ParentScope,
807                                              const char *Name, size_t NameLen,
808                                              LLVMBool ExportSymbols) {
809   return wrap(unwrap(Builder)->createNameSpace(
810       unwrapDI<DIScope>(ParentScope), StringRef(Name, NameLen), ExportSymbols));
811 }
812 
813 LLVMMetadataRef LLVMDIBuilderCreateFunction(
814     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
815     size_t NameLen, const char *LinkageName, size_t LinkageNameLen,
816     LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty,
817     LLVMBool IsLocalToUnit, LLVMBool IsDefinition,
818     unsigned ScopeLine, LLVMDIFlags Flags, LLVMBool IsOptimized) {
819   return wrap(unwrap(Builder)->createFunction(
820       unwrapDI<DIScope>(Scope), {Name, NameLen}, {LinkageName, LinkageNameLen},
821       unwrapDI<DIFile>(File), LineNo, unwrapDI<DISubroutineType>(Ty), ScopeLine,
822       map_from_llvmDIFlags(Flags),
823       pack_into_DISPFlags(IsLocalToUnit, IsDefinition, IsOptimized), nullptr,
824       nullptr, nullptr));
825 }
826 
827 
828 LLVMMetadataRef LLVMDIBuilderCreateLexicalBlock(
829     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope,
830     LLVMMetadataRef File, unsigned Line, unsigned Col) {
831   return wrap(unwrap(Builder)->createLexicalBlock(unwrapDI<DIScope>(Scope),
832                                                   unwrapDI<DIFile>(File),
833                                                   Line, Col));
834 }
835 
836 LLVMMetadataRef
837 LLVMDIBuilderCreateLexicalBlockFile(LLVMDIBuilderRef Builder,
838                                     LLVMMetadataRef Scope,
839                                     LLVMMetadataRef File,
840                                     unsigned Discriminator) {
841   return wrap(unwrap(Builder)->createLexicalBlockFile(unwrapDI<DIScope>(Scope),
842                                                       unwrapDI<DIFile>(File),
843                                                       Discriminator));
844 }
845 
846 LLVMMetadataRef
847 LLVMDIBuilderCreateImportedModuleFromNamespace(LLVMDIBuilderRef Builder,
848                                                LLVMMetadataRef Scope,
849                                                LLVMMetadataRef NS,
850                                                LLVMMetadataRef File,
851                                                unsigned Line) {
852   return wrap(unwrap(Builder)->createImportedModule(unwrapDI<DIScope>(Scope),
853                                                     unwrapDI<DINamespace>(NS),
854                                                     unwrapDI<DIFile>(File),
855                                                     Line));
856 }
857 
858 LLVMMetadataRef
859 LLVMDIBuilderCreateImportedModuleFromAlias(LLVMDIBuilderRef Builder,
860                                            LLVMMetadataRef Scope,
861                                            LLVMMetadataRef ImportedEntity,
862                                            LLVMMetadataRef File,
863                                            unsigned Line) {
864   return wrap(unwrap(Builder)->createImportedModule(
865                   unwrapDI<DIScope>(Scope),
866                   unwrapDI<DIImportedEntity>(ImportedEntity),
867                   unwrapDI<DIFile>(File), Line));
868 }
869 
870 LLVMMetadataRef
871 LLVMDIBuilderCreateImportedModuleFromModule(LLVMDIBuilderRef Builder,
872                                             LLVMMetadataRef Scope,
873                                             LLVMMetadataRef M,
874                                             LLVMMetadataRef File,
875                                             unsigned Line) {
876   return wrap(unwrap(Builder)->createImportedModule(unwrapDI<DIScope>(Scope),
877                                                     unwrapDI<DIModule>(M),
878                                                     unwrapDI<DIFile>(File),
879                                                     Line));
880 }
881 
882 LLVMMetadataRef
883 LLVMDIBuilderCreateImportedDeclaration(LLVMDIBuilderRef Builder,
884                                        LLVMMetadataRef Scope,
885                                        LLVMMetadataRef Decl,
886                                        LLVMMetadataRef File,
887                                        unsigned Line,
888                                        const char *Name, size_t NameLen) {
889   return wrap(unwrap(Builder)->createImportedDeclaration(
890                   unwrapDI<DIScope>(Scope),
891                   unwrapDI<DINode>(Decl),
892                   unwrapDI<DIFile>(File), Line, {Name, NameLen}));
893 }
894 
895 LLVMMetadataRef
896 LLVMDIBuilderCreateDebugLocation(LLVMContextRef Ctx, unsigned Line,
897                                  unsigned Column, LLVMMetadataRef Scope,
898                                  LLVMMetadataRef InlinedAt) {
899   return wrap(DILocation::get(*unwrap(Ctx), Line, Column, unwrap(Scope),
900                               unwrap(InlinedAt)));
901 }
902 
903 unsigned LLVMDILocationGetLine(LLVMMetadataRef Location) {
904   return unwrapDI<DILocation>(Location)->getLine();
905 }
906 
907 unsigned LLVMDILocationGetColumn(LLVMMetadataRef Location) {
908   return unwrapDI<DILocation>(Location)->getColumn();
909 }
910 
911 LLVMMetadataRef LLVMDILocationGetScope(LLVMMetadataRef Location) {
912   return wrap(unwrapDI<DILocation>(Location)->getScope());
913 }
914 
915 LLVMMetadataRef LLVMDILocationGetInlinedAt(LLVMMetadataRef Location) {
916   return wrap(unwrapDI<DILocation>(Location)->getInlinedAt());
917 }
918 
919 LLVMMetadataRef LLVMDIScopeGetFile(LLVMMetadataRef Scope) {
920   return wrap(unwrapDI<DIScope>(Scope)->getFile());
921 }
922 
923 const char *LLVMDIFileGetDirectory(LLVMMetadataRef File, unsigned *Len) {
924   auto Dir = unwrapDI<DIFile>(File)->getDirectory();
925   *Len = Dir.size();
926   return Dir.data();
927 }
928 
929 const char *LLVMDIFileGetFilename(LLVMMetadataRef File, unsigned *Len) {
930   auto Name = unwrapDI<DIFile>(File)->getFilename();
931   *Len = Name.size();
932   return Name.data();
933 }
934 
935 const char *LLVMDIFileGetSource(LLVMMetadataRef File, unsigned *Len) {
936   if (auto Src = unwrapDI<DIFile>(File)->getSource()) {
937     *Len = Src->size();
938     return Src->data();
939   }
940   *Len = 0;
941   return "";
942 }
943 
944 LLVMMetadataRef LLVMDIBuilderCreateMacro(LLVMDIBuilderRef Builder,
945                                          LLVMMetadataRef ParentMacroFile,
946                                          unsigned Line,
947                                          LLVMDWARFMacinfoRecordType RecordType,
948                                          const char *Name, size_t NameLen,
949                                          const char *Value, size_t ValueLen) {
950   return wrap(
951       unwrap(Builder)->createMacro(unwrapDI<DIMacroFile>(ParentMacroFile), Line,
952                                    static_cast<MacinfoRecordType>(RecordType),
953                                    {Name, NameLen}, {Value, ValueLen}));
954 }
955 
956 LLVMMetadataRef
957 LLVMDIBuilderCreateTempMacroFile(LLVMDIBuilderRef Builder,
958                                  LLVMMetadataRef ParentMacroFile, unsigned Line,
959                                  LLVMMetadataRef File) {
960   return wrap(unwrap(Builder)->createTempMacroFile(
961       unwrapDI<DIMacroFile>(ParentMacroFile), Line, unwrapDI<DIFile>(File)));
962 }
963 
964 LLVMMetadataRef LLVMDIBuilderCreateEnumerator(LLVMDIBuilderRef Builder,
965                                               const char *Name, size_t NameLen,
966                                               int64_t Value,
967                                               LLVMBool IsUnsigned) {
968   return wrap(unwrap(Builder)->createEnumerator({Name, NameLen}, Value,
969                                                 IsUnsigned != 0));
970 }
971 
972 LLVMMetadataRef LLVMDIBuilderCreateEnumerationType(
973   LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
974   size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
975   uint64_t SizeInBits, uint32_t AlignInBits, LLVMMetadataRef *Elements,
976   unsigned NumElements, LLVMMetadataRef ClassTy) {
977 auto Elts = unwrap(Builder)->getOrCreateArray({unwrap(Elements),
978                                                NumElements});
979 return wrap(unwrap(Builder)->createEnumerationType(
980     unwrapDI<DIScope>(Scope), {Name, NameLen}, unwrapDI<DIFile>(File),
981     LineNumber, SizeInBits, AlignInBits, Elts, unwrapDI<DIType>(ClassTy)));
982 }
983 
984 LLVMMetadataRef LLVMDIBuilderCreateUnionType(
985   LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
986   size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
987   uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags,
988   LLVMMetadataRef *Elements, unsigned NumElements, unsigned RunTimeLang,
989   const char *UniqueId, size_t UniqueIdLen) {
990   auto Elts = unwrap(Builder)->getOrCreateArray({unwrap(Elements),
991                                                  NumElements});
992   return wrap(unwrap(Builder)->createUnionType(
993      unwrapDI<DIScope>(Scope), {Name, NameLen}, unwrapDI<DIFile>(File),
994      LineNumber, SizeInBits, AlignInBits, map_from_llvmDIFlags(Flags),
995      Elts, RunTimeLang, {UniqueId, UniqueIdLen}));
996 }
997 
998 
999 LLVMMetadataRef
1000 LLVMDIBuilderCreateArrayType(LLVMDIBuilderRef Builder, uint64_t Size,
1001                              uint32_t AlignInBits, LLVMMetadataRef Ty,
1002                              LLVMMetadataRef *Subscripts,
1003                              unsigned NumSubscripts) {
1004   auto Subs = unwrap(Builder)->getOrCreateArray({unwrap(Subscripts),
1005                                                  NumSubscripts});
1006   return wrap(unwrap(Builder)->createArrayType(Size, AlignInBits,
1007                                                unwrapDI<DIType>(Ty), Subs));
1008 }
1009 
1010 LLVMMetadataRef
1011 LLVMDIBuilderCreateVectorType(LLVMDIBuilderRef Builder, uint64_t Size,
1012                               uint32_t AlignInBits, LLVMMetadataRef Ty,
1013                               LLVMMetadataRef *Subscripts,
1014                               unsigned NumSubscripts) {
1015   auto Subs = unwrap(Builder)->getOrCreateArray({unwrap(Subscripts),
1016                                                  NumSubscripts});
1017   return wrap(unwrap(Builder)->createVectorType(Size, AlignInBits,
1018                                                 unwrapDI<DIType>(Ty), Subs));
1019 }
1020 
1021 LLVMMetadataRef
1022 LLVMDIBuilderCreateBasicType(LLVMDIBuilderRef Builder, const char *Name,
1023                              size_t NameLen, uint64_t SizeInBits,
1024                              LLVMDWARFTypeEncoding Encoding,
1025                              LLVMDIFlags Flags) {
1026   return wrap(unwrap(Builder)->createBasicType({Name, NameLen},
1027                                                SizeInBits, Encoding,
1028                                                map_from_llvmDIFlags(Flags)));
1029 }
1030 
1031 LLVMMetadataRef LLVMDIBuilderCreatePointerType(
1032     LLVMDIBuilderRef Builder, LLVMMetadataRef PointeeTy,
1033     uint64_t SizeInBits, uint32_t AlignInBits, unsigned AddressSpace,
1034     const char *Name, size_t NameLen) {
1035   return wrap(unwrap(Builder)->createPointerType(unwrapDI<DIType>(PointeeTy),
1036                                          SizeInBits, AlignInBits,
1037                                          AddressSpace, {Name, NameLen}));
1038 }
1039 
1040 LLVMMetadataRef LLVMDIBuilderCreateStructType(
1041     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1042     size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
1043     uint64_t SizeInBits, uint32_t AlignInBits, LLVMDIFlags Flags,
1044     LLVMMetadataRef DerivedFrom, LLVMMetadataRef *Elements,
1045     unsigned NumElements, unsigned RunTimeLang, LLVMMetadataRef VTableHolder,
1046     const char *UniqueId, size_t UniqueIdLen) {
1047   auto Elts = unwrap(Builder)->getOrCreateArray({unwrap(Elements),
1048                                                  NumElements});
1049   return wrap(unwrap(Builder)->createStructType(
1050       unwrapDI<DIScope>(Scope), {Name, NameLen}, unwrapDI<DIFile>(File),
1051       LineNumber, SizeInBits, AlignInBits, map_from_llvmDIFlags(Flags),
1052       unwrapDI<DIType>(DerivedFrom), Elts, RunTimeLang,
1053       unwrapDI<DIType>(VTableHolder), {UniqueId, UniqueIdLen}));
1054 }
1055 
1056 LLVMMetadataRef LLVMDIBuilderCreateMemberType(
1057     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1058     size_t NameLen, LLVMMetadataRef File, unsigned LineNo, uint64_t SizeInBits,
1059     uint32_t AlignInBits, uint64_t OffsetInBits, LLVMDIFlags Flags,
1060     LLVMMetadataRef Ty) {
1061   return wrap(unwrap(Builder)->createMemberType(unwrapDI<DIScope>(Scope),
1062       {Name, NameLen}, unwrapDI<DIFile>(File), LineNo, SizeInBits, AlignInBits,
1063       OffsetInBits, map_from_llvmDIFlags(Flags), unwrapDI<DIType>(Ty)));
1064 }
1065 
1066 LLVMMetadataRef
1067 LLVMDIBuilderCreateUnspecifiedType(LLVMDIBuilderRef Builder, const char *Name,
1068                                    size_t NameLen) {
1069   return wrap(unwrap(Builder)->createUnspecifiedType({Name, NameLen}));
1070 }
1071 
1072 LLVMMetadataRef
1073 LLVMDIBuilderCreateStaticMemberType(
1074     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1075     size_t NameLen, LLVMMetadataRef File, unsigned LineNumber,
1076     LLVMMetadataRef Type, LLVMDIFlags Flags, LLVMValueRef ConstantVal,
1077     uint32_t AlignInBits) {
1078   return wrap(unwrap(Builder)->createStaticMemberType(
1079                   unwrapDI<DIScope>(Scope), {Name, NameLen},
1080                   unwrapDI<DIFile>(File), LineNumber, unwrapDI<DIType>(Type),
1081                   map_from_llvmDIFlags(Flags), unwrap<Constant>(ConstantVal),
1082                   AlignInBits));
1083 }
1084 
1085 LLVMMetadataRef
1086 LLVMDIBuilderCreateObjCIVar(LLVMDIBuilderRef Builder,
1087                             const char *Name, size_t NameLen,
1088                             LLVMMetadataRef File, unsigned LineNo,
1089                             uint64_t SizeInBits, uint32_t AlignInBits,
1090                             uint64_t OffsetInBits, LLVMDIFlags Flags,
1091                             LLVMMetadataRef Ty, LLVMMetadataRef PropertyNode) {
1092   return wrap(unwrap(Builder)->createObjCIVar(
1093                   {Name, NameLen}, unwrapDI<DIFile>(File), LineNo,
1094                   SizeInBits, AlignInBits, OffsetInBits,
1095                   map_from_llvmDIFlags(Flags), unwrapDI<DIType>(Ty),
1096                   unwrapDI<MDNode>(PropertyNode)));
1097 }
1098 
1099 LLVMMetadataRef
1100 LLVMDIBuilderCreateObjCProperty(LLVMDIBuilderRef Builder,
1101                                 const char *Name, size_t NameLen,
1102                                 LLVMMetadataRef File, unsigned LineNo,
1103                                 const char *GetterName, size_t GetterNameLen,
1104                                 const char *SetterName, size_t SetterNameLen,
1105                                 unsigned PropertyAttributes,
1106                                 LLVMMetadataRef Ty) {
1107   return wrap(unwrap(Builder)->createObjCProperty(
1108                   {Name, NameLen}, unwrapDI<DIFile>(File), LineNo,
1109                   {GetterName, GetterNameLen}, {SetterName, SetterNameLen},
1110                   PropertyAttributes, unwrapDI<DIType>(Ty)));
1111 }
1112 
1113 LLVMMetadataRef
1114 LLVMDIBuilderCreateObjectPointerType(LLVMDIBuilderRef Builder,
1115                                      LLVMMetadataRef Type) {
1116   return wrap(unwrap(Builder)->createObjectPointerType(unwrapDI<DIType>(Type)));
1117 }
1118 
1119 LLVMMetadataRef
1120 LLVMDIBuilderCreateTypedef(LLVMDIBuilderRef Builder, LLVMMetadataRef Type,
1121                            const char *Name, size_t NameLen,
1122                            LLVMMetadataRef File, unsigned LineNo,
1123                            LLVMMetadataRef Scope, uint32_t AlignInBits) {
1124   return wrap(unwrap(Builder)->createTypedef(
1125       unwrapDI<DIType>(Type), {Name, NameLen}, unwrapDI<DIFile>(File), LineNo,
1126       unwrapDI<DIScope>(Scope), AlignInBits));
1127 }
1128 
1129 LLVMMetadataRef
1130 LLVMDIBuilderCreateInheritance(LLVMDIBuilderRef Builder,
1131                                LLVMMetadataRef Ty, LLVMMetadataRef BaseTy,
1132                                uint64_t BaseOffset, uint32_t VBPtrOffset,
1133                                LLVMDIFlags Flags) {
1134   return wrap(unwrap(Builder)->createInheritance(
1135                   unwrapDI<DIType>(Ty), unwrapDI<DIType>(BaseTy),
1136                   BaseOffset, VBPtrOffset, map_from_llvmDIFlags(Flags)));
1137 }
1138 
1139 LLVMMetadataRef
1140 LLVMDIBuilderCreateForwardDecl(
1141     LLVMDIBuilderRef Builder, unsigned Tag, const char *Name,
1142     size_t NameLen, LLVMMetadataRef Scope, LLVMMetadataRef File, unsigned Line,
1143     unsigned RuntimeLang, uint64_t SizeInBits, uint32_t AlignInBits,
1144     const char *UniqueIdentifier, size_t UniqueIdentifierLen) {
1145   return wrap(unwrap(Builder)->createForwardDecl(
1146                   Tag, {Name, NameLen}, unwrapDI<DIScope>(Scope),
1147                   unwrapDI<DIFile>(File), Line, RuntimeLang, SizeInBits,
1148                   AlignInBits, {UniqueIdentifier, UniqueIdentifierLen}));
1149 }
1150 
1151 LLVMMetadataRef
1152 LLVMDIBuilderCreateReplaceableCompositeType(
1153     LLVMDIBuilderRef Builder, unsigned Tag, const char *Name,
1154     size_t NameLen, LLVMMetadataRef Scope, LLVMMetadataRef File, unsigned Line,
1155     unsigned RuntimeLang, uint64_t SizeInBits, uint32_t AlignInBits,
1156     LLVMDIFlags Flags, const char *UniqueIdentifier,
1157     size_t UniqueIdentifierLen) {
1158   return wrap(unwrap(Builder)->createReplaceableCompositeType(
1159                   Tag, {Name, NameLen}, unwrapDI<DIScope>(Scope),
1160                   unwrapDI<DIFile>(File), Line, RuntimeLang, SizeInBits,
1161                   AlignInBits, map_from_llvmDIFlags(Flags),
1162                   {UniqueIdentifier, UniqueIdentifierLen}));
1163 }
1164 
1165 LLVMMetadataRef
1166 LLVMDIBuilderCreateQualifiedType(LLVMDIBuilderRef Builder, unsigned Tag,
1167                                  LLVMMetadataRef Type) {
1168   return wrap(unwrap(Builder)->createQualifiedType(Tag,
1169                                                    unwrapDI<DIType>(Type)));
1170 }
1171 
1172 LLVMMetadataRef
1173 LLVMDIBuilderCreateReferenceType(LLVMDIBuilderRef Builder, unsigned Tag,
1174                                  LLVMMetadataRef Type) {
1175   return wrap(unwrap(Builder)->createReferenceType(Tag,
1176                                                    unwrapDI<DIType>(Type)));
1177 }
1178 
1179 LLVMMetadataRef
1180 LLVMDIBuilderCreateNullPtrType(LLVMDIBuilderRef Builder) {
1181   return wrap(unwrap(Builder)->createNullPtrType());
1182 }
1183 
1184 LLVMMetadataRef
1185 LLVMDIBuilderCreateMemberPointerType(LLVMDIBuilderRef Builder,
1186                                      LLVMMetadataRef PointeeType,
1187                                      LLVMMetadataRef ClassType,
1188                                      uint64_t SizeInBits,
1189                                      uint32_t AlignInBits,
1190                                      LLVMDIFlags Flags) {
1191   return wrap(unwrap(Builder)->createMemberPointerType(
1192                   unwrapDI<DIType>(PointeeType),
1193                   unwrapDI<DIType>(ClassType), AlignInBits, SizeInBits,
1194                   map_from_llvmDIFlags(Flags)));
1195 }
1196 
1197 LLVMMetadataRef
1198 LLVMDIBuilderCreateBitFieldMemberType(LLVMDIBuilderRef Builder,
1199                                       LLVMMetadataRef Scope,
1200                                       const char *Name, size_t NameLen,
1201                                       LLVMMetadataRef File, unsigned LineNumber,
1202                                       uint64_t SizeInBits,
1203                                       uint64_t OffsetInBits,
1204                                       uint64_t StorageOffsetInBits,
1205                                       LLVMDIFlags Flags, LLVMMetadataRef Type) {
1206   return wrap(unwrap(Builder)->createBitFieldMemberType(
1207                   unwrapDI<DIScope>(Scope), {Name, NameLen},
1208                   unwrapDI<DIFile>(File), LineNumber,
1209                   SizeInBits, OffsetInBits, StorageOffsetInBits,
1210                   map_from_llvmDIFlags(Flags), unwrapDI<DIType>(Type)));
1211 }
1212 
1213 LLVMMetadataRef LLVMDIBuilderCreateClassType(LLVMDIBuilderRef Builder,
1214     LLVMMetadataRef Scope, const char *Name, size_t NameLen,
1215     LLVMMetadataRef File, unsigned LineNumber, uint64_t SizeInBits,
1216     uint32_t AlignInBits, uint64_t OffsetInBits, LLVMDIFlags Flags,
1217     LLVMMetadataRef DerivedFrom,
1218     LLVMMetadataRef *Elements, unsigned NumElements,
1219     LLVMMetadataRef VTableHolder, LLVMMetadataRef TemplateParamsNode,
1220     const char *UniqueIdentifier, size_t UniqueIdentifierLen) {
1221   auto Elts = unwrap(Builder)->getOrCreateArray({unwrap(Elements),
1222                                                  NumElements});
1223   return wrap(unwrap(Builder)->createClassType(
1224                   unwrapDI<DIScope>(Scope), {Name, NameLen},
1225                   unwrapDI<DIFile>(File), LineNumber,
1226                   SizeInBits, AlignInBits, OffsetInBits,
1227                   map_from_llvmDIFlags(Flags), unwrapDI<DIType>(DerivedFrom),
1228                   Elts, unwrapDI<DIType>(VTableHolder),
1229                   unwrapDI<MDNode>(TemplateParamsNode),
1230                   {UniqueIdentifier, UniqueIdentifierLen}));
1231 }
1232 
1233 LLVMMetadataRef
1234 LLVMDIBuilderCreateArtificialType(LLVMDIBuilderRef Builder,
1235                                   LLVMMetadataRef Type) {
1236   return wrap(unwrap(Builder)->createArtificialType(unwrapDI<DIType>(Type)));
1237 }
1238 
1239 const char *LLVMDITypeGetName(LLVMMetadataRef DType, size_t *Length) {
1240   StringRef Str = unwrap<DIType>(DType)->getName();
1241   *Length = Str.size();
1242   return Str.data();
1243 }
1244 
1245 uint64_t LLVMDITypeGetSizeInBits(LLVMMetadataRef DType) {
1246   return unwrapDI<DIType>(DType)->getSizeInBits();
1247 }
1248 
1249 uint64_t LLVMDITypeGetOffsetInBits(LLVMMetadataRef DType) {
1250   return unwrapDI<DIType>(DType)->getOffsetInBits();
1251 }
1252 
1253 uint32_t LLVMDITypeGetAlignInBits(LLVMMetadataRef DType) {
1254   return unwrapDI<DIType>(DType)->getAlignInBits();
1255 }
1256 
1257 unsigned LLVMDITypeGetLine(LLVMMetadataRef DType) {
1258   return unwrapDI<DIType>(DType)->getLine();
1259 }
1260 
1261 LLVMDIFlags LLVMDITypeGetFlags(LLVMMetadataRef DType) {
1262   return map_to_llvmDIFlags(unwrapDI<DIType>(DType)->getFlags());
1263 }
1264 
1265 LLVMMetadataRef LLVMDIBuilderGetOrCreateTypeArray(LLVMDIBuilderRef Builder,
1266                                                   LLVMMetadataRef *Types,
1267                                                   size_t Length) {
1268   return wrap(
1269       unwrap(Builder)->getOrCreateTypeArray({unwrap(Types), Length}).get());
1270 }
1271 
1272 LLVMMetadataRef
1273 LLVMDIBuilderCreateSubroutineType(LLVMDIBuilderRef Builder,
1274                                   LLVMMetadataRef File,
1275                                   LLVMMetadataRef *ParameterTypes,
1276                                   unsigned NumParameterTypes,
1277                                   LLVMDIFlags Flags) {
1278   auto Elts = unwrap(Builder)->getOrCreateTypeArray({unwrap(ParameterTypes),
1279                                                      NumParameterTypes});
1280   return wrap(unwrap(Builder)->createSubroutineType(
1281     Elts, map_from_llvmDIFlags(Flags)));
1282 }
1283 
1284 LLVMMetadataRef LLVMDIBuilderCreateExpression(LLVMDIBuilderRef Builder,
1285                                               int64_t *Addr, size_t Length) {
1286   return wrap(unwrap(Builder)->createExpression(ArrayRef<int64_t>(Addr,
1287                                                                   Length)));
1288 }
1289 
1290 LLVMMetadataRef
1291 LLVMDIBuilderCreateConstantValueExpression(LLVMDIBuilderRef Builder,
1292                                            int64_t Value) {
1293   return wrap(unwrap(Builder)->createConstantValueExpression(Value));
1294 }
1295 
1296 LLVMMetadataRef LLVMDIBuilderCreateGlobalVariableExpression(
1297     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1298     size_t NameLen, const char *Linkage, size_t LinkLen, LLVMMetadataRef File,
1299     unsigned LineNo, LLVMMetadataRef Ty, LLVMBool LocalToUnit,
1300     LLVMMetadataRef Expr, LLVMMetadataRef Decl, uint32_t AlignInBits) {
1301   return wrap(unwrap(Builder)->createGlobalVariableExpression(
1302       unwrapDI<DIScope>(Scope), {Name, NameLen}, {Linkage, LinkLen},
1303       unwrapDI<DIFile>(File), LineNo, unwrapDI<DIType>(Ty), LocalToUnit,
1304       true, unwrap<DIExpression>(Expr), unwrapDI<MDNode>(Decl),
1305       nullptr, AlignInBits));
1306 }
1307 
1308 LLVMMetadataRef LLVMDIGlobalVariableExpressionGetVariable(LLVMMetadataRef GVE) {
1309   return wrap(unwrapDI<DIGlobalVariableExpression>(GVE)->getVariable());
1310 }
1311 
1312 LLVMMetadataRef LLVMDIGlobalVariableExpressionGetExpression(
1313     LLVMMetadataRef GVE) {
1314   return wrap(unwrapDI<DIGlobalVariableExpression>(GVE)->getExpression());
1315 }
1316 
1317 LLVMMetadataRef LLVMDIVariableGetFile(LLVMMetadataRef Var) {
1318   return wrap(unwrapDI<DIVariable>(Var)->getFile());
1319 }
1320 
1321 LLVMMetadataRef LLVMDIVariableGetScope(LLVMMetadataRef Var) {
1322   return wrap(unwrapDI<DIVariable>(Var)->getScope());
1323 }
1324 
1325 unsigned LLVMDIVariableGetLine(LLVMMetadataRef Var) {
1326   return unwrapDI<DIVariable>(Var)->getLine();
1327 }
1328 
1329 LLVMMetadataRef LLVMTemporaryMDNode(LLVMContextRef Ctx, LLVMMetadataRef *Data,
1330                                     size_t Count) {
1331   return wrap(
1332       MDTuple::getTemporary(*unwrap(Ctx), {unwrap(Data), Count}).release());
1333 }
1334 
1335 void LLVMDisposeTemporaryMDNode(LLVMMetadataRef TempNode) {
1336   MDNode::deleteTemporary(unwrapDI<MDNode>(TempNode));
1337 }
1338 
1339 void LLVMMetadataReplaceAllUsesWith(LLVMMetadataRef TargetMetadata,
1340                                     LLVMMetadataRef Replacement) {
1341   auto *Node = unwrapDI<MDNode>(TargetMetadata);
1342   Node->replaceAllUsesWith(unwrap<Metadata>(Replacement));
1343   MDNode::deleteTemporary(Node);
1344 }
1345 
1346 LLVMMetadataRef LLVMDIBuilderCreateTempGlobalVariableFwdDecl(
1347     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1348     size_t NameLen, const char *Linkage, size_t LnkLen, LLVMMetadataRef File,
1349     unsigned LineNo, LLVMMetadataRef Ty, LLVMBool LocalToUnit,
1350     LLVMMetadataRef Decl, uint32_t AlignInBits) {
1351   return wrap(unwrap(Builder)->createTempGlobalVariableFwdDecl(
1352       unwrapDI<DIScope>(Scope), {Name, NameLen}, {Linkage, LnkLen},
1353       unwrapDI<DIFile>(File), LineNo, unwrapDI<DIType>(Ty), LocalToUnit,
1354       unwrapDI<MDNode>(Decl), nullptr, AlignInBits));
1355 }
1356 
1357 LLVMValueRef
1358 LLVMDIBuilderInsertDeclareBefore(LLVMDIBuilderRef Builder, LLVMValueRef Storage,
1359                                  LLVMMetadataRef VarInfo, LLVMMetadataRef Expr,
1360                                  LLVMMetadataRef DL, LLVMValueRef Instr) {
1361   return wrap(unwrap(Builder)->insertDeclare(
1362                   unwrap(Storage), unwrap<DILocalVariable>(VarInfo),
1363                   unwrap<DIExpression>(Expr), unwrap<DILocation>(DL),
1364                   unwrap<Instruction>(Instr)));
1365 }
1366 
1367 LLVMValueRef LLVMDIBuilderInsertDeclareAtEnd(
1368     LLVMDIBuilderRef Builder, LLVMValueRef Storage, LLVMMetadataRef VarInfo,
1369     LLVMMetadataRef Expr, LLVMMetadataRef DL, LLVMBasicBlockRef Block) {
1370   return wrap(unwrap(Builder)->insertDeclare(
1371                   unwrap(Storage), unwrap<DILocalVariable>(VarInfo),
1372                   unwrap<DIExpression>(Expr), unwrap<DILocation>(DL),
1373                   unwrap(Block)));
1374 }
1375 
1376 LLVMValueRef LLVMDIBuilderInsertDbgValueBefore(LLVMDIBuilderRef Builder,
1377                                                LLVMValueRef Val,
1378                                                LLVMMetadataRef VarInfo,
1379                                                LLVMMetadataRef Expr,
1380                                                LLVMMetadataRef DebugLoc,
1381                                                LLVMValueRef Instr) {
1382   return wrap(unwrap(Builder)->insertDbgValueIntrinsic(
1383                   unwrap(Val), unwrap<DILocalVariable>(VarInfo),
1384                   unwrap<DIExpression>(Expr), unwrap<DILocation>(DebugLoc),
1385                   unwrap<Instruction>(Instr)));
1386 }
1387 
1388 LLVMValueRef LLVMDIBuilderInsertDbgValueAtEnd(LLVMDIBuilderRef Builder,
1389                                               LLVMValueRef Val,
1390                                               LLVMMetadataRef VarInfo,
1391                                               LLVMMetadataRef Expr,
1392                                               LLVMMetadataRef DebugLoc,
1393                                               LLVMBasicBlockRef Block) {
1394   return wrap(unwrap(Builder)->insertDbgValueIntrinsic(
1395                   unwrap(Val), unwrap<DILocalVariable>(VarInfo),
1396                   unwrap<DIExpression>(Expr), unwrap<DILocation>(DebugLoc),
1397                   unwrap(Block)));
1398 }
1399 
1400 LLVMMetadataRef LLVMDIBuilderCreateAutoVariable(
1401     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1402     size_t NameLen, LLVMMetadataRef File, unsigned LineNo, LLVMMetadataRef Ty,
1403     LLVMBool AlwaysPreserve, LLVMDIFlags Flags, uint32_t AlignInBits) {
1404   return wrap(unwrap(Builder)->createAutoVariable(
1405                   unwrap<DIScope>(Scope), {Name, NameLen}, unwrap<DIFile>(File),
1406                   LineNo, unwrap<DIType>(Ty), AlwaysPreserve,
1407                   map_from_llvmDIFlags(Flags), AlignInBits));
1408 }
1409 
1410 LLVMMetadataRef LLVMDIBuilderCreateParameterVariable(
1411     LLVMDIBuilderRef Builder, LLVMMetadataRef Scope, const char *Name,
1412     size_t NameLen, unsigned ArgNo, LLVMMetadataRef File, unsigned LineNo,
1413     LLVMMetadataRef Ty, LLVMBool AlwaysPreserve, LLVMDIFlags Flags) {
1414   return wrap(unwrap(Builder)->createParameterVariable(
1415                   unwrap<DIScope>(Scope), {Name, NameLen}, ArgNo, unwrap<DIFile>(File),
1416                   LineNo, unwrap<DIType>(Ty), AlwaysPreserve,
1417                   map_from_llvmDIFlags(Flags)));
1418 }
1419 
1420 LLVMMetadataRef LLVMDIBuilderGetOrCreateSubrange(LLVMDIBuilderRef Builder,
1421                                                  int64_t Lo, int64_t Count) {
1422   return wrap(unwrap(Builder)->getOrCreateSubrange(Lo, Count));
1423 }
1424 
1425 LLVMMetadataRef LLVMDIBuilderGetOrCreateArray(LLVMDIBuilderRef Builder,
1426                                               LLVMMetadataRef *Data,
1427                                               size_t Length) {
1428   Metadata **DataValue = unwrap(Data);
1429   return wrap(unwrap(Builder)->getOrCreateArray({DataValue, Length}).get());
1430 }
1431 
1432 LLVMMetadataRef LLVMGetSubprogram(LLVMValueRef Func) {
1433   return wrap(unwrap<Function>(Func)->getSubprogram());
1434 }
1435 
1436 void LLVMSetSubprogram(LLVMValueRef Func, LLVMMetadataRef SP) {
1437   unwrap<Function>(Func)->setSubprogram(unwrap<DISubprogram>(SP));
1438 }
1439 
1440 unsigned LLVMDISubprogramGetLine(LLVMMetadataRef Subprogram) {
1441   return unwrapDI<DISubprogram>(Subprogram)->getLine();
1442 }
1443 
1444 LLVMMetadataRef LLVMInstructionGetDebugLoc(LLVMValueRef Inst) {
1445   return wrap(unwrap<Instruction>(Inst)->getDebugLoc().getAsMDNode());
1446 }
1447 
1448 void LLVMInstructionSetDebugLoc(LLVMValueRef Inst, LLVMMetadataRef Loc) {
1449   if (Loc)
1450     unwrap<Instruction>(Inst)->setDebugLoc(DebugLoc(unwrap<MDNode>(Loc)));
1451   else
1452     unwrap<Instruction>(Inst)->setDebugLoc(DebugLoc());
1453 }
1454 
1455 LLVMMetadataKind LLVMGetMetadataKind(LLVMMetadataRef Metadata) {
1456   switch(unwrap(Metadata)->getMetadataID()) {
1457 #define HANDLE_METADATA_LEAF(CLASS) \
1458   case Metadata::CLASS##Kind: \
1459     return (LLVMMetadataKind)LLVM##CLASS##MetadataKind;
1460 #include "llvm/IR/Metadata.def"
1461   default:
1462     return (LLVMMetadataKind)LLVMGenericDINodeMetadataKind;
1463   }
1464 }
1465