lib/CodeGen/AsmPrinter/WinCodeViewLineTables.cpp

   1 //===-- llvm/lib/CodeGen/AsmPrinter/WinCodeViewLineTables.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 line tables info into COFF files.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "WinCodeViewLineTables.h"
  15 #include "llvm/MC/MCExpr.h"
  16 #include "llvm/MC/MCSymbol.h"
  17 #include "llvm/Support/COFF.h"
  18
  19 namespace llvm {
  20
  21 StringRef WinCodeViewLineTables::getFullFilepath(const MDNode *S) {
  22   assert(S);
  23   DIDescriptor D(S);
  24   assert((D.isCompileUnit() || D.isFile() || D.isSubprogram() ||
  25           D.isLexicalBlockFile() || D.isLexicalBlock()) &&
  26          "Unexpected scope info");
  27
  28   DIScope Scope(S);
  29   StringRef Dir = Scope.getDirectory(),
  30             Filename = Scope.getFilename();
  31   char *&Result = DirAndFilenameToFilepathMap[std::make_pair(Dir, Filename)];
  32   if (Result != 0)
  33     return Result;
  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   std::string Filepath;
  40   if (Filename.find(':') == 1)
  41     Filepath = Filename;
  42   else
  43     Filepath = (Dir + Twine("\\") + Filename).str();
  44
  45   // Canonicalize the path.  We have to do it textually because we may no longer
  46   // have access the file in the filesystem.
  47   // First, replace all slashes with backslashes.
  48   std::replace(Filepath.begin(), Filepath.end(), '/', '\\');
  49
  50   // Remove all "\.\" with "\".
  51   size_t Cursor = 0;
  52   while ((Cursor = Filepath.find("\\.\\", Cursor)) != std::string::npos)
  53     Filepath.erase(Cursor, 2);
  54
  55   // Replace all "\XXX\..\" with "\".  Don't try too hard though as the original
  56   // path should be well-formatted, e.g. start with a drive letter, etc.
  57   Cursor = 0;
  58   while ((Cursor = Filepath.find("\\..\\", Cursor)) != std::string::npos) {
  59     // Something's wrong if the path starts with "\..\", abort.
  60     if (Cursor == 0)
  61       break;
  62
  63     size_t PrevSlash = Filepath.rfind('\\', Cursor - 1);
  64     if (PrevSlash == std::string::npos)
  65       // Something's wrong, abort.
  66       break;
  67
  68     Filepath.erase(PrevSlash, Cursor + 3 - PrevSlash);
  69     // The next ".." might be following the one we've just erased.
  70     Cursor = PrevSlash;
  71   }
  72
  73   // Remove all duplicate backslashes.
  74   Cursor = 0;
  75   while ((Cursor = Filepath.find("\\\\", Cursor)) != std::string::npos)
  76     Filepath.erase(Cursor, 1);
  77
  78   Result = strdup(Filepath.c_str());
  79   return StringRef(Result);
  80 }
  81
  82 void WinCodeViewLineTables::maybeRecordLocation(DebugLoc DL,
  83                                                 const MachineFunction *MF) {
  84   const MDNode *Scope = DL.getScope(MF->getFunction()->getContext());
  85   if (!Scope)
  86     return;
  87   StringRef Filename = getFullFilepath(Scope);
  88
  89   // Skip this instruction if it has the same file:line as the previous one.
  90   assert(CurFn);
  91   if (!CurFn->Instrs.empty()) {
  92     const InstrInfoTy &LastInstr = InstrInfo[CurFn->Instrs.back()];
  93     if (LastInstr.Filename == Filename && LastInstr.LineNumber == DL.getLine())
  94       return;
  95   }
  96   FileNameRegistry.add(Filename);
  97
  98   MCSymbol *MCL = Asm->MMI->getContext().CreateTempSymbol();
  99   Asm->OutStreamer.EmitLabel(MCL);
 100   CurFn->Instrs.push_back(MCL);
 101   InstrInfo[MCL] = InstrInfoTy(Filename, DL.getLine());
 102 }
 103
 104 WinCodeViewLineTables::WinCodeViewLineTables(AsmPrinter *AP)
 105     : Asm(0), CurFn(0) {
 106   MachineModuleInfo *MMI = AP->MMI;
 107
 108   // If module doesn't have named metadata anchors or COFF debug section
 109   // is not available, skip any debug info related stuff.
 110   if (!MMI->getModule()->getNamedMetadata("llvm.dbg.cu") ||
 111       !AP->getObjFileLowering().getCOFFDebugSymbolsSection())
 112     return;
 113
 114   // Tell MMI that we have debug info.
 115   MMI->setDebugInfoAvailability(true);
 116   Asm = AP;
 117 }
 118
 119 static void EmitLabelDiff(MCStreamer &Streamer,
 120                           const MCSymbol *From, const MCSymbol *To) {
 121   MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
 122   MCContext &Context = Streamer.getContext();
 123   const MCExpr *FromRef = MCSymbolRefExpr::Create(From, Variant, Context),
 124                *ToRef   = MCSymbolRefExpr::Create(To, Variant, Context);
 125   const MCExpr *AddrDelta =
 126       MCBinaryExpr::Create(MCBinaryExpr::Sub, ToRef, FromRef, Context);
 127   Streamer.EmitValue(AddrDelta, 4);
 128 }
 129
 130 void WinCodeViewLineTables::emitDebugInfoForFunction(const Function *GV) {
 131   // For each function there is a separate subsection
 132   // which holds the PC to file:line table.
 133   const MCSymbol *Fn = Asm->getSymbol(GV);
 134   const FunctionInfo &FI = FnDebugInfo[GV];
 135   assert(Fn);
 136   assert(FI.Instrs.size() > 0);
 137
 138   // PCs/Instructions are grouped into segments sharing the same filename.
 139   // Pre-calculate the lengths (in instructions) of these segments and store
 140   // them in a map for convenience.  Each index in the map is the sequential
 141   // number of the respective instruction that starts a new segment.
 142   DenseMap<size_t, size_t> FilenameSegmentLengths;
 143   size_t LastSegmentEnd = 0;
 144   StringRef PrevFilename = InstrInfo[FI.Instrs[0]].Filename;
 145   for (size_t J = 1, F = FI.Instrs.size(); J != F; ++J) {
 146     if (PrevFilename == InstrInfo[FI.Instrs[J]].Filename)
 147       continue;
 148     FilenameSegmentLengths[LastSegmentEnd] = J - LastSegmentEnd;
 149     LastSegmentEnd = J;
 150     PrevFilename = InstrInfo[FI.Instrs[J]].Filename;
 151   }
 152   FilenameSegmentLengths[LastSegmentEnd] = FI.Instrs.size() - LastSegmentEnd;
 153
 154   // Emit the control code of the subsection followed by the payload size.
 155   Asm->OutStreamer.AddComment(
 156       "Linetable subsection for " + Twine(Fn->getName()));
 157   Asm->EmitInt32(COFF::DEBUG_LINE_TABLE_SUBSECTION);
 158   MCSymbol *SubsectionBegin = Asm->MMI->getContext().CreateTempSymbol(),
 159            *SubsectionEnd = Asm->MMI->getContext().CreateTempSymbol();
 160   EmitLabelDiff(Asm->OutStreamer, SubsectionBegin, SubsectionEnd);
 161   Asm->OutStreamer.EmitLabel(SubsectionBegin);
 162
 163   // Identify the function this subsection is for.
 164   Asm->OutStreamer.EmitCOFFSecRel32(Fn);
 165   Asm->OutStreamer.EmitCOFFSectionIndex(Fn);
 166
 167   // Length of the function's code, in bytes.
 168   EmitLabelDiff(Asm->OutStreamer, Fn, FI.End);
 169
 170   // PC-to-linenumber lookup table:
 171   MCSymbol *FileSegmentEnd = 0;
 172   for (size_t J = 0, F = FI.Instrs.size(); J != F; ++J) {
 173     MCSymbol *Instr = FI.Instrs[J];
 174     assert(InstrInfo.count(Instr));
 175
 176     if (FilenameSegmentLengths.count(J)) {
 177       // We came to a beginning of a new filename segment.
 178       if (FileSegmentEnd)
 179         Asm->OutStreamer.EmitLabel(FileSegmentEnd);
 180       StringRef CurFilename = InstrInfo[FI.Instrs[J]].Filename;
 181       assert(FileNameRegistry.Infos.count(CurFilename));
 182       size_t IndexInStringTable =
 183           FileNameRegistry.Infos[CurFilename].FilenameID;
 184       // Each segment starts with the offset of the filename
 185       // in the string table.
 186       Asm->OutStreamer.AddComment(
 187           "Segment for file '" + Twine(CurFilename) + "' begins");
 188       MCSymbol *FileSegmentBegin = Asm->MMI->getContext().CreateTempSymbol();
 189       Asm->OutStreamer.EmitLabel(FileSegmentBegin);
 190       Asm->EmitInt32(8 * IndexInStringTable);
 191
 192       // Number of PC records in the lookup table.
 193       size_t SegmentLength = FilenameSegmentLengths[J];
 194       Asm->EmitInt32(SegmentLength);
 195
 196       // Full size of the segment for this filename, including the prev two
 197       // records.
 198       FileSegmentEnd = Asm->MMI->getContext().CreateTempSymbol();
 199       EmitLabelDiff(Asm->OutStreamer, FileSegmentBegin, FileSegmentEnd);
 200     }
 201
 202     // The first PC with the given linenumber and the linenumber itself.
 203     EmitLabelDiff(Asm->OutStreamer, Fn, Instr);
 204     Asm->EmitInt32(InstrInfo[Instr].LineNumber);
 205   }
 206
 207   if (FileSegmentEnd)
 208     Asm->OutStreamer.EmitLabel(FileSegmentEnd);
 209   Asm->OutStreamer.EmitLabel(SubsectionEnd);
 210 }
 211
 212 void WinCodeViewLineTables::endModule() {
 213   if (FnDebugInfo.empty())
 214     return;
 215
 216   assert(Asm != 0);
 217   Asm->OutStreamer.SwitchSection(
 218       Asm->getObjFileLowering().getCOFFDebugSymbolsSection());
 219   Asm->EmitInt32(COFF::DEBUG_SECTION_MAGIC);
 220
 221   // The COFF .debug$S section consists of several subsections, each starting
 222   // with a 4-byte control code (e.g. 0xF1, 0xF2, etc) and then a 4-byte length
 223   // of the payload followed by the payload itself.  The subsections are 4-byte
 224   // aligned.
 225
 226   for (size_t I = 0, E = VisitedFunctions.size(); I != E; ++I)
 227     emitDebugInfoForFunction(VisitedFunctions[I]);
 228
 229   // This subsection holds a file index to offset in string table table.
 230   Asm->OutStreamer.AddComment("File index to string table offset subsection");
 231   Asm->EmitInt32(COFF::DEBUG_INDEX_SUBSECTION);
 232   size_t NumFilenames = FileNameRegistry.Infos.size();
 233   Asm->EmitInt32(8 * NumFilenames);
 234   for (size_t I = 0, E = FileNameRegistry.Filenames.size(); I != E; ++I) {
 235     StringRef Filename = FileNameRegistry.Filenames[I];
 236     // For each unique filename, just write it's offset in the string table.
 237     Asm->EmitInt32(FileNameRegistry.Infos[Filename].StartOffset);
 238     // The function name offset is not followed by any additional data.
 239     Asm->EmitInt32(0);
 240   }
 241
 242   // This subsection holds the string table.
 243   Asm->OutStreamer.AddComment("String table");
 244   Asm->EmitInt32(COFF::DEBUG_STRING_TABLE_SUBSECTION);
 245   Asm->EmitInt32(FileNameRegistry.LastOffset);
 246   // The payload starts with a null character.
 247   Asm->EmitInt8(0);
 248
 249   for (size_t I = 0, E = FileNameRegistry.Filenames.size(); I != E; ++I) {
 250     // Just emit unique filenames one by one, separated by a null character.
 251     Asm->OutStreamer.EmitBytes(FileNameRegistry.Filenames[I]);
 252     Asm->EmitInt8(0);
 253   }
 254
 255   // No more subsections. Fill with zeros to align the end of the section by 4.
 256   Asm->OutStreamer.EmitFill((-FileNameRegistry.LastOffset) % 4, 0);
 257
 258   clear();
 259 }
 260
 261 void WinCodeViewLineTables::beginFunction(const MachineFunction *MF) {
 262   assert(!CurFn && "Can't process two functions at once!");
 263
 264   if (!Asm || !Asm->MMI->hasDebugInfo())
 265     return;
 266
 267   // Grab the lexical scopes for the function, if we don't have any of those
 268   // then we're not going to be able to do anything.
 269   LScopes.initialize(*MF);
 270   if (LScopes.empty())
 271     return;
 272
 273   const Function *GV = MF->getFunction();
 274   assert(FnDebugInfo.count(GV) == false);
 275   VisitedFunctions.push_back(GV);
 276   CurFn = &FnDebugInfo[GV];
 277
 278   // Find the end of the function prolog.
 279   // FIXME: is there a simpler a way to do this? Can we just search
 280   // for the first instruction of the function, not the last of the prolog?
 281   DebugLoc PrologEndLoc;
 282   bool EmptyPrologue = true;
 283   for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
 284        I != E && PrologEndLoc.isUnknown(); ++I) {
 285     for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
 286          II != IE; ++II) {
 287       const MachineInstr *MI = II;
 288       if (MI->isDebugValue())
 289         continue;
 290
 291       // First known non-DBG_VALUE and non-frame setup location marks
 292       // the beginning of the function body.
 293       // FIXME: do we need the first subcondition?
 294       if (!MI->getFlag(MachineInstr::FrameSetup) &&
 295           (!MI->getDebugLoc().isUnknown())) {
 296         PrologEndLoc = MI->getDebugLoc();
 297         break;
 298       }
 299       EmptyPrologue = false;
 300     }
 301   }
 302   // Record beginning of function if we have a non-empty prologue.
 303   if (!PrologEndLoc.isUnknown() && !EmptyPrologue) {
 304     DebugLoc FnStartDL =
 305         PrologEndLoc.getFnDebugLoc(MF->getFunction()->getContext());
 306     maybeRecordLocation(FnStartDL, MF);
 307   }
 308 }
 309
 310 void WinCodeViewLineTables::endFunction(const MachineFunction *) {
 311   if (!Asm || !CurFn)  // We haven't created any debug info for this function.
 312     return;
 313
 314   if (CurFn->Instrs.empty())
 315     llvm_unreachable("Can this ever happen?");
 316
 317   // Define end label for subprogram.
 318   MCSymbol *FunctionEndSym = Asm->OutStreamer.getContext().CreateTempSymbol();
 319   Asm->OutStreamer.EmitLabel(FunctionEndSym);
 320   CurFn->End = FunctionEndSym;
 321   CurFn = 0;
 322 }
 323
 324 void WinCodeViewLineTables::beginInstruction(const MachineInstr *MI) {
 325   // Ignore DBG_VALUE locations and function prologue.
 326   if (!Asm || MI->isDebugValue() || MI->getFlag(MachineInstr::FrameSetup))
 327     return;
 328   DebugLoc DL = MI->getDebugLoc();
 329   if (DL == PrevInstLoc || DL.isUnknown())
 330     return;
 331   maybeRecordLocation(DL, Asm->MF);
 332 }
 333 }