Merge pull request #53 from DougGregor/moar-output

Plumb through primary files for parsable output

Author: aciidgh

Package.swift

@@ -10,6 +10,9 @@ let package = Package(
     .executable(
       name: "swift-driver",
       targets: ["swift-driver"]),
+    .library(
+      name: "SwiftDriver",
+      targets: ["SwiftDriver"]),
   ],
   dependencies: [
     .package(url: "https://github.com/apple/swift-tools-support-core.git", .branch("master")),

Sources/SwiftDriver/Driver/Driver.swift

@@ -370,7 +370,7 @@ extension Driver {
     // Start up an executor and perform the build.
     let mainOutput = jobs.last!.outputs.first!
     let jobExecutor = JobExecutor(jobs: jobs, resolver: resolver, executorDelegate: executorDelegate)
-    try jobExecutor.build(mainOutput)
+    try jobExecutor.build(mainOutput.file)
   }
 
   /// Returns the path to the Swift binary.

Sources/SwiftDriver/Driver/ToolExecutionDelegate.swift

@@ -2,7 +2,6 @@ import TSCBasic
 
 /// Delegate for printing execution information on the command-line.
 struct ToolExecutionDelegate: JobExecutorDelegate {
-
   enum Mode {
     case verbose
     case parsableOutput
@@ -20,11 +19,15 @@ struct ToolExecutionDelegate: JobExecutorDelegate {
       stdoutStream.flush()
     case .parsableOutput:
 
+      // Compute the outputs for the message.
+      let outputs: [BeganMessage.Output] = job.outputs.map {
+        .init(path: $0.file.name, type: $0.type.rawValue)
+      }
+
       let beganMessage = BeganMessage(
         pid: pid,
-        // FIXME: This needs to be the primary inputs :/
-        inputs: job.inputs.map{ $0.name },
-        outputs: job.outputs.map{ .init(path: $0.name, type: "object") },
+        inputs: job.displayInputs.map{ $0.file.name },
+        outputs: outputs,
         commandExecutable: arguments[0],
         commandArguments: arguments[1...].map{ String($0) }
       )
@@ -34,22 +37,24 @@ struct ToolExecutionDelegate: JobExecutorDelegate {
     }
   }
 
-  func jobHadOutput(job: Job, output: String) {
-    // FIXME: Merge with job finished delegate.
-    // FIXME: Need to see how current driver handles stdout/stderr.
-    stdoutStream <<< output
-    stdoutStream.flush()
-  }
-
-  func jobFinished(job: Job, success: Bool, pid: Int) {
+  func jobFinished(job: Job, result: ProcessResult, pid: Int) {
     switch mode {
     case .regular, .verbose:
       break
     case .parsableOutput:
-      // FIXME: Get the actual exit status.
-      let finishedMessage = FinishedMessage(exitStatus: success ? 0 : 1, pid: pid, output: nil)
-      let message = ParsableMessage.finishedMessage(name: job.kind.rawValue, msg: finishedMessage)
-      emit(message)
+
+      switch result.exitStatus {
+      case .terminated(let code):
+        let output = (try? result.utf8Output() + result.utf8stderrOutput()) ?? ""
+        let finishedMessage = FinishedMessage(exitStatus: Int(code), pid: pid, output: output.isEmpty ? nil : output)
+        let message = ParsableMessage.finishedMessage(name: job.kind.rawValue, msg: finishedMessage)
+        emit(message)
+
+      case .signalled:
+        // FIXME: Implement this.
+        break
+      }
+
     }
   }
 

Sources/SwiftDriver/Execution/JobExecutor.swift

@@ -54,11 +54,8 @@ public protocol JobExecutorDelegate {
   /// Called when a job starts executing.
   func jobStarted(job: Job, arguments: [String], pid: Int)
 
-  /// Called when job had any output.
-  func jobHadOutput(job: Job, output: String)
-
   /// Called when a job finished.
-  func jobFinished(job: Job, success: Bool, pid: Int)
+  func jobFinished(job: Job, result: ProcessResult, pid: Int)
 }
 
 public final class JobExecutor {
@@ -121,8 +118,8 @@ public final class JobExecutor {
     var producerMap: [VirtualPath: Job] = [:]
     for job in jobs {
       for output in job.outputs {
-        assert(!producerMap.keys.contains(output), "multiple producers for output \(output): \(job) \(producerMap[output]!)")
-        producerMap[output] = job
+        assert(!producerMap.keys.contains(output.file), "multiple producers for output \(output): \(job) \(producerMap[output.file]!)")
+        producerMap[output.file] = job
       }
     }
 
@@ -189,7 +186,7 @@ class ExecuteJobRule: LLBuildRule {
     let context = engine.jobExecutorContext
 
     for (idx, input) in key.job.inputs.enumerated() {
-      if let producingJob = context.producerMap[input] {
+      if let producingJob = context.producerMap[input.file] {
         let key = ExecuteJobRule.RuleKey(job: producingJob)
         engine.taskNeedsInput(key, inputID: idx)
       }
@@ -238,23 +235,25 @@ class ExecuteJobRule: LLBuildRule {
       let result = try process.waitUntilExit()
       let success = result.exitStatus == .terminated(code: 0)
 
-      let output = try result.utf8Output() + result.utf8stderrOutput()
-
-      // FIXME: We should stream this.
+      // Inform the delegate about job finishing.
       context.delegateQueue.async {
-        context.executorDelegate?.jobHadOutput(job: job, output: output)
+        context.executorDelegate?.jobFinished(job: job, result: result, pid: pid)
       }
 
       value = .jobExecution(success: success)
     } catch {
+      context.delegateQueue.async {
+        let result = ProcessResult(
+          arguments: [],
+          exitStatus: .terminated(code: 1),
+          output: Result.success([]),
+          stderrOutput: Result.success([])
+        )
+        context.executorDelegate?.jobFinished(job: job, result: result, pid: 0)
+      }
       value = .jobExecution(success: false)
     }
 
-    // Inform the delegate about job finishing.
-    context.delegateQueue.async {
-      context.executorDelegate?.jobFinished(job: job, success: value.success, pid: pid)
-    }
-
     engine.taskIsComplete(value)
   }
 }

Sources/SwiftDriver/Jobs/CompileJob.swift

@@ -15,11 +15,11 @@ extension Driver {
   }
 
   /// Add the compiler inputs for a frontend compilation job, and return the corresponding primary set of outputs.
-  mutating func addCompileInputs(primaryInputs: [TypedVirtualPath], inputs: inout [VirtualPath], commandLine: inout [Job.ArgTemplate]) -> [TypedVirtualPath] {
+  mutating func addCompileInputs(primaryInputs: [TypedVirtualPath], inputs: inout [TypedVirtualPath], commandLine: inout [Job.ArgTemplate]) -> [TypedVirtualPath] {
     // Collect the set of input files that are part of the Swift compilation.
-    let swiftInputFiles: [VirtualPath] = inputFiles.compactMap { inputFile in
+    let swiftInputFiles: [TypedVirtualPath] = inputFiles.compactMap { inputFile in
       if inputFile.type.isPartOfSwiftCompilation {
-        return inputFile.file
+        return inputFile
       }
 
       return nil
@@ -29,7 +29,7 @@ extension Driver {
     // we can check more quickly.
     let usesPrimaryFileInputs = compilerMode.usesPrimaryFileInputs
     assert(!usesPrimaryFileInputs || !primaryInputs.isEmpty)
-    let primaryInputFiles: Set<VirtualPath> = usesPrimaryFileInputs ? Set(primaryInputs.map { $0.file }) : Set()
+    let primaryInputFiles = usesPrimaryFileInputs ? Set(primaryInputs) : Set()
 
     // Add each of the input files.
     // FIXME: Use/create input file lists and primary input file lists.
@@ -41,14 +41,15 @@ extension Driver {
       if isPrimary {
         commandLine.appendFlag(.primary_file)
       }
-      commandLine.append(.path(input))
+      commandLine.append(.path(input.file))
 
       // If there is a primary output, add it.
       if isPrimary, let compilerOutputType = compilerOutputType {
-        primaryOutputs.append(
-          TypedVirtualPath(
-            file: (outputFileMap ?? OutputFileMap()).getOutput(inputFile: input, outputType: compilerOutputType),
-            type: compilerOutputType))
+        let output = (outputFileMap ?? OutputFileMap()).getOutput(
+          inputFile: input.file,
+          outputType: compilerOutputType
+        )
+        primaryOutputs.append(TypedVirtualPath(file: output, type: compilerOutputType))
       }
     }
 
@@ -59,7 +60,7 @@ extension Driver {
   mutating func compileJob(primaryInputs: [TypedVirtualPath], outputType: FileType?,
                            allOutputs: inout [TypedVirtualPath]) throws -> Job {
     var commandLine: [Job.ArgTemplate] = swiftCompilerPrefixArgs.map { Job.ArgTemplate.flag($0) }
-    var inputs: [VirtualPath] = []
+    var inputs: [TypedVirtualPath] = []
     var outputs: [TypedVirtualPath] = []
 
     commandLine.appendFlag("-frontend")
@@ -123,7 +124,14 @@ extension Driver {
     try commandLine.appendLast(.disable_autolinking_runtime_compatibility_dynamic_replacements, from: &parsedOptions)
 
     allOutputs += outputs
-    return Job(kind: .compile, tool: swiftCompiler, commandLine: commandLine, inputs: inputs, outputs: outputs.map { $0.file })
+    return Job(
+      kind: .compile,
+      tool: swiftCompiler,
+      commandLine: commandLine,
+      displayInputs: primaryInputs,
+      inputs: inputs,
+      outputs: outputs
+    )
   }
 }
 

Sources/SwiftDriver/Jobs/Job.swift

@@ -23,13 +23,14 @@ public struct Job: Codable, Equatable {
   /// The command-line arguments of the job.
   public var commandLine: [ArgTemplate]
 
+  /// The list of inputs to use for displaying purposes.
+  public var displayInputs: [TypedVirtualPath]
+
   /// The list of inputs for this job.
-  // FIXME: Figure out the exact type that is required here.
-  public var inputs: [VirtualPath]
+  public var inputs: [TypedVirtualPath]
 
   /// The outputs produced by the job.
-  // FIXME: Figure out the exact type that is required here.
-  public var outputs: [VirtualPath]
+  public var outputs: [TypedVirtualPath]
 
   /// The kind of job.
   public var kind: Kind
@@ -38,12 +39,14 @@ public struct Job: Codable, Equatable {
     kind: Kind,
     tool: VirtualPath,
     commandLine: [ArgTemplate],
-    inputs: [VirtualPath],
-    outputs: [VirtualPath]
+    displayInputs: [TypedVirtualPath]? = nil,
+    inputs: [TypedVirtualPath],
+    outputs: [TypedVirtualPath]
   ) {
     self.kind = kind
     self.tool = tool
     self.commandLine = commandLine
+    self.displayInputs = displayInputs ?? []
     self.inputs = inputs
     self.outputs = outputs
   }

Sources/SwiftDriver/Jobs/LinkJob.swift

@@ -364,8 +364,8 @@ extension Driver {
     }
 
     // Add inputs.
-    let inputFiles = inputs.map { $0.file }
-    commandLine.append(contentsOf: inputFiles.map { .path($0) })
+    let inputFiles = inputs
+    commandLine.append(contentsOf: inputFiles.map { .path($0.file) })
 
     // Add the output
     commandLine.appendFlag("-o")
@@ -382,7 +382,7 @@ extension Driver {
       tool: .absolute(try toolchain.getToolPath(linkerTool)),
       commandLine: commandLine,
       inputs: inputFiles,
-      outputs: [outputFile]
+      outputs: [.init(file: outputFile, type: .object)]
     )
   }
 }

Sources/SwiftDriver/Jobs/MergeModuleJob.swift

@@ -3,8 +3,10 @@ import TSCBasic
 extension Driver {
   mutating func mergeModuleJob(inputs allInputs: [TypedVirtualPath]) throws -> Job {
     var commandLine: [Job.ArgTemplate] = swiftCompilerPrefixArgs.map { Job.ArgTemplate.flag($0) }
-    var inputs: [VirtualPath] = []
-    var outputs: [VirtualPath] = [moduleOutput!.outputPath]
+    var inputs: [TypedVirtualPath] = []
+    var outputs: [TypedVirtualPath] = [
+      TypedVirtualPath(file: moduleOutput!.outputPath, type: .swiftModule)
+    ]
 
     commandLine.appendFlags("-frontend", "-merge-modules", "-emit-module")
 
@@ -14,7 +16,7 @@ extension Driver {
     for input in allInputs {
       assert(input.type == .swiftModule)
       commandLine.append(.path(input.file))
-      inputs.append(input.file)
+      inputs.append(input)
     }
 
     // Tell all files to parse as library, which is necessary to load them as
@@ -33,19 +35,19 @@ extension Driver {
     // FIXME: Add MSVC runtime library flags
 
     // Add suppplementable outputs.
-    func addSupplementalOutput(path: VirtualPath?, flag: String) {
+    func addSupplementalOutput(path: VirtualPath?, flag: String, type: FileType) {
       guard let path = path else { return }
 
       commandLine.appendFlag(flag)
       commandLine.appendPath(path)
-      outputs.append(path)
+      outputs.append(.init(file: path, type: type))
     }
 
-    addSupplementalOutput(path: moduleDocOutputPath, flag: "-emit-module-doc-path")
-    addSupplementalOutput(path: swiftInterfacePath, flag: "-emit-module-interface-path")
-    addSupplementalOutput(path: serializedDiagnosticsFilePath, flag: "-serialize-diagnostics-path")
-    addSupplementalOutput(path: objcGeneratedHeaderPath, flag: "-emit-objc-header-path")
-    addSupplementalOutput(path: tbdPath, flag: "-emit-tbd-path")
+    addSupplementalOutput(path: moduleDocOutputPath, flag: "-emit-module-doc-path", type: .swiftDocumentation)
+    addSupplementalOutput(path: swiftInterfacePath, flag: "-emit-module-interface-path", type: .swiftInterface)
+    addSupplementalOutput(path: serializedDiagnosticsFilePath, flag: "-serialize-diagnostics-path", type: .diagnostics)
+    addSupplementalOutput(path: objcGeneratedHeaderPath, flag: "-emit-objc-header-path", type: .objcHeader)
+    addSupplementalOutput(path: tbdPath, flag: "-emit-tbd-path", type: .tbd)
 
     commandLine.appendFlag(.o)
     commandLine.appendPath(moduleOutput!.outputPath)

Sources/SwiftDriver/Utilities/FileType.swift

@@ -2,7 +2,7 @@
 ///
 /// The raw values for these enumerations describe the default extension for]
 /// the file type.
-public enum FileType: String, Hashable, CaseIterable {
+public enum FileType: String, Hashable, CaseIterable, Codable {
   /// Swift source file.
   case swift
 

Sources/SwiftDriver/Utilities/TypedVirtualPath.swift

@@ -1,5 +1,5 @@
 /// A path for which the type of the input is known.
-public struct TypedVirtualPath: Hashable {
+public struct TypedVirtualPath: Hashable, Codable {
   /// The file this input refers to.
   public let file: VirtualPath