Skip to content

Commit 9e73749

Browse files
hartbithartbit
committed
Support linking binary modules
1 parent 3d6e608 commit 9e73749

File tree

6 files changed

+377
-5
lines changed

6 files changed

+377
-5
lines changed

‎Sources/Build/BuildPlan.swift

+71-5
Original file line numberDiff line numberDiff line change
@@ -544,6 +544,7 @@ public final class SwiftTargetBuildDescription {
544544
args += moduleCacheArgs
545545
args += buildParameters.sanitizers.compileSwiftFlags()
546546
args += ["-parseable-output"]
547+
args += ["-F", buildParameters.buildPath.pathString]
547548

548549
// Emit the ObjC compatibility header if enabled.
549550
if shouldEmitObjCCompatibilityHeader {
@@ -1326,6 +1327,33 @@ public class BuildPlan {
13261327
buildProduct.additionalFlags += pkgConfig(for: target).libs
13271328
}
13281329

1330+
// Add flags for binary targets.
1331+
let binaryPaths = dependencies.binaryModules.compactMap({ module -> AbsolutePath? in
1332+
guard case let target as BinaryTarget = module.underlyingTarget else {
1333+
fatalError("This should not be possible.")
1334+
}
1335+
1336+
return xcFrameworkBinaryPath(for: target)
1337+
})
1338+
1339+
if !binaryPaths.isEmpty {
1340+
buildProduct.additionalFlags += ["-F", buildParameters.buildPath.pathString]
1341+
}
1342+
1343+
for binaryPath in binaryPaths {
1344+
let destination = buildParameters.buildPath.appending(component: binaryPath.basename)
1345+
1346+
if fileSystem.exists(destination) {
1347+
try fileSystem.removeFileTree(destination)
1348+
}
1349+
1350+
try fileSystem.copy(from: binaryPath, to: destination)
1351+
1352+
buildProduct.additionalFlags += [
1353+
"-framework", binaryPath.basenameWithoutExt
1354+
]
1355+
}
1356+
13291357
// Link C++ if needed.
13301358
// Note: This will come from build settings in future.
13311359
for target in dependencies.staticTargets {
@@ -1374,7 +1402,8 @@ public class BuildPlan {
13741402
) -> (
13751403
dylibs: [ResolvedProduct],
13761404
staticTargets: [ResolvedTarget],
1377-
systemModules: [ResolvedTarget]
1405+
systemModules: [ResolvedTarget],
1406+
binaryModules: [ResolvedTarget]
13781407
) {
13791408

13801409
// Sort the product targets in topological order.
@@ -1401,6 +1430,7 @@ public class BuildPlan {
14011430
var linkLibraries = [ResolvedProduct]()
14021431
var staticTargets = [ResolvedTarget]()
14031432
var systemModules = [ResolvedTarget]()
1433+
var binaryModules = [ResolvedTarget]()
14041434

14051435
for dependency in allTargets {
14061436
switch dependency {
@@ -1415,12 +1445,12 @@ public class BuildPlan {
14151445
// Library targets should always be included.
14161446
case .library:
14171447
staticTargets.append(target)
1418-
// Add system target targets to system targets array.
1448+
// Add system target to system targets array.
14191449
case .systemModule:
14201450
systemModules.append(target)
1451+
// Add binary target to binary targets array.
14211452
case .binary:
1422-
// TODO: Implement
1423-
break
1453+
binaryModules.append(target)
14241454
}
14251455

14261456
case .product(let product):
@@ -1437,7 +1467,7 @@ public class BuildPlan {
14371467
}
14381468
}
14391469

1440-
return (linkLibraries, staticTargets, systemModules)
1470+
return (linkLibraries, staticTargets, systemModules, binaryModules)
14411471
}
14421472

14431473
/// Plan a Clang target.
@@ -1590,8 +1620,44 @@ public class BuildPlan {
15901620
return pkgConfigCache[target]!
15911621
}
15921622

1623+
/// Get arguments for linking against a xcframework.
1624+
private func xcFrameworkBinaryPath(for target: BinaryTarget) -> AbsolutePath? {
1625+
func calculateBinaryPath() -> AbsolutePath? {
1626+
// Parse the XCFramework's Info.plist.
1627+
let infoPath = target.artifactPath.appending(component: "Info.plist")
1628+
guard let info = XCFrameworkInfo(path: infoPath, diagnostics: diagnostics) else {
1629+
return nil
1630+
}
1631+
1632+
// Check that it supports the curren target.
1633+
guard let library = info.libraries.first(where: {
1634+
$0.platform.os == buildParameters.triple.os &&
1635+
$0.architectures.contains(buildParameters.triple.arch)
1636+
}) else {
1637+
diagnostics.emit(error: """
1638+
artifact '\(target.name)' does not support the target platform and architecture \
1639+
('\(buildParameters.triple)')
1640+
""")
1641+
return nil
1642+
}
1643+
1644+
let binaryPath = target.artifactPath.appending(components: library.identifier, library.path)
1645+
return binaryPath
1646+
}
1647+
1648+
// If we don't have the flags yet, calculate them.
1649+
if !xcFrameworkCache.keys.contains(target) {
1650+
xcFrameworkCache[target] = calculateBinaryPath()
1651+
}
1652+
1653+
return xcFrameworkCache[target]!
1654+
}
1655+
15931656
/// Cache for pkgConfig flags.
15941657
private var pkgConfigCache = [SystemLibraryTarget: (cFlags: [String], libs: [String])]()
1658+
1659+
/// Cache for xcframework binary paths.
1660+
private var xcFrameworkCache = [BinaryTarget: AbsolutePath?]()
15951661
}
15961662

15971663
private extension Diagnostic.Message {

‎Sources/Build/ManifestBuilder.swift

+2
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,8 @@ extension LLBuildManifestBuilder {
234234
func addStaticTargetInputs(_ target: ResolvedTarget) {
235235
// Ignore C Modules.
236236
if target.underlyingTarget is SystemLibraryTarget { return }
237+
// Ignore Binary Modules.
238+
if target.underlyingTarget is BinaryTarget { return }
237239

238240
// Depend on the binary for executable targets.
239241
if target.type == .executable {

‎Sources/Build/XCFrameworkInfo.swift

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
/*
2+
This source file is part of the Swift.org open source project
3+
4+
Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
5+
Licensed under Apache License v2.0 with Runtime Library Exception
6+
7+
See http://swift.org/LICENSE.txt for license information
8+
See http://swift.org/CONTRIBUTORS.txt for Swift project authors
9+
*/
10+
11+
import TSCBasic
12+
import PackageModel
13+
import Foundation
14+
15+
public struct XCFrameworkInfo: Equatable {
16+
public enum Platform: String {
17+
case macOS = "macos"
18+
}
19+
20+
public struct Library: Equatable {
21+
public let identifier: String
22+
public let path: String
23+
public let platform: Platform
24+
public let architectures: [Triple.Arch]
25+
26+
public init(identifier: String, path: String, platform: Platform, architectures: [Triple.Arch]) {
27+
self.identifier = identifier
28+
self.path = path
29+
self.platform = platform
30+
self.architectures = architectures
31+
}
32+
}
33+
34+
public let libraries: [Library]
35+
36+
public init(libraries: [Library]) {
37+
self.libraries = libraries
38+
}
39+
}
40+
41+
extension XCFrameworkInfo {
42+
public init?(path: AbsolutePath, diagnostics: DiagnosticsEngine, fileSystem: FileSystem = localFileSystem) {
43+
guard fileSystem.exists(path) else {
44+
diagnostics.emit(error: "missing XCFramework Info.plist at '\(path)'")
45+
return nil
46+
}
47+
48+
do {
49+
let plistBytes = try fileSystem.readFileContents(path)
50+
51+
let decoder = PropertyListDecoder()
52+
self = try plistBytes.withData({ data in
53+
try decoder.decode(XCFrameworkInfo.self, from: data)
54+
})
55+
} catch {
56+
diagnostics.emit(error: "failed parsing XCFramework Info.plist at '\(path)': \(error)")
57+
return nil
58+
}
59+
}
60+
}
61+
62+
extension XCFrameworkInfo.Platform {
63+
var os: Triple.OS {
64+
switch self {
65+
case .macOS:
66+
return .macOS
67+
}
68+
}
69+
}
70+
71+
extension XCFrameworkInfo: Decodable {
72+
enum CodingKeys: String, CodingKey {
73+
case libraries = "AvailableLibraries"
74+
}
75+
}
76+
77+
extension Triple.Arch: Decodable { }
78+
extension XCFrameworkInfo.Platform: Decodable { }
79+
extension XCFrameworkInfo.Library: Decodable {
80+
enum CodingKeys: String, CodingKey {
81+
case identifier = "LibraryIdentifier"
82+
case path = "LibraryPath"
83+
case platform = "SupportedPlatform"
84+
case architectures = "SupportedArchitectures"
85+
}
86+
}

‎Tests/BuildTests/BuildPlanTests.swift

+137
Original file line numberDiff line numberDiff line change
@@ -1861,6 +1861,143 @@ final class BuildPlanTests: XCTestCase {
18611861
"/path/to/build/debug/Bar.build/Bar.swift.o",
18621862
])
18631863
}
1864+
1865+
func testBinaryTargets() throws {
1866+
let fs = InMemoryFileSystem(emptyFiles:
1867+
"/Pkg/Sources/exe/main.swift",
1868+
"/Pkg/Sources/Library/lib.swift"
1869+
)
1870+
1871+
try! fs.createDirectory(AbsolutePath("/Pkg/Binary1.xcframework"), recursive: true)
1872+
try! fs.writeFileContents(
1873+
AbsolutePath("/Pkg/Binary1.xcframework/Info.plist"),
1874+
bytes: ByteString(encodingAsUTF8: """
1875+
<?xml version="1.0" encoding="UTF-8"?>
1876+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
1877+
<plist version="1.0">
1878+
<dict>
1879+
<key>AvailableLibraries</key>
1880+
<array>
1881+
<dict>
1882+
<key>LibraryIdentifier</key>
1883+
<string>macos-x86_64</string>
1884+
<key>LibraryPath</key>
1885+
<string>Binary1.framework</string>
1886+
<key>SupportedArchitectures</key>
1887+
<array>
1888+
<string>x86_64</string>
1889+
</array>
1890+
<key>SupportedPlatform</key>
1891+
<string>macos</string>
1892+
</dict>
1893+
</array>
1894+
<key>CFBundlePackageType</key>
1895+
<string>XFWK</string>
1896+
<key>XCFrameworkFormatVersion</key>
1897+
<string>1.0</string>
1898+
</dict>
1899+
</plist>
1900+
"""))
1901+
1902+
try! fs.createDirectory(AbsolutePath("/Pkg/Binary2.xcframework"), recursive: true)
1903+
try! fs.writeFileContents(
1904+
AbsolutePath("/Pkg/Binary2.xcframework/Info.plist"),
1905+
bytes: ByteString(encodingAsUTF8: """
1906+
<?xml version="1.0" encoding="UTF-8"?>
1907+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
1908+
<plist version="1.0">
1909+
<dict>
1910+
<key>AvailableLibraries</key>
1911+
<array>
1912+
<dict>
1913+
<key>LibraryIdentifier</key>
1914+
<string>macos-x86_64</string>
1915+
<key>LibraryPath</key>
1916+
<string>Binary2.framework</string>
1917+
<key>SupportedArchitectures</key>
1918+
<array>
1919+
<string>x86_64</string>
1920+
</array>
1921+
<key>SupportedPlatform</key>
1922+
<string>macos</string>
1923+
</dict>
1924+
</array>
1925+
<key>CFBundlePackageType</key>
1926+
<string>XFWK</string>
1927+
<key>XCFrameworkFormatVersion</key>
1928+
<string>1.0</string>
1929+
</dict>
1930+
</plist>
1931+
"""))
1932+
1933+
let diagnostics = DiagnosticsEngine()
1934+
let graph = loadPackageGraph(
1935+
fs: fs,
1936+
diagnostics: diagnostics,
1937+
manifests: [
1938+
Manifest.createV4Manifest(
1939+
name: "Pkg",
1940+
path: "/Pkg",
1941+
url: "/Pkg",
1942+
packageKind: .root,
1943+
products: [
1944+
ProductDescription(name: "exe", type: .executable, targets: ["exe"]),
1945+
ProductDescription(name: "Library", type: .library(.dynamic), targets: ["Library"]),
1946+
],
1947+
targets: [
1948+
TargetDescription(name: "exe", dependencies: ["Binary1", "Library"]),
1949+
TargetDescription(name: "Library", dependencies: ["Binary2"]),
1950+
TargetDescription(name: "Binary1", path: "Binary1.xcframework", type: .binary),
1951+
TargetDescription(name: "Binary2", path: "Binary2.xcframework", type: .binary),
1952+
]
1953+
),
1954+
]
1955+
)
1956+
XCTAssertNoDiagnostics(diagnostics)
1957+
1958+
let result = BuildPlanResult(plan: try BuildPlan(
1959+
buildParameters: mockBuildParameters(destinationTriple: .macOS),
1960+
graph: graph,
1961+
diagnostics: diagnostics,
1962+
fileSystem: fs
1963+
))
1964+
1965+
result.checkProductsCount(2)
1966+
result.checkTargetsCount(2)
1967+
1968+
let libraryCompileArguments = try result.target(for: "Library").swiftTarget().compileArguments()
1969+
XCTAssertMatch(libraryCompileArguments, [
1970+
.anySequence,
1971+
"-F", "/path/to/build/debug",
1972+
.anySequence,
1973+
])
1974+
1975+
let libraryLinkArguments = try result.buildProduct(for: "Library").linkArguments()
1976+
XCTAssertMatch(libraryLinkArguments, [
1977+
.anySequence,
1978+
"-F", "/path/to/build/debug",
1979+
.anySequence,
1980+
"-framework", "Binary2",
1981+
])
1982+
1983+
let exeCompileArguments = try result.target(for: "exe").swiftTarget().compileArguments()
1984+
XCTAssertMatch(exeCompileArguments, [
1985+
.anySequence,
1986+
"-F", "/path/to/build/debug",
1987+
.anySequence,
1988+
])
1989+
1990+
let exeLinkArguments = try result.buildProduct(for: "exe").linkArguments()
1991+
XCTAssertMatch(exeLinkArguments, [
1992+
.anySequence,
1993+
"-F", "/path/to/build/debug",
1994+
.anySequence,
1995+
"-framework", "Binary1",
1996+
.anySequence,
1997+
"-framework", "Binary2",
1998+
.anySequence,
1999+
])
2000+
}
18642001
}
18652002

18662003
// MARK:- Test Helpers

0 commit comments

Comments
 (0)