Handle base output paths correctly for frontend-only plans

Author: owenv

Sources/SwiftDriver/Driver/Driver.swift

@@ -604,7 +604,7 @@ extension Driver {
       return
     }
 
-    if jobs.contains(where: { $0.requiresInPlaceExecution }) {
+    if jobs.contains(where: { $0.requiresInPlaceExecution }) || jobs.count == 1 {
       assert(jobs.count == 1, "Cannot execute in place for multi-job build plans")
       return try executeJobInPlace(jobs[0], resolver: resolver, forceResponseFiles: forceResponseFiles)
     }

Sources/SwiftDriver/Jobs/CompileJob.swift

@@ -26,7 +26,7 @@ extension Driver {
   }
 
   /// Add the compiler inputs for a frontend compilation job, and return the corresponding primary set of outputs.
-  func addCompileInputs(primaryInputs: [TypedVirtualPath], inputs: inout [TypedVirtualPath], commandLine: inout [Job.ArgTemplate]) -> [TypedVirtualPath] {
+  func addCompileInputs(primaryInputs: [TypedVirtualPath], inputs: inout [TypedVirtualPath], commandLine: inout [Job.ArgTemplate], baseOutput: VirtualPath?) -> [TypedVirtualPath] {
     // Collect the set of input files that are part of the Swift compilation.
     let swiftInputFiles: [TypedVirtualPath] = inputFiles.compactMap { inputFile in
       if inputFile.type.isPartOfSwiftCompilation {
@@ -58,7 +58,7 @@ extension Driver {
       // add an output for the input.
       if isPrimary || numThreads > 0,
           let compilerOutputType = compilerOutputType {
-        let output = (outputFileMap ?? OutputFileMap()).getOutput(
+        let output = baseOutput ?? (outputFileMap ?? OutputFileMap()).getOutput(
           inputFile: input.file,
           outputType: compilerOutputType
         )
@@ -69,7 +69,7 @@ extension Driver {
     // When not using primary file inputs or multithreading, add a single output.
     if !usesPrimaryFileInputs && numThreads == 0,
         let outputType = compilerOutputType {
-      let existingOutputPath = outputFileMap?.existingOutputForSingleInput(
+      let existingOutputPath = baseOutput ?? outputFileMap?.existingOutputForSingleInput(
           outputType: outputType)
       let output = existingOutputPath ?? VirtualPath.temporary(.init(moduleName.appendingFileTypeExtension(outputType)))
       primaryOutputs.append(TypedVirtualPath(file: output, type: outputType))
@@ -80,14 +80,14 @@ extension Driver {
 
   /// Form a compile job, which executes the Swift frontend to produce various outputs.
   mutating func compileJob(primaryInputs: [TypedVirtualPath], outputType: FileType?,
-                           allOutputs: inout [TypedVirtualPath]) throws -> Job {
+                           allOutputs: inout [TypedVirtualPath], baseOutputPath: VirtualPath?) throws -> Job {
     var commandLine: [Job.ArgTemplate] = swiftCompilerPrefixArgs.map { Job.ArgTemplate.flag($0) }
     var inputs: [TypedVirtualPath] = []
     var outputs: [TypedVirtualPath] = []
 
     commandLine.appendFlag("-frontend")
     addCompileModeOption(outputType: outputType, commandLine: &commandLine)
-    let primaryOutputs = addCompileInputs(primaryInputs: primaryInputs, inputs: &inputs, commandLine: &commandLine)
+    let primaryOutputs = addCompileInputs(primaryInputs: primaryInputs, inputs: &inputs, commandLine: &commandLine, baseOutput: baseOutputPath)
     outputs += primaryOutputs
     outputs += try addFrontendSupplementaryOutputArguments(commandLine: &commandLine, primaryInputs: primaryInputs)
 

Sources/SwiftDriver/Jobs/Planning.swift

@@ -62,6 +62,17 @@ extension Driver {
       jobs.append(try emitModuleJob())
     }
 
+    var compileBaseOutputPath: VirtualPath? = nil
+    if (compilerOutputType == .object && linkerOutputType == nil) ||
+        compilerOutputType == .assembly || compilerOutputType == .sil ||
+        compilerOutputType == .raw_sil || compilerOutputType == .llvmIR {
+      if let baseOutput = parsedOptions.getLastArgument(.o)?.asSingle {
+        compileBaseOutputPath = try VirtualPath(path: baseOutput)
+      } else if compilerOutputType?.isTextual ?? false {
+        compileBaseOutputPath = .standardOutput
+      }
+    }
+
     let partitions: BatchPartitions?
     switch compilerMode {
     case .batchCompile(let batchInfo):
@@ -74,7 +85,7 @@ extension Driver {
       // Create a single compile job for all of the files, none of which
       // are primary.
       var jobOutputs: [TypedVirtualPath] = []
-      let job = try compileJob(primaryInputs: [], outputType: compilerOutputType, allOutputs: &jobOutputs)
+      let job = try compileJob(primaryInputs: [], outputType: compilerOutputType, allOutputs: &jobOutputs, baseOutputPath: compileBaseOutputPath)
       jobs.append(job)
       addJobOutputs(jobOutputs)
 
@@ -104,7 +115,7 @@ extension Driver {
         }
 
         var jobOutputs: [TypedVirtualPath] = []
-        let job = try compileJob(primaryInputs: primaryInputs, outputType: compilerOutputType, allOutputs: &jobOutputs)
+        let job = try compileJob(primaryInputs: primaryInputs, outputType: compilerOutputType, allOutputs: &jobOutputs, baseOutputPath: compileBaseOutputPath)
         jobs.append(job)
         addJobOutputs(jobOutputs)
 

Sources/SwiftDriver/Utilities/FileType.swift

@@ -246,3 +246,14 @@ extension FileType {
     }
   }
 }
+
+extension FileType {
+  var isTextual: Bool {
+    switch self {
+    case .swift, .sil, .dependencies, .assembly, .ast, .raw_sil, .llvmIR, .objcHeader, .autolink, .importedModules, .tbd, .moduleTrace, .optimizationRecord, .swiftInterface:
+      return true
+    case .image, .object, .dSYM, .pch, .sib, .raw_sib, .swiftModule, .swiftDocumentation, .swiftSourceInfoFile, .llvmBitcode, .diagnostics, .pcm, .swiftDeps, .remap, .indexData:
+      return false
+    }
+  }
+}

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -363,6 +363,34 @@ final class SwiftDriverTests: XCTestCase {
     try assertNoDriverDiagnostics(args: "swiftc", "foo-bar.swift")
   }
 
+  func testBaseOutputPaths() throws {
+    // Test the combination of -c and -o includes the base output path.
+    do {
+      var driver = try Driver(args: ["swiftc", "-c", "foo.swift", "-o", "/some/output/path/bar.o"])
+      let plannedJobs = try driver.planBuild()
+      XCTAssertEqual(plannedJobs.count, 1)
+      XCTAssertEqual(plannedJobs[0].kind, .compile)
+      XCTAssertTrue(plannedJobs[0].commandLine.contains(.path(try VirtualPath(path: "/some/output/path/bar.o"))))
+    }
+
+    do {
+      var driver = try Driver(args: ["swiftc", "-emit-sil", "foo.swift", "-o", "/some/output/path/bar.sil"])
+      let plannedJobs = try driver.planBuild()
+      XCTAssertEqual(plannedJobs.count, 1)
+      XCTAssertEqual(plannedJobs[0].kind, .compile)
+      XCTAssertTrue(plannedJobs[0].commandLine.contains(.path(try VirtualPath(path: "/some/output/path/bar.sil"))))
+    }
+
+    do {
+      // If no output is specified, verify we print to stdout for textual formats.
+      var driver = try Driver(args: ["swiftc", "-emit-assembly", "foo.swift"])
+      let plannedJobs = try driver.planBuild()
+      XCTAssertEqual(plannedJobs.count, 1)
+      XCTAssertEqual(plannedJobs[0].kind, .compile)
+      XCTAssertTrue(plannedJobs[0].commandLine.contains(.path(.standardOutput)))
+    }
+  }
+
   func testStandardCompileJobs() throws {
     var driver1 = try Driver(args: ["swiftc", "foo.swift", "bar.swift", "-module-name", "Test"])
     let plannedJobs = try driver1.planBuild()