Merge pull request #14961 from davidungar/PR-18-10-HHH

[Batch mode] Restore -### functionality for batch-mode by extending OutputLevel.

Author: David Ungar

include/swift/Driver/Compilation.h

@@ -51,6 +51,9 @@ namespace driver {
 enum class OutputLevel {
   /// Indicates that normal output should be produced.
   Normal,
+  
+  /// Indicates that only jobs should be printed and not run. (-###)
+  PrintJobs,
 
   /// Indicates that verbose output should be produced. (-v)
   Verbose,

include/swift/Driver/Driver.h

@@ -357,9 +357,6 @@ class Driver {
   /// Print the list of Actions in a Compilation.
   void printActions(const Compilation &C) const;
 
-  /// Print the list of Jobs in a Compilation.
-  void printJobs(const Compilation &C) const;
-
   /// Print the driver version.
   void printVersion(const ToolChain &TC, raw_ostream &OS) const;
 

lib/Driver/Compilation.cpp

@@ -311,11 +311,21 @@ namespace driver {
         DriverTimers[BeganCmd]->startTimer();
       }
 
-      // For verbose output, print out each command as it begins execution.
-      if (Comp.Level == OutputLevel::Verbose)
+      switch (Comp.Level) {
+      case OutputLevel::Normal:
+        break;
+        // For command line or verbose output, print out each command as it
+        // begins execution.
+      case OutputLevel::PrintJobs:
+        BeganCmd->printCommandLineAndEnvironment(llvm::outs());
+        break;
+      case OutputLevel::Verbose:
         BeganCmd->printCommandLine(llvm::errs());
-      else if (Comp.Level == OutputLevel::Parseable)
+        break;
+      case OutputLevel::Parseable:
         parseable_output::emitBeganMessage(llvm::errs(), *BeganCmd, Pid);
+        break;
+      }
     }
 
     /// Note that a .swiftdeps file failed to load and take corrective actions:
@@ -450,15 +460,22 @@ namespace driver {
           DriverTimers[FinishedCmd]->stopTimer();
         }
 
-        if (Comp.Level == OutputLevel::Parseable) {
-          // Parseable output was requested.
-          parseable_output::emitFinishedMessage(llvm::errs(), *FinishedCmd, Pid,
-                                                ReturnCode, Output);
-        } else {
-          // Otherwise, send the buffered output to stderr, though only if we
+        switch (Comp.Level) {
+        case OutputLevel::PrintJobs:
+          // Only print the jobs, not the outputs
+          break;
+        case OutputLevel::Normal:
+        case OutputLevel::Verbose:
+          // Send the buffered output to stderr, though only if we
           // support getting buffered output.
           if (TaskQueue::supportsBufferingOutput())
             llvm::errs() << Output;
+          break;
+        case OutputLevel::Parseable:
+          // Parseable output was requested.
+          parseable_output::emitFinishedMessage(llvm::errs(), *FinishedCmd, Pid,
+                                                ReturnCode, Output);
+          break;
         }
       }
 
@@ -1156,8 +1173,17 @@ int Compilation::performSingleCommand(const Job *Cmd) {
   if (!writeFilelistIfNecessary(Cmd, Diags))
     return 1;
 
-  if (Level == OutputLevel::Verbose)
+  switch (Level) {
+  case OutputLevel::Normal:
+  case OutputLevel::Parseable:
+    break;
+  case OutputLevel::PrintJobs:
+    Cmd->printCommandLineAndEnvironment(llvm::outs());
+    return 0;
+  case OutputLevel::Verbose:
     Cmd->printCommandLine(llvm::errs());
+    break;
+  }
 
   SmallVector<const char *, 128> Argv;
   Argv.push_back(Cmd->getExecutable());

lib/Driver/Driver.cpp

@@ -518,9 +518,9 @@ Driver::buildCompilation(const ToolChain &TC,
   bool DriverPrintDerivedOutputFileMap =
     ArgList->hasArg(options::OPT_driver_print_derived_output_file_map);
   DriverPrintBindings = ArgList->hasArg(options::OPT_driver_print_bindings);
-  bool DriverPrintJobs = ArgList->hasArg(options::OPT_driver_print_jobs);
   bool DriverSkipExecution =
-    ArgList->hasArg(options::OPT_driver_skip_execution);
+    ArgList->hasArg(options::OPT_driver_skip_execution,
+                    options::OPT_driver_print_jobs);
   bool ShowIncrementalBuildDecisions =
     ArgList->hasArg(options::OPT_driver_show_incremental);
   bool ShowJobLifecycle =
@@ -682,9 +682,12 @@ Driver::buildCompilation(const ToolChain &TC,
   }
 
   OutputLevel Level = OutputLevel::Normal;
-  if (const Arg *A = ArgList->getLastArg(options::OPT_v,
-                                         options::OPT_parseable_output)) {
-    if (A->getOption().matches(options::OPT_v))
+  if (const Arg *A =
+          ArgList->getLastArg(options::OPT_driver_print_jobs, options::OPT_v,
+                              options::OPT_parseable_output)) {
+    if (A->getOption().matches(options::OPT_driver_print_jobs))
+      Level = OutputLevel::PrintJobs;
+    else if (A->getOption().matches(options::OPT_v))
       Level = OutputLevel::Verbose;
     else if (A->getOption().matches(options::OPT_parseable_output))
       Level = OutputLevel::Parseable;
@@ -757,11 +760,6 @@ Driver::buildCompilation(const ToolChain &TC,
   if (DriverPrintBindings)
     return nullptr;
 
-  if (DriverPrintJobs) {
-    printJobs(*C);
-    return nullptr;
-  }
-
   return C;
 }
 
@@ -2625,11 +2623,6 @@ void Driver::printActions(const Compilation &C) const {
   }
 }
 
-void Driver::printJobs(const Compilation &C) const {
-  for (const Job *J : C.getJobs())
-    J->printCommandLineAndEnvironment(llvm::outs());
-}
-
 void Driver::printVersion(const ToolChain &TC, raw_ostream &OS) const {
   OS << version::getSwiftFullVersion(
     version::Version::getCurrentLanguageVersion()) << '\n';

test/Driver/batch_mode_print_jobs.swift

@@ -0,0 +1,18 @@
+// Ensure that the -### and -driver-print-jobs options work properly in batch
+// mode. They should each do the same thing, so test them both.
+//
+// Test be sure that the output does reflect the batching, in other words
+// multiple primary files. Also test to be sure that the output is on
+// stdout, and NOT stderr.
+
+
+// RUN: %empty-directory(%t)
+// RUN: touch %t/file-01.swift %t/file-02.swift %t/file-03.swift
+// RUN: echo 'public func main() {}' >%t/main.swift
+//
+// RUN: %swiftc_driver -enable-batch-mode -c -emit-module -module-name main -j 2 %t/file-01.swift %t/file-02.swift %t/file-03.swift %t/main.swift  -driver-print-jobs 2>%t/shouldBeEmpty1 | %FileCheck %s -check-prefix=CHECK-COMBINED
+// RUN: %swiftc_driver -enable-batch-mode -c -emit-module -module-name main -j 2 %t/file-01.swift %t/file-02.swift %t/file-03.swift %t/main.swift  -###  2>%t/shouldBeEmpty2 | %FileCheck %s  -check-prefix=CHECK-COMBINED
+// RUN: test -z "`cat %t/shouldBeEmpty1`"
+// RUN: test -z "`cat %t/shouldBeEmpty2`"
+//
+// CHECK-COMBINED: -primary-file {{.*}}/file-01.swift -primary-file {{.*}}/file-02.swift {{.*}}/file-03.swift {{.*}}/main.swift

test/Driver/embed-bitcode.swift

@@ -97,15 +97,15 @@
 // CHECK-LIB: -emit-bc
 // CHECK-LIB: -primary-file
 // CHECK-LIB: swift -frontend
-// CHECK-LIB: -emit-module
-// CHECK-LIB: swift -frontend
 // CHECK-LIB: -c
 // CHECK-LIB: -embed-bitcode
 // CHECK-LIB: -disable-llvm-optzns
 // CHECK-LIB: swift -frontend
 // CHECK-LIB: -c
 // CHECK-LIB: -embed-bitcode
 // CHECK-LIB: -disable-llvm-optzns
+// CHECK-LIB: swift -frontend
+// CHECK-LIB: -emit-module
 // CHECK-LIB-NOT: swift -frontend
 
 // RUN: %target-swiftc_driver -embed-bitcode -emit-module %s 2>&1 -### | %FileCheck %s -check-prefix=WARN-EMBED-BITCODE