1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
//===- DependencyScannerTest.cpp ------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "clang/AST/ASTConsumer.h"
#include "clang/AST/DeclCXX.h"
#include "clang/AST/DeclGroup.h"
#include "clang/Frontend/ASTUnit.h"
#include "clang/Frontend/CompilerInstance.h"
#include "clang/Frontend/FrontendAction.h"
#include "clang/Frontend/FrontendActions.h"
#include "clang/Tooling/CompilationDatabase.h"
#include "clang/Tooling/DependencyScanning/DependencyScanningTool.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/CAS/CASProvidingFileSystem.h"
#include "llvm/CAS/CachingOnDiskFileSystem.h"
#include "llvm/CAS/ObjectStore.h"
#include "llvm/MC/TargetRegistry.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/Path.h"
#include "llvm/Support/TargetSelect.h"
#include "llvm/Testing/Support/Error.h"
#include "gtest/gtest.h"
#include <algorithm>
#include <string>
using namespace clang;
using namespace clang::cas;
using namespace tooling;
using namespace dependencies;
namespace {
/// Prints out all of the gathered dependencies into a string.
class TestFileCollector : public DependencyFileGenerator {
public:
TestFileCollector(DependencyOutputOptions &Opts,
std::vector<std::string> &Deps)
: DependencyFileGenerator(Opts), Deps(Deps) {}
void finishedMainFile(DiagnosticsEngine &Diags) override {
auto NewDeps = getDependencies();
Deps.insert(Deps.end(), NewDeps.begin(), NewDeps.end());
}
private:
std::vector<std::string> &Deps;
};
class TestDependencyScanningAction : public tooling::ToolAction {
public:
TestDependencyScanningAction(std::vector<std::string> &Deps) : Deps(Deps) {}
bool runInvocation(std::shared_ptr<CompilerInvocation> Invocation,
FileManager *FileMgr,
std::shared_ptr<PCHContainerOperations> PCHContainerOps,
DiagnosticConsumer *DiagConsumer) override {
CompilerInstance Compiler(std::move(PCHContainerOps));
Compiler.setInvocation(std::move(Invocation));
Compiler.setFileManager(FileMgr);
Compiler.createDiagnostics(DiagConsumer, /*ShouldOwnClient=*/false);
if (!Compiler.hasDiagnostics())
return false;
Compiler.createSourceManager(*FileMgr);
Compiler.addDependencyCollector(std::make_shared<TestFileCollector>(
Compiler.getInvocation().getDependencyOutputOpts(), Deps));
auto Action = std::make_unique<PreprocessOnlyAction>();
return Compiler.ExecuteAction(*Action);
}
private:
std::vector<std::string> &Deps;
};
} // namespace
TEST(DependencyScanner, ScanDepsReuseFilemanager) {
std::vector<std::string> Compilation = {"-c", "-E", "-MT", "test.cpp.o"};
StringRef CWD = "/root";
FixedCompilationDatabase CDB(CWD, Compilation);
auto VFS = new llvm::vfs::InMemoryFileSystem();
VFS->setCurrentWorkingDirectory(CWD);
auto Sept = llvm::sys::path::get_separator();
std::string HeaderPath =
std::string(llvm::formatv("{0}root{0}header.h", Sept));
std::string SymlinkPath =
std::string(llvm::formatv("{0}root{0}symlink.h", Sept));
std::string TestPath = std::string(llvm::formatv("{0}root{0}test.cpp", Sept));
VFS->addFile(HeaderPath, 0, llvm::MemoryBuffer::getMemBuffer("\n"));
VFS->addHardLink(SymlinkPath, HeaderPath);
VFS->addFile(TestPath, 0,
llvm::MemoryBuffer::getMemBuffer(
"#include \"symlink.h\"\n#include \"header.h\"\n"));
ClangTool Tool(CDB, {"test.cpp"}, std::make_shared<PCHContainerOperations>(),
VFS);
Tool.clearArgumentsAdjusters();
std::vector<std::string> Deps;
TestDependencyScanningAction Action(Deps);
Tool.run(&Action);
using llvm::sys::path::convert_to_slash;
// The first invocation should return dependencies in order of access.
ASSERT_EQ(Deps.size(), 3u);
EXPECT_EQ(convert_to_slash(Deps[0]), "/root/test.cpp");
EXPECT_EQ(convert_to_slash(Deps[1]), "/root/symlink.h");
EXPECT_EQ(convert_to_slash(Deps[2]), "/root/header.h");
// The file manager should still have two FileEntries, as one file is a
// hardlink.
FileManager &Files = Tool.getFiles();
EXPECT_EQ(Files.getNumUniqueRealFiles(), 2u);
Deps.clear();
Tool.run(&Action);
// The second invocation should have the same order of dependencies.
ASSERT_EQ(Deps.size(), 3u);
EXPECT_EQ(convert_to_slash(Deps[0]), "/root/test.cpp");
EXPECT_EQ(convert_to_slash(Deps[1]), "/root/symlink.h");
EXPECT_EQ(convert_to_slash(Deps[2]), "/root/header.h");
EXPECT_EQ(Files.getNumUniqueRealFiles(), 2u);
}
TEST(DependencyScanner, ScanDepsReuseFilemanagerSkippedFile) {
std::vector<std::string> Compilation = {"-c", "-E", "-MT", "test.cpp.o"};
StringRef CWD = "/root";
FixedCompilationDatabase CDB(CWD, Compilation);
auto VFS = new llvm::vfs::InMemoryFileSystem();
VFS->setCurrentWorkingDirectory(CWD);
auto Sept = llvm::sys::path::get_separator();
std::string HeaderPath =
std::string(llvm::formatv("{0}root{0}header.h", Sept));
std::string SymlinkPath =
std::string(llvm::formatv("{0}root{0}symlink.h", Sept));
std::string TestPath = std::string(llvm::formatv("{0}root{0}test.cpp", Sept));
std::string Test2Path =
std::string(llvm::formatv("{0}root{0}test2.cpp", Sept));
VFS->addFile(HeaderPath, 0,
llvm::MemoryBuffer::getMemBuffer("#pragma once\n"));
VFS->addHardLink(SymlinkPath, HeaderPath);
VFS->addFile(TestPath, 0,
llvm::MemoryBuffer::getMemBuffer(
"#include \"header.h\"\n#include \"symlink.h\"\n"));
VFS->addFile(Test2Path, 0,
llvm::MemoryBuffer::getMemBuffer(
"#include \"symlink.h\"\n#include \"header.h\"\n"));
ClangTool Tool(CDB, {"test.cpp", "test2.cpp"},
std::make_shared<PCHContainerOperations>(), VFS);
Tool.clearArgumentsAdjusters();
std::vector<std::string> Deps;
TestDependencyScanningAction Action(Deps);
Tool.run(&Action);
using llvm::sys::path::convert_to_slash;
ASSERT_EQ(Deps.size(), 6u);
EXPECT_EQ(convert_to_slash(Deps[0]), "/root/test.cpp");
EXPECT_EQ(convert_to_slash(Deps[1]), "/root/header.h");
EXPECT_EQ(convert_to_slash(Deps[2]), "/root/symlink.h");
EXPECT_EQ(convert_to_slash(Deps[3]), "/root/test2.cpp");
EXPECT_EQ(convert_to_slash(Deps[4]), "/root/symlink.h");
EXPECT_EQ(convert_to_slash(Deps[5]), "/root/header.h");
}
TEST(DependencyScanner, ScanDepsReuseFilemanagerHasInclude) {
std::vector<std::string> Compilation = {"-c", "-E", "-MT", "test.cpp.o"};
StringRef CWD = "/root";
FixedCompilationDatabase CDB(CWD, Compilation);
auto VFS = new llvm::vfs::InMemoryFileSystem();
VFS->setCurrentWorkingDirectory(CWD);
auto Sept = llvm::sys::path::get_separator();
std::string HeaderPath =
std::string(llvm::formatv("{0}root{0}header.h", Sept));
std::string SymlinkPath =
std::string(llvm::formatv("{0}root{0}symlink.h", Sept));
std::string TestPath = std::string(llvm::formatv("{0}root{0}test.cpp", Sept));
VFS->addFile(HeaderPath, 0, llvm::MemoryBuffer::getMemBuffer("\n"));
VFS->addHardLink(SymlinkPath, HeaderPath);
VFS->addFile(
TestPath, 0,
llvm::MemoryBuffer::getMemBuffer("#if __has_include(\"header.h\") && "
"__has_include(\"symlink.h\")\n#endif"));
ClangTool Tool(CDB, {"test.cpp", "test.cpp"},
std::make_shared<PCHContainerOperations>(), VFS);
Tool.clearArgumentsAdjusters();
std::vector<std::string> Deps;
TestDependencyScanningAction Action(Deps);
Tool.run(&Action);
using llvm::sys::path::convert_to_slash;
ASSERT_EQ(Deps.size(), 6u);
EXPECT_EQ(convert_to_slash(Deps[0]), "/root/test.cpp");
EXPECT_EQ(convert_to_slash(Deps[1]), "/root/header.h");
EXPECT_EQ(convert_to_slash(Deps[2]), "/root/symlink.h");
EXPECT_EQ(convert_to_slash(Deps[3]), "/root/test.cpp");
EXPECT_EQ(convert_to_slash(Deps[4]), "/root/header.h");
EXPECT_EQ(convert_to_slash(Deps[5]), "/root/symlink.h");
}
TEST(DependencyScanner, ScanDepsWithFS) {
std::vector<std::string> CommandLine = {"clang",
"-target",
"x86_64-apple-macosx10.7",
"-c",
"test.cpp",
"-o"
"test.cpp.o"};
StringRef CWD = "/root";
auto VFS = new llvm::vfs::InMemoryFileSystem();
VFS->setCurrentWorkingDirectory(CWD);
auto Sept = llvm::sys::path::get_separator();
std::string HeaderPath =
std::string(llvm::formatv("{0}root{0}header.h", Sept));
std::string TestPath = std::string(llvm::formatv("{0}root{0}test.cpp", Sept));
VFS->addFile(HeaderPath, 0, llvm::MemoryBuffer::getMemBuffer("\n"));
VFS->addFile(TestPath, 0,
llvm::MemoryBuffer::getMemBuffer("#include \"header.h\"\n"));
DependencyScanningService Service(ScanningMode::DependencyDirectivesScan,
ScanningOutputFormat::Make, CASOptions(),
nullptr, nullptr, nullptr);
DependencyScanningTool ScanTool(Service, VFS);
std::string DepFile;
ASSERT_THAT_ERROR(
ScanTool.getDependencyFile(CommandLine, CWD).moveInto(DepFile),
llvm::Succeeded());
using llvm::sys::path::convert_to_slash;
EXPECT_EQ(convert_to_slash(DepFile),
"test.cpp.o: /root/test.cpp /root/header.h\n");
}
TEST(DependencyScanner, DepScanFSWithCASProvider) {
std::shared_ptr<ObjectStore> DB = llvm::cas::createInMemoryCAS();
auto FS = llvm::makeIntrusiveRefCnt<llvm::vfs::InMemoryFileSystem>();
FS->setCurrentWorkingDirectory("/root");
StringRef Path = "a.h";
StringRef Contents = "a";
FS->addFile(Path, 0, llvm::MemoryBuffer::getMemBuffer(Contents));
std::unique_ptr<llvm::vfs::FileSystem> CASFS =
llvm::cas::createCASProvidingFileSystem(DB, FS);
DependencyScanningService Service(ScanningMode::DependencyDirectivesScan,
ScanningOutputFormat::Make, CASOptions(),
nullptr, nullptr, nullptr);
{
DependencyScanningWorkerFilesystem DepFS(Service.getSharedCache(),
std::move(CASFS));
std::optional<ObjectRef> CASContents;
auto Buf = DepFS.getBufferForFile(Path, /*FileSize*/ -1,
/*RequiresNullTerminator*/ false,
/*IsVolatile*/ false, &CASContents);
ASSERT_TRUE(Buf);
EXPECT_EQ(Contents, (*Buf)->getBuffer());
ASSERT_TRUE(CASContents);
std::optional<ObjectProxy> BlobContents;
ASSERT_THAT_ERROR(DB->getProxy(*CASContents).moveInto(BlobContents),
llvm::Succeeded());
EXPECT_EQ(BlobContents->getData(), Contents);
}
{
// Check that even though we pass a new InMemoryFileSystem instance here the
// DependencyScanningService's SharedCache cached the file's buffer and
// cas::ObjectRef and will be able to provide it.
DependencyScanningWorkerFilesystem DepFS(Service.getSharedCache(),
new llvm::vfs::InMemoryFileSystem);
DepFS.setCurrentWorkingDirectory("/root");
llvm::ErrorOr<std::unique_ptr<llvm::vfs::File>> File =
DepFS.openFileForRead(Path);
ASSERT_TRUE(File);
ASSERT_TRUE(*File);
llvm::ErrorOr<std::optional<ObjectRef>> Ref =
(*File)->getObjectRefForContent();
ASSERT_TRUE(Ref);
ASSERT_TRUE(*Ref);
std::optional<ObjectProxy> BlobContents;
ASSERT_THAT_ERROR(DB->getProxy(**Ref).moveInto(BlobContents),
llvm::Succeeded());
EXPECT_EQ(BlobContents->getData(), Contents);
}
}
TEST(DependencyScanner, ScanDepsWithModuleLookup) {
std::vector<std::string> CommandLine = {
"clang",
"-target",
"x86_64-apple-macosx10.7",
"-c",
"test.m",
"-o"
"test.m.o",
"-fmodules",
"-I/root/SomeSources",
};
StringRef CWD = "/root";
auto VFS = new llvm::vfs::InMemoryFileSystem();
VFS->setCurrentWorkingDirectory(CWD);
auto Sept = llvm::sys::path::get_separator();
std::string OtherPath =
std::string(llvm::formatv("{0}root{0}SomeSources{0}other.h", Sept));
std::string TestPath = std::string(llvm::formatv("{0}root{0}test.m", Sept));
VFS->addFile(OtherPath, 0, llvm::MemoryBuffer::getMemBuffer("\n"));
VFS->addFile(TestPath, 0, llvm::MemoryBuffer::getMemBuffer("@import Foo;\n"));
struct InterceptorFS : llvm::vfs::ProxyFileSystem {
std::vector<std::string> StatPaths;
std::vector<std::string> ReadFiles;
InterceptorFS(IntrusiveRefCntPtr<FileSystem> UnderlyingFS)
: ProxyFileSystem(UnderlyingFS) {}
llvm::ErrorOr<llvm::vfs::Status> status(const Twine &Path) override {
StatPaths.push_back(Path.str());
return ProxyFileSystem::status(Path);
}
llvm::ErrorOr<std::unique_ptr<llvm::vfs::File>>
openFileForRead(const Twine &Path) override {
ReadFiles.push_back(Path.str());
return ProxyFileSystem::openFileForRead(Path);
}
};
auto InterceptFS = llvm::makeIntrusiveRefCnt<InterceptorFS>(VFS);
DependencyScanningService Service(ScanningMode::DependencyDirectivesScan,
ScanningOutputFormat::Make, CASOptions(),
nullptr, nullptr, nullptr);
DependencyScanningTool ScanTool(Service, InterceptFS);
// This will fail with "fatal error: module 'Foo' not found" but it doesn't
// matter, the point of the test is to check that files are not read
// unnecessarily.
std::string DepFile;
ASSERT_THAT_ERROR(
ScanTool.getDependencyFile(CommandLine, CWD).moveInto(DepFile),
llvm::Failed());
EXPECT_TRUE(llvm::find(InterceptFS->StatPaths, OtherPath) ==
InterceptFS->StatPaths.end());
EXPECT_EQ(InterceptFS->ReadFiles, std::vector<std::string>{"test.m"});
}
|
