Expose a low-level BSP interface wrapping SWBBuildServiceSession

SWBBuildServer implements BSP message handling and is intended to back a higher level BSP which manages the project model and generates PIF and a build request (SwiftPM).

As part of this change, many of the core BSP types are vendored into the new SWBBuildServerProtocol target from SourceKitLSP with minor modifications.

Author: owenv

CMakeLists.txt

@@ -81,6 +81,7 @@ add_compile_definitions(USE_STATIC_PLUGIN_INITIALIZATION)
 find_package(ArgumentParser)
 find_package(LLBuild)
 find_package(SwiftDriver)
+find_package(SwiftToolsProtocols)
 find_package(SwiftSystem)
 find_package(TSC)
 # NOTE: these two are required for LLBuild dependencies

Package.swift

@@ -106,7 +106,17 @@ let package = Package(
         // Libraries
         .target(
             name: "SwiftBuild",
-            dependencies: ["SWBCSupport", "SWBCore", "SWBProtocol", "SWBUtil", "SWBProjectModel"],
+            dependencies: [
+                "SWBCSupport",
+                "SWBCore",
+                "SWBProtocol",
+                "SWBUtil",
+                "SWBProjectModel",
+                .product(name: "BuildServerProtocol", package: "swift-tools-protocols"),
+                .product(name: "LanguageServerProtocol", package: "swift-tools-protocols"),
+                .product(name: "LanguageServerProtocolTransport", package: "swift-tools-protocols")
+
+            ],
             exclude: ["CMakeLists.txt"],
             swiftSettings: swiftSettings(languageMode: .v5)),
         .target(
@@ -460,6 +470,7 @@ if useLocalDependencies {
         .package(path: "../swift-driver"),
         .package(path: "../swift-system"),
         .package(path: "../swift-argument-parser"),
+        .package(path: "../swift-tools-protocols"),
     ]
     if !useLLBuildFramework {
         package.dependencies +=  [.package(path: "../llbuild"),]
@@ -469,6 +480,7 @@ if useLocalDependencies {
         .package(url: "https://github.com/swiftlang/swift-driver.git", branch: "main"),
         .package(url: "https://github.com/apple/swift-system.git", .upToNextMajor(from: "1.5.0")),
         .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.0.3"),
+        .package(url: "https://github.com/swiftlang/swift-tools-protocols.git", .upToNextMinor(from: "0.0.2")),
     ]
     if !useLLBuildFramework {
         package.dependencies += [.package(url: "https://github.com/swiftlang/swift-llbuild.git", branch: "main"),]

Plugins/cmake-smoke-test/cmake-smoke-test.swift

@@ -58,7 +58,10 @@ struct CMakeSmokeTest: CommandPlugin {
         let swiftDriverURL = try findDependency("swift-driver", pluginContext: context)
         let swiftDriverBuildURL = context.pluginWorkDirectoryURL.appending(component: "swift-driver")
 
-        for url in [swiftToolsSupportCoreBuildURL, swiftSystemBuildURL, llbuildBuildURL, swiftArgumentParserBuildURL, swiftDriverBuildURL, swiftBuildBuildURL] {
+        let swiftToolsProtocolsURL = try findDependency("swift-tools-protocols", pluginContext: context)
+        let swiftToolsProtocolsBuildURL = context.pluginWorkDirectoryURL.appending(component: "swift-tools-protocols")
+
+        for url in [swiftToolsSupportCoreBuildURL, swiftSystemBuildURL, llbuildBuildURL, swiftArgumentParserBuildURL, swiftDriverBuildURL, swiftToolsProtocolsBuildURL, swiftBuildBuildURL] {
             try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
         }
 
@@ -75,7 +78,8 @@ struct CMakeSmokeTest: CommandPlugin {
             "-DLLBuild_DIR=\(llbuildBuildURL.appending(components: "cmake", "modules").filePath)",
             "-DTSC_DIR=\(swiftToolsSupportCoreBuildURL.appending(components: "cmake", "modules").filePath)",
             "-DSwiftDriver_DIR=\(swiftDriverBuildURL.appending(components: "cmake", "modules").filePath)",
-            "-DSwiftSystem_DIR=\(swiftSystemBuildURL.appending(components: "cmake", "modules").filePath)"
+            "-DSwiftSystem_DIR=\(swiftSystemBuildURL.appending(components: "cmake", "modules").filePath)",
+            "-DSwiftToolsProtocols_DIR=\(swiftToolsProtocolsBuildURL.appending(components: "cmake", "modules").filePath)"
         ]
 
         let sharedCMakeArgs = [
@@ -112,6 +116,11 @@ struct CMakeSmokeTest: CommandPlugin {
         try await Process.checkNonZeroExit(url: ninjaURL, arguments: [], workingDirectory: swiftDriverBuildURL)
         Diagnostics.progress("Built swift-driver")
 
+        Diagnostics.progress("Building swift-tools-protocols")
+        try await Process.checkNonZeroExit(url: cmakeURL, arguments: sharedCMakeArgs + [swiftToolsProtocolsURL.filePath], workingDirectory: swiftToolsProtocolsBuildURL)
+        try await Process.checkNonZeroExit(url: ninjaURL, arguments: [], workingDirectory: swiftToolsProtocolsBuildURL)
+        Diagnostics.progress("Built swift-tools-protocols")
+
         Diagnostics.progress("Building swift-build in \(swiftBuildBuildURL)")
         try await Process.checkNonZeroExit(url: cmakeURL, arguments: sharedCMakeArgs + [swiftBuildURL.filePath], workingDirectory: swiftBuildBuildURL)
         try await Process.checkNonZeroExit(url: ninjaURL, arguments: [], workingDirectory: swiftBuildBuildURL)

Sources/SWBCore/Settings/BuiltinMacros.swift

@@ -482,6 +482,7 @@ public final class BuiltinMacros {
     public static let BUILD_DIR = BuiltinMacros.declarePathMacro("BUILD_DIR")
     public static let BUILD_LIBRARY_FOR_DISTRIBUTION = BuiltinMacros.declareBooleanMacro("BUILD_LIBRARY_FOR_DISTRIBUTION")
     public static let BUILD_PACKAGE_FOR_DISTRIBUTION = BuiltinMacros.declareBooleanMacro("BUILD_PACKAGE_FOR_DISTRIBUTION")
+    public static let BUILD_SERVER_PROTOCOL_TARGET_TAGS = BuiltinMacros.declareBooleanMacro("BUILD_SERVER_PROTOCOL_TARGET_TAGS")
     public static let BUILD_VARIANTS = BuiltinMacros.declareStringListMacro("BUILD_VARIANTS")
     public static let BuiltBinaryPath = BuiltinMacros.declareStringMacro("BuiltBinaryPath")
     public static let BUNDLE_FORMAT = BuiltinMacros.declareStringMacro("BUNDLE_FORMAT")
@@ -1478,6 +1479,7 @@ public final class BuiltinMacros {
         BUILD_DIR,
         BUILD_LIBRARY_FOR_DISTRIBUTION,
         BUILD_PACKAGE_FOR_DISTRIBUTION,
+        BUILD_SERVER_PROTOCOL_TARGET_TAGS,
         BUILD_STYLE,
         BUILD_VARIANTS,
         BUILT_PRODUCTS_DIR,

Sources/SWBUtil/Lock.swift

@@ -138,3 +138,23 @@ extension SWBMutex where Value: ~Copyable, Value == Void {
         try withLock { _ throws(E) -> sending Result in return try body() }
     }
 }
+
+extension SWBMutex where Value: BinaryInteger & Sendable {
+    public func fetchAndIncrement() -> Value {
+        withLock { value in
+            let retVal = value
+            value += 1
+            return retVal
+        }
+    }
+}
+
+extension SWBMutex {
+    public func takeValue<T>() -> Value where Value == Optional<T> {
+        withLock { value in
+            let retVal = value
+            value = nil
+            return retVal
+        }
+    }
+}

Sources/SwiftBuild/CMakeLists.txt

@@ -36,6 +36,7 @@ add_library(SwiftBuild
   SWBBuildOperationBacktraceFrame.swift
   SWBBuildParameters.swift
   SWBBuildRequest.swift
+  SWBBuildServer.swift
   SWBBuildService.swift
   SWBBuildServiceConnection.swift
   SWBBuildServiceConsole.swift
@@ -70,7 +71,13 @@ target_link_libraries(SwiftBuild PUBLIC
   SWBCore
   SWBProtocol
   SWBUtil
-  SWBProjectModel)
+  SWBProjectModel
+  SwiftToolsProtocols::LSPCAtomics
+  SwiftToolsProtocols::SKLogging
+  SwiftToolsProtocols::SwiftExtensions
+  SwiftToolsProtocols::BuildServerProtocol
+  SwiftToolsProtocols::LanguageServerProtocol
+  SwiftToolsProtocols::LanguageServerProtocolTransport)
 
 set_target_properties(SwiftBuild PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})