Build: pass through Embedded flag to link jobs (swiftlang#7304)

### Motivation:

Without passing this flag, Swift Driver links such products as if
they're not built for embedded platforms at all, passing incorrect flags
to the linker. This is not reproducible when using plain `swiftc`, as
that combines both compile and link jobs by default, but SwiftPM prefers
to run those separately, which requires this special handling.

### Modifications:

Directly checking in `ProductBuildDescription/linkArguments` whether all
of the product's targets are built in the embedded mode. If so, we're
passing the embedded mode flag to Swift Driver.

Unfortunately, `BuildSettings.AssignmentTable` is formed too early in
the build process right in `PackageModel`, while we still need to run
checks specific build settings quite late in the build stage. Because of
that, there's no clean way to check if `Embedded` flag is passed other
than directly rendering `BuildSettings.Scope` to a string and running a
substring check on that. In the future we should move `BuildSettings`
out of `PackageModel`, ensuring that SwiftPM clients don't rely on this
behavior anymore.

### Result:

Products that have targets using Embedded Swift can be built with
SwiftPM, assuming that Swift Driver handles other linker flags
correctly.

Author: MaxDesiatov

Sources/Build/BuildDescription/ProductBuildDescription.swift

@@ -12,7 +12,10 @@
 
 import Basics
 import PackageGraph
+
+@_spi(SwiftPMInternal)
 import PackageModel
+
 import OrderedCollections
 import SPMBuildCore
 
@@ -198,7 +201,7 @@ public final class ProductBuildDescription: SPMBuildCore.ProductBuildDescription
             // No arguments for static libraries.
             return []
         case .test:
-            // Test products are bundle when using objectiveC, executable when using test entry point.
+            // Test products are bundle when using Objective-C, executable when using test entry point.
             switch self.buildParameters.testingParameters.testProductStyle {
             case .loadableBundle:
                 args += ["-Xlinker", "-bundle"]
@@ -271,8 +274,21 @@ public final class ProductBuildDescription: SPMBuildCore.ProductBuildDescription
         }
         args += ["@\(self.linkFileListPath.pathString)"]
 
-        // Embed the swift stdlib library path inside tests and executables on Darwin.
         if containsSwiftTargets {
+            // Pass experimental features to link jobs in addition to compile jobs. Preserve ordering while eliminating
+            // duplicates with `OrderedSet`.
+            var experimentalFeatures = OrderedSet<String>()
+            for target in self.product.targets {
+                let swiftSettings = target.underlying.buildSettingsDescription.filter { $0.tool == .swift }
+                for case let .enableExperimentalFeature(feature) in swiftSettings.map(\.kind)  {
+                    experimentalFeatures.append(feature)
+                }
+            }
+            for feature in experimentalFeatures {
+                args += ["-enable-experimental-feature", feature]
+            }
+
+            // Embed the swift stdlib library path inside tests and executables on Darwin.
             let useStdlibRpath: Bool
             switch self.product.type {
             case .library(let type):
@@ -297,11 +313,9 @@ public final class ProductBuildDescription: SPMBuildCore.ProductBuildDescription
                     args += ["-Xlinker", "-rpath", "-Xlinker", backDeployedStdlib.pathString]
                 }
             }
-        }
-
-        // Don't link runtime compatibility patch libraries if there are no
-        // Swift sources in the target.
-        if !containsSwiftTargets {
+        } else {
+            // Don't link runtime compatibility patch libraries if there are no
+            // Swift sources in the target.
             args += ["-runtime-compatibility-version", "none"]
         }
 

Sources/PackageLoading/PackageBuilder.swift

@@ -887,7 +887,11 @@ public final class PackageBuilder {
         }
 
         // Create the build setting assignment table for this target.
-        let buildSettings = try self.buildSettings(for: manifestTarget, targetRoot: potentialModule.path, cxxLanguageStandard: self.manifest.cxxLanguageStandard)
+        let buildSettings = try self.buildSettings(
+            for: manifestTarget,
+            targetRoot: potentialModule.path,
+            cxxLanguageStandard: self.manifest.cxxLanguageStandard
+        )
 
         // Compute the path to public headers directory.
         let publicHeaderComponent = manifestTarget.publicHeadersPath ?? ClangTarget.defaultPublicHeadersComponent
@@ -979,6 +983,7 @@ public final class PackageBuilder {
                 packageAccess: potentialModule.packageAccess,
                 swiftVersion: try self.swiftVersion(),
                 buildSettings: buildSettings,
+                buildSettingsDescription: manifestTarget.settings,
                 usesUnsafeFlags: manifestTarget.usesUnsafeFlags
             )
         } else {
@@ -1021,14 +1026,18 @@ public final class PackageBuilder {
                 ignored: ignored,
                 dependencies: dependencies,
                 buildSettings: buildSettings,
+                buildSettingsDescription: manifestTarget.settings,
                 usesUnsafeFlags: manifestTarget.usesUnsafeFlags
             )
         }
     }
 
     /// Creates build setting assignment table for the given target.
-    func buildSettings(for target: TargetDescription?, targetRoot: AbsolutePath, cxxLanguageStandard: String? = nil) throws -> BuildSettings
-        .AssignmentTable
+    func buildSettings(
+        for target: TargetDescription?,
+        targetRoot: AbsolutePath,
+        cxxLanguageStandard: String? = nil
+    ) throws -> BuildSettings.AssignmentTable
     {
         var table = BuildSettings.AssignmentTable()
         guard let target else { return table }
@@ -1665,23 +1674,21 @@ extension PackageBuilder {
                 let sources = Sources(paths: [sourceFile], root: sourceFile.parentDirectory)
                 let buildSettings: BuildSettings.AssignmentTable
 
-                do {
-                    let targetDescription = try TargetDescription(
-                        name: name,
-                        dependencies: dependencies
-                            .map {
-                                TargetDescription.Dependency.target(name: $0.name)
-                            },
-                        path: sourceFile.parentDirectory.pathString,
-                        sources: [sourceFile.pathString],
-                        type: .executable,
-                        packageAccess: false
-                    )
-                    buildSettings = try self.buildSettings(
-                        for: targetDescription,
-                        targetRoot: sourceFile.parentDirectory
-                    )
-                }
+                let targetDescription = try TargetDescription(
+                    name: name,
+                    dependencies: dependencies
+                        .map {
+                            TargetDescription.Dependency.target(name: $0.name)
+                        },
+                    path: sourceFile.parentDirectory.pathString,
+                    sources: [sourceFile.pathString],
+                    type: .executable,
+                    packageAccess: false
+                )
+                buildSettings = try self.buildSettings(
+                    for: targetDescription,
+                    targetRoot: sourceFile.parentDirectory
+                )
 
                 return SwiftTarget(
                     name: name,
@@ -1692,6 +1699,7 @@ extension PackageBuilder {
                     packageAccess: false,
                     swiftVersion: try swiftVersion(),
                     buildSettings: buildSettings,
+                    buildSettingsDescription: targetDescription.settings,
                     usesUnsafeFlags: false
                 )
             }

Sources/PackageModel/Target/BinaryTarget.swift

@@ -41,6 +41,7 @@ public final class BinaryTarget: Target {
             dependencies: [],
             packageAccess: false,
             buildSettings: .init(),
+            buildSettingsDescription: [],
             pluginUsages: [],
             usesUnsafeFlags: false
         )

Sources/PackageModel/Target/ClangTarget.swift

@@ -53,6 +53,7 @@ public final class ClangTarget: Target {
         others: [AbsolutePath] = [],
         dependencies: [Target.Dependency] = [],
         buildSettings: BuildSettings.AssignmentTable = .init(),
+        buildSettingsDescription: [TargetBuildSettingDescription.Setting] = [],
         usesUnsafeFlags: Bool
     ) throws {
         guard includeDir.isDescendantOfOrEqual(to: sources.root) else {
@@ -76,6 +77,7 @@ public final class ClangTarget: Target {
             dependencies: dependencies,
             packageAccess: false,
             buildSettings: buildSettings,
+            buildSettingsDescription: buildSettingsDescription,
             pluginUsages: [],
             usesUnsafeFlags: usesUnsafeFlags
         )

Sources/PackageModel/Target/PluginTarget.swift

@@ -36,6 +36,7 @@ public final class PluginTarget: Target {
             dependencies: dependencies,
             packageAccess: packageAccess,
             buildSettings: .init(),
+            buildSettingsDescription: [],
             pluginUsages: [],
             usesUnsafeFlags: false
         )

Sources/PackageModel/Target/SwiftTarget.swift

@@ -33,6 +33,7 @@ public final class SwiftTarget: Target {
             dependencies: dependencies,
             packageAccess: packageAccess,
             buildSettings: .init(),
+            buildSettingsDescription: [],
             pluginUsages: [],
             usesUnsafeFlags: false
         )
@@ -54,6 +55,7 @@ public final class SwiftTarget: Target {
         packageAccess: Bool,
         swiftVersion: SwiftLanguageVersion,
         buildSettings: BuildSettings.AssignmentTable = .init(),
+        buildSettingsDescription: [TargetBuildSettingDescription.Setting] = [],
         pluginUsages: [PluginUsage] = [],
         usesUnsafeFlags: Bool
     ) {
@@ -70,6 +72,7 @@ public final class SwiftTarget: Target {
             dependencies: dependencies,
             packageAccess: packageAccess,
             buildSettings: buildSettings,
+            buildSettingsDescription: buildSettingsDescription,
             pluginUsages: pluginUsages,
             usesUnsafeFlags: usesUnsafeFlags
         )
@@ -100,6 +103,7 @@ public final class SwiftTarget: Target {
             dependencies: dependencies,
             packageAccess: packageAccess,
             buildSettings: .init(),
+            buildSettingsDescription: [],
             pluginUsages: [],
             usesUnsafeFlags: false
         )

Sources/PackageModel/Target/SystemLibraryTarget.swift

@@ -43,6 +43,7 @@ public final class SystemLibraryTarget: Target {
             dependencies: [],
             packageAccess: false,
             buildSettings: .init(),
+            buildSettingsDescription: [],
             pluginUsages: [],
             usesUnsafeFlags: false
         )

Sources/PackageModel/Target/Target.swift

@@ -260,6 +260,9 @@ public class Target: PolymorphicCodableProtocol {
     /// The build settings assignments of this target.
     public let buildSettings: BuildSettings.AssignmentTable
 
+    @_spi(SwiftPMInternal)
+    public let buildSettingsDescription: [TargetBuildSettingDescription.Setting]
+
     /// The usages of package plugins by this target.
     public let pluginUsages: [PluginUsage]
 
@@ -278,6 +281,7 @@ public class Target: PolymorphicCodableProtocol {
         dependencies: [Target.Dependency],
         packageAccess: Bool,
         buildSettings: BuildSettings.AssignmentTable,
+        buildSettingsDescription: [TargetBuildSettingDescription.Setting],
         pluginUsages: [PluginUsage],
         usesUnsafeFlags: Bool
     ) {
@@ -293,12 +297,27 @@ public class Target: PolymorphicCodableProtocol {
         self.c99name = self.name.spm_mangledToC99ExtendedIdentifier()
         self.packageAccess = packageAccess
         self.buildSettings = buildSettings
+        self.buildSettingsDescription = buildSettingsDescription
         self.pluginUsages = pluginUsages
         self.usesUnsafeFlags = usesUnsafeFlags
     }
 
     private enum CodingKeys: String, CodingKey {
-        case name, potentialBundleName, defaultLocalization, platforms, type, path, sources, resources, ignored, others, packageAccess, buildSettings, pluginUsages, usesUnsafeFlags
+        case name
+        case potentialBundleName
+        case defaultLocalization
+        case platforms
+        case type
+        case path
+        case sources
+        case resources
+        case ignored
+        case others
+        case packageAccess
+        case buildSettings
+        case buildSettingsDescription
+        case pluginUsages
+        case usesUnsafeFlags
     }
 
     public func encode(to encoder: Encoder) throws {
@@ -316,6 +335,7 @@ public class Target: PolymorphicCodableProtocol {
         try container.encode(others, forKey: .others)
         try container.encode(packageAccess, forKey: .packageAccess)
         try container.encode(buildSettings, forKey: .buildSettings)
+        try container.encode(buildSettingsDescription, forKey: .buildSettingsDescription)
         // FIXME: pluginUsages property is skipped on purpose as it points to
         // the actual target dependency object.
         try container.encode(usesUnsafeFlags, forKey: .usesUnsafeFlags)
@@ -337,6 +357,10 @@ public class Target: PolymorphicCodableProtocol {
         self.c99name = self.name.spm_mangledToC99ExtendedIdentifier()
         self.packageAccess = try container.decode(Bool.self, forKey: .packageAccess)
         self.buildSettings = try container.decode(BuildSettings.AssignmentTable.self, forKey: .buildSettings)
+        self.buildSettingsDescription = try container.decode(
+            [TargetBuildSettingDescription.Setting].self,
+            forKey: .buildSettingsDescription
+        )
         // FIXME: pluginUsages property is skipped on purpose as it points to
         // the actual target dependency object.
         self.pluginUsages = []

Tests/BuildTests/ProductBuildDescriptionTests.swift

@@ -0,0 +1,75 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2014-2021 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
+//
+//===----------------------------------------------------------------------===//
+
+@testable
+import Build
+
+import class Basics.ObservabilitySystem
+import class TSCBasic.InMemoryFileSystem
+
+import class PackageModel.Manifest
+import struct PackageModel.TargetDescription
+
+@testable
+import struct PackageGraph.ResolvedProduct
+
+import func SPMTestSupport.loadPackageGraph
+import func SPMTestSupport.mockBuildParameters
+import func SPMTestSupport.XCTAssertNoDiagnostics
+import XCTest
+
+final class ProductBuildDescriptionTests: XCTestCase {
+    func testEmbeddedProducts() throws {
+        let fs = InMemoryFileSystem(
+            emptyFiles:
+            "/Pkg/Sources/exe/main.swift"
+        )
+
+        let observability = ObservabilitySystem.makeForTesting()
+        let graph = try loadPackageGraph(
+            fileSystem: fs,
+            manifests: [
+                Manifest.createRootManifest(
+                    displayName: "Pkg",
+                    path: "/Pkg",
+                    targets: [
+                        TargetDescription(
+                            name: "exe",
+                            settings: [.init(tool: .swift, kind: .enableExperimentalFeature("Embedded"))]
+                        ),
+                    ]
+                ),
+            ],
+            observabilityScope: observability.topScope
+        )
+        XCTAssertNoDiagnostics(observability.diagnostics)
+
+        let id = ResolvedProduct.ID(productName: "exe", packageIdentity: .plain("pkg"), buildTriple: .destination)
+        let package = try XCTUnwrap(graph.rootPackages.first)
+        let product = try XCTUnwrap(graph.allProducts[id])
+
+        let buildDescription = try ProductBuildDescription(
+            package: package,
+            product: product,
+            toolsVersion: .v5_9,
+            buildParameters: mockBuildParameters(environment: .init(platform: .macOS)),
+            fileSystem: fs,
+            observabilityScope: observability.topScope
+        )
+
+        XCTAssertTrue(
+            try buildDescription.linkArguments()
+                .joined(separator: " ")
+                .contains("-enable-experimental-feature Embedded")
+        )
+    }
+}