1 //===--- DependencyFile.cpp - Generate dependency file --------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This code generates dependency files.
12 //===----------------------------------------------------------------------===//
14 #include "clang/Frontend/Utils.h"
15 #include "clang/Basic/FileManager.h"
16 #include "clang/Basic/SourceManager.h"
17 #include "clang/Frontend/DependencyOutputOptions.h"
18 #include "clang/Frontend/FrontendDiagnostic.h"
19 #include "clang/Lex/DirectoryLookup.h"
20 #include "clang/Lex/LexDiagnostic.h"
21 #include "clang/Lex/ModuleMap.h"
22 #include "clang/Lex/PPCallbacks.h"
23 #include "clang/Lex/Preprocessor.h"
24 #include "clang/Serialization/ASTReader.h"
25 #include "llvm/ADT/StringSet.h"
26 #include "llvm/ADT/StringSwitch.h"
27 #include "llvm/Support/FileSystem.h"
28 #include "llvm/Support/Path.h"
29 #include "llvm/Support/raw_ostream.h"
31 using namespace clang;
34 struct DepCollectorPPCallbacks : public PPCallbacks {
35 DependencyCollector &DepCollector;
37 DepCollectorPPCallbacks(DependencyCollector &L, SourceManager &SM)
38 : DepCollector(L), SM(SM) { }
40 void FileChanged(SourceLocation Loc, FileChangeReason Reason,
41 SrcMgr::CharacteristicKind FileType,
42 FileID PrevFID) override {
43 if (Reason != PPCallbacks::EnterFile)
46 // Dependency generation really does want to go all the way to the
47 // file entry for a source location to find out what is depended on.
48 // We do not want #line markers to affect dependency generation!
50 SM.getFileEntryForID(SM.getFileID(SM.getExpansionLoc(Loc)));
55 llvm::sys::path::remove_leading_dotslash(FE->getName());
57 DepCollector.maybeAddDependency(Filename, /*FromModule*/false,
58 FileType != SrcMgr::C_User,
59 /*IsModuleFile*/false, /*IsMissing*/false);
62 void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok,
63 StringRef FileName, bool IsAngled,
64 CharSourceRange FilenameRange, const FileEntry *File,
65 StringRef SearchPath, StringRef RelativePath,
66 const Module *Imported) override {
68 DepCollector.maybeAddDependency(FileName, /*FromModule*/false,
69 /*IsSystem*/false, /*IsModuleFile*/false,
71 // Files that actually exist are handled by FileChanged.
74 void EndOfMainFile() override {
75 DepCollector.finishedMainFile();
79 struct DepCollectorMMCallbacks : public ModuleMapCallbacks {
80 DependencyCollector &DepCollector;
81 DepCollectorMMCallbacks(DependencyCollector &DC) : DepCollector(DC) {}
83 void moduleMapFileRead(SourceLocation Loc, const FileEntry &Entry,
84 bool IsSystem) override {
85 StringRef Filename = Entry.getName();
86 DepCollector.maybeAddDependency(Filename, /*FromModule*/false,
88 /*IsModuleFile*/false,
93 struct DepCollectorASTListener : public ASTReaderListener {
94 DependencyCollector &DepCollector;
95 DepCollectorASTListener(DependencyCollector &L) : DepCollector(L) { }
96 bool needsInputFileVisitation() override { return true; }
97 bool needsSystemInputFileVisitation() override {
98 return DepCollector.needSystemDependencies();
100 void visitModuleFile(StringRef Filename,
101 serialization::ModuleKind Kind) override {
102 DepCollector.maybeAddDependency(Filename, /*FromModule*/true,
103 /*IsSystem*/false, /*IsModuleFile*/true,
106 bool visitInputFile(StringRef Filename, bool IsSystem,
107 bool IsOverridden, bool IsExplicitModule) override {
108 if (IsOverridden || IsExplicitModule)
111 DepCollector.maybeAddDependency(Filename, /*FromModule*/true, IsSystem,
112 /*IsModuleFile*/false, /*IsMissing*/false);
116 } // end anonymous namespace
118 void DependencyCollector::maybeAddDependency(StringRef Filename, bool FromModule,
119 bool IsSystem, bool IsModuleFile,
121 if (Seen.insert(Filename).second &&
122 sawDependency(Filename, FromModule, IsSystem, IsModuleFile, IsMissing))
123 Dependencies.push_back(Filename);
126 static bool isSpecialFilename(StringRef Filename) {
127 return llvm::StringSwitch<bool>(Filename)
128 .Case("<built-in>", true)
129 .Case("<stdin>", true)
133 bool DependencyCollector::sawDependency(StringRef Filename, bool FromModule,
134 bool IsSystem, bool IsModuleFile,
136 return !isSpecialFilename(Filename) &&
137 (needSystemDependencies() || !IsSystem);
140 DependencyCollector::~DependencyCollector() { }
141 void DependencyCollector::attachToPreprocessor(Preprocessor &PP) {
143 llvm::make_unique<DepCollectorPPCallbacks>(*this, PP.getSourceManager()));
144 PP.getHeaderSearchInfo().getModuleMap().addModuleMapCallbacks(
145 llvm::make_unique<DepCollectorMMCallbacks>(*this));
147 void DependencyCollector::attachToASTReader(ASTReader &R) {
148 R.addListener(llvm::make_unique<DepCollectorASTListener>(*this));
152 /// Private implementation for DependencyFileGenerator
153 class DFGImpl : public PPCallbacks {
154 std::vector<std::string> Files;
155 llvm::StringSet<> FilesSet;
156 const Preprocessor *PP;
157 std::string OutputFile;
158 std::vector<std::string> Targets;
159 bool IncludeSystemHeaders;
161 bool AddMissingHeaderDeps;
162 bool SeenMissingHeader;
163 bool IncludeModuleFiles;
164 DependencyOutputFormat OutputFormat;
167 bool FileMatchesDepCriteria(const char *Filename,
168 SrcMgr::CharacteristicKind FileType);
169 void OutputDependencyFile();
172 DFGImpl(const Preprocessor *_PP, const DependencyOutputOptions &Opts)
173 : PP(_PP), OutputFile(Opts.OutputFile), Targets(Opts.Targets),
174 IncludeSystemHeaders(Opts.IncludeSystemHeaders),
175 PhonyTarget(Opts.UsePhonyTargets),
176 AddMissingHeaderDeps(Opts.AddMissingHeaderDeps),
177 SeenMissingHeader(false),
178 IncludeModuleFiles(Opts.IncludeModuleFiles),
179 OutputFormat(Opts.OutputFormat) {
180 for (const auto &ExtraDep : Opts.ExtraDeps) {
181 AddFilename(ExtraDep);
185 void FileChanged(SourceLocation Loc, FileChangeReason Reason,
186 SrcMgr::CharacteristicKind FileType,
187 FileID PrevFID) override;
188 void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok,
189 StringRef FileName, bool IsAngled,
190 CharSourceRange FilenameRange, const FileEntry *File,
191 StringRef SearchPath, StringRef RelativePath,
192 const Module *Imported) override;
194 void EndOfMainFile() override {
195 OutputDependencyFile();
198 void AddFilename(StringRef Filename);
199 bool includeSystemHeaders() const { return IncludeSystemHeaders; }
200 bool includeModuleFiles() const { return IncludeModuleFiles; }
203 class DFGMMCallback : public ModuleMapCallbacks {
206 DFGMMCallback(DFGImpl &Parent) : Parent(Parent) {}
207 void moduleMapFileRead(SourceLocation Loc, const FileEntry &Entry,
208 bool IsSystem) override {
209 if (!IsSystem || Parent.includeSystemHeaders())
210 Parent.AddFilename(Entry.getName());
214 class DFGASTReaderListener : public ASTReaderListener {
217 DFGASTReaderListener(DFGImpl &Parent)
219 bool needsInputFileVisitation() override { return true; }
220 bool needsSystemInputFileVisitation() override {
221 return Parent.includeSystemHeaders();
223 void visitModuleFile(StringRef Filename,
224 serialization::ModuleKind Kind) override;
225 bool visitInputFile(StringRef Filename, bool isSystem,
226 bool isOverridden, bool isExplicitModule) override;
230 DependencyFileGenerator::DependencyFileGenerator(void *Impl)
233 DependencyFileGenerator *DependencyFileGenerator::CreateAndAttachToPreprocessor(
234 clang::Preprocessor &PP, const clang::DependencyOutputOptions &Opts) {
236 if (Opts.Targets.empty()) {
237 PP.getDiagnostics().Report(diag::err_fe_dependency_file_requires_MT);
241 // Disable the "file not found" diagnostic if the -MG option was given.
242 if (Opts.AddMissingHeaderDeps)
243 PP.SetSuppressIncludeNotFoundError(true);
245 DFGImpl *Callback = new DFGImpl(&PP, Opts);
246 PP.addPPCallbacks(std::unique_ptr<PPCallbacks>(Callback));
247 PP.getHeaderSearchInfo().getModuleMap().addModuleMapCallbacks(
248 llvm::make_unique<DFGMMCallback>(*Callback));
249 return new DependencyFileGenerator(Callback);
252 void DependencyFileGenerator::AttachToASTReader(ASTReader &R) {
253 DFGImpl *I = reinterpret_cast<DFGImpl *>(Impl);
254 assert(I && "missing implementation");
255 R.addListener(llvm::make_unique<DFGASTReaderListener>(*I));
258 /// FileMatchesDepCriteria - Determine whether the given Filename should be
259 /// considered as a dependency.
260 bool DFGImpl::FileMatchesDepCriteria(const char *Filename,
261 SrcMgr::CharacteristicKind FileType) {
262 if (isSpecialFilename(Filename))
265 if (IncludeSystemHeaders)
268 return FileType == SrcMgr::C_User;
271 void DFGImpl::FileChanged(SourceLocation Loc,
272 FileChangeReason Reason,
273 SrcMgr::CharacteristicKind FileType,
275 if (Reason != PPCallbacks::EnterFile)
278 // Dependency generation really does want to go all the way to the
279 // file entry for a source location to find out what is depended on.
280 // We do not want #line markers to affect dependency generation!
281 SourceManager &SM = PP->getSourceManager();
283 const FileEntry *FE =
284 SM.getFileEntryForID(SM.getFileID(SM.getExpansionLoc(Loc)));
287 StringRef Filename = FE->getName();
288 if (!FileMatchesDepCriteria(Filename.data(), FileType))
291 AddFilename(llvm::sys::path::remove_leading_dotslash(Filename));
294 void DFGImpl::InclusionDirective(SourceLocation HashLoc,
295 const Token &IncludeTok,
298 CharSourceRange FilenameRange,
299 const FileEntry *File,
300 StringRef SearchPath,
301 StringRef RelativePath,
302 const Module *Imported) {
304 if (AddMissingHeaderDeps)
305 AddFilename(FileName);
307 SeenMissingHeader = true;
311 void DFGImpl::AddFilename(StringRef Filename) {
312 if (FilesSet.insert(Filename).second)
313 Files.push_back(Filename);
316 /// Print the filename, with escaping or quoting that accommodates the three
317 /// most likely tools that use dependency files: GNU Make, BSD Make, and
320 /// BSD Make is the simplest case: It does no escaping at all. This means
321 /// characters that are normally delimiters, i.e. space and # (the comment
322 /// character) simply aren't supported in filenames.
324 /// GNU Make does allow space and # in filenames, but to avoid being treated
325 /// as a delimiter or comment, these must be escaped with a backslash. Because
326 /// backslash is itself the escape character, if a backslash appears in a
327 /// filename, it should be escaped as well. (As a special case, $ is escaped
328 /// as $$, which is the normal Make way to handle the $ character.)
329 /// For compatibility with BSD Make and historical practice, if GNU Make
330 /// un-escapes characters in a filename but doesn't find a match, it will
331 /// retry with the unmodified original string.
333 /// GCC tries to accommodate both Make formats by escaping any space or #
334 /// characters in the original filename, but not escaping backslashes. The
335 /// apparent intent is so that filenames with backslashes will be handled
336 /// correctly by BSD Make, and by GNU Make in its fallback mode of using the
337 /// unmodified original string; filenames with # or space characters aren't
338 /// supported by BSD Make at all, but will be handled correctly by GNU Make
339 /// due to the escaping.
341 /// A corner case that GCC gets only partly right is when the original filename
342 /// has a backslash immediately followed by space or #. GNU Make would expect
343 /// this backslash to be escaped; however GCC escapes the original backslash
344 /// only when followed by space, not #. It will therefore take a dependency
345 /// from a directive such as
346 /// #include "a\ b\#c.h"
349 /// which GNU Make will interpret as
351 /// followed by a comment. Failing to find this file, it will fall back to the
352 /// original string, which probably doesn't exist either; in any case it won't
355 /// which is the actual filename specified by the include directive.
357 /// Clang does what GCC does, rather than what GNU Make expects.
359 /// NMake/Jom has a different set of scary characters, but wraps filespecs in
360 /// double-quotes to avoid misinterpreting them; see
361 /// https://msdn.microsoft.com/en-us/library/dd9y37ha.aspx for NMake info,
362 /// https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx
363 /// for Windows file-naming info.
364 static void PrintFilename(raw_ostream &OS, StringRef Filename,
365 DependencyOutputFormat OutputFormat) {
366 if (OutputFormat == DependencyOutputFormat::NMake) {
367 // Add quotes if needed. These are the characters listed as "special" to
368 // NMake, that are legal in a Windows filespec, and that could cause
369 // misinterpretation of the dependency string.
370 if (Filename.find_first_of(" #${}^!") != StringRef::npos)
371 OS << '\"' << Filename << '\"';
376 assert(OutputFormat == DependencyOutputFormat::Make);
377 for (unsigned i = 0, e = Filename.size(); i != e; ++i) {
378 if (Filename[i] == '#') // Handle '#' the broken gcc way.
380 else if (Filename[i] == ' ') { // Handle space correctly.
383 while (j > 0 && Filename[--j] == '\\')
385 } else if (Filename[i] == '$') // $ is escaped by $$.
391 void DFGImpl::OutputDependencyFile() {
392 if (SeenMissingHeader) {
393 llvm::sys::fs::remove(OutputFile);
398 llvm::raw_fd_ostream OS(OutputFile, EC, llvm::sys::fs::F_Text);
400 PP->getDiagnostics().Report(diag::err_fe_error_opening) << OutputFile
405 // Write out the dependency targets, trying to avoid overly long
406 // lines when possible. We try our best to emit exactly the same
407 // dependency file as GCC (4.2), assuming the included files are the
409 const unsigned MaxColumns = 75;
410 unsigned Columns = 0;
412 for (StringRef Target : Targets) {
413 unsigned N = Target.size();
416 } else if (Columns + N + 2 > MaxColumns) {
423 // Targets already quoted as needed.
430 // Now add each dependency in the order it was seen, but avoiding
432 for (StringRef File : Files) {
433 // Start a new line if this would exceed the column limit. Make
434 // sure to leave space for a trailing " \" in case we need to
435 // break the line on the next iteration.
436 unsigned N = File.size();
437 if (Columns + (N + 1) + 2 > MaxColumns) {
442 PrintFilename(OS, File, OutputFormat);
447 // Create phony targets if requested.
448 if (PhonyTarget && !Files.empty()) {
449 // Skip the first entry, this is always the input file itself.
450 for (auto I = Files.begin() + 1, E = Files.end(); I != E; ++I) {
452 PrintFilename(OS, *I, OutputFormat);
458 bool DFGASTReaderListener::visitInputFile(llvm::StringRef Filename,
459 bool IsSystem, bool IsOverridden,
460 bool IsExplicitModule) {
461 assert(!IsSystem || needsSystemInputFileVisitation());
462 if (IsOverridden || IsExplicitModule)
465 Parent.AddFilename(Filename);
469 void DFGASTReaderListener::visitModuleFile(llvm::StringRef Filename,
470 serialization::ModuleKind Kind) {
471 if (Parent.includeModuleFiles())
472 Parent.AddFilename(Filename);