Add SIL and IR generation support to -save-temps option

This extends -save-temps to emit SIL and IR alongside existing temporary files. In the case where an output file map is used with -save-temps, e.g. incremental compilation, only emit the SIL and IR if it has been requested as an output in the filemap. rdar://160297896

Author: rjmansfield

Sources/SwiftDriver/Jobs/FrontendJobHelpers.swift

@@ -690,6 +690,10 @@ extension Driver {
  } else if let directory = directory {
  let outputPath = try generateSupplementaryOutputPath(for: inputFile, outputType: outputType, directory: directory)
  flaggedInputOutputPairs.append((flag: flag, input: inputFile, output: outputPath))
+ } else if parsedOptions.hasArgument(.saveTemps) {
+ // When using -save-temps without explicit directories, output to current directory
+ let outputPath = try generateSupplementaryOutputPath(for: inputFile, outputType: outputType, directory: ".")
+ flaggedInputOutputPairs.append((flag: flag, input: inputFile, output: outputPath))
  }
  }
  }
@@ -707,7 +711,7 @@ extension Driver {
  let directory = parsedOptions.getLastArgument(directoryOption)?.asSingle
  let hasFileMapEntries = outputFileMap?.hasEntries(for: outputType) ?? false
 
- if directory != nil || hasFileMapEntries {
+ if directory != nil || hasFileMapEntries || (parsedOptions.hasArgument(.saveTemps) && !hasFileMapEntries) {
  let inputsToProcess: [TypedVirtualPath]
  if compilerMode.usesPrimaryFileInputs {
  inputsToProcess = input.map { [$0] } ?? []
@@ -807,17 +811,40 @@ extension Driver {
  input: input,
  flag: "-serialize-diagnostics-path")
 
- try addOutputOfType(
- outputType: .sil,
- finalOutputPath: silOutputPath,
- input: input,
- flag: "-sil-output-path")
+ // Add SIL and IR outputs when explicitly requested via directory options, file maps, or -save-temps
+ let saveTempsWithoutFileMap = parsedOptions.hasArgument(.saveTemps) && outputFileMap == nil
+ let hasSilFileMapEntries = outputFileMap?.hasEntries(for: .sil) ?? false
+ let hasIrFileMapEntries = outputFileMap?.hasEntries(for: .llvmIR) ?? false
 
- try addOutputOfType(
- outputType: .llvmIR,
- finalOutputPath: llvmIROutputPath,
- input: input,
- flag: "-ir-output-path")
+ let silOutputPathSupported = Driver.isOptionFound("-sil-output-path", allOpts: supportedFrontendFlags)
+ let irOutputPathSupported = Driver.isOptionFound("-ir-output-path", allOpts: supportedFrontendFlags)
+
+ if !silOutputPathSupported && (parsedOptions.hasArgument(.silOutputDir) || hasSilFileMapEntries) {
+ diagnosticEngine.emit(.warning("frontend does not support -sil-output-path; SIL output will not be emitted"))
+ }
+
+ if !irOutputPathSupported && (parsedOptions.hasArgument(.irOutputDir) || hasIrFileMapEntries) {
+ diagnosticEngine.emit(.warning("frontend does not support -ir-output-path; IR output will not be emitted"))
+ }
+
+ let shouldAddSilOutput = silOutputPathSupported && (parsedOptions.hasArgument(.silOutputDir) || saveTempsWithoutFileMap || hasSilFileMapEntries)
+ let shouldAddIrOutput = irOutputPathSupported && (parsedOptions.hasArgument(.irOutputDir) || saveTempsWithoutFileMap || hasIrFileMapEntries)
+
+ if shouldAddSilOutput {
+ try addOutputOfType(
+ outputType: .sil,
+ finalOutputPath: silOutputPath,
+ input: input,
+ flag: "-sil-output-path")
+ }
+
+ if shouldAddIrOutput {
+ try addOutputOfType(
+ outputType: .llvmIR,
+ finalOutputPath: llvmIROutputPath,
+ input: input,
+ flag: "-ir-output-path")
+ }
  }
 
  if compilerMode.usesPrimaryFileInputs {

Tests/SwiftDriverTests/JobExecutorTests.swift

@@ -536,8 +536,12 @@ final class JobExecutorTests: XCTestCase {
  executor: executor)
  let jobs = try driver.planBuild()
  XCTAssertEqual(jobs.removingAutolinkExtractJobs().map(\.kind), [.compile, .link])
- XCTAssertEqual(jobs[0].outputs.count, 1)
- let compileOutput = jobs[0].outputs[0].file
+ // With -save-temps, we now have additional SIL and IR outputs, so expect more outputs
+ XCTAssertTrue(jobs[0].outputs.count >= 1, "Should have at least the object file output")
+ // Find the main object file output
+ let objectOutput = jobs[0].outputs.first { $0.type == .object }
+ XCTAssertNotNil(objectOutput, "Should have object file output")
+ let compileOutput = objectOutput!.file
  guard matchTemporary(compileOutput, "main.o") else {
  XCTFail("unexpected output")
  return
@@ -585,5 +589,53 @@ final class JobExecutorTests: XCTestCase {
  )
  }
  }
+
+ // Test that -save-temps also saves SIL and IR intermediate files
+ do {
+ // Skip test if frontend doesn't support these options
+ let diags = DiagnosticsEngine()
+ let executor = try SwiftDriverExecutor(diagnosticsEngine: diags,
+ processSet: ProcessSet(),
+ fileSystem: localFileSystem,
+ env: ProcessEnv.block)
+ let checkDriver = try Driver(args: ["swiftc", "foo.swift"] + getHostToolchainSdkArg(executor),
+ envBlock: ProcessEnv.block,
+ diagnosticsOutput: .engine(diags),
+ fileSystem: localFileSystem,
+ executor: executor)
+ guard Driver.isOptionFound("-sil-output-path", allOpts: checkDriver.supportedFrontendFlags) &&
+ Driver.isOptionFound("-ir-output-path", allOpts: checkDriver.supportedFrontendFlags) else {
+ throw XCTSkip("Skipping: frontend does not support -sil-output-path or -ir-output-path")
+ }
+
+ try withTemporaryDirectory { path in
+ let main = path.appending(component: "main.swift")
+ try localFileSystem.writeFileContents(main, bytes: "print(\"hello, world!\")")
+ let diags = DiagnosticsEngine()
+ let executor = try SwiftDriverExecutor(diagnosticsEngine: diags,
+ processSet: ProcessSet(),
+ fileSystem: localFileSystem,
+ env: ProcessEnv.block)
+ let outputPath = path.appending(component: "finalOutput")
+ var driver = try Driver(args: ["swiftc", main.pathString,
+ "-save-temps",
+ "-o", outputPath.pathString] + getHostToolchainSdkArg(executor),
+ envBlock: ProcessEnv.block,
+ diagnosticsOutput: .engine(diags),
+ fileSystem: localFileSystem,
+ executor: executor)
+ let jobs = try driver.planBuild()
+ let compileJobs = jobs.removingAutolinkExtractJobs()
+ XCTAssertEqual(compileJobs.map(\.kind), [.compile, .link])
+
+ let compileJob = compileJobs[0]
+
+ XCTAssertTrue(compileJob.commandLine.contains(.flag("-sil-output-path")))
+ XCTAssertTrue(compileJob.commandLine.contains(.flag("-ir-output-path")))
+
+ let hasMultipleOutputs = compileJob.outputs.count > 1
+ XCTAssertTrue(hasMultipleOutputs, "Should have additional SIL/IR outputs when using -save-temps")
+ }
+ }
  }
 }