Merge remote-tracking branch 'origin/master' into cs_OnlyOneDependencyFile

Author: cltnschlosser

CMakeLists.txt

@@ -0,0 +1,47 @@
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+# Licensed under Apache License v2.0 with Runtime Library Exception
+#
+# See http://swift.org/LICENSE.txt for license information
+# See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+
+cmake_minimum_required(VERSION 3.15.1)
+
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules)
+
+project(SwiftDriver LANGUAGES Swift)
+
+set(SWIFT_VERSION 5)
+set(CMAKE_Swift_LANGUAGE_VERSION ${SWIFT_VERSION})
+if(CMAKE_VERSION VERSION_LESS 3.16)
+    add_compile_options($<$<COMPILE_LANGUAGE:Swift>:-swift-version$<SEMICOLON>${SWIFT_VERSION}>)
+    set(CMAKE_LINK_LIBRARY_FLAG "-l")
+endif()
+
+set(CMAKE_Swift_MODULE_DIRECTORY ${CMAKE_BINARY_DIR}/swift)
+
+if(CMAKE_VERSION VERSION_LESS 3.16 AND CMAKE_SYSTEM_NAME STREQUAL Windows)
+  set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+  set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+else()
+  set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+  set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+endif()
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+
+option(BUILD_SHARED_LIBS "Build shared libraryes by default" YES)
+
+find_package(TSC CONFIG REQUIRED)
+
+find_package(LLBuild CONFIG)
+if(NOT LLBuild_FOUND)
+  find_package(LLBuild REQUIRED)
+endif()
+
+find_package(dispatch QUIET)
+find_package(Foundation QUIET)
+find_package(Yams CONFIG REQUIRED)
+
+add_subdirectory(Sources)
+add_subdirectory(cmake/modules)

Package.resolved

@@ -1,10 +1,11 @@
 // swift-tools-version:5.1
 import PackageDescription
+import class Foundation.ProcessInfo
 
 let package = Package(
   name: "swift-driver",
   platforms: [
-    .macOS(.v10_13),
+    .macOS(.v10_10),
   ],
   products: [
     .executable(
@@ -20,11 +21,6 @@ let package = Package(
       name: "SwiftOptions",
       targets: ["SwiftOptions"]),
   ],
-  dependencies: [
-    .package(url: "https://github.com/apple/swift-tools-support-core.git", .branch("master")),
-    .package(url: "https://github.com/apple/swift-llbuild.git", .branch("master")),
-    .package(url: "https://github.com/jpsim/Yams.git", .branch("master")),
-  ],
   targets: [
     /// The driver library.
     .target(
@@ -59,3 +55,17 @@ let package = Package(
   ],
   cxxLanguageStandard: .cxx14
 )
+
+if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil {
+  package.dependencies += [
+    .package(url: "https://github.com/apple/swift-tools-support-core.git", .branch("master")),
+    .package(url: "https://github.com/apple/swift-llbuild.git", .branch("master")),
+    .package(url: "https://github.com/jpsim/Yams.git", .branch("master")),
+    ]
+} else {
+    package.dependencies += [
+        .package(path: "../swiftpm/swift-tools-support-core"),
+        .package(path: "../yams"),
+        .package(path: "../llbuild"),
+    ]
+}

Package.swift

@@ -11,7 +11,7 @@ The `swift-driver` project is a new implementation of the Swift compiler driver
 
 ## Getting Started
 
-Use the Swift package manager to build `swift-driver`:
+The preferred way to build `swift-driver` is to use the Swift package manager:
 
 ```
 $ swift build
@@ -32,6 +32,26 @@ SWIFT_EXEC=$SOME_PATH/swiftc swift build
 
 Similarly, one can use the new Swift driver within Xcode by adding a custom build setting (usually at the project level) named `SWIFT_EXEC` that refers to `$SOME_PATH/swiftc`.
 
+## Building with CMake
+
+`swift-driver` can also be built with CMake, which is suggested for
+environments where the Swift Package Manager is not yet
+available. Doing so requires several dependencies to be built first,
+all with CMake:
+
+* (Non-Apple platforms only) [swift-corelibs-foundation](https://github.com/apple/swift-corelibs-foundation)
+* [llbuild](https://github.com/apple/swift-llbuild) configure CMake with `-DLLBUILD_SUPPORT_BINDINGS="Swift"` when building
+  ```
+  cmake -B <llbuild-build-dir> -G Ninja <llbuild-source-dir> -DLLBUILD_SUPPORT_BINDINGS="Swift"
+  ```
+* [Yams](https://github.com/jpsim/Yams)
+
+Once those dependencies have built, build `swift-driver` itself:
+```
+cmake -B <swift-driver-build-dir> -G Ninja <swift-driver-source-dir> -DTSC_DIR=<swift-tools-support-core-build-dir>/cmake/modules -DLLBuild_DIR=<llbuild-build-dir>/cmake/modules -DYams_DIR=<yamls-build-dir>/cmake/modules
+cmake --build <swift-driver-build-dir>
+```
+
 ## Developing `swift-driver`
 
 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.

README.md

@@ -0,0 +1,12 @@
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+# Licensed under Apache License v2.0 with Runtime Library Exception
+#
+# See http://swift.org/LICENSE.txt for license information
+# See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+
+add_subdirectory(SwiftOptions)
+add_subdirectory(SwiftDriver)
+add_subdirectory(swift-driver)
+add_subdirectory(swift-help)

Sources/CMakeLists.txt

@@ -0,0 +1,76 @@
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
+# Licensed under Apache License v2.0 with Runtime Library Exception
+#
+# See http://swift.org/LICENSE.txt for license information
+# See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+
+add_library(SwiftDriver
+  Driver/CompilerMode.swift
+  Driver/DebugInfo.swift
+  Driver/Driver.swift
+  Driver/LinkKind.swift
+  Driver/OutputFileMap.swift
+  Driver/ToolExecutionDelegate.swift
+
+  Execution/JobExecutor.swift
+  Execution/ParsableOutput.swift
+  Execution/ProcessProtocol.swift
+  Execution/llbuild.swift
+
+  "Incremental Compilation/IncrementalCompilation.swift"
+  "Incremental Compilation/InputIInfoMap.swift"
+  "Incremental Compilation/InputInfo.swift"
+
+  Jobs/AutolinkExtractJob.swift
+  Jobs/CommandLineArguments.swift
+  Jobs/CompileJob.swift
+  Jobs/DarwinToolchain+LinkerSupport.swift
+  Jobs/EmitModuleJob.swift
+  Jobs/FrontendJobHelpers.swift
+  Jobs/GenerateDSYMJob.swift
+  Jobs/GeneratePCHJob.swift
+  Jobs/GeneratePCMJob.swift
+  Jobs/GenericUnixToolchain+LinkerSupport.swift
+  Jobs/InterpretJob.swift
+  Jobs/Job.swift
+  Jobs/LinkJob.swift
+  Jobs/MergeModuleJob.swift
+  Jobs/Planning.swift
+  Jobs/ReplJob.swift
+  Jobs/Toolchain+InterpreterSupport.swift
+  Jobs/Toolchain+LinkerSupport.swift
+  Jobs/VerifyDebugInfoJob.swift
+
+  Toolchains/DarwinToolchain.swift
+  Toolchains/GenericUnixToolchain.swift
+  Toolchains/Toolchain.swift
+
+  Utilities/DOTJobGraphSerializer.swift
+  Utilities/DateAdditions.swift
+  Utilities/Diagnostics.swift
+  Utilities/FileType.swift
+  Utilities/PredictableRandomNumberGenerator.swift
+  Utilities/RelativePathAdditions.swift
+  Utilities/Sanitizer.swift
+  Utilities/StringAdditions.swift
+  Utilities/System.swift
+  Utilities/Triple+Platforms.swift
+  Utilities/Triple.swift
+  Utilities/TypedVirtualPath.swift
+  Utilities/VirtualPath.swift)
+
+target_link_libraries(SwiftDriver PUBLIC
+  TSCBasic
+  SwiftOptions
+  llbuildSwift
+  CYaml
+  Yams)
+
+set_property(GLOBAL APPEND PROPERTY SWIFTDRIVER_EXPORTS SwiftDriver)
+
+# NOTE: workaround for CMake not setting up include flags yet
+set_target_properties(SwiftDriver PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
+

Sources/SwiftDriver/CMakeLists.txt

@@ -42,12 +42,13 @@ public enum ModuleOutput: Equatable {
 
 /// The Swift driver.
 public struct Driver {
-  public enum Error: Swift.Error, DiagnosticData {
+  public enum Error: Swift.Error, Equatable, DiagnosticData {
     case invalidDriverName(String)
     case invalidInput(String)
     case noJobsPassedToDriverFromEmptyInputFileList
     case relativeFrontendPath(String)
     case subcommandPassedToDriver
+    case integratedReplRemoved
 
     public var description: String {
       switch self {
@@ -62,6 +63,8 @@ public struct Driver {
         return "relative frontend path: \(path)"
       case .subcommandPassedToDriver:
         return "subcommand passed to driver"
+      case .integratedReplRemoved:
+        return "Compiler-internal integrated REPL has been removed; use the LLDB-enhanced REPL instead."
       }
     }
   }
@@ -298,7 +301,7 @@ public struct Driver {
     }
 
     // Determine the compilation mode.
-    self.compilerMode = Self.computeCompilerMode(&parsedOptions, driverKind: driverKind, diagnosticsEngine: diagnosticEngine)
+    self.compilerMode = try Self.computeCompilerMode(&parsedOptions, driverKind: driverKind, diagnosticsEngine: diagnosticEngine)
 
     // Figure out the primary outputs from the driver.
     (self.compilerOutputType, self.linkerOutputType) = Self.determinePrimaryOutputs(&parsedOptions, driverKind: driverKind, diagnosticsEngine: diagnosticEngine)
@@ -764,16 +767,19 @@ extension Driver {
     _ parsedOptions: inout ParsedOptions,
     driverKind: DriverKind,
     diagnosticsEngine: DiagnosticsEngine
-  ) -> CompilerMode {
+  ) throws -> CompilerMode {
     // Some output flags affect the compiler mode.
     if let outputOption = parsedOptions.getLast(in: .modes) {
       switch outputOption.option {
       case .emitPch, .emitImportedModules:
         return .singleCompile
 
-      case .repl, .deprecatedIntegratedRepl, .lldbRepl:
+      case .repl, .lldbRepl:
         return .repl
 
+      case .deprecatedIntegratedRepl:
+        throw Error.integratedReplRemoved
+
       case .emitPcm:
         return .compilePCM
 

Sources/SwiftDriver/Driver/Driver.swift

@@ -256,7 +256,7 @@ struct JobExecutorBuildDelegate: LLBuildEngineDelegate {
     case ExecuteAllJobsRule.ruleName:
       return ExecuteAllJobsRule(key)
     case ExecuteJobRule.ruleName:
-      return ExecuteJobRule(key)
+      return ExecuteJobRule(key, context: context)
     default:
       fatalError("Unknown rule \(rule)")
     }
@@ -336,18 +336,18 @@ class ExecuteJobRule: LLBuildRule {
   override class var ruleName: String { "\(ExecuteJobRule.self)" }
 
   private let key: RuleKey
+  private let context: JobExecutor.Context
 
   /// True if any of the inputs had any error.
   private var allInputsSucceeded: Bool = true
 
-  init(_ key: Key) {
+  init(_ key: Key, context: JobExecutor.Context) {
     self.key = RuleKey(key)
+    self.context = context
     super.init()
   }
 
   override func start(_ engine: LLTaskBuildEngine) {
-    let context = engine.jobExecutorContext
-
     for (idx, input) in key.job.inputs.enumerated() {
       if let producingJob = context.producerMap[input.file] {
         let key = ExecuteJobRule.RuleKey(job: producingJob)
@@ -375,14 +375,11 @@ class ExecuteJobRule: LLBuildRule {
       return engine.taskIsComplete(DriverBuildValue.jobExecution(success: false))
     }
 
-    let context = engine.jobExecutorContext
-    context.jobQueue.addOperation {
-      self.executeJob(engine)
-    }
+    engine.taskIsComplete(self.executeJob(engine))
   }
 
-  private func executeJob(_ engine: LLTaskBuildEngine) {
-    let context = engine.jobExecutorContext
+  private func executeJob(_ engine: LLTaskBuildEngine) -> DriverBuildValue {
+    let context = self.context
     let resolver = context.argsResolver
     let job = key.job
     let env = context.env.merging(job.extraEnvironment, uniquingKeysWith: { $1 })
@@ -423,6 +420,7 @@ class ExecuteJobRule: LLBuildRule {
       context.delegateQueue.async {
         let result = ProcessResult(
           arguments: [],
+          environment: env,
           exitStatus: .terminated(code: 1),
           output: Result.success([]),
           stderrOutput: Result.success([])
@@ -432,15 +430,8 @@ class ExecuteJobRule: LLBuildRule {
       value = .jobExecution(success: false)
     }
 
-    engine.taskIsComplete(value)
+    return value
   }
 }
 
 extension Job: LLBuildValue { }
-
-extension LLTaskBuildEngine {
-  /// Returns the job executor context.
-  var jobExecutorContext: JobExecutor.Context {
-    return (delegate as! JobExecutorBuildDelegate).context
-  }
-}

Sources/SwiftDriver/Execution/JobExecutor.swift

@@ -30,7 +30,11 @@ public struct ParsableMessage {
 
   public func toJSON() throws -> Data {
     let encoder = JSONEncoder()
-    encoder.outputFormatting = [.prettyPrinted, .sortedKeys]
+    if #available(macOS 10.13, *) {
+      encoder.outputFormatting = [.prettyPrinted, .sortedKeys]
+    } else {
+      encoder.outputFormatting = [.prettyPrinted]
+    }
     return try encoder.encode(self)
   }
 }

Sources/SwiftDriver/Execution/ParsableOutput.swift

@@ -111,10 +111,6 @@ public class LLTaskBuildEngine {
         self.engine = engine
     }
 
-    var delegate: LLBuildEngineDelegate {
-      return (engine.engine.delegate as! LLBuildEngine.Delegate).delegate
-    }
-
     public func taskNeedsInput<T: LLBuildKey>(_ key: T, inputID: Int) {
         let encodedKey = RuleKey(
             rule: T.BuildRule.ruleName, data: key.toKey().data).toKey()