1 //===-- arcmt-test.cpp - ARC Migration Tool testbed -----------------------===// 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 "clang/ARCMigrate/ARCMT.h" 10 #include "clang/AST/ASTContext.h" 11 #include "clang/Frontend/PCHContainerOperations.h" 12 #include "clang/Frontend/TextDiagnosticPrinter.h" 13 #include "clang/Frontend/Utils.h" 14 #include "clang/Frontend/VerifyDiagnosticConsumer.h" 15 #include "clang/Lex/Preprocessor.h" 16 #include "clang/Lex/PreprocessorOptions.h" 17 #include "llvm/Support/FileSystem.h" 18 #include "llvm/Support/MemoryBuffer.h" 19 #include "llvm/Support/Path.h" 20 #include "llvm/Support/Signals.h" 21 #include <system_error> 22 23 using namespace clang; 24 using namespace arcmt; 25 26 static llvm::cl::opt<bool> 27 CheckOnly("check-only", 28 llvm::cl::desc("Just check for issues that need to be handled manually")); 29 30 //static llvm::cl::opt<bool> 31 //TestResultForARC("test-result", 32 //llvm::cl::desc("Test the result of transformations by parsing it in ARC mode")); 33 34 static llvm::cl::opt<bool> 35 OutputTransformations("output-transformations", 36 llvm::cl::desc("Print the source transformations")); 37 38 static llvm::cl::opt<bool> 39 VerifyDiags("verify",llvm::cl::desc("Verify emitted diagnostics and warnings")); 40 41 static llvm::cl::opt<bool> 42 VerboseOpt("v", llvm::cl::desc("Enable verbose output")); 43 44 static llvm::cl::opt<bool> 45 VerifyTransformedFiles("verify-transformed-files", 46 llvm::cl::desc("Read pairs of file mappings (typically the output of " 47 "c-arcmt-test) and compare their contents with the filenames " 48 "provided in command-line")); 49 50 static llvm::cl::opt<std::string> 51 RemappingsFile("remappings-file", 52 llvm::cl::desc("Pairs of file mappings (typically the output of " 53 "c-arcmt-test)")); 54 55 static llvm::cl::list<std::string> 56 ResultFiles(llvm::cl::Positional, llvm::cl::desc("<filename>...")); 57 58 static llvm::cl::extrahelp extraHelp( 59 "\nusage with compiler args: arcmt-test [options] --args [compiler flags]\n"); 60 61 // This function isn't referenced outside its translation unit, but it 62 // can't use the "static" keyword because its address is used for 63 // GetMainExecutable (since some platforms don't support taking the 64 // address of main, and some platforms can't implement GetMainExecutable 65 // without being given the address of a function in the main executable). 66 std::string GetExecutablePath(const char *Argv0) { 67 // This just needs to be some symbol in the binary; C++ doesn't 68 // allow taking the address of ::main however. 69 void *MainAddr = (void*) (intptr_t) GetExecutablePath; 70 return llvm::sys::fs::getMainExecutable(Argv0, MainAddr); 71 } 72 73 static void printSourceLocation(SourceLocation loc, ASTContext &Ctx, 74 raw_ostream &OS); 75 static void printSourceRange(CharSourceRange range, ASTContext &Ctx, 76 raw_ostream &OS); 77 78 namespace { 79 80 class PrintTransforms : public MigrationProcess::RewriteListener { 81 ASTContext *Ctx; 82 raw_ostream &OS; 83 84 public: 85 PrintTransforms(raw_ostream &OS) 86 : Ctx(nullptr), OS(OS) {} 87 88 void start(ASTContext &ctx) override { Ctx = &ctx; } 89 void finish() override { Ctx = nullptr; } 90 91 void insert(SourceLocation loc, StringRef text) override { 92 assert(Ctx); 93 OS << "Insert: "; 94 printSourceLocation(loc, *Ctx, OS); 95 OS << " \"" << text << "\"\n"; 96 } 97 98 void remove(CharSourceRange range) override { 99 assert(Ctx); 100 OS << "Remove: "; 101 printSourceRange(range, *Ctx, OS); 102 OS << '\n'; 103 } 104 }; 105 106 } // anonymous namespace 107 108 static bool checkForMigration(StringRef resourcesPath, 109 ArrayRef<const char *> Args) { 110 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions(); 111 DiagnosticConsumer *DiagClient = 112 new TextDiagnosticPrinter(llvm::errs(), &*DiagOpts); 113 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs()); 114 IntrusiveRefCntPtr<DiagnosticsEngine> Diags( 115 new DiagnosticsEngine(DiagID, &*DiagOpts, DiagClient)); 116 // Chain in -verify checker, if requested. 117 VerifyDiagnosticConsumer *verifyDiag = nullptr; 118 if (VerifyDiags) { 119 verifyDiag = new VerifyDiagnosticConsumer(*Diags); 120 Diags->setClient(verifyDiag); 121 } 122 123 CompilerInvocation CI; 124 if (!CompilerInvocation::CreateFromArgs(CI, Args, *Diags)) 125 return true; 126 127 if (CI.getFrontendOpts().Inputs.empty()) { 128 llvm::errs() << "error: no input files\n"; 129 return true; 130 } 131 132 if (!CI.getLangOpts()->ObjC) 133 return false; 134 135 arcmt::checkForManualIssues(CI, CI.getFrontendOpts().Inputs[0], 136 std::make_shared<PCHContainerOperations>(), 137 Diags->getClient()); 138 return Diags->getClient()->getNumErrors() > 0; 139 } 140 141 static void printResult(FileRemapper &remapper, raw_ostream &OS) { 142 PreprocessorOptions PPOpts; 143 remapper.applyMappings(PPOpts); 144 // The changed files will be in memory buffers, print them. 145 for (const auto &RB : PPOpts.RemappedFileBuffers) 146 OS << RB.second->getBuffer(); 147 } 148 149 static bool performTransformations(StringRef resourcesPath, 150 ArrayRef<const char *> Args) { 151 // Check first. 152 if (checkForMigration(resourcesPath, Args)) 153 return true; 154 155 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions(); 156 DiagnosticConsumer *DiagClient = 157 new TextDiagnosticPrinter(llvm::errs(), &*DiagOpts); 158 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs()); 159 IntrusiveRefCntPtr<DiagnosticsEngine> TopDiags( 160 new DiagnosticsEngine(DiagID, &*DiagOpts, &*DiagClient)); 161 162 CompilerInvocation origCI; 163 if (!CompilerInvocation::CreateFromArgs(origCI, Args, *TopDiags)) 164 return true; 165 166 if (origCI.getFrontendOpts().Inputs.empty()) { 167 llvm::errs() << "error: no input files\n"; 168 return true; 169 } 170 171 if (!origCI.getLangOpts()->ObjC) 172 return false; 173 174 MigrationProcess migration(origCI, std::make_shared<PCHContainerOperations>(), 175 DiagClient); 176 177 std::vector<TransformFn> 178 transforms = arcmt::getAllTransformations(origCI.getLangOpts()->getGC(), 179 origCI.getMigratorOpts().NoFinalizeRemoval); 180 assert(!transforms.empty()); 181 182 std::unique_ptr<PrintTransforms> transformPrinter; 183 if (OutputTransformations) 184 transformPrinter.reset(new PrintTransforms(llvm::outs())); 185 186 for (unsigned i=0, e = transforms.size(); i != e; ++i) { 187 bool err = migration.applyTransform(transforms[i], transformPrinter.get()); 188 if (err) return true; 189 190 if (VerboseOpt) { 191 if (i == e-1) 192 llvm::errs() << "\n##### FINAL RESULT #####\n"; 193 else 194 llvm::errs() << "\n##### OUTPUT AFTER "<< i+1 <<". TRANSFORMATION #####\n"; 195 printResult(migration.getRemapper(), llvm::errs()); 196 llvm::errs() << "\n##########################\n\n"; 197 } 198 } 199 200 if (!OutputTransformations) 201 printResult(migration.getRemapper(), llvm::outs()); 202 203 // FIXME: TestResultForARC 204 205 return false; 206 } 207 208 static bool filesCompareEqual(StringRef fname1, StringRef fname2) { 209 using namespace llvm; 210 211 ErrorOr<std::unique_ptr<MemoryBuffer>> file1 = MemoryBuffer::getFile(fname1); 212 if (!file1) 213 return false; 214 215 ErrorOr<std::unique_ptr<MemoryBuffer>> file2 = MemoryBuffer::getFile(fname2); 216 if (!file2) 217 return false; 218 219 return file1.get()->getBuffer() == file2.get()->getBuffer(); 220 } 221 222 static bool verifyTransformedFiles(ArrayRef<std::string> resultFiles) { 223 using namespace llvm; 224 225 assert(!resultFiles.empty()); 226 227 std::map<StringRef, StringRef> resultMap; 228 229 for (ArrayRef<std::string>::iterator 230 I = resultFiles.begin(), E = resultFiles.end(); I != E; ++I) { 231 StringRef fname(*I); 232 if (!fname.endswith(".result")) { 233 errs() << "error: filename '" << fname 234 << "' does not have '.result' extension\n"; 235 return true; 236 } 237 resultMap[sys::path::stem(fname)] = fname; 238 } 239 240 ErrorOr<std::unique_ptr<MemoryBuffer>> inputBuf = std::error_code(); 241 if (RemappingsFile.empty()) 242 inputBuf = MemoryBuffer::getSTDIN(); 243 else 244 inputBuf = MemoryBuffer::getFile(RemappingsFile); 245 if (!inputBuf) { 246 errs() << "error: could not read remappings input\n"; 247 return true; 248 } 249 250 SmallVector<StringRef, 8> strs; 251 inputBuf.get()->getBuffer().split(strs, "\n", /*MaxSplit=*/-1, 252 /*KeepEmpty=*/false); 253 254 if (strs.empty()) { 255 errs() << "error: no files to verify from stdin\n"; 256 return true; 257 } 258 if (strs.size() % 2 != 0) { 259 errs() << "error: files to verify are not original/result pairs\n"; 260 return true; 261 } 262 263 for (unsigned i = 0, e = strs.size(); i != e; i += 2) { 264 StringRef inputOrigFname = strs[i]; 265 StringRef inputResultFname = strs[i+1]; 266 267 std::map<StringRef, StringRef>::iterator It; 268 It = resultMap.find(sys::path::filename(inputOrigFname)); 269 if (It == resultMap.end()) { 270 errs() << "error: '" << inputOrigFname << "' is not in the list of " 271 << "transformed files to verify\n"; 272 return true; 273 } 274 275 if (!sys::fs::exists(It->second)) { 276 errs() << "error: '" << It->second << "' does not exist\n"; 277 return true; 278 } 279 if (!sys::fs::exists(inputResultFname)) { 280 errs() << "error: '" << inputResultFname << "' does not exist\n"; 281 return true; 282 } 283 284 if (!filesCompareEqual(It->second, inputResultFname)) { 285 errs() << "error: '" << It->second << "' is different than " 286 << "'" << inputResultFname << "'\n"; 287 return true; 288 } 289 290 resultMap.erase(It); 291 } 292 293 if (!resultMap.empty()) { 294 for (std::map<StringRef, StringRef>::iterator 295 I = resultMap.begin(), E = resultMap.end(); I != E; ++I) 296 errs() << "error: '" << I->second << "' was not verified!\n"; 297 return true; 298 } 299 300 return false; 301 } 302 303 //===----------------------------------------------------------------------===// 304 // Misc. functions. 305 //===----------------------------------------------------------------------===// 306 307 static void printSourceLocation(SourceLocation loc, ASTContext &Ctx, 308 raw_ostream &OS) { 309 SourceManager &SM = Ctx.getSourceManager(); 310 PresumedLoc PL = SM.getPresumedLoc(loc); 311 312 OS << llvm::sys::path::filename(PL.getFilename()); 313 OS << ":" << PL.getLine() << ":" 314 << PL.getColumn(); 315 } 316 317 static void printSourceRange(CharSourceRange range, ASTContext &Ctx, 318 raw_ostream &OS) { 319 SourceManager &SM = Ctx.getSourceManager(); 320 const LangOptions &langOpts = Ctx.getLangOpts(); 321 322 PresumedLoc PL = SM.getPresumedLoc(range.getBegin()); 323 324 OS << llvm::sys::path::filename(PL.getFilename()); 325 OS << " [" << PL.getLine() << ":" 326 << PL.getColumn(); 327 OS << " - "; 328 329 SourceLocation end = range.getEnd(); 330 PL = SM.getPresumedLoc(end); 331 332 unsigned endCol = PL.getColumn() - 1; 333 if (!range.isTokenRange()) 334 endCol += Lexer::MeasureTokenLength(end, SM, langOpts); 335 OS << PL.getLine() << ":" << endCol << "]"; 336 } 337 338 //===----------------------------------------------------------------------===// 339 // Command line processing. 340 //===----------------------------------------------------------------------===// 341 342 int main(int argc, const char **argv) { 343 void *MainAddr = (void*) (intptr_t) GetExecutablePath; 344 llvm::sys::PrintStackTraceOnErrorSignal(argv[0]); 345 346 std::string 347 resourcesPath = CompilerInvocation::GetResourcesPath(argv[0], MainAddr); 348 349 int optargc = 0; 350 for (; optargc != argc; ++optargc) { 351 if (StringRef(argv[optargc]) == "--args") 352 break; 353 } 354 llvm::cl::ParseCommandLineOptions(optargc, argv, "arcmt-test"); 355 356 if (VerifyTransformedFiles) { 357 if (ResultFiles.empty()) { 358 llvm::cl::PrintHelpMessage(); 359 return 1; 360 } 361 return verifyTransformedFiles(ResultFiles); 362 } 363 364 if (optargc == argc) { 365 llvm::cl::PrintHelpMessage(); 366 return 1; 367 } 368 369 ArrayRef<const char*> Args(argv+optargc+1, argc-optargc-1); 370 371 if (CheckOnly) 372 return checkForMigration(resourcesPath, Args); 373 374 return performTransformations(resourcesPath, Args); 375 } 376