1 //===-- llvm/lib/CodeGen/AsmPrinter/CodeViewDebug.cpp --*- C++ -*--===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains support for writing Microsoft CodeView debug info.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CodeViewDebug.h"
15 #include "llvm/DebugInfo/CodeView/CodeView.h"
16 #include "llvm/DebugInfo/CodeView/Line.h"
17 #include "llvm/DebugInfo/CodeView/SymbolRecord.h"
18 #include "llvm/DebugInfo/CodeView/TypeIndex.h"
19 #include "llvm/DebugInfo/CodeView/TypeRecord.h"
20 #include "llvm/MC/MCExpr.h"
21 #include "llvm/MC/MCSymbol.h"
22 #include "llvm/Support/COFF.h"
23 
24 using namespace llvm::codeview;
25 
26 namespace llvm {
27 
28 StringRef CodeViewDebug::getFullFilepath(const DIFile *File) {
29   std::string &Filepath = FileToFilepathMap[File];
30   if (!Filepath.empty())
31     return Filepath;
32 
33   StringRef Dir = File->getDirectory(), Filename = File->getFilename();
34 
35   // Clang emits directory and relative filename info into the IR, but CodeView
36   // operates on full paths.  We could change Clang to emit full paths too, but
37   // that would increase the IR size and probably not needed for other users.
38   // For now, just concatenate and canonicalize the path here.
39   if (Filename.find(':') == 1)
40     Filepath = Filename;
41   else
42     Filepath = (Dir + "\\" + Filename).str();
43 
44   // Canonicalize the path.  We have to do it textually because we may no longer
45   // have access the file in the filesystem.
46   // First, replace all slashes with backslashes.
47   std::replace(Filepath.begin(), Filepath.end(), '/', '\\');
48 
49   // Remove all "\.\" with "\".
50   size_t Cursor = 0;
51   while ((Cursor = Filepath.find("\\.\\", Cursor)) != std::string::npos)
52     Filepath.erase(Cursor, 2);
53 
54   // Replace all "\XXX\..\" with "\".  Don't try too hard though as the original
55   // path should be well-formatted, e.g. start with a drive letter, etc.
56   Cursor = 0;
57   while ((Cursor = Filepath.find("\\..\\", Cursor)) != std::string::npos) {
58     // Something's wrong if the path starts with "\..\", abort.
59     if (Cursor == 0)
60       break;
61 
62     size_t PrevSlash = Filepath.rfind('\\', Cursor - 1);
63     if (PrevSlash == std::string::npos)
64       // Something's wrong, abort.
65       break;
66 
67     Filepath.erase(PrevSlash, Cursor + 3 - PrevSlash);
68     // The next ".." might be following the one we've just erased.
69     Cursor = PrevSlash;
70   }
71 
72   // Remove all duplicate backslashes.
73   Cursor = 0;
74   while ((Cursor = Filepath.find("\\\\", Cursor)) != std::string::npos)
75     Filepath.erase(Cursor, 1);
76 
77   return Filepath;
78 }
79 
80 unsigned CodeViewDebug::maybeRecordFile(const DIFile *F) {
81   unsigned NextId = FileIdMap.size() + 1;
82   auto Insertion = FileIdMap.insert(std::make_pair(F, NextId));
83   if (Insertion.second) {
84     // We have to compute the full filepath and emit a .cv_file directive.
85     StringRef FullPath = getFullFilepath(F);
86     NextId = OS.EmitCVFileDirective(NextId, FullPath);
87     assert(NextId == FileIdMap.size() && ".cv_file directive failed");
88   }
89   return Insertion.first->second;
90 }
91 
92 CodeViewDebug::InlineSite &CodeViewDebug::getInlineSite(const DILocation *Loc) {
93   const DILocation *InlinedAt = Loc->getInlinedAt();
94   auto Insertion = CurFn->InlineSites.insert({InlinedAt, InlineSite()});
95   if (Insertion.second) {
96     InlineSite &Site = Insertion.first->second;
97     Site.SiteFuncId = NextFuncId++;
98     Site.Inlinee = Loc->getScope()->getSubprogram();
99     InlinedSubprograms.insert(Loc->getScope()->getSubprogram());
100   }
101   return Insertion.first->second;
102 }
103 
104 void CodeViewDebug::maybeRecordLocation(DebugLoc DL,
105                                         const MachineFunction *MF) {
106   // Skip this instruction if it has the same location as the previous one.
107   if (DL == CurFn->LastLoc)
108     return;
109 
110   const DIScope *Scope = DL.get()->getScope();
111   if (!Scope)
112     return;
113 
114   // Skip this line if it is longer than the maximum we can record.
115   LineInfo LI(DL.getLine(), DL.getLine(), /*IsStatement=*/true);
116   if (LI.getStartLine() != DL.getLine() || LI.isAlwaysStepInto() ||
117       LI.isNeverStepInto())
118     return;
119 
120   ColumnInfo CI(DL.getCol(), /*EndColumn=*/0);
121   if (CI.getStartColumn() != DL.getCol())
122     return;
123 
124   if (!CurFn->HaveLineInfo)
125     CurFn->HaveLineInfo = true;
126   unsigned FileId = 0;
127   if (CurFn->LastLoc.get() && CurFn->LastLoc->getFile() == DL->getFile())
128     FileId = CurFn->LastFileId;
129   else
130     FileId = CurFn->LastFileId = maybeRecordFile(DL->getFile());
131   CurFn->LastLoc = DL;
132 
133   unsigned FuncId = CurFn->FuncId;
134   if (const DILocation *Loc = DL->getInlinedAt()) {
135     // If this location was actually inlined from somewhere else, give it the ID
136     // of the inline call site.
137     FuncId = getInlineSite(DL.get()).SiteFuncId;
138     // Ensure we have links in the tree of inline call sites.
139     const DILocation *ChildLoc = nullptr;
140     while (Loc->getInlinedAt()) {
141       InlineSite &Site = getInlineSite(Loc);
142       if (ChildLoc) {
143         // Record the child inline site if not already present.
144         auto B = Site.ChildSites.begin(), E = Site.ChildSites.end();
145         if (std::find(B, E, Loc) != E)
146           break;
147         Site.ChildSites.push_back(Loc);
148       }
149       ChildLoc = Loc;
150     }
151   }
152 
153   OS.EmitCVLocDirective(FuncId, FileId, DL.getLine(), DL.getCol(),
154                         /*PrologueEnd=*/false,
155                         /*IsStmt=*/false, DL->getFilename());
156 }
157 
158 CodeViewDebug::CodeViewDebug(AsmPrinter *AP)
159     : Asm(AP), OS(*Asm->OutStreamer), CurFn(nullptr) {
160   MachineModuleInfo *MMI = AP->MMI;
161 
162   // If module doesn't have named metadata anchors or COFF debug section
163   // is not available, skip any debug info related stuff.
164   if (!MMI->getModule()->getNamedMetadata("llvm.dbg.cu") ||
165       !AP->getObjFileLowering().getCOFFDebugSymbolsSection()) {
166     Asm = nullptr;
167     return;
168   }
169 
170   // Tell MMI that we have debug info.
171   MMI->setDebugInfoAvailability(true);
172 }
173 
174 void CodeViewDebug::endModule() {
175   if (FnDebugInfo.empty())
176     return;
177 
178   emitTypeInformation();
179 
180   // FIXME: For functions that are comdat, we should emit separate .debug$S
181   // sections that are comdat associative with the main function instead of
182   // having one big .debug$S section.
183   assert(Asm != nullptr);
184   OS.SwitchSection(Asm->getObjFileLowering().getCOFFDebugSymbolsSection());
185   OS.AddComment("Debug section magic");
186   OS.EmitIntValue(COFF::DEBUG_SECTION_MAGIC, 4);
187 
188   // The COFF .debug$S section consists of several subsections, each starting
189   // with a 4-byte control code (e.g. 0xF1, 0xF2, etc) and then a 4-byte length
190   // of the payload followed by the payload itself.  The subsections are 4-byte
191   // aligned.
192 
193   // Make a subsection for all the inlined subprograms.
194   emitInlineeLinesSubsection();
195 
196   // Emit per-function debug information.
197   for (auto &P : FnDebugInfo)
198     emitDebugInfoForFunction(P.first, P.second);
199 
200   // This subsection holds a file index to offset in string table table.
201   OS.AddComment("File index to string table offset subsection");
202   OS.EmitCVFileChecksumsDirective();
203 
204   // This subsection holds the string table.
205   OS.AddComment("String table");
206   OS.EmitCVStringTableDirective();
207 
208   clear();
209 }
210 
211 void CodeViewDebug::emitTypeInformation() {
212   // Start the .debug$T section with 0x4.
213   OS.SwitchSection(Asm->getObjFileLowering().getCOFFDebugTypesSection());
214   OS.AddComment("Debug section magic");
215   OS.EmitIntValue(COFF::DEBUG_SECTION_MAGIC, 4);
216 
217   NamedMDNode *CU_Nodes =
218       Asm->MMI->getModule()->getNamedMetadata("llvm.dbg.cu");
219   if (!CU_Nodes)
220     return;
221 
222   // This type info currently only holds function ids for use with inline call
223   // frame info. All functions are assigned a simple 'void ()' type. Emit that
224   // type here.
225   TypeIndex ArgListIdx = getNextTypeIndex();
226   OS.AddComment("Type record length");
227   OS.EmitIntValue(2 + sizeof(ArgList), 2);
228   OS.AddComment("Leaf type: LF_ARGLIST");
229   OS.EmitIntValue(LF_ARGLIST, 2);
230   OS.AddComment("Number of arguments");
231   OS.EmitIntValue(0, 4);
232 
233   TypeIndex VoidProcIdx = getNextTypeIndex();
234   OS.AddComment("Type record length");
235   OS.EmitIntValue(2 + sizeof(ProcedureType), 2);
236   OS.AddComment("Leaf type: LF_PROCEDURE");
237   OS.EmitIntValue(LF_PROCEDURE, 2);
238   OS.AddComment("Return type index");
239   OS.EmitIntValue(TypeIndex::Void().getIndex(), 4);
240   OS.AddComment("Calling convention");
241   OS.EmitIntValue(char(CallingConvention::NearC), 1);
242   OS.AddComment("Function options");
243   OS.EmitIntValue(char(FunctionOptions::None), 1);
244   OS.AddComment("# of parameters");
245   OS.EmitIntValue(0, 2);
246   OS.AddComment("Argument list type index");
247   OS.EmitIntValue(ArgListIdx.getIndex(), 4);
248 
249   for (MDNode *N : CU_Nodes->operands()) {
250     auto *CUNode = cast<DICompileUnit>(N);
251     for (auto *SP : CUNode->getSubprograms()) {
252       StringRef DisplayName = SP->getDisplayName();
253       OS.AddComment("Type record length");
254       OS.EmitIntValue(2 + sizeof(FuncId) + DisplayName.size() + 1, 2);
255       OS.AddComment("Leaf type: LF_FUNC_ID");
256       OS.EmitIntValue(LF_FUNC_ID, 2);
257 
258       OS.AddComment("Scope type index");
259       OS.EmitIntValue(TypeIndex().getIndex(), 4);
260       OS.AddComment("Function type");
261       OS.EmitIntValue(VoidProcIdx.getIndex(), 4);
262       {
263         SmallString<32> NullTerminatedString(DisplayName);
264         if (NullTerminatedString.empty() || NullTerminatedString.back() != '\0')
265           NullTerminatedString.push_back('\0');
266         OS.AddComment("Function name");
267         OS.EmitBytes(NullTerminatedString);
268       }
269 
270       TypeIndex FuncIdIdx = getNextTypeIndex();
271       SubprogramToFuncId.insert(std::make_pair(SP, FuncIdIdx));
272     }
273   }
274 }
275 
276 void CodeViewDebug::emitInlineeLinesSubsection() {
277   if (InlinedSubprograms.empty())
278     return;
279 
280   MCSymbol *InlineBegin = Asm->MMI->getContext().createTempSymbol(),
281            *InlineEnd = Asm->MMI->getContext().createTempSymbol();
282 
283   OS.AddComment("Inlinee lines subsection");
284   OS.EmitIntValue(unsigned(ModuleSubstreamKind::InlineeLines), 4);
285   OS.AddComment("Subsection size");
286   OS.emitAbsoluteSymbolDiff(InlineEnd, InlineBegin, 4);
287   OS.EmitLabel(InlineBegin);
288 
289   // We don't provide any extra file info.
290   // FIXME: Find out if debuggers use this info.
291   OS.AddComment("Inlinee lines signature");
292   OS.EmitIntValue(unsigned(InlineeLinesSignature::Normal), 4);
293 
294   for (const DISubprogram *SP : InlinedSubprograms) {
295     OS.AddBlankLine();
296     TypeIndex TypeId = SubprogramToFuncId[SP];
297     unsigned FileId = maybeRecordFile(SP->getFile());
298     OS.AddComment("Inlined function " + SP->getDisplayName() + " starts at " +
299                   SP->getFilename() + Twine(':') + Twine(SP->getLine()));
300     OS.AddBlankLine();
301     // The filechecksum table uses 8 byte entries for now, and file ids start at
302     // 1.
303     unsigned FileOffset = (FileId - 1) * 8;
304     OS.AddComment("Type index of inlined function");
305     OS.EmitIntValue(TypeId.getIndex(), 4);
306     OS.AddComment("Offset into filechecksum table");
307     OS.EmitIntValue(FileOffset, 4);
308     OS.AddComment("Starting line number");
309     OS.EmitIntValue(SP->getLine(), 4);
310   }
311 
312   OS.EmitLabel(InlineEnd);
313 }
314 
315 void CodeViewDebug::collectInlineSiteChildren(
316     SmallVectorImpl<unsigned> &Children, const FunctionInfo &FI,
317     const InlineSite &Site) {
318   for (const DILocation *ChildSiteLoc : Site.ChildSites) {
319     auto I = FI.InlineSites.find(ChildSiteLoc);
320     assert(I != FI.InlineSites.end());
321     const InlineSite &ChildSite = I->second;
322     Children.push_back(ChildSite.SiteFuncId);
323     collectInlineSiteChildren(Children, FI, ChildSite);
324   }
325 }
326 
327 void CodeViewDebug::emitInlinedCallSite(const FunctionInfo &FI,
328                                         const DILocation *InlinedAt,
329                                         const InlineSite &Site) {
330   MCSymbol *InlineBegin = Asm->MMI->getContext().createTempSymbol(),
331            *InlineEnd = Asm->MMI->getContext().createTempSymbol();
332 
333   assert(SubprogramToFuncId.count(Site.Inlinee));
334   TypeIndex InlineeIdx = SubprogramToFuncId[Site.Inlinee];
335 
336   // SymbolRecord
337   OS.AddComment("Record length");
338   OS.emitAbsoluteSymbolDiff(InlineEnd, InlineBegin, 2);   // RecordLength
339   OS.EmitLabel(InlineBegin);
340   OS.AddComment("Record kind: S_INLINESITE");
341   OS.EmitIntValue(SymbolRecordKind::S_INLINESITE, 2); // RecordKind
342 
343   OS.AddComment("PtrParent");
344   OS.EmitIntValue(0, 4);
345   OS.AddComment("PtrEnd");
346   OS.EmitIntValue(0, 4);
347   OS.AddComment("Inlinee type index");
348   OS.EmitIntValue(InlineeIdx.getIndex(), 4);
349 
350   unsigned FileId = maybeRecordFile(Site.Inlinee->getFile());
351   unsigned StartLineNum = Site.Inlinee->getLine();
352   SmallVector<unsigned, 3> SecondaryFuncIds;
353   collectInlineSiteChildren(SecondaryFuncIds, FI, Site);
354 
355   OS.EmitCVInlineLinetableDirective(Site.SiteFuncId, FileId, StartLineNum,
356                                     FI.Begin, FI.End, SecondaryFuncIds);
357 
358   OS.EmitLabel(InlineEnd);
359 
360   // Recurse on child inlined call sites before closing the scope.
361   for (const DILocation *ChildSite : Site.ChildSites) {
362     auto I = FI.InlineSites.find(ChildSite);
363     assert(I != FI.InlineSites.end() &&
364            "child site not in function inline site map");
365     emitInlinedCallSite(FI, ChildSite, I->second);
366   }
367 
368   // Close the scope.
369   OS.AddComment("Record length");
370   OS.EmitIntValue(2, 2);                                  // RecordLength
371   OS.AddComment("Record kind: S_INLINESITE_END");
372   OS.EmitIntValue(SymbolRecordKind::S_INLINESITE_END, 2); // RecordKind
373 }
374 
375 void CodeViewDebug::emitDebugInfoForFunction(const Function *GV,
376                                              FunctionInfo &FI) {
377   // For each function there is a separate subsection
378   // which holds the PC to file:line table.
379   const MCSymbol *Fn = Asm->getSymbol(GV);
380   assert(Fn);
381 
382   StringRef FuncName;
383   if (auto *SP = getDISubprogram(GV))
384     FuncName = SP->getDisplayName();
385 
386   // If our DISubprogram name is empty, use the mangled name.
387   if (FuncName.empty())
388     FuncName = GlobalValue::getRealLinkageName(GV->getName());
389 
390   // Emit a symbol subsection, required by VS2012+ to find function boundaries.
391   MCSymbol *SymbolsBegin = Asm->MMI->getContext().createTempSymbol(),
392            *SymbolsEnd = Asm->MMI->getContext().createTempSymbol();
393   OS.AddComment("Symbol subsection for " + Twine(FuncName));
394   OS.EmitIntValue(unsigned(ModuleSubstreamKind::Symbols), 4);
395   OS.AddComment("Subsection size");
396   OS.emitAbsoluteSymbolDiff(SymbolsEnd, SymbolsBegin, 4);
397   OS.EmitLabel(SymbolsBegin);
398   {
399     MCSymbol *ProcRecordBegin = Asm->MMI->getContext().createTempSymbol(),
400              *ProcRecordEnd = Asm->MMI->getContext().createTempSymbol();
401     OS.AddComment("Record length");
402     OS.emitAbsoluteSymbolDiff(ProcRecordEnd, ProcRecordBegin, 2);
403     OS.EmitLabel(ProcRecordBegin);
404 
405     OS.AddComment("Record kind: S_GPROC32_ID");
406     OS.EmitIntValue(unsigned(SymbolRecordKind::S_GPROC32_ID), 2);
407 
408     // These fields are filled in by tools like CVPACK which run after the fact.
409     OS.AddComment("PtrParent");
410     OS.EmitIntValue(0, 4);
411     OS.AddComment("PtrEnd");
412     OS.EmitIntValue(0, 4);
413     OS.AddComment("PtrNext");
414     OS.EmitIntValue(0, 4);
415     // This is the important bit that tells the debugger where the function
416     // code is located and what's its size:
417     OS.AddComment("Code size");
418     OS.emitAbsoluteSymbolDiff(FI.End, Fn, 4);
419     OS.AddComment("Offset after prologue");
420     OS.EmitIntValue(0, 4);
421     OS.AddComment("Offset before epilogue");
422     OS.EmitIntValue(0, 4);
423     OS.AddComment("Function type index");
424     OS.EmitIntValue(0, 4);
425     OS.AddComment("Function section relative address");
426     OS.EmitCOFFSecRel32(Fn);
427     OS.AddComment("Function section index");
428     OS.EmitCOFFSectionIndex(Fn);
429     OS.AddComment("Flags");
430     OS.EmitIntValue(0, 1);
431     // Emit the function display name as a null-terminated string.
432     OS.AddComment("Function name");
433     {
434       SmallString<32> NullTerminatedString(FuncName);
435       if (NullTerminatedString.empty() || NullTerminatedString.back() != '\0')
436         NullTerminatedString.push_back('\0');
437       OS.EmitBytes(NullTerminatedString);
438     }
439     OS.EmitLabel(ProcRecordEnd);
440 
441     // Emit inlined call site information. Only emit functions inlined directly
442     // into the parent function. We'll emit the other sites recursively as part
443     // of their parent inline site.
444     for (auto &KV : FI.InlineSites) {
445       const DILocation *InlinedAt = KV.first;
446       if (!InlinedAt->getInlinedAt())
447         emitInlinedCallSite(FI, InlinedAt, KV.second);
448     }
449 
450     // We're done with this function.
451     OS.AddComment("Record length");
452     OS.EmitIntValue(0x0002, 2);
453     OS.AddComment("Record kind: S_PROC_ID_END");
454     OS.EmitIntValue(unsigned(SymbolRecordKind::S_PROC_ID_END), 2);
455   }
456   OS.EmitLabel(SymbolsEnd);
457   // Every subsection must be aligned to a 4-byte boundary.
458   OS.EmitValueToAlignment(4);
459 
460   // We have an assembler directive that takes care of the whole line table.
461   OS.EmitCVLinetableDirective(FI.FuncId, Fn, FI.End);
462 }
463 
464 void CodeViewDebug::beginFunction(const MachineFunction *MF) {
465   assert(!CurFn && "Can't process two functions at once!");
466 
467   if (!Asm || !Asm->MMI->hasDebugInfo())
468     return;
469 
470   const Function *GV = MF->getFunction();
471   assert(FnDebugInfo.count(GV) == false);
472   CurFn = &FnDebugInfo[GV];
473   CurFn->FuncId = NextFuncId++;
474   CurFn->Begin = Asm->getFunctionBegin();
475 
476   // Find the end of the function prolog.
477   // FIXME: is there a simpler a way to do this? Can we just search
478   // for the first instruction of the function, not the last of the prolog?
479   DebugLoc PrologEndLoc;
480   bool EmptyPrologue = true;
481   for (const auto &MBB : *MF) {
482     if (PrologEndLoc)
483       break;
484     for (const auto &MI : MBB) {
485       if (MI.isDebugValue())
486         continue;
487 
488       // First known non-DBG_VALUE and non-frame setup location marks
489       // the beginning of the function body.
490       // FIXME: do we need the first subcondition?
491       if (!MI.getFlag(MachineInstr::FrameSetup) && MI.getDebugLoc()) {
492         PrologEndLoc = MI.getDebugLoc();
493         break;
494       }
495       EmptyPrologue = false;
496     }
497   }
498   // Record beginning of function if we have a non-empty prologue.
499   if (PrologEndLoc && !EmptyPrologue) {
500     DebugLoc FnStartDL = PrologEndLoc.getFnDebugLoc();
501     maybeRecordLocation(FnStartDL, MF);
502   }
503 }
504 
505 void CodeViewDebug::endFunction(const MachineFunction *MF) {
506   if (!Asm || !CurFn)  // We haven't created any debug info for this function.
507     return;
508 
509   const Function *GV = MF->getFunction();
510   assert(FnDebugInfo.count(GV));
511   assert(CurFn == &FnDebugInfo[GV]);
512 
513   // Don't emit anything if we don't have any line tables.
514   if (!CurFn->HaveLineInfo) {
515     FnDebugInfo.erase(GV);
516   } else {
517     CurFn->End = Asm->getFunctionEnd();
518   }
519   CurFn = nullptr;
520 }
521 
522 void CodeViewDebug::beginInstruction(const MachineInstr *MI) {
523   // Ignore DBG_VALUE locations and function prologue.
524   if (!Asm || MI->isDebugValue() || MI->getFlag(MachineInstr::FrameSetup))
525     return;
526   DebugLoc DL = MI->getDebugLoc();
527   if (DL == PrevInstLoc || !DL)
528     return;
529   maybeRecordLocation(DL, Asm->MF);
530 }
531 }
532