Merge pull request #713 from artemcm/55AllowMultipleStdOutOutputs

[5.5] Produce an error when multiple `-o` options are specified in multi-threading mode

Author: artemcm

Sources/SwiftDriver/Driver/Driver.swift

@@ -24,6 +24,7 @@ public struct Driver {
     case relativeFrontendPath(String)
     case subcommandPassedToDriver
     case integratedReplRemoved
+    case cannotSpecify_OForMultipleOutputs
     case conflictingOptions(Option, Option)
     case unableToLoadOutputFileMap(String)
     case unableToDecodeFrontendTargetInfo(String?, [String], String)
@@ -57,6 +58,8 @@ public struct Driver {
         return "subcommand passed to driver"
       case .integratedReplRemoved:
         return "Compiler-internal integrated REPL has been removed; use the LLDB-enhanced REPL instead."
+      case .cannotSpecify_OForMultipleOutputs:
+        return "cannot specify -o when generating multiple output files"
       case .conflictingOptions(let one, let two):
         return "conflicting options '\(one.spelling)' and '\(two.spelling)'"
       case let .unableToDecodeFrontendTargetInfo(outputString, arguments, errorDesc):
@@ -693,6 +696,8 @@ public struct Driver {
         compilerMode: compilerMode,
         outputFileMap: self.outputFileMap,
         moduleName: moduleOutputInfo.name)
+
+    try verifyOutputOptions()
   }
 
   public mutating func planBuild( simulateGetInputFailure: Bool = false ) throws -> [Job] {
@@ -779,6 +784,29 @@ extension Driver {
   }
 }
 
+extension Driver {
+  // Detect mis-use of multi-threading and output file options
+  private func verifyOutputOptions() throws {
+    if compilerOutputType != .swiftModule,
+       parsedOptions.hasArgument(.o),
+       linkerOutputType == nil {
+      let shouldComplain: Bool
+      if numThreads > 0 {
+        // Multi-threading compilation has multiple outputs unless there's only
+        // one input.
+        shouldComplain = self.inputFiles.count > 1
+      } else {
+        // Single-threaded compilation is a problem if we're compiling more than
+        // one file.
+        shouldComplain = self.inputFiles.filter { $0.type.isPartOfSwiftCompilation }.count > 1 && .singleCompile != compilerMode
+      }
+      if shouldComplain {
+        diagnosticEngine.emit(Error.cannotSpecify_OForMultipleOutputs)
+      }
+    }
+  }
+}
+
 // MARK: - Response files.
 extension Driver {
   /// Tokenize a single line in a response file.

Sources/SwiftDriver/Jobs/Planning.swift

@@ -85,7 +85,6 @@ extension Driver {
   -> ([Job], IncrementalCompilationState?) {
     precondition(compilerMode.isStandardCompilationForPlanning,
                  "compiler mode \(compilerMode) is handled elsewhere")
-
     // Determine the initial state for incremental compilation that is required during
     // the planning process. This state contains the module dependency graph and
     // cross-module dependency information.

Sources/SwiftDriverExecution/MultiJobExecutor.swift

@@ -191,7 +191,8 @@ public final class MultiJobExecutor {
                                     to producerMap: inout [VirtualPath.Handle: Int]
     ) {
       for output in job.outputs {
-        if let otherJobIndex = producerMap.updateValue(index, forKey: output.fileHandle) {
+        if output.file != .standardOutput,
+           let otherJobIndex = producerMap.updateValue(index, forKey: output.fileHandle) {
           fatalError("multiple producers for output \(output.file): \(job) & \(knownJobs[otherJobIndex])")
         }
         producerMap[output.fileHandle] = index

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -314,6 +314,16 @@ final class SwiftDriverTests: XCTestCase {
       }
   }
 
+  func testMultiThreadingOutputs() throws {
+    try assertDriverDiagnostics(args: "swiftc", "-c", "foo.swift", "bar.swift", "-o", "bar.ll", "-o", "foo.ll", "-num-threads", "2", "-whole-module-optimization") {
+      $1.expect(.error("cannot specify -o when generating multiple output files"))
+    }
+
+    try assertDriverDiagnostics(args: "swiftc", "-c", "foo.swift", "bar.swift", "-o", "bar.ll", "-o", "foo.ll", "-num-threads", "0") {
+      $1.expect(.error("cannot specify -o when generating multiple output files"))
+    }
+  }
+
   func testBaseOutputPaths() throws {
     // Test the combination of -c and -o includes the base output path.
     do {