Take path arg for comparo

Author: David Ungar

include/swift/AST/DiagnosticsDriver.def

@@ -107,6 +107,9 @@ WARNING(incremental_requires_build_record_entry,none,
         "ignoring -incremental; output file map has no master dependencies "
         "entry (\"%0\" under \"\")", (StringRef))
 
+WARNING(unable_to_open_incremental_comparison_log,none,
+"unable to open incremental comparison log file '%0'", (StringRef))
+
 ERROR(error_os_minimum_deployment,none,
       "Swift requires a minimum deployment target of %0", (StringRef))
 ERROR(error_sdk_too_old,none,

include/swift/Driver/Compilation.h

@@ -19,6 +19,7 @@
 
 #include "swift/Basic/ArrayRefView.h"
 #include "swift/Basic/LLVM.h"
+#include "swift/Basic/NullablePtr.h"
 #include "swift/Basic/OutputFileMap.h"
 #include "swift/Basic/Statistic.h"
 #include "swift/Driver/Driver.h"
@@ -230,14 +231,21 @@ class Compilation {
   /// How many .swift input files?
   unsigned countSwiftInputs() const;
 
-  /// Print out a short message comparing dependencies w/  source-ranges
+  /// Print out a short message comparing dependencies w/  source-ranges, or
+  /// output it to the path below
   const bool CompareIncrementalSchemes;
 
+  /// If not empty, the path to use to log the comparision.
+  const StringRef CompareIncrementalSchemesPath;
+
   template <typename DepJobsT, typename RangeJobsT>
   void updateJobsForComparison(const DepJobsT &depJobs,
                                const RangeJobsT &rangeJobs);
   void setFallingBackForComparison();
-  void printComparision() const;
+  void outputComparison() const;
+
+private:
+  void outputComparison(llvm::raw_ostream &) const;
 
 private:
   llvm::SmallPtrSet<const Job *, 16> DependencyCompileJobs;
@@ -280,7 +288,8 @@ class Compilation {
               bool EmitExperimentalDependencyDotFileAfterEveryImport = false,
               bool ExperimentalDependenciesIncludeIntrafileOnes = false,
               bool EnableSourceRangeDependencies = false,
-              bool CompareIncrementalSchemes = false);
+              bool CompareIncrementalSchemes = false,
+              StringRef CompareIncrementalSchemesPath = "");
   // clang-format on
   ~Compilation();
 

include/swift/Option/Options.td

@@ -145,9 +145,19 @@ HelpText<"Try using source range information">;
 
 
 def driver_compare_incremental_schemes :
-Flag<["-"], "driver-compare-incremental-schemes">, Flags<[]>,
+Flag<["-"], "driver-compare-incremental-schemes">, Flags<[DoesNotAffectIncrementalBuild]>,
 HelpText<"Print a simple message comparing dependencies with source ranges (w/ fallback)">;
 
+def driver_compare_incremental_schemes_path :
+Separate<["-"], "driver-compare-incremental-schemes-path">, Flags<[ArgumentIsPath,DoesNotAffectIncrementalBuild]>,
+HelpText<"Path to use for machine-readable comparision">,
+MetaVarName<"<path>">;
+
+def driver_compare_incremental_schemes_path_EQ :
+Joined<["-"], "driver-compare-incremental-schemes-path=">, Flags<[]>,
+Alias<driver_compare_incremental_schemes_path>;
+
+
 def driver_verify_experimental_dependency_graph_after_every_import :
 Flag<["-"], "driver-verify-experimental-dependency-graph-after-every-import">,
 InternalDebugOpt,

lib/Driver/Compilation.cpp

@@ -126,7 +126,8 @@ Compilation::Compilation(DiagnosticEngine &Diags,
                          bool EmitExperimentalDependencyDotFileAfterEveryImport,
                          bool ExperimentalDependenciesIncludeIntrafileOnes,
                          bool EnableSourceRangeDependencies,
-                         bool CompareIncrementalSchemes)
+                         bool CompareIncrementalSchemes,
+                         StringRef CompareIncrementalSchemesPath)
   : Diags(Diags), TheToolChain(TC),
     TheOutputInfo(OI),
     Level(Level),
@@ -156,7 +157,8 @@ Compilation::Compilation(DiagnosticEngine &Diags,
     ExperimentalDependenciesIncludeIntrafileOnes(
       ExperimentalDependenciesIncludeIntrafileOnes),
     EnableSourceRangeDependencies(EnableSourceRangeDependencies),
-    CompareIncrementalSchemes(CompareIncrementalSchemes) {
+    CompareIncrementalSchemes(CompareIncrementalSchemes),
+    CompareIncrementalSchemesPath(CompareIncrementalSchemesPath) {
 };
 // clang-format on
 
@@ -1906,7 +1908,7 @@ int Compilation::performJobs(std::unique_ptr<TaskQueue> &&TQ) {
   bool abnormalExit;
   int result = performJobsImpl(abnormalExit, std::move(TQ));
 
-  printComparision();
+  outputComparison();
 
   if (!SaveTemps) {
     for (const auto &pathPair : TempFilePaths) {
@@ -1954,21 +1956,42 @@ void Compilation::setFallingBackForComparison() {
   SourceRangeCompileJobs = None;
 }
 
-void Compilation::printComparision() const {
+void Compilation::outputComparison() const {
   if (!CompareIncrementalSchemes)
     return;
+
+  if (CompareIncrementalSchemesPath.empty()) {
+    outputComparison(llvm::outs());
+    return;
+  }
+
+  std::error_code EC;
+  using namespace llvm::sys::fs;
+  llvm::raw_fd_ostream OS(CompareIncrementalSchemesPath, EC, CD_OpenAlways,
+                          FA_Write, OF_Append | OF_Text);
+
+  if (EC) {
+    getDiags().diagnose(SourceLoc(),
+                        diag::unable_to_open_incremental_comparison_log,
+                        CompareIncrementalSchemesPath);
+    return;
+  }
+  outputComparison(OS);
+}
+
+void Compilation::outputComparison(llvm::raw_ostream &out) const {
   if (!getIncrementalBuildEnabled())
-    llvm::outs() << "*** Comparing incremental strategies is moot: incremental "
-                    "compilation disabled ***\n";
+    out << "*** Comparing incremental strategies is moot: incremental "
+           "compilation disabled ***\n";
   else if (SourceRangeCompileJobs)
-    llvm::outs() << "*** Comparing deps: " << DependencyCompileJobs.size()
-                 << ", ranges: " << SourceRangeCompileJobs->size()
-                 << ", total: " << countSwiftInputs() << " ***\n";
+    out << "*** Comparing deps: " << DependencyCompileJobs.size()
+        << ", ranges: " << SourceRangeCompileJobs->size()
+        << ", total: " << countSwiftInputs() << " ***\n";
   else
-    llvm::outs() << "*** Comparing incremental strategies is moot: would fall "
-                    "back and run "
-                 << DependencyCompileJobs.size()
-                 << ", total: " << countSwiftInputs() << " ***\n";
+    out << "*** Comparing incremental strategies is moot: would fall "
+           "back and run "
+        << DependencyCompileJobs.size() << ", total: " << countSwiftInputs()
+        << " ***\n";
 }
 
 unsigned Compilation::countSwiftInputs() const {

lib/Driver/Driver.cpp

@@ -857,7 +857,10 @@ Driver::buildCompilation(const ToolChain &TC,
   const bool EnableSourceRangeDependencies =
       ArgList->hasArg(options::OPT_enable_source_range_dependencies);
   const bool CompareIncrementalSchemes =
-      ArgList->hasArg(options::OPT_driver_compare_incremental_schemes);
+      ArgList->hasArg(options::OPT_driver_compare_incremental_schemes) ||
+      ArgList->hasArg(options::OPT_driver_compare_incremental_schemes_path);
+  const StringRef CompareIncrementalSchemesPath = ArgList->getLastArgValue(
+      options::OPT_driver_compare_incremental_schemes_path);
 
   Optional<OutputFileMap> OFM = buildOutputFileMap(
       *TranslatedArgList, workingDirectory,
@@ -982,7 +985,8 @@ Driver::buildCompilation(const ToolChain &TC,
         EmitExperimentalDependencyDotFileAfterEveryImport,
         ExperimentalDependenciesIncludeIntrafileOnes,
         EnableSourceRangeDependencies,
-        CompareIncrementalSchemes);
+        CompareIncrementalSchemes,
+        CompareIncrementalSchemesPath);
     // clang-format on
   }
 

test/Driver/Dependencies/range-lifecycle.swift

@@ -69,11 +69,11 @@
 // Now, do it again with range dependencies enabled:
 // =============================================================================
 
-// RUN: cd %t && %swiftc_driver -driver-compare-incremental-schemes -enable-source-range-dependencies -output-file-map %t/output.json -incremental -enable-batch-mode ./main.swift ./fileA.swift ./fileB.swift -module-name main -j2 -driver-show-job-lifecycle -driver-show-incremental  >& %t/output2
+// RUN: cd %t && %swiftc_driver -driver-compare-incremental-schemes-path=./comparo -enable-source-range-dependencies -output-file-map %t/output.json -incremental -enable-batch-mode ./main.swift ./fileA.swift ./fileB.swift -module-name main -j2 -driver-show-job-lifecycle -driver-show-incremental  >& %t/output2
 
 // RUN: %FileCheck -check-prefix=CHECK-HAS-NO-BATCHES  %s < %t/output2
 
-// RUN: %FileCheck -check-prefix=CHECK-COMPARE-DISABLED %s < %t/output2
+// RUN: %FileCheck -check-prefix=CHECK-COMPARE-DISABLED %s < %t/comparo
 
 // RUN: %FileCheck -check-prefix=CHECK-TURN-ON-RANGES %s < %t/output2
 
@@ -131,11 +131,12 @@
 // =============================================================================
 
 
-// RUN: cd %t && %swiftc_driver -driver-compare-incremental-schemes -enable-source-range-dependencies -output-file-map %t/output.json -incremental -enable-batch-mode ./main.swift ./fileA.swift ./fileB.swift -module-name main -j2 -driver-show-job-lifecycle -driver-show-incremental >& %t/output3
+// RUN: cd %t && %swiftc_driver -driver-compare-incremental-schemes-path ./comparo -enable-source-range-dependencies -output-file-map %t/output.json -incremental -enable-batch-mode ./main.swift ./fileA.swift ./fileB.swift -module-name main -j2 -driver-show-job-lifecycle -driver-show-incremental >& %t/output3
 
 // RUN: %FileCheck -check-prefix=CHECK-HAS-NO-BATCHES  %s < %t/output3
 
-// RUN: %FileCheck -check-prefix=CHECK-COMPARE-0-0-3 %s < %t/output3
+// RUN: %FileCheck -check-prefix=CHECK-COMPARE-DISABLED %s < %t/comparo
+// RUN: %FileCheck -check-prefix=CHECK-COMPARE-0-0-3 %s < %t/comparo
 // CHECK-COMPARE-0-0-3: *** Comparing deps: 0, ranges: 0, total: 3 ***
 
 // RUN: %FileCheck -check-prefix=CHECK-INCREMENTAL-ENABLED %s < %t/output3