blob: 27da45fffae80665ed4c60027e56416b0b70112c [file] [log] [blame]
John McCalld70fb982011-06-15 23:25:17 +00001//===-- arcmt-test.cpp - ARC Migration Tool testbed -----------------------===//
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#include "clang/ARCMigrate/ARCMT.h"
11#include "clang/Frontend/ASTUnit.h"
12#include "clang/Frontend/TextDiagnosticPrinter.h"
John McCalld70fb982011-06-15 23:25:17 +000013#include "clang/Frontend/Utils.h"
Chandler Carruthcc0694c2012-12-04 09:25:21 +000014#include "clang/Frontend/VerifyDiagnosticConsumer.h"
John McCalld70fb982011-06-15 23:25:17 +000015#include "clang/Lex/Preprocessor.h"
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +000016#include "llvm/Support/FileSystem.h"
Chandler Carruthcc0694c2012-12-04 09:25:21 +000017#include "llvm/Support/MemoryBuffer.h"
John McCalld70fb982011-06-15 23:25:17 +000018#include "llvm/Support/Signals.h"
Rafael Espindola8a8e5542014-06-12 17:19:42 +000019#include <system_error>
John McCalld70fb982011-06-15 23:25:17 +000020
21using namespace clang;
22using namespace arcmt;
23
24static llvm::cl::opt<bool>
25CheckOnly("check-only",
26 llvm::cl::desc("Just check for issues that need to be handled manually"));
27
28//static llvm::cl::opt<bool>
29//TestResultForARC("test-result",
30//llvm::cl::desc("Test the result of transformations by parsing it in ARC mode"));
31
32static llvm::cl::opt<bool>
33OutputTransformations("output-transformations",
34 llvm::cl::desc("Print the source transformations"));
35
36static llvm::cl::opt<bool>
37VerifyDiags("verify",llvm::cl::desc("Verify emitted diagnostics and warnings"));
38
39static llvm::cl::opt<bool>
40VerboseOpt("v", llvm::cl::desc("Enable verbose output"));
41
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +000042static llvm::cl::opt<bool>
43VerifyTransformedFiles("verify-transformed-files",
44llvm::cl::desc("Read pairs of file mappings (typically the output of "
45 "c-arcmt-test) and compare their contents with the filenames "
46 "provided in command-line"));
47
48static llvm::cl::opt<std::string>
49RemappingsFile("remappings-file",
50 llvm::cl::desc("Pairs of file mappings (typically the output of "
51 "c-arcmt-test)"));
52
53static llvm::cl::list<std::string>
54ResultFiles(llvm::cl::Positional, llvm::cl::desc("<filename>..."));
55
John McCalld70fb982011-06-15 23:25:17 +000056static llvm::cl::extrahelp extraHelp(
57 "\nusage with compiler args: arcmt-test [options] --args [compiler flags]\n");
58
59// This function isn't referenced outside its translation unit, but it
60// can't use the "static" keyword because its address is used for
61// GetMainExecutable (since some platforms don't support taking the
62// address of main, and some platforms can't implement GetMainExecutable
63// without being given the address of a function in the main executable).
Rafael Espindola9678d272013-06-26 05:03:40 +000064std::string GetExecutablePath(const char *Argv0) {
John McCalld70fb982011-06-15 23:25:17 +000065 // This just needs to be some symbol in the binary; C++ doesn't
66 // allow taking the address of ::main however.
67 void *MainAddr = (void*) (intptr_t) GetExecutablePath;
Rafael Espindola9678d272013-06-26 05:03:40 +000068 return llvm::sys::fs::getMainExecutable(Argv0, MainAddr);
John McCalld70fb982011-06-15 23:25:17 +000069}
70
71static void printSourceLocation(SourceLocation loc, ASTContext &Ctx,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000072 raw_ostream &OS);
John McCalld70fb982011-06-15 23:25:17 +000073static void printSourceRange(CharSourceRange range, ASTContext &Ctx,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000074 raw_ostream &OS);
John McCalld70fb982011-06-15 23:25:17 +000075
76namespace {
77
78class PrintTransforms : public MigrationProcess::RewriteListener {
79 ASTContext *Ctx;
Chris Lattner0e62c1c2011-07-23 10:55:15 +000080 raw_ostream &OS;
John McCalld70fb982011-06-15 23:25:17 +000081
82public:
Chris Lattner0e62c1c2011-07-23 10:55:15 +000083 PrintTransforms(raw_ostream &OS)
Craig Topper69186e72014-06-08 08:38:04 +000084 : Ctx(nullptr), OS(OS) {}
John McCalld70fb982011-06-15 23:25:17 +000085
Craig Topper36835562014-03-15 07:47:46 +000086 void start(ASTContext &ctx) override { Ctx = &ctx; }
Craig Topper69186e72014-06-08 08:38:04 +000087 void finish() override { Ctx = nullptr; }
John McCalld70fb982011-06-15 23:25:17 +000088
Craig Topper36835562014-03-15 07:47:46 +000089 void insert(SourceLocation loc, StringRef text) override {
John McCalld70fb982011-06-15 23:25:17 +000090 assert(Ctx);
91 OS << "Insert: ";
92 printSourceLocation(loc, *Ctx, OS);
93 OS << " \"" << text << "\"\n";
94 }
95
Craig Topper36835562014-03-15 07:47:46 +000096 void remove(CharSourceRange range) override {
John McCalld70fb982011-06-15 23:25:17 +000097 assert(Ctx);
98 OS << "Remove: ";
99 printSourceRange(range, *Ctx, OS);
100 OS << '\n';
101 }
102};
103
104} // anonymous namespace
105
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000106static bool checkForMigration(StringRef resourcesPath,
Chris Lattner54b16772011-07-23 17:14:25 +0000107 ArrayRef<const char *> Args) {
Douglas Gregor811db4e2012-10-23 22:26:28 +0000108 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions();
David Blaikiee2eefae2011-09-25 23:39:51 +0000109 DiagnosticConsumer *DiagClient =
Douglas Gregor811db4e2012-10-23 22:26:28 +0000110 new TextDiagnosticPrinter(llvm::errs(), &*DiagOpts);
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000111 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
112 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000113 new DiagnosticsEngine(DiagID, &*DiagOpts, DiagClient));
John McCalld70fb982011-06-15 23:25:17 +0000114 // Chain in -verify checker, if requested.
Craig Topper69186e72014-06-08 08:38:04 +0000115 VerifyDiagnosticConsumer *verifyDiag = nullptr;
John McCalld70fb982011-06-15 23:25:17 +0000116 if (VerifyDiags) {
David Blaikie69609dc2011-09-26 00:38:03 +0000117 verifyDiag = new VerifyDiagnosticConsumer(*Diags);
John McCalld70fb982011-06-15 23:25:17 +0000118 Diags->setClient(verifyDiag);
119 }
120
Argyrios Kyrtzidis6e4ef202011-06-16 00:53:46 +0000121 CompilerInvocation CI;
Dylan Noblesmithe99b27f2011-12-23 03:05:38 +0000122 if (!CompilerInvocation::CreateFromArgs(CI, Args.begin(), Args.end(), *Diags))
123 return true;
John McCalld70fb982011-06-15 23:25:17 +0000124
Argyrios Kyrtzidis6e4ef202011-06-16 00:53:46 +0000125 if (CI.getFrontendOpts().Inputs.empty()) {
John McCalld70fb982011-06-15 23:25:17 +0000126 llvm::errs() << "error: no input files\n";
127 return true;
128 }
129
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000130 if (!CI.getLangOpts()->ObjC1)
John McCalld70fb982011-06-15 23:25:17 +0000131 return false;
132
Douglas Gregor32fbe312012-01-20 16:28:04 +0000133 arcmt::checkForManualIssues(CI, CI.getFrontendOpts().Inputs[0],
Argyrios Kyrtzidis90b6a2a2011-06-18 00:53:41 +0000134 Diags->getClient());
135 return Diags->getClient()->getNumErrors() > 0;
John McCalld70fb982011-06-15 23:25:17 +0000136}
137
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000138static void printResult(FileRemapper &remapper, raw_ostream &OS) {
Ted Kremenekf7639e12012-03-06 20:06:33 +0000139 PreprocessorOptions PPOpts;
140 remapper.applyMappings(PPOpts);
John McCalld70fb982011-06-15 23:25:17 +0000141 // The changed files will be in memory buffers, print them.
142 for (unsigned i = 0, e = PPOpts.RemappedFileBuffers.size(); i != e; ++i) {
143 const llvm::MemoryBuffer *mem = PPOpts.RemappedFileBuffers[i].second;
144 OS << mem->getBuffer();
145 }
146}
147
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000148static bool performTransformations(StringRef resourcesPath,
Chris Lattner54b16772011-07-23 17:14:25 +0000149 ArrayRef<const char *> Args) {
John McCalld70fb982011-06-15 23:25:17 +0000150 // Check first.
151 if (checkForMigration(resourcesPath, Args))
152 return true;
153
Douglas Gregor811db4e2012-10-23 22:26:28 +0000154 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions();
David Blaikiee2eefae2011-09-25 23:39:51 +0000155 DiagnosticConsumer *DiagClient =
Douglas Gregor811db4e2012-10-23 22:26:28 +0000156 new TextDiagnosticPrinter(llvm::errs(), &*DiagOpts);
Dylan Noblesmithc95d8192012-02-20 14:00:23 +0000157 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
158 IntrusiveRefCntPtr<DiagnosticsEngine> TopDiags(
Douglas Gregor811db4e2012-10-23 22:26:28 +0000159 new DiagnosticsEngine(DiagID, &*DiagOpts, &*DiagClient));
John McCalld70fb982011-06-15 23:25:17 +0000160
Argyrios Kyrtzidis6e4ef202011-06-16 00:53:46 +0000161 CompilerInvocation origCI;
Dylan Noblesmithe99b27f2011-12-23 03:05:38 +0000162 if (!CompilerInvocation::CreateFromArgs(origCI, Args.begin(), Args.end(),
163 *TopDiags))
164 return true;
John McCalld70fb982011-06-15 23:25:17 +0000165
Argyrios Kyrtzidis6e4ef202011-06-16 00:53:46 +0000166 if (origCI.getFrontendOpts().Inputs.empty()) {
John McCalld70fb982011-06-15 23:25:17 +0000167 llvm::errs() << "error: no input files\n";
168 return true;
169 }
170
Ted Kremenek8cf47df2011-11-17 23:01:24 +0000171 if (!origCI.getLangOpts()->ObjC1)
John McCalld70fb982011-06-15 23:25:17 +0000172 return false;
173
Argyrios Kyrtzidis6e4ef202011-06-16 00:53:46 +0000174 MigrationProcess migration(origCI, DiagClient);
John McCalld70fb982011-06-15 23:25:17 +0000175
Argyrios Kyrtzidisd208ef92011-11-04 15:58:08 +0000176 std::vector<TransformFn>
Fariborz Jahanian48fd81b2012-01-26 20:57:58 +0000177 transforms = arcmt::getAllTransformations(origCI.getLangOpts()->getGC(),
178 origCI.getMigratorOpts().NoFinalizeRemoval);
John McCalld70fb982011-06-15 23:25:17 +0000179 assert(!transforms.empty());
180
Ahmed Charlesb8984322014-03-07 20:03:18 +0000181 std::unique_ptr<PrintTransforms> transformPrinter;
John McCalld70fb982011-06-15 23:25:17 +0000182 if (OutputTransformations)
183 transformPrinter.reset(new PrintTransforms(llvm::outs()));
184
185 for (unsigned i=0, e = transforms.size(); i != e; ++i) {
186 bool err = migration.applyTransform(transforms[i], transformPrinter.get());
187 if (err) return true;
188
189 if (VerboseOpt) {
190 if (i == e-1)
191 llvm::errs() << "\n##### FINAL RESULT #####\n";
192 else
193 llvm::errs() << "\n##### OUTPUT AFTER "<< i+1 <<". TRANSFORMATION #####\n";
194 printResult(migration.getRemapper(), llvm::errs());
195 llvm::errs() << "\n##########################\n\n";
196 }
197 }
198
199 if (!OutputTransformations)
200 printResult(migration.getRemapper(), llvm::outs());
201
202 // FIXME: TestResultForARC
203
204 return false;
205}
206
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000207static bool filesCompareEqual(StringRef fname1, StringRef fname2) {
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000208 using namespace llvm;
209
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000210 ErrorOr<std::unique_ptr<MemoryBuffer>> file1 = MemoryBuffer::getFile(fname1);
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000211 if (!file1)
212 return false;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000213
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000214 ErrorOr<std::unique_ptr<MemoryBuffer>> file2 = MemoryBuffer::getFile(fname2);
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000215 if (!file2)
216 return false;
217
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000218 return file1.get()->getBuffer() == file2.get()->getBuffer();
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000219}
220
Chris Lattner54b16772011-07-23 17:14:25 +0000221static bool verifyTransformedFiles(ArrayRef<std::string> resultFiles) {
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000222 using namespace llvm;
223
224 assert(!resultFiles.empty());
225
226 std::map<StringRef, StringRef> resultMap;
227
228 for (ArrayRef<std::string>::iterator
229 I = resultFiles.begin(), E = resultFiles.end(); I != E; ++I) {
230 StringRef fname(*I);
231 if (!fname.endswith(".result")) {
232 errs() << "error: filename '" << fname
233 << "' does not have '.result' extension\n";
234 return true;
235 }
236 resultMap[sys::path::stem(fname)] = fname;
237 }
238
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000239 ErrorOr<std::unique_ptr<MemoryBuffer>> inputBuf = std::error_code();
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000240 if (RemappingsFile.empty())
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000241 inputBuf = MemoryBuffer::getSTDIN();
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000242 else
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000243 inputBuf = MemoryBuffer::getFile(RemappingsFile);
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000244 if (!inputBuf) {
245 errs() << "error: could not read remappings input\n";
246 return true;
247 }
248
249 SmallVector<StringRef, 8> strs;
Rafael Espindola2d2b4202014-07-06 17:43:24 +0000250 inputBuf.get()->getBuffer().split(strs, "\n", /*MaxSplit=*/-1,
251 /*KeepEmpty=*/false);
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000252
253 if (strs.empty()) {
254 errs() << "error: no files to verify from stdin\n";
255 return true;
256 }
257 if (strs.size() % 2 != 0) {
258 errs() << "error: files to verify are not original/result pairs\n";
259 return true;
260 }
261
262 for (unsigned i = 0, e = strs.size(); i != e; i += 2) {
263 StringRef inputOrigFname = strs[i];
264 StringRef inputResultFname = strs[i+1];
265
266 std::map<StringRef, StringRef>::iterator It;
267 It = resultMap.find(sys::path::filename(inputOrigFname));
268 if (It == resultMap.end()) {
269 errs() << "error: '" << inputOrigFname << "' is not in the list of "
270 << "transformed files to verify\n";
271 return true;
272 }
273
274 bool exists = false;
275 sys::fs::exists(It->second, exists);
276 if (!exists) {
277 errs() << "error: '" << It->second << "' does not exist\n";
278 return true;
279 }
280 sys::fs::exists(inputResultFname, exists);
281 if (!exists) {
282 errs() << "error: '" << inputResultFname << "' does not exist\n";
283 return true;
284 }
285
286 if (!filesCompareEqual(It->second, inputResultFname)) {
287 errs() << "error: '" << It->second << "' is different than "
288 << "'" << inputResultFname << "'\n";
289 return true;
290 }
291
292 resultMap.erase(It);
293 }
294
295 if (!resultMap.empty()) {
296 for (std::map<StringRef, StringRef>::iterator
297 I = resultMap.begin(), E = resultMap.end(); I != E; ++I)
298 errs() << "error: '" << I->second << "' was not verified!\n";
299 return true;
300 }
301
302 return false;
303}
304
John McCalld70fb982011-06-15 23:25:17 +0000305//===----------------------------------------------------------------------===//
306// Misc. functions.
307//===----------------------------------------------------------------------===//
308
309static void printSourceLocation(SourceLocation loc, ASTContext &Ctx,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000310 raw_ostream &OS) {
John McCalld70fb982011-06-15 23:25:17 +0000311 SourceManager &SM = Ctx.getSourceManager();
312 PresumedLoc PL = SM.getPresumedLoc(loc);
313
314 OS << llvm::sys::path::filename(PL.getFilename());
315 OS << ":" << PL.getLine() << ":"
316 << PL.getColumn();
317}
318
319static void printSourceRange(CharSourceRange range, ASTContext &Ctx,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000320 raw_ostream &OS) {
John McCalld70fb982011-06-15 23:25:17 +0000321 SourceManager &SM = Ctx.getSourceManager();
David Blaikiebbafb8a2012-03-11 07:00:24 +0000322 const LangOptions &langOpts = Ctx.getLangOpts();
John McCalld70fb982011-06-15 23:25:17 +0000323
324 PresumedLoc PL = SM.getPresumedLoc(range.getBegin());
325
326 OS << llvm::sys::path::filename(PL.getFilename());
327 OS << " [" << PL.getLine() << ":"
328 << PL.getColumn();
329 OS << " - ";
330
331 SourceLocation end = range.getEnd();
332 PL = SM.getPresumedLoc(end);
333
334 unsigned endCol = PL.getColumn() - 1;
335 if (!range.isTokenRange())
336 endCol += Lexer::MeasureTokenLength(end, SM, langOpts);
337 OS << PL.getLine() << ":" << endCol << "]";
338}
339
340//===----------------------------------------------------------------------===//
341// Command line processing.
342//===----------------------------------------------------------------------===//
343
344int main(int argc, const char **argv) {
John McCalld70fb982011-06-15 23:25:17 +0000345 void *MainAddr = (void*) (intptr_t) GetExecutablePath;
346 llvm::sys::PrintStackTraceOnErrorSignal();
347
348 std::string
349 resourcesPath = CompilerInvocation::GetResourcesPath(argv[0], MainAddr);
350
351 int optargc = 0;
352 for (; optargc != argc; ++optargc) {
353 if (StringRef(argv[optargc]) == "--args")
354 break;
355 }
David Blaikie09d20ee2012-02-07 19:36:38 +0000356 llvm::cl::ParseCommandLineOptions(optargc, argv, "arcmt-test");
Argyrios Kyrtzidis7fbd97f2011-07-09 20:00:58 +0000357
358 if (VerifyTransformedFiles) {
359 if (ResultFiles.empty()) {
360 llvm::cl::PrintHelpMessage();
361 return 1;
362 }
363 return verifyTransformedFiles(ResultFiles);
364 }
365
John McCalld70fb982011-06-15 23:25:17 +0000366 if (optargc == argc) {
367 llvm::cl::PrintHelpMessage();
368 return 1;
369 }
370
Chris Lattner54b16772011-07-23 17:14:25 +0000371 ArrayRef<const char*> Args(argv+optargc+1, argc-optargc-1);
John McCalld70fb982011-06-15 23:25:17 +0000372
373 if (CheckOnly)
374 return checkForMigration(resourcesPath, Args);
375
376 return performTransformations(resourcesPath, Args);
377}