Merge pull request #5 from apple/master

merge upstream

Author: sjavora

README.md

@@ -36,6 +36,10 @@ Similarly, one can use the new Swift driver within Xcode by adding a custom buil
 
 The new Swift driver is a work in progress, and there are numerous places for anyone with an interest to contribute! This section covers testing, miscellaneous development tips and tricks, and a rough development plan showing what work still needs to be done.
 
+### Driver Documentation
+
+For a conceptual overview of the driver, see [The Swift Driver, Compilation Model, and Command-Line Experience](https://github.com/apple/swift/blob/master/docs/Driver.md). To learn more about the internals, see [Driver Design & Internals](https://github.com/apple/swift/blob/master/docs/DriverInternals.rst) and [Parseable Driver Output](https://github.com/apple/swift/blob/master/docs/DriverParseableOutput.rst).
+
 ### Testing
 
 Test using command-line SwiftPM or Xcode.

Sources/SwiftDriver/Driver/Driver.swift

@@ -43,6 +43,7 @@ public struct Driver {
   enum Error: Swift.Error {
     case invalidDriverName(String)
     case invalidInput(String)
+    case subcommandPassedToDriver
   }
 
   /// The set of environment variables that are visible to the driver and
@@ -193,11 +194,15 @@ public struct Driver {
     diagnosticsHandler: @escaping DiagnosticsEngine.DiagnosticsHandler = Driver.stderrDiagnosticsHandler
   ) throws {
     self.env = env
-    
-    // FIXME: Determine if we should run as subcommand.
 
     self.diagnosticEngine = DiagnosticsEngine(handlers: [diagnosticsHandler])
+
+    if case .subcommand = try Self.invocationRunMode(forArgs: args).mode {
+      throw Error.subcommandPassedToDriver
+    }
+
     var args = try Self.expandResponseFiles(args, diagnosticsEngine: self.diagnosticEngine)[...]
+
     self.driverKind = try Self.determineDriverKind(args: &args)
     self.optionTable = OptionTable()
     self.parsedOptions = try optionTable.parse(Array(args))
@@ -351,6 +356,54 @@ public struct Driver {
   }
 }
 
+extension Driver {
+
+  public enum InvocationRunMode: Equatable {
+    case normal(isRepl: Bool)
+    case subcommand(String)
+  }
+
+  /// Determines whether the given arguments constitute a normal invocation,
+  /// or whether they invoke a subcommand.
+  ///
+  /// Returns the invocation mode along with the arguments modified for that mode.
+  public static func invocationRunMode(
+    forArgs args: [String]
+  ) throws -> (mode: InvocationRunMode, args: [String]) {
+
+    assert(!args.isEmpty)
+
+    let execName = try VirtualPath(path: args[0]).basenameWithoutExt
+
+    // If we are not run as 'swift' or there are no program arguments, always invoke as normal.
+    guard execName == "swift", args.count > 1 else { return (.normal(isRepl: false), args) }
+
+    // Otherwise, we have a program argument.
+    let firstArg = args[1]
+
+    // If it looks like an option or a path, then invoke in interactive mode with the arguments as given.
+    if firstArg.hasPrefix("-") || firstArg.hasPrefix("/") || firstArg.contains(".") {
+        return (.normal(isRepl: false), args)
+    }
+
+    // Otherwise, we should have some sort of subcommand.
+
+    var updatedArgs = args
+
+    // If it is the "built-in" 'repl', then use the normal driver.
+    if firstArg == "repl" {
+        updatedArgs.remove(at: 1)
+        return (.normal(isRepl: true), updatedArgs)
+    }
+
+    let subcommand = "swift-\(firstArg)"
+
+    updatedArgs.replaceSubrange(0...1, with: [subcommand])
+
+    return (.subcommand(subcommand), updatedArgs)
+  }
+}
+
 // MARK: - Response files.
 extension Driver {
   /// Tokenize a single line in a response file.

Sources/SwiftDriver/Driver/DriverKind.swift

@@ -9,7 +9,8 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
-/// Describes which mode the driver is in, which dictates
+
+/// Describes which mode the driver is in.
 public enum DriverKind {
   case interactive
   case batch

Sources/SwiftDriver/Driver/OutputFileMap.swift

@@ -31,21 +31,12 @@ public struct OutputFileMap: Equatable {
       return output
     }
 
-    // Create a temporary file
-    let baseName: String
-    switch inputFile {
-    case .absolute(let path):
-      baseName = path.basenameWithoutExt
-    case .relative(let path), .temporary(let path):
-      baseName = path.basenameWithoutExt
-    case .standardInput:
-      baseName = ""
-    case .standardOutput:
+    if inputFile == .standardOutput {
       fatalError("Standard output cannot be an input file")
     }
 
     // Form the virtual path.
-    return .temporary(RelativePath(baseName.appendingFileTypeExtension(outputType)))
+    return .temporary(RelativePath(inputFile.basenameWithoutExt.appendingFileTypeExtension(outputType)))
   }
 
   public func existingOutput(inputFile: VirtualPath, outputType: FileType) -> VirtualPath? {

Sources/SwiftDriver/Driver/ToolExecutionDelegate.swift

@@ -11,6 +11,17 @@
 //===----------------------------------------------------------------------===//
 import TSCBasic
 
+#if canImport(Darwin)
+import Darwin.C
+#elseif os(Windows)
+import MSVCRT
+import WinSDK
+#elseif canImport(Glibc)
+import Glibc
+#else
+#error("Missing libc or equivalent")
+#endif
+
 /// Delegate for printing execution information on the command-line.
 public struct ToolExecutionDelegate: JobExecutorDelegate {
   public enum Mode {
@@ -43,7 +54,7 @@ public struct ToolExecutionDelegate: JobExecutorDelegate {
         commandArguments: arguments[1...].map{ String($0) }
       )
 
-      let message = ParsableMessage.beganMessage(name: job.kind.rawValue, msg: beganMessage)
+      let message = ParsableMessage(name: job.kind.rawValue, kind: .began(beganMessage))
       emit(message)
     }
   }
@@ -58,18 +69,20 @@ public struct ToolExecutionDelegate: JobExecutorDelegate {
       }
 
     case .parsableOutput:
+      let output = (try? result.utf8Output() + result.utf8stderrOutput()).flatMap { $0.isEmpty ? nil : $0 }
+      let message: ParsableMessage
+
       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)
+        let finishedMessage = FinishedMessage(exitStatus: Int(code), pid: pid, output: output)
+        message = ParsableMessage(name: job.kind.rawValue, kind: .finished(finishedMessage))
 
-      case .signalled:
-        // FIXME: Implement this.
-        break
+      case .signalled(let signal):
+        let errorMessage = strsignal(signal).map { String(cString: $0) } ?? ""
+        let signalledMessage = SignalledMessage(pid: pid, output: output, errorMessage: errorMessage, signal: Int(signal))
+        message = ParsableMessage(name: job.kind.rawValue, kind: .signalled(signalledMessage))
       }
-
+      emit(message)
     }
   }
 

Sources/SwiftDriver/Execution/ParsableOutput.swift

@@ -9,33 +9,23 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
-import TSCBasic
 
 import Foundation
 
 public struct ParsableMessage {
   public enum Kind {
     case began(BeganMessage)
     case finished(FinishedMessage)
-    case signalled
+    case signalled(SignalledMessage)
     case skipped
   }
 
   public let name: String
   public let kind: Kind
 
-  public static func beganMessage(
-    name: String,
-    msg: BeganMessage
-  ) -> ParsableMessage {
-    return ParsableMessage(name: name, kind: .began(msg))
-  }
-
-  public static func finishedMessage(
-    name: String,
-    msg: FinishedMessage
-  ) -> ParsableMessage {
-    return ParsableMessage(name: name, kind: .finished(msg))
+  public init(name: String, kind: Kind) {
+    self.name = name
+    self.kind = kind
   }
 
   public func toJSON() throws -> Data {
@@ -109,6 +99,27 @@ public struct FinishedMessage: Encodable {
   }
 }
 
+public struct SignalledMessage: Encodable {
+  let pid: Int
+  let output: String?
+  let errorMessage: String
+  let signal: Int
+
+  public init(pid: Int, output: String?, errorMessage: String, signal: Int) {
+    self.pid = pid
+    self.output = output
+    self.errorMessage = errorMessage
+    self.signal = signal
+  }
+
+  private enum CodingKeys: String, CodingKey {
+    case pid
+    case output
+    case errorMessage = "error-message"
+    case signal
+  }
+}
+
 extension ParsableMessage: Encodable {
   enum CodingKeys: CodingKey {
     case name
@@ -126,8 +137,9 @@ extension ParsableMessage: Encodable {
     case .finished(let msg):
       try container.encode("finished", forKey: .kind)
       try msg.encode(to: encoder)
-    case .signalled:
-      break
+    case .signalled(let msg):
+      try container.encode("signalled", forKey: .kind)
+      try msg.encode(to: encoder)
     case .skipped:
       break
     }

Sources/SwiftDriver/Execution/llbuild.swift

@@ -12,13 +12,7 @@
 
 // FIXME: This is directly copied from SwiftPM, consider moving this to llbuild.
 
-// We either export the llbuildSwift shared library or the llbuild framework.
-#if canImport(llbuildSwift)
 @_exported import llbuildSwift
-@_exported import llbuild
-#else
-@_exported import llbuild
-#endif
 
 import Foundation
 

Sources/SwiftDriver/Incremental Compilation/IncrementalCompilation.swift

@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 import TSCBasic
-import TSCUtility
 import Foundation
 
 // FIXME: rename to something like IncrementalCompilationInitialState

Sources/SwiftDriver/Incremental Compilation/InputIInfoMap.swift

@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 import TSCBasic
-import TSCUtility
 import Foundation
 @_implementationOnly import Yams
 
@@ -173,7 +172,4 @@ extension Diagnostic.Message {
   static func remark_could_not_read_build_record(_ error: Error) -> Diagnostic.Message {
     .remark("Incremental compilation could not read build record: \(error.localizedDescription).")
   }
-  static var remark_incremental_compilation_not_implemented_yet: Diagnostic.Message {
-    .remark("Incremental compilation not implemented yet")
-  }
 }

Sources/SwiftDriver/Incremental Compilation/InputInfo.swift

@@ -9,8 +9,6 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
-import TSCBasic
-import TSCUtility
 import Foundation
 
 public struct InputInfo: Equatable {
@@ -22,8 +20,6 @@ public struct InputInfo: Equatable {
     self.status = status
     self.previousModTime = previousModTime
   }
-
-  static let newlyAdded = Self(status: .newlyAdded, previousModTime: Date.distantFuture)
 }
 
 public extension InputInfo {

Sources/SwiftDriver/Jobs/AutolinkExtractJob.swift

@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 import TSCBasic
-import TSCUtility
 
 extension Driver {
   mutating func autolinkExtractJob(inputs: [TypedVirtualPath]) throws -> Job? {

Sources/SwiftDriver/Jobs/DarwinToolchain+LinkerSupport.swift

@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 import TSCBasic
-import TSCUtility
 
 extension DarwinToolchain {
   private func findARCLiteLibPath() throws -> AbsolutePath? {

Sources/SwiftDriver/Jobs/GenerateDSYMJob.swift

@@ -9,8 +9,6 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
-import TSCBasic
-import TSCUtility
 
 extension Driver {
   func generateDSYMJob(inputs: [TypedVirtualPath]) throws -> Job {

Sources/SwiftDriver/Jobs/GenericUnixToolchain+LinkerSupport.swift

@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 import TSCBasic
-import TSCUtility
 
 extension GenericUnixToolchain {
   private func defaultLinker(for targetTriple: Triple) -> String? {

Sources/SwiftDriver/Jobs/Job.swift

@@ -83,16 +83,6 @@ extension Job: CustomStringConvertible {
   }
 }
 
-/// The type of action.
-enum ActionType {
-  case compile
-  case mergeModule
-  case dynamicLink
-  case generateDSYM
-  case generatePCH
-  case verifyDebugInfo
-}
-
 // MARK: - Job.ArgTemplate + Codable
 
 extension Job.ArgTemplate: Codable {

Sources/SwiftDriver/Jobs/MergeModuleJob.swift

@@ -9,7 +9,6 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
-import TSCBasic
 
 extension Driver {
   mutating func mergeModuleJob(inputs allInputs: [TypedVirtualPath]) throws -> Job {

Sources/SwiftDriver/Jobs/Toolchain+LinkerSupport.swift

@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 import TSCBasic
-import TSCUtility
 
 extension Toolchain {
   // MARK: - Path computation

Sources/SwiftDriver/Options/Option.swift

@@ -130,8 +130,8 @@ extension Option {
 }
 
 extension Option {
-  /// Whether this option is accepted by the
-  public func isAcceptedBy(_ driverKind: DriverKind) -> Bool {
+  /// Whether this option is accepted by a driver of the given kind.
+  public func isAccepted(by driverKind: DriverKind) -> Bool {
     switch driverKind {
     case .autolinkExtract:
       return attributes.contains(.autolinkExtract)