1 //===--- ARCMT.cpp - Migration to ARC mode --------------------------------===//
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 #include "Internals.h"
11 #include "clang/AST/ASTConsumer.h"
12 #include "clang/Basic/DiagnosticCategories.h"
13 #include "clang/Frontend/ASTUnit.h"
14 #include "clang/Frontend/CompilerInstance.h"
15 #include "clang/Frontend/FrontendAction.h"
16 #include "clang/Frontend/TextDiagnosticPrinter.h"
17 #include "clang/Frontend/Utils.h"
18 #include "clang/Lex/Preprocessor.h"
19 #include "clang/Rewrite/Core/Rewriter.h"
20 #include "clang/Sema/SemaDiagnostic.h"
21 #include "clang/Serialization/ASTReader.h"
22 #include "llvm/ADT/Triple.h"
23 #include "llvm/Support/MemoryBuffer.h"
24 using namespace clang;
25 using namespace arcmt;
27 bool CapturedDiagList::clearDiagnostic(ArrayRef<unsigned> IDs,
29 if (range.isInvalid())
33 ListTy::iterator I = List.begin();
34 while (I != List.end()) {
35 FullSourceLoc diagLoc = I->getLocation();
36 if ((IDs.empty() || // empty means clear all diagnostics in the range.
37 std::find(IDs.begin(), IDs.end(), I->getID()) != IDs.end()) &&
38 !diagLoc.isBeforeInTranslationUnitThan(range.getBegin()) &&
39 (diagLoc == range.getEnd() ||
40 diagLoc.isBeforeInTranslationUnitThan(range.getEnd()))) {
42 ListTy::iterator eraseS = I++;
43 if (eraseS->getLevel() != DiagnosticsEngine::Note)
44 while (I != List.end() && I->getLevel() == DiagnosticsEngine::Note)
46 // Clear the diagnostic and any notes following it.
47 I = List.erase(eraseS, I);
57 bool CapturedDiagList::hasDiagnostic(ArrayRef<unsigned> IDs,
58 SourceRange range) const {
59 if (range.isInvalid())
62 ListTy::const_iterator I = List.begin();
63 while (I != List.end()) {
64 FullSourceLoc diagLoc = I->getLocation();
65 if ((IDs.empty() || // empty means any diagnostic in the range.
66 std::find(IDs.begin(), IDs.end(), I->getID()) != IDs.end()) &&
67 !diagLoc.isBeforeInTranslationUnitThan(range.getBegin()) &&
68 (diagLoc == range.getEnd() ||
69 diagLoc.isBeforeInTranslationUnitThan(range.getEnd()))) {
79 void CapturedDiagList::reportDiagnostics(DiagnosticsEngine &Diags) const {
80 for (ListTy::const_iterator I = List.begin(), E = List.end(); I != E; ++I)
84 bool CapturedDiagList::hasErrors() const {
85 for (ListTy::const_iterator I = List.begin(), E = List.end(); I != E; ++I)
86 if (I->getLevel() >= DiagnosticsEngine::Error)
94 class CaptureDiagnosticConsumer : public DiagnosticConsumer {
95 DiagnosticsEngine &Diags;
96 DiagnosticConsumer &DiagClient;
97 CapturedDiagList &CapturedDiags;
98 bool HasBegunSourceFile;
100 CaptureDiagnosticConsumer(DiagnosticsEngine &diags,
101 DiagnosticConsumer &client,
102 CapturedDiagList &capturedDiags)
103 : Diags(diags), DiagClient(client), CapturedDiags(capturedDiags),
104 HasBegunSourceFile(false) { }
106 void BeginSourceFile(const LangOptions &Opts,
107 const Preprocessor *PP) override {
108 // Pass BeginSourceFile message onto DiagClient on first call.
109 // The corresponding EndSourceFile call will be made from an
110 // explicit call to FinishCapture.
111 if (!HasBegunSourceFile) {
112 DiagClient.BeginSourceFile(Opts, PP);
113 HasBegunSourceFile = true;
117 void FinishCapture() {
118 // Call EndSourceFile on DiagClient on completion of capture to
119 // enable VerifyDiagnosticConsumer to check diagnostics *after*
120 // it has received the diagnostic list.
121 if (HasBegunSourceFile) {
122 DiagClient.EndSourceFile();
123 HasBegunSourceFile = false;
127 ~CaptureDiagnosticConsumer() override {
128 assert(!HasBegunSourceFile && "FinishCapture not called!");
131 void HandleDiagnostic(DiagnosticsEngine::Level level,
132 const Diagnostic &Info) override {
133 if (DiagnosticIDs::isARCDiagnostic(Info.getID()) ||
134 level >= DiagnosticsEngine::Error || level == DiagnosticsEngine::Note) {
135 if (Info.getLocation().isValid())
136 CapturedDiags.push_back(StoredDiagnostic(level, Info));
140 // Non-ARC warnings are ignored.
141 Diags.setLastDiagnosticIgnored();
145 } // end anonymous namespace
147 static bool HasARCRuntime(CompilerInvocation &origCI) {
148 // This duplicates some functionality from Darwin::AddDeploymentTarget
149 // but this function is well defined, so keep it decoupled from the driver
150 // and avoid unrelated complications.
151 llvm::Triple triple(origCI.getTargetOpts().Triple);
154 return triple.getOSMajorVersion() >= 5;
156 if (triple.getOS() == llvm::Triple::Darwin)
157 return triple.getOSMajorVersion() >= 11;
159 if (triple.getOS() == llvm::Triple::MacOSX) {
160 unsigned Major, Minor, Micro;
161 triple.getOSVersion(Major, Minor, Micro);
162 return Major > 10 || (Major == 10 && Minor >= 7);
168 static CompilerInvocation *
169 createInvocationForMigration(CompilerInvocation &origCI,
170 const PCHContainerReader &PCHContainerRdr) {
171 std::unique_ptr<CompilerInvocation> CInvok;
172 CInvok.reset(new CompilerInvocation(origCI));
173 PreprocessorOptions &PPOpts = CInvok->getPreprocessorOpts();
174 if (!PPOpts.ImplicitPCHInclude.empty()) {
175 // We can't use a PCH because it was likely built in non-ARC mode and we
176 // want to parse in ARC. Include the original header.
177 FileManager FileMgr(origCI.getFileSystemOpts());
178 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
179 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
180 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
181 new IgnoringDiagConsumer()));
182 std::string OriginalFile = ASTReader::getOriginalSourceFile(
183 PPOpts.ImplicitPCHInclude, FileMgr, PCHContainerRdr, *Diags);
184 if (!OriginalFile.empty())
185 PPOpts.Includes.insert(PPOpts.Includes.begin(), OriginalFile);
186 PPOpts.ImplicitPCHInclude.clear();
188 // FIXME: Get the original header of a PTH as well.
189 CInvok->getPreprocessorOpts().ImplicitPTHInclude.clear();
190 std::string define = getARCMTMacroName();
192 CInvok->getPreprocessorOpts().addMacroDef(define);
193 CInvok->getLangOpts()->ObjCAutoRefCount = true;
194 CInvok->getLangOpts()->setGC(LangOptions::NonGC);
195 CInvok->getDiagnosticOpts().ErrorLimit = 0;
196 CInvok->getDiagnosticOpts().PedanticErrors = 0;
198 // Ignore -Werror flags when migrating.
199 std::vector<std::string> WarnOpts;
200 for (std::vector<std::string>::iterator
201 I = CInvok->getDiagnosticOpts().Warnings.begin(),
202 E = CInvok->getDiagnosticOpts().Warnings.end(); I != E; ++I) {
203 if (!StringRef(*I).startswith("error"))
204 WarnOpts.push_back(*I);
206 WarnOpts.push_back("error=arc-unsafe-retained-assign");
207 CInvok->getDiagnosticOpts().Warnings = std::move(WarnOpts);
209 CInvok->getLangOpts()->ObjCARCWeak = HasARCRuntime(origCI);
211 return CInvok.release();
214 static void emitPremigrationErrors(const CapturedDiagList &arcDiags,
215 DiagnosticOptions *diagOpts,
217 TextDiagnosticPrinter printer(llvm::errs(), diagOpts);
218 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
219 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
220 new DiagnosticsEngine(DiagID, diagOpts, &printer,
221 /*ShouldOwnClient=*/false));
222 Diags->setSourceManager(&PP.getSourceManager());
224 printer.BeginSourceFile(PP.getLangOpts(), &PP);
225 arcDiags.reportDiagnostics(*Diags);
226 printer.EndSourceFile();
229 //===----------------------------------------------------------------------===//
230 // checkForManualIssues.
231 //===----------------------------------------------------------------------===//
233 bool arcmt::checkForManualIssues(
234 CompilerInvocation &origCI, const FrontendInputFile &Input,
235 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
236 DiagnosticConsumer *DiagClient, bool emitPremigrationARCErrors,
237 StringRef plistOut) {
238 if (!origCI.getLangOpts()->ObjC1)
241 LangOptions::GCMode OrigGCMode = origCI.getLangOpts()->getGC();
242 bool NoNSAllocReallocError = origCI.getMigratorOpts().NoNSAllocReallocError;
243 bool NoFinalizeRemoval = origCI.getMigratorOpts().NoFinalizeRemoval;
245 std::vector<TransformFn> transforms = arcmt::getAllTransformations(OrigGCMode,
247 assert(!transforms.empty());
249 std::unique_ptr<CompilerInvocation> CInvok;
251 createInvocationForMigration(origCI, PCHContainerOps->getRawReader()));
252 CInvok->getFrontendOpts().Inputs.clear();
253 CInvok->getFrontendOpts().Inputs.push_back(Input);
255 CapturedDiagList capturedDiags;
258 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
259 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
260 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
261 DiagClient, /*ShouldOwnClient=*/false));
263 // Filter of all diagnostics.
264 CaptureDiagnosticConsumer errRec(*Diags, *DiagClient, capturedDiags);
265 Diags->setClient(&errRec, /*ShouldOwnClient=*/false);
267 std::unique_ptr<ASTUnit> Unit(ASTUnit::LoadFromCompilerInvocationAction(
268 CInvok.release(), PCHContainerOps, Diags));
270 errRec.FinishCapture();
274 // Don't filter diagnostics anymore.
275 Diags->setClient(DiagClient, /*ShouldOwnClient=*/false);
277 ASTContext &Ctx = Unit->getASTContext();
279 if (Diags->hasFatalErrorOccurred()) {
281 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
282 capturedDiags.reportDiagnostics(*Diags);
283 DiagClient->EndSourceFile();
284 errRec.FinishCapture();
288 if (emitPremigrationARCErrors)
289 emitPremigrationErrors(capturedDiags, &origCI.getDiagnosticOpts(),
290 Unit->getPreprocessor());
291 if (!plistOut.empty()) {
292 SmallVector<StoredDiagnostic, 8> arcDiags;
293 for (CapturedDiagList::iterator
294 I = capturedDiags.begin(), E = capturedDiags.end(); I != E; ++I)
295 arcDiags.push_back(*I);
296 writeARCDiagsToPlist(plistOut, arcDiags,
297 Ctx.getSourceManager(), Ctx.getLangOpts());
300 // After parsing of source files ended, we want to reuse the
301 // diagnostics objects to emit further diagnostics.
302 // We call BeginSourceFile because DiagnosticConsumer requires that
303 // diagnostics with source range information are emitted only in between
304 // BeginSourceFile() and EndSourceFile().
305 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
307 // No macros will be added since we are just checking and we won't modify
309 std::vector<SourceLocation> ARCMTMacroLocs;
311 TransformActions testAct(*Diags, capturedDiags, Ctx, Unit->getPreprocessor());
312 MigrationPass pass(Ctx, OrigGCMode, Unit->getSema(), testAct, capturedDiags,
314 pass.setNoFinalizeRemoval(NoFinalizeRemoval);
315 if (!NoNSAllocReallocError)
316 Diags->setSeverity(diag::warn_arcmt_nsalloc_realloc, diag::Severity::Error,
319 for (unsigned i=0, e = transforms.size(); i != e; ++i)
322 capturedDiags.reportDiagnostics(*Diags);
324 DiagClient->EndSourceFile();
325 errRec.FinishCapture();
327 return capturedDiags.hasErrors() || testAct.hasReportedErrors();
330 //===----------------------------------------------------------------------===//
331 // applyTransformations.
332 //===----------------------------------------------------------------------===//
335 applyTransforms(CompilerInvocation &origCI, const FrontendInputFile &Input,
336 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
337 DiagnosticConsumer *DiagClient, StringRef outputDir,
338 bool emitPremigrationARCErrors, StringRef plistOut) {
339 if (!origCI.getLangOpts()->ObjC1)
342 LangOptions::GCMode OrigGCMode = origCI.getLangOpts()->getGC();
344 // Make sure checking is successful first.
345 CompilerInvocation CInvokForCheck(origCI);
346 if (arcmt::checkForManualIssues(CInvokForCheck, Input, PCHContainerOps,
347 DiagClient, emitPremigrationARCErrors,
351 CompilerInvocation CInvok(origCI);
352 CInvok.getFrontendOpts().Inputs.clear();
353 CInvok.getFrontendOpts().Inputs.push_back(Input);
355 MigrationProcess migration(CInvok, PCHContainerOps, DiagClient, outputDir);
356 bool NoFinalizeRemoval = origCI.getMigratorOpts().NoFinalizeRemoval;
358 std::vector<TransformFn> transforms = arcmt::getAllTransformations(OrigGCMode,
360 assert(!transforms.empty());
362 for (unsigned i=0, e = transforms.size(); i != e; ++i) {
363 bool err = migration.applyTransform(transforms[i]);
364 if (err) return true;
367 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
368 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
369 new DiagnosticsEngine(DiagID, &origCI.getDiagnosticOpts(),
370 DiagClient, /*ShouldOwnClient=*/false));
372 if (outputDir.empty()) {
373 origCI.getLangOpts()->ObjCAutoRefCount = true;
374 return migration.getRemapper().overwriteOriginal(*Diags);
376 return migration.getRemapper().flushToDisk(outputDir, *Diags);
380 bool arcmt::applyTransformations(
381 CompilerInvocation &origCI, const FrontendInputFile &Input,
382 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
383 DiagnosticConsumer *DiagClient) {
384 return applyTransforms(origCI, Input, PCHContainerOps, DiagClient,
385 StringRef(), false, StringRef());
388 bool arcmt::migrateWithTemporaryFiles(
389 CompilerInvocation &origCI, const FrontendInputFile &Input,
390 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
391 DiagnosticConsumer *DiagClient, StringRef outputDir,
392 bool emitPremigrationARCErrors, StringRef plistOut) {
393 assert(!outputDir.empty() && "Expected output directory path");
394 return applyTransforms(origCI, Input, PCHContainerOps, DiagClient, outputDir,
395 emitPremigrationARCErrors, plistOut);
398 bool arcmt::getFileRemappings(std::vector<std::pair<std::string,std::string> > &
401 DiagnosticConsumer *DiagClient) {
402 assert(!outputDir.empty());
404 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
405 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
406 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
407 DiagClient, /*ShouldOwnClient=*/false));
409 FileRemapper remapper;
410 bool err = remapper.initFromDisk(outputDir, *Diags,
411 /*ignoreIfFilesChanged=*/true);
415 PreprocessorOptions PPOpts;
416 remapper.applyMappings(PPOpts);
417 remap = PPOpts.RemappedFiles;
423 //===----------------------------------------------------------------------===//
424 // CollectTransformActions.
425 //===----------------------------------------------------------------------===//
429 class ARCMTMacroTrackerPPCallbacks : public PPCallbacks {
430 std::vector<SourceLocation> &ARCMTMacroLocs;
433 ARCMTMacroTrackerPPCallbacks(std::vector<SourceLocation> &ARCMTMacroLocs)
434 : ARCMTMacroLocs(ARCMTMacroLocs) { }
436 void MacroExpands(const Token &MacroNameTok, const MacroDefinition &MD,
437 SourceRange Range, const MacroArgs *Args) override {
438 if (MacroNameTok.getIdentifierInfo()->getName() == getARCMTMacroName())
439 ARCMTMacroLocs.push_back(MacroNameTok.getLocation());
443 class ARCMTMacroTrackerAction : public ASTFrontendAction {
444 std::vector<SourceLocation> &ARCMTMacroLocs;
447 ARCMTMacroTrackerAction(std::vector<SourceLocation> &ARCMTMacroLocs)
448 : ARCMTMacroLocs(ARCMTMacroLocs) { }
450 std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
451 StringRef InFile) override {
452 CI.getPreprocessor().addPPCallbacks(
453 llvm::make_unique<ARCMTMacroTrackerPPCallbacks>(ARCMTMacroLocs));
454 return llvm::make_unique<ASTConsumer>();
458 class RewritesApplicator : public TransformActions::RewriteReceiver {
460 MigrationProcess::RewriteListener *Listener;
463 RewritesApplicator(Rewriter &rewriter, ASTContext &ctx,
464 MigrationProcess::RewriteListener *listener)
465 : rewriter(rewriter), Listener(listener) {
467 Listener->start(ctx);
469 ~RewritesApplicator() override {
474 void insert(SourceLocation loc, StringRef text) override {
475 bool err = rewriter.InsertText(loc, text, /*InsertAfter=*/true,
476 /*indentNewLines=*/true);
477 if (!err && Listener)
478 Listener->insert(loc, text);
481 void remove(CharSourceRange range) override {
482 Rewriter::RewriteOptions removeOpts;
483 removeOpts.IncludeInsertsAtBeginOfRange = false;
484 removeOpts.IncludeInsertsAtEndOfRange = false;
485 removeOpts.RemoveLineIfEmpty = true;
487 bool err = rewriter.RemoveText(range, removeOpts);
488 if (!err && Listener)
489 Listener->remove(range);
492 void increaseIndentation(CharSourceRange range,
493 SourceLocation parentIndent) override {
494 rewriter.IncreaseIndentation(range, parentIndent);
498 } // end anonymous namespace.
500 /// \brief Anchor for VTable.
501 MigrationProcess::RewriteListener::~RewriteListener() { }
503 MigrationProcess::MigrationProcess(
504 const CompilerInvocation &CI,
505 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
506 DiagnosticConsumer *diagClient, StringRef outputDir)
507 : OrigCI(CI), PCHContainerOps(PCHContainerOps), DiagClient(diagClient),
508 HadARCErrors(false) {
509 if (!outputDir.empty()) {
510 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
511 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
512 new DiagnosticsEngine(DiagID, &CI.getDiagnosticOpts(),
513 DiagClient, /*ShouldOwnClient=*/false));
514 Remapper.initFromDisk(outputDir, *Diags, /*ignoreIfFilesChanges=*/true);
518 bool MigrationProcess::applyTransform(TransformFn trans,
519 RewriteListener *listener) {
520 std::unique_ptr<CompilerInvocation> CInvok;
522 createInvocationForMigration(OrigCI, PCHContainerOps->getRawReader()));
523 CInvok->getDiagnosticOpts().IgnoreWarnings = true;
525 Remapper.applyMappings(CInvok->getPreprocessorOpts());
527 CapturedDiagList capturedDiags;
528 std::vector<SourceLocation> ARCMTMacroLocs;
531 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
532 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
533 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
534 DiagClient, /*ShouldOwnClient=*/false));
536 // Filter of all diagnostics.
537 CaptureDiagnosticConsumer errRec(*Diags, *DiagClient, capturedDiags);
538 Diags->setClient(&errRec, /*ShouldOwnClient=*/false);
540 std::unique_ptr<ARCMTMacroTrackerAction> ASTAction;
541 ASTAction.reset(new ARCMTMacroTrackerAction(ARCMTMacroLocs));
543 std::unique_ptr<ASTUnit> Unit(ASTUnit::LoadFromCompilerInvocationAction(
544 CInvok.release(), PCHContainerOps, Diags, ASTAction.get()));
546 errRec.FinishCapture();
549 Unit->setOwnsRemappedFileBuffers(false); // FileRemapper manages that.
551 HadARCErrors = HadARCErrors || capturedDiags.hasErrors();
553 // Don't filter diagnostics anymore.
554 Diags->setClient(DiagClient, /*ShouldOwnClient=*/false);
556 ASTContext &Ctx = Unit->getASTContext();
558 if (Diags->hasFatalErrorOccurred()) {
560 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
561 capturedDiags.reportDiagnostics(*Diags);
562 DiagClient->EndSourceFile();
563 errRec.FinishCapture();
567 // After parsing of source files ended, we want to reuse the
568 // diagnostics objects to emit further diagnostics.
569 // We call BeginSourceFile because DiagnosticConsumer requires that
570 // diagnostics with source range information are emitted only in between
571 // BeginSourceFile() and EndSourceFile().
572 DiagClient->BeginSourceFile(Ctx.getLangOpts(), &Unit->getPreprocessor());
574 Rewriter rewriter(Ctx.getSourceManager(), Ctx.getLangOpts());
575 TransformActions TA(*Diags, capturedDiags, Ctx, Unit->getPreprocessor());
576 MigrationPass pass(Ctx, OrigCI.getLangOpts()->getGC(),
577 Unit->getSema(), TA, capturedDiags, ARCMTMacroLocs);
582 RewritesApplicator applicator(rewriter, Ctx, listener);
583 TA.applyRewrites(applicator);
586 DiagClient->EndSourceFile();
587 errRec.FinishCapture();
589 if (DiagClient->getNumErrors())
592 for (Rewriter::buffer_iterator
593 I = rewriter.buffer_begin(), E = rewriter.buffer_end(); I != E; ++I) {
594 FileID FID = I->first;
595 RewriteBuffer &buf = I->second;
596 const FileEntry *file = Ctx.getSourceManager().getFileEntryForID(FID);
598 std::string newFname = file->getName();
599 newFname += "-trans";
600 SmallString<512> newText;
601 llvm::raw_svector_ostream vecOS(newText);
604 std::unique_ptr<llvm::MemoryBuffer> memBuf(
605 llvm::MemoryBuffer::getMemBufferCopy(
606 StringRef(newText.data(), newText.size()), newFname));
607 SmallString<64> filePath(file->getName());
608 Unit->getFileManager().FixupRelativePath(filePath);
609 Remapper.remap(filePath.str(), std::move(memBuf));