1 //===- DebugTranslation.cpp - MLIR to LLVM Debug conversion ---------------===//
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 #include "DebugTranslation.h"
10 #include "mlir/Dialect/LLVMIR/LLVMDialect.h"
11 #include "llvm/IR/Metadata.h"
12 #include "llvm/IR/Module.h"
13 #include "llvm/Support/FileSystem.h"
14 #include "llvm/Support/Path.h"
15 
16 using namespace mlir;
17 using namespace mlir::LLVM;
18 using namespace mlir::LLVM::detail;
19 
20 /// A utility walker that interrupts if the operation has valid debug
21 /// information.
22 static WalkResult interruptIfValidLocation(Operation *op) {
23   return op->getLoc().isa<UnknownLoc>() ? WalkResult::advance()
24                                         : WalkResult::interrupt();
25 }
26 
27 DebugTranslation::DebugTranslation(Operation *module, llvm::Module &llvmModule)
28     : builder(llvmModule), llvmCtx(llvmModule.getContext()),
29       compileUnit(nullptr) {
30 
31   // If the module has no location information, there is nothing to do.
32   if (!module->walk(interruptIfValidLocation).wasInterrupted())
33     return;
34 
35   // TODO: Several parts of this are incorrect. Different source
36   // languages may interpret different parts of the debug information
37   // differently. Frontends will also want to pipe in various information, like
38   // flags. This is fine for now as we only emit line-table information and not
39   // types or variables. This should disappear as the debug information story
40   // evolves; i.e. when we have proper attributes for LLVM debug metadata.
41   compileUnit = builder.createCompileUnit(
42       llvm::dwarf::DW_LANG_C,
43       builder.createFile(llvmModule.getModuleIdentifier(), "/"),
44       /*Producer=*/"mlir", /*isOptimized=*/true, /*Flags=*/"", /*RV=*/0);
45 
46   // Mark this module as having debug information.
47   StringRef debugVersionKey = "Debug Info Version";
48   if (!llvmModule.getModuleFlag(debugVersionKey))
49     llvmModule.addModuleFlag(llvm::Module::Warning, debugVersionKey,
50                              llvm::DEBUG_METADATA_VERSION);
51 
52   if (auto targetTripleAttr =
53           module->getAttr(LLVM::LLVMDialect::getTargetTripleAttrName())) {
54     auto targetTriple =
55         llvm::Triple(targetTripleAttr.cast<StringAttr>().getValue());
56     if (targetTriple.isKnownWindowsMSVCEnvironment()) {
57       // Dwarf debugging files will be generated by default, unless "CodeView"
58       // is set explicitly. Windows/MSVC should use CodeView instead.
59       llvmModule.addModuleFlag(llvm::Module::Warning, "CodeView", 1);
60     }
61   }
62 }
63 
64 /// Finalize the translation of debug information.
65 void DebugTranslation::finalize() { builder.finalize(); }
66 
67 /// Attempt to extract a filename for the given loc.
68 static FileLineColLoc extractFileLoc(Location loc) {
69   if (auto fileLoc = loc.dyn_cast<FileLineColLoc>())
70     return fileLoc;
71   if (auto nameLoc = loc.dyn_cast<NameLoc>())
72     return extractFileLoc(nameLoc.getChildLoc());
73   if (auto opaqueLoc = loc.dyn_cast<OpaqueLoc>())
74     return extractFileLoc(opaqueLoc.getFallbackLocation());
75   return FileLineColLoc();
76 }
77 
78 /// Translate the debug information for the given function.
79 void DebugTranslation::translate(LLVMFuncOp func, llvm::Function &llvmFunc) {
80   // If the function doesn't have location information, there is nothing to
81   // translate.
82   if (!compileUnit || !func.walk(interruptIfValidLocation).wasInterrupted())
83     return;
84 
85   // If we are to create debug info for the function, we need to ensure that all
86   // inlinable calls in it are with debug info, otherwise the LLVM verifier will
87   // complain. For now, be more restricted and treat all calls as inlinable.
88   const bool hasCallWithoutDebugInfo =
89       func.walk([](LLVM::CallOp call) {
90             return call.getLoc().isa<UnknownLoc>() ? WalkResult::interrupt()
91                                                    : WalkResult::advance();
92           })
93           .wasInterrupted();
94   if (hasCallWithoutDebugInfo)
95     return;
96 
97   FileLineColLoc fileLoc = extractFileLoc(func.getLoc());
98   auto *file =
99       translateFile(fileLoc ? fileLoc.getFilename().strref() : "<unknown>");
100   unsigned line = fileLoc ? fileLoc.getLine() : 0;
101 
102   // TODO: This is the bare essentials for now. We will likely end
103   // up with wrapper metadata around LLVMs metadata in the future, so this
104   // doesn't need to be smart until then.
105   llvm::DISubroutineType *type =
106       builder.createSubroutineType(builder.getOrCreateTypeArray(llvm::None));
107   llvm::DISubprogram::DISPFlags spFlags = llvm::DISubprogram::SPFlagDefinition |
108                                           llvm::DISubprogram::SPFlagOptimized;
109   llvm::DISubprogram *program =
110       builder.createFunction(compileUnit, func.getName(), func.getName(), file,
111                              line, type, line, llvm::DINode::FlagZero, spFlags);
112   llvmFunc.setSubprogram(program);
113   builder.finalizeSubprogram(program);
114 }
115 
116 //===----------------------------------------------------------------------===//
117 // Locations
118 //===----------------------------------------------------------------------===//
119 
120 /// Translate the given location to an llvm debug location.
121 const llvm::DILocation *
122 DebugTranslation::translateLoc(Location loc, llvm::DILocalScope *scope) {
123   if (!compileUnit)
124     return nullptr;
125   return translateLoc(loc, scope, /*inlinedAt=*/nullptr);
126 }
127 
128 /// Translate the given location to an llvm DebugLoc.
129 const llvm::DILocation *
130 DebugTranslation::translateLoc(Location loc, llvm::DILocalScope *scope,
131                                const llvm::DILocation *inlinedAt) {
132   // LLVM doesn't have a representation for unknown.
133   if (!scope || loc.isa<UnknownLoc>())
134     return nullptr;
135 
136   // Check for a cached instance.
137   auto existingIt = locationToLoc.find(std::make_pair(loc, scope));
138   if (existingIt != locationToLoc.end())
139     return existingIt->second;
140 
141   const llvm::DILocation *llvmLoc = nullptr;
142   if (auto callLoc = loc.dyn_cast<CallSiteLoc>()) {
143     // For callsites, the caller is fed as the inlinedAt for the callee.
144     const auto *callerLoc = translateLoc(callLoc.getCaller(), scope, inlinedAt);
145     llvmLoc = translateLoc(callLoc.getCallee(), scope, callerLoc);
146 
147   } else if (auto fileLoc = loc.dyn_cast<FileLineColLoc>()) {
148     auto *file = translateFile(fileLoc.getFilename());
149     auto *fileScope = builder.createLexicalBlockFile(scope, file);
150     llvmLoc = llvm::DILocation::get(llvmCtx, fileLoc.getLine(),
151                                     fileLoc.getColumn(), fileScope,
152                                     const_cast<llvm::DILocation *>(inlinedAt));
153 
154   } else if (auto fusedLoc = loc.dyn_cast<FusedLoc>()) {
155     ArrayRef<Location> locations = fusedLoc.getLocations();
156 
157     // For fused locations, merge each of the nodes.
158     llvmLoc = translateLoc(locations.front(), scope, inlinedAt);
159     for (Location locIt : locations.drop_front()) {
160       llvmLoc = llvm::DILocation::getMergedLocation(
161           llvmLoc, translateLoc(locIt, scope, inlinedAt));
162     }
163 
164   } else if (auto nameLoc = loc.dyn_cast<NameLoc>()) {
165     llvmLoc = translateLoc(loc.cast<NameLoc>().getChildLoc(), scope, inlinedAt);
166 
167   } else if (auto opaqueLoc = loc.dyn_cast<OpaqueLoc>()) {
168     llvmLoc = translateLoc(loc.cast<OpaqueLoc>().getFallbackLocation(), scope,
169                            inlinedAt);
170   } else {
171     llvm_unreachable("unknown location kind");
172   }
173 
174   locationToLoc.try_emplace(std::make_pair(loc, scope), llvmLoc);
175   return llvmLoc;
176 }
177 
178 /// Create an llvm debug file for the given file path.
179 llvm::DIFile *DebugTranslation::translateFile(StringRef fileName) {
180   auto *&file = fileMap[fileName];
181   if (file)
182     return file;
183 
184   // Make sure the current working directory is up-to-date.
185   if (currentWorkingDir.empty())
186     llvm::sys::fs::current_path(currentWorkingDir);
187 
188   StringRef directory = currentWorkingDir;
189   SmallString<128> dirBuf;
190   SmallString<128> fileBuf;
191   if (llvm::sys::path::is_absolute(fileName)) {
192     // Strip the common prefix (if it is more than just "/") from current
193     // directory and FileName for a more space-efficient encoding.
194     auto fileIt = llvm::sys::path::begin(fileName);
195     auto fileE = llvm::sys::path::end(fileName);
196     auto curDirIt = llvm::sys::path::begin(directory);
197     auto curDirE = llvm::sys::path::end(directory);
198     for (; curDirIt != curDirE && *curDirIt == *fileIt; ++curDirIt, ++fileIt)
199       llvm::sys::path::append(dirBuf, *curDirIt);
200     if (std::distance(llvm::sys::path::begin(directory), curDirIt) == 1) {
201       // Don't strip the common prefix if it is only the root "/"  since that
202       // would make LLVM diagnostic locations confusing.
203       directory = StringRef();
204     } else {
205       for (; fileIt != fileE; ++fileIt)
206         llvm::sys::path::append(fileBuf, *fileIt);
207       directory = dirBuf;
208       fileName = fileBuf;
209     }
210   }
211   return (file = builder.createFile(fileName, directory));
212 }
213