[PackageModel] Add a new target kind - provided library

xedin · furby-tm · commit b9924691c957 · 2024-05-15T00:45:03.000-06:00
This target points to a prebuilt library that comes from
a certain location in a toolchain. It's going to be injected
by the package manager into library manifests and shouldn't
be accessible via user-facing APIs.
diff --git a/Sources/Build/BuildDescription/ProductBuildDescription.swift b/Sources/Build/BuildDescription/ProductBuildDescription.swift
@@ -45,6 +45,9 @@ package final class ProductBuildDescription: SPMBuildCore.ProductBuildDescriptio
     // Computed during build planning.
     var dylibs: [ProductBuildDescription] = []
 
+    /// The list of provided libraries that are going to be used by this product.
+    var providedLibraries: [String: AbsolutePath] = [:]
+
     /// Any additional flags to be added. These flags are expected to be computed during build planning.
     var additionalFlags: [String] = []
 
@@ -156,6 +159,8 @@ package final class ProductBuildDescription: SPMBuildCore.ProductBuildDescriptio
             args += ["-F", self.buildParameters.buildPath.pathString]
         }
 
+        self.providedLibraries.forEach { args += ["-L", $1.pathString, "-l", $0] }
+
         args += ["-L", self.buildParameters.buildPath.pathString]
         args += try ["-o", binaryPath.pathString]
         args += ["-module-name", self.product.name.spm_mangledToC99ExtendedIdentifier()]
diff --git a/Sources/Build/BuildManifest/LLBuildManifestBuilder+Swift.swift b/Sources/Build/BuildManifest/LLBuildManifestBuilder+Swift.swift
@@ -424,6 +424,8 @@ extension LLBuildManifestBuilder {
             if target.underlying is BinaryTarget { return }
             // Ignore Plugin Targets.
             if target.underlying is PluginTarget { return }
+            // Ignore Provided Libraries.
+            if target.underlying is ProvidedLibraryTarget { return }
 
             // Depend on the binary for executable targets.
             if target.type == .executable {
diff --git a/Sources/Build/BuildPlan/BuildPlan+Product.swift b/Sources/Build/BuildPlan/BuildPlan+Product.swift
@@ -115,6 +115,8 @@ extension BuildPlan {
         }
         buildProduct.libraryBinaryPaths = dependencies.libraryBinaryPaths
 
+        buildProduct.providedLibraries = dependencies.providedLibraries
+
         buildProduct.availableTools = dependencies.availableTools
     }
 
@@ -127,6 +129,7 @@ extension BuildPlan {
         staticTargets: [ResolvedModule],
         systemModules: [ResolvedModule],
         libraryBinaryPaths: Set<AbsolutePath>,
+        providedLibraries: [String: AbsolutePath],
         availableTools: [String: AbsolutePath]
     ) {
         /* Prior to tools-version 5.9, we used to erroneously recursively traverse executable/plugin dependencies and statically include their
@@ -207,6 +210,7 @@ extension BuildPlan {
         var staticTargets = [ResolvedModule]()
         var systemModules = [ResolvedModule]()
         var libraryBinaryPaths: Set<AbsolutePath> = []
+        var providedLibraries = [String: AbsolutePath]()
         var availableTools = [String: AbsolutePath]()
 
         for dependency in allTargets {
@@ -260,6 +264,8 @@ extension BuildPlan {
                     }
                 case .plugin:
                     continue
+                case .providedLibrary:
+                    providedLibraries[target.name] = target.underlying.path
                 }
 
             case .product(let product, _):
@@ -277,7 +283,7 @@ extension BuildPlan {
             }
         }
 
-        return (linkLibraries, staticTargets, systemModules, libraryBinaryPaths, availableTools)
+        return (linkLibraries, staticTargets, systemModules, libraryBinaryPaths, providedLibraries, availableTools)
     }
 
     /// Extracts the artifacts  from an artifactsArchive
diff --git a/Sources/Build/BuildPlan/BuildPlan+Swift.swift b/Sources/Build/BuildPlan/BuildPlan+Swift.swift
@@ -14,6 +14,7 @@ import struct Basics.InternalError
 import class PackageModel.BinaryTarget
 import class PackageModel.ClangTarget
 import class PackageModel.SystemLibraryTarget
+import class PackageModel.ProvidedLibraryTarget
 
 extension BuildPlan {
     func plan(swiftTarget: SwiftTargetBuildDescription) throws {
@@ -48,6 +49,10 @@ extension BuildPlan {
                         swiftTarget.libraryBinaryPaths.insert(library.libraryPath)
                     }
                 }
+            case let target as ProvidedLibraryTarget:
+                swiftTarget.additionalFlags += [
+                    "-I", target.path.pathString
+                ]
             default:
                 break
             }
diff --git a/Sources/Build/BuildPlan/BuildPlan.swift b/Sources/Build/BuildPlan/BuildPlan.swift
@@ -433,7 +433,7 @@ public class BuildPlan: SPMBuildCore.BuildPlan {
                     toolsVersion: toolsVersion,
                     fileSystem: fileSystem
                 ))
-            case is SystemLibraryTarget, is BinaryTarget:
+            case is SystemLibraryTarget, is BinaryTarget, is ProvidedLibraryTarget:
                 break
             default:
                 throw InternalError("unhandled \(target.underlying)")
diff --git a/Sources/Commands/Snippets/Cards/TopCard.swift b/Sources/Commands/Snippets/Cards/TopCard.swift
@@ -153,6 +153,8 @@ fileprivate extension Target.Kind {
             return "snippets"
         case .macro:
             return "macros"
+        case .providedLibrary:
+            return "provided libraries"
         }
     }
 }
diff --git a/Sources/PackageLoading/PackageBuilder.swift b/Sources/PackageLoading/PackageBuilder.swift
@@ -542,6 +542,16 @@ public final class PackageBuilder {
                     throw ModuleError.artifactNotFound(targetName: target.name, expectedArtifactName: target.name)
                 }
                 return artifact.path
+            } else if let targetPath = target.path, target.type == .providedLibrary {
+                guard let path = try? AbsolutePath(validating: targetPath) else {
+                    throw ModuleError.invalidCustomPath(target: target.name, path: targetPath)
+                }
+
+                if !self.fileSystem.isDirectory(path) {
+                    throw ModuleError.unsupportedTargetPath(targetPath)
+                }
+
+                return path
             } else if let subpath = target.path { // If there is a custom path defined, use that.
                 if subpath == "" || subpath == "." {
                     return self.packagePath
@@ -865,6 +875,11 @@ public final class PackageBuilder {
                 path: potentialModule.path,
                 origin: artifactOrigin
             )
+        } else if potentialModule.type == .providedLibrary {
+            return ProvidedLibraryTarget(
+                name: potentialModule.name,
+                path: potentialModule.path
+            )
         }
 
         // Check for duplicate target dependencies
diff --git a/Sources/PackageModel/CMakeLists.txt b/Sources/PackageModel/CMakeLists.txt
@@ -51,6 +51,7 @@ add_library(PackageModel
   Target/BinaryTarget.swift
   Target/ClangTarget.swift
   Target/PluginTarget.swift
+  Target/ProvidedLibraryTarget.swift
   Target/SwiftTarget.swift
   Target/SystemLibraryTarget.swift
   Target/Target.swift
diff --git a/Sources/PackageModel/Manifest/TargetDescription.swift b/Sources/PackageModel/Manifest/TargetDescription.swift
@@ -21,6 +21,7 @@ public struct TargetDescription: Hashable, Encodable, Sendable {
         case binary
         case plugin
         case `macro`
+        case providedLibrary
     }
 
     /// Represents a target's dependency on another entity.
@@ -223,6 +224,19 @@ public struct TargetDescription: Hashable, Encodable, Sendable {
             if pkgConfig != nil { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "pkgConfig") }
             if providers != nil { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "providers") }
             if pluginCapability != nil { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "pluginCapability") }
+        case .providedLibrary:
+            if path == nil { throw Error.providedLibraryTargetRequiresPath(targetName: name) }
+            if url != nil { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "url") }
+            if !dependencies.isEmpty { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "dependencies") }
+            if !exclude.isEmpty { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "exclude") }
+            if sources != nil { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "sources") }
+            if !resources.isEmpty { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "resources") }
+            if publicHeadersPath != nil { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "publicHeadersPath") }
+            if pkgConfig != nil { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "pkgConfig") }
+            if providers != nil { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "providers") }
+            if pluginCapability != nil { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "pluginCapability") }
+            if !settings.isEmpty { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "settings") }
+            if pluginUsages != nil { throw Error.disallowedPropertyInTarget(targetName: name, propertyName: "pluginUsages") }
         }
 
         self.name = name
@@ -380,13 +394,16 @@ import protocol Foundation.LocalizedError
 private enum Error: LocalizedError, Equatable {
     case binaryTargetRequiresEitherPathOrURL(targetName: String)
     case disallowedPropertyInTarget(targetName: String, propertyName: String)
-    
+    case providedLibraryTargetRequiresPath(targetName: String)
+
     var errorDescription: String? {
         switch self {
         case .binaryTargetRequiresEitherPathOrURL(let targetName):
             return "binary target '\(targetName)' neither defines neither path nor URL for its artifacts"
         case .disallowedPropertyInTarget(let targetName, let propertyName):
             return "target '\(targetName)' contains a value for disallowed property '\(propertyName)'"
+        case .providedLibraryTargetRequiresPath(let targetName):
+            return "provided library target '\(targetName)' does not define a path to the library"
         }
     }
 }
diff --git a/Sources/PackageModel/ManifestSourceGeneration.swift b/Sources/PackageModel/ManifestSourceGeneration.swift
@@ -317,6 +317,8 @@ fileprivate extension SourceCodeFragment {
             self.init(enum: "plugin", subnodes: params, multiline: true)
         case .macro:
             self.init(enum: "macro", subnodes: params, multiline: true)
+        case .providedLibrary:
+            self.init(enum: "providedLibrary", subnodes: params, multiline: true)
         }
     }
 
diff --git a/Sources/PackageModel/Target/ProvidedLibraryTarget.swift b/Sources/PackageModel/Target/ProvidedLibraryTarget.swift
@@ -0,0 +1,44 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2014-2024 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 the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import struct Basics.AbsolutePath
+
+/// Represents a target library that comes from a toolchain in prebuilt form.
+public final class ProvidedLibraryTarget: Target {
+    public init(
+        name: String,
+        path: AbsolutePath
+    ) {
+        let sources = Sources(paths: [], root: path)
+        super.init(
+            name: name,
+            type: .providedLibrary,
+            path: sources.root,
+            sources: sources,
+            dependencies: [],
+            packageAccess: false,
+            buildSettings: .init(),
+            buildSettingsDescription: [],
+            pluginUsages: [],
+            usesUnsafeFlags: false
+        )
+    }
+
+
+    public override func encode(to encoder: Encoder) throws {
+        try super.encode(to: encoder)
+    }
+
+    required public init(from decoder: Decoder) throws {
+        try super.init(from: decoder)
+    }
+}
diff --git a/Sources/PackageModel/Target/Target.swift b/Sources/PackageModel/Target/Target.swift
@@ -21,6 +21,7 @@ public class Target: PolymorphicCodableProtocol {
         SystemLibraryTarget.self,
         BinaryTarget.self,
         PluginTarget.self,
+        ProvidedLibraryTarget.self,
     ]
 
     /// The target kind.
@@ -33,6 +34,7 @@ public class Target: PolymorphicCodableProtocol {
         case plugin
         case snippet
         case `macro`
+        case providedLibrary
     }
 
     /// A group a target belongs to that allows customizing access boundaries. A target is treated as
diff --git a/Sources/PackageModelSyntax/AddTarget.swift b/Sources/PackageModelSyntax/AddTarget.swift
@@ -62,7 +62,7 @@ public struct AddTarget {
         )
 
         let outerDirectory: String? = switch target.type {
-        case .binary, .plugin, .system: nil
+        case .binary, .plugin, .system, .providedLibrary: nil
         case .executable, .regular, .macro: "Sources"
         case .test: "Tests"
         }
@@ -167,7 +167,7 @@ public struct AddTarget {
         }
 
         let sourceFileText: SourceFileSyntax = switch target.type {
-        case .binary, .plugin, .system:
+        case .binary, .plugin, .system, .providedLibrary:
             fatalError("should have exited above")
 
         case .macro:
diff --git a/Sources/PackageModelSyntax/TargetDescription+Syntax.swift b/Sources/PackageModelSyntax/TargetDescription+Syntax.swift
@@ -27,6 +27,7 @@ extension TargetDescription: ManifestSyntaxRepresentable {
         case .regular: "target"
         case .system: "systemLibrary"
         case .test: "testTarget"
+        case .providedLibrary: "providedLibrary"
         }
     }
 
diff --git a/Sources/SPMBuildCore/Plugins/PluginContextSerializer.swift b/Sources/SPMBuildCore/Plugins/PluginContextSerializer.swift
@@ -282,7 +282,7 @@ fileprivate extension WireInput.Target.TargetInfo.SourceModuleKind {
             self = .test
         case .macro:
             self = .macro
-        case .binary, .plugin, .systemModule:
+        case .binary, .plugin, .systemModule, .providedLibrary:
             throw StringError("unexpected target kind \(kind) for source module")
         }
     }
diff --git a/Sources/XCBuildSupport/PIFBuilder.swift b/Sources/XCBuildSupport/PIFBuilder.swift
@@ -399,6 +399,9 @@ final class PackagePIFProjectBuilder: PIFProjectBuilder {
         case .macro:
             // Macros are not supported when using XCBuild, similar to package plugins.
             return
+        case .providedLibrary:
+            // Provided libraries don't need to be built.
+            return
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,8 @@ extension BuildPlan {`
`115`	`115`	`}`
`116`	`116`	`buildProduct.libraryBinaryPaths = dependencies.libraryBinaryPaths`
`117`	`117`
	`118`	`+ buildProduct.providedLibraries = dependencies.providedLibraries`
	`119`	`+`
`118`	`120`	`buildProduct.availableTools = dependencies.availableTools`
`119`	`121`	`}`
`120`	`122`
`@@ -127,6 +129,7 @@ extension BuildPlan {`
`127`	`129`	`staticTargets: [ResolvedModule],`
`128`	`130`	`systemModules: [ResolvedModule],`
`129`	`131`	`libraryBinaryPaths: Set<AbsolutePath>,`
	`132`	`+ providedLibraries: [String: AbsolutePath],`
`130`	`133`	`availableTools: [String: AbsolutePath]`
`131`	`134`	`) {`
`132`	`135`	`/* Prior to tools-version 5.9, we used to erroneously recursively traverse executable/plugin dependencies and statically include their`
`@@ -207,6 +210,7 @@ extension BuildPlan {`
`207`	`210`	`var staticTargets = [ResolvedModule]()`
`208`	`211`	`var systemModules = [ResolvedModule]()`
`209`	`212`	`var libraryBinaryPaths: Set<AbsolutePath> = []`
	`213`	`+ var providedLibraries = [String: AbsolutePath]()`
`210`	`214`	`var availableTools = [String: AbsolutePath]()`
`211`	`215`
`212`	`216`	`for dependency in allTargets {`
`@@ -260,6 +264,8 @@ extension BuildPlan {`
`260`	`264`	`}`
`261`	`265`	`case .plugin:`
`262`	`266`	`continue`
	`267`	`+ case .providedLibrary:`
	`268`	`+ providedLibraries[target.name] = target.underlying.path`
`263`	`269`	`}`
`264`	`270`
`265`	`271`	`case .product(let product, _):`
`@@ -277,7 +283,7 @@ extension BuildPlan {`
`277`	`283`	`}`
`278`	`284`	`}`
`279`	`285`
`280`		`- return (linkLibraries, staticTargets, systemModules, libraryBinaryPaths, availableTools)`
	`286`	`+ return (linkLibraries, staticTargets, systemModules, libraryBinaryPaths, providedLibraries, availableTools)`
`281`	`287`	`}`
`282`	`288`
`283`	`289`	`/// Extracts the artifacts from an artifactsArchive`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ import struct Basics.InternalError`
`14`	`14`	`import class PackageModel.BinaryTarget`
`15`	`15`	`import class PackageModel.ClangTarget`
`16`	`16`	`import class PackageModel.SystemLibraryTarget`
	`17`	`+import class PackageModel.ProvidedLibraryTarget`
`17`	`18`
`18`	`19`	`extension BuildPlan {`
`19`	`20`	`func plan(swiftTarget: SwiftTargetBuildDescription) throws {`
`@@ -48,6 +49,10 @@ extension BuildPlan {`
`48`	`49`	`swiftTarget.libraryBinaryPaths.insert(library.libraryPath)`
`49`	`50`	`}`
`50`	`51`	`}`
	`52`	`+ case let target as ProvidedLibraryTarget:`
	`53`	`+ swiftTarget.additionalFlags += [`
	`54`	`+ "-I", target.path.pathString`
	`55`	`+ ]`
`51`	`56`	`default:`
`52`	`57`	`break`
`53`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -153,6 +153,8 @@ fileprivate extension Target.Kind {`
`153`	`153`	`return "snippets"`
`154`	`154`	`case .macro:`
`155`	`155`	`return "macros"`
	`156`	`+ case .providedLibrary:`
	`157`	`+ return "provided libraries"`
`156`	`158`	`}`
`157`	`159`	`}`
`158`	`160`	`}`
Original file line number	Diff line number	Diff line change
`@@ -317,6 +317,8 @@ fileprivate extension SourceCodeFragment {`
`317`	`317`	`self.init(enum: "plugin", subnodes: params, multiline: true)`
`318`	`318`	`case .macro:`
`319`	`319`	`self.init(enum: "macro", subnodes: params, multiline: true)`
	`320`	`+ case .providedLibrary:`
	`321`	`+ self.init(enum: "providedLibrary", subnodes: params, multiline: true)`
`320`	`322`	`}`
`321`	`323`	`}`
`322`	`324`