Merge pull request #1026 from compnerd/resources

SwiftDriver: add support for resolving the registrar via SDKROOT

Author: compnerd

Sources/SwiftDriver/Jobs/WindowsToolchain+LinkerSupport.swift

@@ -13,6 +13,19 @@
 import TSCBasic
 import SwiftOptions
 
+private func architecture(for triple: Triple) -> String {
+  // The concept of a "major" arch name only applies to Linux triples
+  guard triple.os == .linux else { return triple.archName }
+
+  // HACK: We don't wrap LLVM's ARM target architecture parsing, and we should
+  //       definitely not try to port it. This check was only normalizing
+  //       "armv7a/armv7r" and similar variants for armv6 to 'armv7' and
+  //       'armv6', so just take a brute-force approach
+  if triple.archName.contains("armv7") { return "armv7" }
+  if triple.archName.contains("armv6") { return "armv6" }
+  return triple.archName
+}
+
 extension WindowsToolchain {
   public func addPlatformSpecificLinkerArgs(to commandLine: inout [Job.ArgTemplate],
                                             parsedOptions: inout ParsedOptions,
@@ -111,10 +124,22 @@ extension WindowsToolchain {
     commandLine.appendFlag(.L)
     commandLine.appendPath(VirtualPath.lookup(targetInfo.runtimeLibraryImportPaths.last!.path))
 
-    // FIXME(compnerd) figure out how to ensure that the SDK relative path is
-    // the last one
-    commandLine.appendPath(VirtualPath.lookup(targetInfo.runtimeLibraryImportPaths.last!.path)
-                              .appending(component: "swiftrt.obj"))
+    // Locate the Swift registration helper by honouring any explicit
+    // `-resource-dir`, `-sdk`, or the `SDKROOT` environment variable, and
+    // finally falling back to the target information.
+    let rsrc: VirtualPath
+    if let resourceDir = parsedOptions.getLastArgument(.resourceDir) {
+      rsrc = try VirtualPath(path: resourceDir.asSingle)
+    } else if let sdk = parsedOptions.getLastArgument(.sdk)?.asSingle ?? env["SDKROOT"], !sdk.isEmpty {
+      rsrc = try VirtualPath(path: AbsolutePath(validating: sdk)
+                                      .appending(components: "usr", "lib", "swift",
+                                                 targetTriple.platformName() ?? "",
+                                                 architecture(for: targetTriple))
+                                      .pathString)
+    } else {
+      rsrc = VirtualPath.lookup(targetInfo.runtimeResourcePath.path)
+    }
+    commandLine.appendPath(rsrc.appending(component: "swiftrt.obj"))
 
     commandLine.append(contentsOf: inputs.compactMap { (input: TypedVirtualPath) -> Job.ArgTemplate? in
       switch input.type {

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -6074,6 +6074,84 @@ final class SwiftDriverTests: XCTestCase {
       let job = jobs.first!
       XCTAssertEqual(job.kind, .link)
       XCTAssertTrue(job.tool.name.hasSuffix(executableName("clang++")))
+#endif
+  }
+
+  func testRegistrarLookup() throws {
+#if os(Windows)
+    let SDKROOT: AbsolutePath =
+        try localFileSystem.currentWorkingDirectory.map { AbsolutePath("/SDKROOT", relativeTo: $0) }
+            ?? AbsolutePath(validating: "/SDKROOT")
+
+    let resourceDir: AbsolutePath =
+        try localFileSystem.currentWorkingDirectory.map { AbsolutePath("/swift/resources", relativeTo: $0) }
+            ?? AbsolutePath(validating: "/swift/resources")
+
+    let platform: String = "windows"
+#if arch(x86_64)
+    let arch: String = "x86_64"
+#elseif arch(arm64)
+    let arch: String = "aarch64"
+#else
+#error("unsupported build architecture")
+#endif
+
+    do {
+      var driver = try Driver(args: [
+        "swiftc", "-emit-library", "-o", "library.dll", "library.obj", "-resource-dir", resourceDir.nativePathString(escaped: false),
+      ])
+      let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+      XCTAssertEqual(jobs.count, 1)
+      let job = jobs.first!
+      XCTAssertEqual(job.kind, .link)
+      XCTAssertTrue(job.commandLine.contains(.path(.absolute(resourceDir.appending(component: "swiftrt.obj")))))
+    }
+
+    do {
+      var driver = try Driver(args: [
+        "swiftc", "-emit-library", "-o", "library.dll", "library.obj", "-sdk", SDKROOT.nativePathString(escaped: false),
+      ])
+      let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+      XCTAssertEqual(jobs.count, 1)
+      let job = jobs.first!
+      XCTAssertEqual(job.kind, .link)
+      XCTAssertTrue(job.commandLine.contains(.path(.absolute(SDKROOT.appending(components: "usr", "lib", "swift", platform, arch, "swiftrt.obj")))))
+    }
+
+    do {
+      var env = ProcessEnv.vars
+      env["SDKROOT"] = SDKROOT.nativePathString(escaped: false)
+
+      var driver = try Driver(args: [
+        "swiftc", "-emit-library", "-o", "library.dll", "library.obj"
+      ], env: env)
+      let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+      XCTAssertEqual(jobs.count, 1)
+      let job = jobs.first!
+      XCTAssertEqual(job.kind, .link)
+      XCTAssertTrue(job.commandLine.contains(.path(.absolute(SDKROOT.appending(components: "usr", "lib", "swift", platform, arch, "swiftrt.obj")))))
+    }
+
+    // Cannot test this due to `SDKROOT` escaping from the execution environment
+    // into the `-print-target-info` step, which then resets the
+    // `runtimeResourcePath` to be the SDK relative path rahter than the
+    // toolchain relative path.
+#if false
+    do {
+      var env = ProcessEnv.vars
+      env["SDKROOT"] = nil
+
+      var driver = try Driver(args: [
+        "swiftc", "-emit-library", "-o", "library.dll", "library.obj"
+      ], env: env)
+      driver.frontendTargetInfo.runtimeResourcePath = SDKROOT
+      let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+      XCTAssertEqual(jobs.count, 1)
+      let job = jobs.first!
+      XCTAssertEqual(job.kind, .link)
+      XCTAssertTrue(job.commandLine.contains(.path(.absolute(SDKROOT.appending(components: "usr", "lib", "swift", platform, arch, "swiftrt.obj")))))
+    }
+#endif
 #endif
   }
 }