Add an rpath flag to disable the default of looking in the local directory for shared libraries (#6947)

finagolfin · web-flow · commit 38e21a29ec40 · 2023-10-10T10:50:50.000-07:00
This is useful when deploying build products, as most executables are
not installed in the same directory as libraries and system libraries do
not need it for system paths. Use the new flag when installing SwiftPM
itself and the {Manifest,Plugin}API libraries on ELF platforms.

On linux, I currently see this with Swift 5.9:
```
&gt; readelf -d swift-5.9-RELEASE-ubuntu20.04/usr/lib/swift/pm/*I/lib*so swift-5.9-RELEASE-ubuntu20.04/usr/bin/swift-package|ag "File:|runpath"
File: swift-5.9-RELEASE-ubuntu20.04/usr/lib/swift/pm/ManifestAPI/libPackageDescription.so
 0x000000000000001d (RUNPATH)            Library runpath: [$ORIGIN:$ORIGIN/../../linux]
File: swift-5.9-RELEASE-ubuntu20.04/usr/lib/swift/pm/PluginAPI/libPackagePlugin.so
 0x000000000000001d (RUNPATH)            Library runpath: [$ORIGIN:$ORIGIN/../../linux]
File: swift-5.9-RELEASE-ubuntu20.04/usr/bin/swift-package
 0x000000000000001d (RUNPATH)            Library runpath: [$ORIGIN:$ORIGIN/../lib/swift/linux]
```
After applying this pull to trunk on Android, the extraneous rpath is
gone:
```
&gt; llvm-readelf -d build/Ninja-Release/toolchain-android-aarch64/usr/lib/swift/pm/*I/lib*so build/Ninja-Release/toolchain-android-aarch64/usr/bin/swift-package|ag "File:|runpath"
File: build/Ninja-Release/toolchain-android-aarch64/usr/lib/swift/pm/ManifestAPI/libPackageDescription.so
  0x000000000000001d (RUNPATH)      Library runpath: [$ORIGIN/../../android]
File: build/Ninja-Release/toolchain-android-aarch64/usr/lib/swift/pm/PluginAPI/libPackagePlugin.so
  0x000000000000001d (RUNPATH)      Library runpath: [$ORIGIN/../../android]
File: build/Ninja-Release/toolchain-android-aarch64/usr/bin/swift-package
  0x000000000000001d (RUNPATH)         Library runpath: [$ORIGIN/../lib/swift/android:/data/data/com.termux/files/usr/lib]
```
I have no idea if this is useful on Darwin too, but I went ahead and
disabled adding `@loader_rpath` too. Let me know if that's worthwhile.
diff --git a/Sources/Build/BuildDescription/ProductBuildDescription.swift b/Sources/Build/BuildDescription/ProductBuildDescription.swift
@@ -257,12 +257,14 @@ public final class ProductBuildDescription: SPMBuildCore.ProductBuildDescription
         }
 
         // Set rpath such that dynamic libraries are looked up
-        // adjacent to the product.
-        if self.buildParameters.targetTriple.isLinux() {
-            args += ["-Xlinker", "-rpath=$ORIGIN"]
-        } else if self.buildParameters.targetTriple.isDarwin() {
-            let rpath = self.product.type == .test ? "@loader_path/../../../" : "@loader_path"
-            args += ["-Xlinker", "-rpath", "-Xlinker", rpath]
+        // adjacent to the product, unless overridden.
+        if !self.buildParameters.shouldDisableLocalRpath {
+            if self.buildParameters.targetTriple.isLinux() {
+                args += ["-Xlinker", "-rpath=$ORIGIN"]
+            } else if self.buildParameters.targetTriple.isDarwin() {
+                let rpath = self.product.type == .test ? "@loader_path/../../../" : "@loader_path"
+                args += ["-Xlinker", "-rpath", "-Xlinker", rpath]
+            }
         }
         args += ["@\(self.linkFileListPath.pathString)"]
 
diff --git a/Sources/CoreCommands/Options.swift b/Sources/CoreCommands/Options.swift
@@ -524,6 +524,10 @@ public struct LinkerOptions: ParsableArguments {
     /// If should link the Swift stdlib statically.
     @Flag(name: .customLong("static-swift-stdlib"), inversion: .prefixedNo, help: "Link Swift stdlib statically")
     public var shouldLinkStaticSwiftStdlib: Bool = false
+
+    /// Disables adding $ORIGIN/@loader_path to the rpath, useful when deploying
+    @Flag(name: .customLong("disable-local-rpath"), help: "Disable adding $ORIGIN/@loader_path to the rpath by default")
+    public var shouldDisableLocalRpath: Bool = false
 }
 
 // MARK: - Extensions
diff --git a/Sources/CoreCommands/SwiftTool.swift b/Sources/CoreCommands/SwiftTool.swift
@@ -683,6 +683,7 @@ public final class SwiftTool {
             architectures: options.build.architectures,
             workers: options.build.jobs ?? UInt32(ProcessInfo.processInfo.activeProcessorCount),
             shouldLinkStaticSwiftStdlib: options.linker.shouldLinkStaticSwiftStdlib,
+            shouldDisableLocalRpath: options.linker.shouldDisableLocalRpath,
             canRenameEntrypointFunctionName: driverSupport.checkSupportedFrontendFlags(
                 flags: ["entry-point-function-name"],
                 toolchain: toolchain,
diff --git a/Sources/SPMBuildCore/BuildParameters.swift b/Sources/SPMBuildCore/BuildParameters.swift
@@ -190,6 +190,9 @@ public struct BuildParameters: Encodable {
     /// If should link the Swift stdlib statically.
     public var shouldLinkStaticSwiftStdlib: Bool
 
+    /// Disables adding $ORIGIN/@loader_path to the rpath, useful when deploying
+    public var shouldDisableLocalRpath: Bool
+
     /// Which compiler sanitizers should be enabled
     public var sanitizers: EnabledSanitizers
 
@@ -362,6 +365,7 @@ public struct BuildParameters: Encodable {
         architectures: [String]? = nil,
         workers: UInt32 = UInt32(ProcessInfo.processInfo.activeProcessorCount),
         shouldLinkStaticSwiftStdlib: Bool = false,
+        shouldDisableLocalRpath: Bool = false,
         shouldEnableManifestCaching: Bool = false,
         canRenameEntrypointFunctionName: Bool = false,
         shouldCreateDylibForDynamicProducts: Bool = true,
@@ -424,6 +428,7 @@ public struct BuildParameters: Encodable {
         self.architectures = architectures
         self.workers = workers
         self.shouldLinkStaticSwiftStdlib = shouldLinkStaticSwiftStdlib
+        self.shouldDisableLocalRpath = shouldDisableLocalRpath
         self.shouldEnableManifestCaching = shouldEnableManifestCaching
         self.shouldCreateDylibForDynamicProducts = shouldCreateDylibForDynamicProducts
         self.canRenameEntrypointFunctionName = canRenameEntrypointFunctionName
@@ -487,6 +492,7 @@ public struct BuildParameters: Encodable {
             architectures: nil,
             workers: self.workers,
             shouldLinkStaticSwiftStdlib: self.shouldLinkStaticSwiftStdlib,
+            shouldDisableLocalRpath: self.shouldDisableLocalRpath,
             shouldEnableManifestCaching: self.shouldEnableManifestCaching,
             canRenameEntrypointFunctionName: self.canRenameEntrypointFunctionName,
             shouldCreateDylibForDynamicProducts: self.shouldCreateDylibForDynamicProducts,
diff --git a/Sources/swift-bootstrap/main.swift b/Sources/swift-bootstrap/main.swift
@@ -118,6 +118,10 @@ struct SwiftBootstrapBuildTool: ParsableCommand {
         case error
     }
 
+    /// Disables adding $ORIGIN/@loader_path to the rpath, useful when deploying
+    @Flag(name: .customLong("disable-local-rpath"), help: "Disable adding $ORIGIN/@loader_path to the rpath by default")
+    public var shouldDisableLocalRpath: Bool = false
+
     private var buildSystem: BuildSystemProvider.Kind {
         #if os(macOS)
         // Force the Xcode build system if we want to build more than one arch.
@@ -188,7 +192,8 @@ struct SwiftBootstrapBuildTool: ParsableCommand {
                 buildFlags: self.buildFlags,
                 manifestBuildFlags: self.manifestFlags,
                 useIntegratedSwiftDriver: self.useIntegratedSwiftDriver,
-                explicitTargetDependencyImportCheck: self.explicitTargetDependencyImportCheck
+                explicitTargetDependencyImportCheck: self.explicitTargetDependencyImportCheck,
+                shouldDisableLocalRpath: self.shouldDisableLocalRpath
             )
         } catch _ as Diagnostics {
             throw ExitCode.failure
@@ -232,7 +237,8 @@ struct SwiftBootstrapBuildTool: ParsableCommand {
             buildFlags: BuildFlags,
             manifestBuildFlags: [String],
             useIntegratedSwiftDriver: Bool,
-            explicitTargetDependencyImportCheck: TargetDependencyImportCheckingMode
+            explicitTargetDependencyImportCheck: TargetDependencyImportCheckingMode,
+            shouldDisableLocalRpath: Bool
         ) throws {
             let buildSystem = try createBuildSystem(
                 packagePath: packagePath,
@@ -244,6 +250,7 @@ struct SwiftBootstrapBuildTool: ParsableCommand {
                 manifestBuildFlags: manifestBuildFlags,
                 useIntegratedSwiftDriver: useIntegratedSwiftDriver,
                 explicitTargetDependencyImportCheck: explicitTargetDependencyImportCheck,
+                shouldDisableLocalRpath: shouldDisableLocalRpath,
                 logLevel: logLevel
             )
             try buildSystem.build(subset: .allExcludingTests)
@@ -259,6 +266,7 @@ struct SwiftBootstrapBuildTool: ParsableCommand {
             manifestBuildFlags: [String],
             useIntegratedSwiftDriver: Bool,
             explicitTargetDependencyImportCheck: TargetDependencyImportCheckingMode,
+            shouldDisableLocalRpath: Bool,
             logLevel: Basics.Diagnostic.Severity
         ) throws -> BuildSystem {
 
@@ -277,6 +285,7 @@ struct SwiftBootstrapBuildTool: ParsableCommand {
                 targetTriple: self.targetToolchain.targetTriple,
                 flags: buildFlags,
                 architectures: architectures,
+                shouldDisableLocalRpath: shouldDisableLocalRpath,
                 useIntegratedSwiftDriver: useIntegratedSwiftDriver,
                 isXcodeBuildSystemEnabled: buildSystem == .xcode,
                 explicitTargetDependencyImportCheckingMode: explicitTargetDependencyImportCheck == .error ? .error : .none,
diff --git a/Tests/BuildTests/BuildPlanTests.swift b/Tests/BuildTests/BuildPlanTests.swift
@@ -5021,4 +5021,80 @@ final class BuildPlanTests: XCTestCase {
             XCTFail("expected a Swift target")
         }
     }
+
+    func testBasicSwiftPackageWithoutLocalRpath() throws {
+        let fs = InMemoryFileSystem(emptyFiles:
+            "/Pkg/Sources/exe/main.swift",
+            "/Pkg/Sources/lib/lib.swift"
+        )
+
+        let observability = ObservabilitySystem.makeForTesting()
+        let graph = try loadPackageGraph(
+            fileSystem: fs,
+            manifests: [
+                Manifest.createRootManifest(
+                    displayName: "Pkg",
+                    path: "/Pkg",
+                    targets: [
+                        TargetDescription(name: "exe", dependencies: ["lib"]),
+                        TargetDescription(name: "lib", dependencies: []),
+                    ]),
+            ],
+            observabilityScope: observability.topScope
+        )
+        XCTAssertNoDiagnostics(observability.diagnostics)
+
+        let result = try BuildPlanResult(plan: BuildPlan(
+            buildParameters: mockBuildParameters(shouldDisableLocalRpath: true),
+            graph: graph,
+            fileSystem: fs,
+            observabilityScope: observability.topScope
+        ))
+
+        result.checkProductsCount(1)
+        result.checkTargetsCount(2)
+
+        let buildPath = result.plan.buildParameters.dataPath.appending(components: "debug")
+
+      #if os(macOS)
+        let linkArguments = [
+            result.plan.buildParameters.toolchain.swiftCompilerPath.pathString,
+            "-L", buildPath.pathString,
+            "-o", buildPath.appending(components: "exe").pathString,
+            "-module-name", "exe",
+            "-emit-executable",
+            "@\(buildPath.appending(components: "exe.product", "Objects.LinkFileList"))",
+            "-Xlinker", "-rpath", "-Xlinker", "/fake/path/lib/swift-5.5/macosx",
+            "-target", defaultTargetTriple,
+            "-Xlinker", "-add_ast_path", "-Xlinker", buildPath.appending(components: "exe.build", "exe.swiftmodule").pathString,
+            "-Xlinker", "-add_ast_path", "-Xlinker", buildPath.appending(components: "lib.swiftmodule").pathString,
+            "-g",
+        ]
+      #elseif os(Windows)
+        let linkArguments = [
+            result.plan.buildParameters.toolchain.swiftCompilerPath.pathString,
+            "-L", buildPath.pathString,
+            "-o", buildPath.appending(components: "exe.exe").pathString,
+            "-module-name", "exe",
+            "-emit-executable",
+            "@\(buildPath.appending(components: "exe.product", "Objects.LinkFileList"))",
+            "-target", defaultTargetTriple,
+            "-g", "-use-ld=lld", "-Xlinker", "-debug:dwarf",
+        ]
+      #else
+        let linkArguments = [
+            result.plan.buildParameters.toolchain.swiftCompilerPath.pathString,
+            "-L", buildPath.pathString,
+            "-o", buildPath.appending(components: "exe").pathString,
+            "-module-name", "exe",
+            "-emit-executable",
+            "@\(buildPath.appending(components: "exe.product", "Objects.LinkFileList"))",
+            "-target", defaultTargetTriple,
+            "-g"
+        ]
+      #endif
+
+        XCTAssertEqual(try result.buildProduct(for: "exe").linkArguments(), linkArguments)
+        XCTAssertNoDiagnostics(observability.diagnostics)
+    }
 }
diff --git a/Tests/BuildTests/MockBuildTestHelper.swift b/Tests/BuildTests/MockBuildTestHelper.swift
@@ -72,6 +72,7 @@ func mockBuildParameters(
     toolchain: PackageModel.Toolchain = MockToolchain(),
     flags: PackageModel.BuildFlags = PackageModel.BuildFlags(),
     shouldLinkStaticSwiftStdlib: Bool = false,
+    shouldDisableLocalRpath: Bool = false,
     canRenameEntrypointFunctionName: Bool = false,
     targetTriple: Basics.Triple = hostTriple,
     indexStoreMode: BuildParameters.IndexStoreMode = .off,
@@ -89,6 +90,7 @@ func mockBuildParameters(
         pkgConfigDirectories: [],
         workers: 3,
         shouldLinkStaticSwiftStdlib: shouldLinkStaticSwiftStdlib,
+        shouldDisableLocalRpath: shouldDisableLocalRpath,
         canRenameEntrypointFunctionName: canRenameEntrypointFunctionName,
         indexStoreMode: indexStoreMode,
         useExplicitModuleBuild: useExplicitModuleBuild,
diff --git a/Utilities/bootstrap b/Utilities/bootstrap
@@ -769,6 +769,9 @@ def get_swiftpm_flags(args):
             "--configuration", "release",
         ])
 
+    if not '-macosx' in args.build_target and args.command == 'install':
+        build_flags.append("--disable-local-rpath")
+
     if args.verbose:
         build_flags.append("--verbose")
 
