Add autolink-extract for Linux

Author: Harlan Haskins

Sources/SwiftDriver/Jobs/AutolinkExtractJob.swift

@@ -0,0 +1,29 @@
+import TSCBasic
+import TSCUtility
+
+extension Driver {
+  mutating func autolinkExtractJob(inputs: [TypedVirtualPath]) throws -> Job? {
+    // On ELF platforms there's no built in autolinking mechanism, so we
+    // pull the info we need from the .o files directly and pass them as an
+    // argument input file to the linker.
+    // FIXME: Also handle Cygwin and MinGW
+    guard inputs.count > 0 && targetTriple.objectFormat == .elf else {
+      return nil
+    }
+
+    var commandLine = [Job.ArgTemplate]()
+    let output = VirtualPath.temporary("\(moduleName).autolink")
+
+    commandLine.append(contentsOf: inputs.map { .path($0.file) })
+    commandLine.appendFlag(.o)
+    commandLine.appendPath(output)
+
+    return Job(
+      kind: .autolinkExtract,
+      tool: .absolute(try toolchain.getToolPath(.swiftAutolinkExtract)),
+      commandLine: commandLine,
+      inputs: inputs,
+      outputs: [.init(file: output, type: .autolink)]
+    )
+  }
+}

Sources/SwiftDriver/Jobs/GenericUnixToolchain+LinkerSupport.swift

@@ -145,7 +145,14 @@ extension GenericUnixToolchain {
         )
       commandLine.appendPath(swiftrtPath)
 
-      commandLine.append(contentsOf: inputs.map { .path($0.file) })
+      let inputFiles: [Job.ArgTemplate] = inputs.map { input in
+        // Autolink inputs are handled specially
+        if input.type == .autolink {
+          return .flag("@\(input.file.name)")
+        }
+        return .path(input.file)
+      }
+      commandLine.append(contentsOf: inputFiles)
 
       let fSystemArgs = parsedOptions.filter {
         $0.option == .F || $0.option == .Fsystem
@@ -164,14 +171,6 @@ extension GenericUnixToolchain {
         commandLine.appendFlag(path)
       }
 
-      // FIXME: Add any autolinking scripts to the arguments
-//      for (const Job *Cmd : context.Inputs) {
-//        auto &OutputInfo = Cmd->getOutput()
-//        if (OutputInfo.getPrimaryOutputType() == file_types::TY_AutolinkFile)
-//        Arguments.push_back(context.Args.MakeArgString(
-//        Twine("@") + OutputInfo.getPrimaryOutputFilename()))
-//      }
-
       // Add the runtime library link paths.
       for path in runtimePaths {
         commandLine.appendFlag(.L)

Sources/SwiftDriver/Jobs/Job.swift

@@ -7,6 +7,7 @@ public struct Job: Codable, Equatable {
     case mergeModule = "merge-module"
     case link
     case generateDSYM = "generate-dsym"
+    case autolinkExtract = "autolink-extract"
   }
 
   public enum ArgTemplate: Equatable {

Sources/SwiftDriver/Jobs/Planning.swift

@@ -62,12 +62,19 @@ extension Driver {
       jobs.append(try mergeModuleJob(inputs: moduleInputs))
     }
 
+    // If we need to autolink-extract, do so.
+    let autolinkInputs = linkerInputs.filter { $0.type == .object }
+    if let autolinkExtractJob = try autolinkExtractJob(inputs: autolinkInputs) {
+      linkerInputs.append(contentsOf: autolinkExtractJob.outputs)
+      jobs.append(autolinkExtractJob)
+    }
 
     // If we should link, do so.
     if linkerOutputType != nil && !linkerInputs.isEmpty {
       jobs.append(try linkJob(inputs: linkerInputs))
     }
 
+
     // FIXME: Lots of follow-up actions for merging modules, etc.
 
     return jobs

Sources/SwiftDriver/Toolchains/DarwinToolchain.swift

@@ -1,5 +1,12 @@
 import TSCBasic
 
+/// Utility function to lookup an executable using xcrun.
+func xcrunFind(exec: String) throws -> AbsolutePath {
+  let path = try Process.checkNonZeroExit(
+    arguments: ["xcrun", "-sdk", "macosx", "--find", exec]).spm_chomp()
+  return AbsolutePath(path)
+}
+
 /// Toolchain for Darwin-based platforms, such as macOS and iOS.
 ///
 /// FIXME: This class is not thread-safe.
@@ -21,6 +28,8 @@ public final class DarwinToolchain: Toolchain {
         arguments: ["xcrun", "-toolchain", "default", "-f", "clang"]
       ).spm_chomp()
       return AbsolutePath(result)
+    case .swiftAutolinkExtract:
+      return try xcrunFind(exec: "swift-autolink-extract")
     }
   }
 
@@ -57,13 +66,6 @@ public final class DarwinToolchain: Toolchain {
     }
   }
 
-  /// Utility function to lookup an executable using xcrun.
-  private func xcrunFind(exec: String) throws -> AbsolutePath {
-    let path = try Process.checkNonZeroExit(
-      arguments: ["xcrun", "-sdk", "macosx", "--find", exec]).spm_chomp()
-    return AbsolutePath(path)
-  }
-
   public var compatibility50: Result<AbsolutePath, Error> {
     resourcesDirectory.map{ $0.appending(component: "libswiftCompatibility50.a") }
   }

Sources/SwiftDriver/Toolchains/GenericUnixToolchain.swift

@@ -17,7 +17,14 @@ public final class GenericUnixToolchain: Toolchain {
       return path
     }
 
+    // If we happen to be on a macOS host, some tools might not be in our
+    // PATH, so we'll just use xcrun to find them too.
+    #if os(macOS)
+    return try xcrunFind(exec: exec)
+    #else
     throw Error.unableToFind(tool: exec)
+    #endif
+
   }
 
   public func makeLinkerOutputFilename(moduleName: String, type: LinkOutputType) -> String {
@@ -39,6 +46,8 @@ public final class GenericUnixToolchain: Toolchain {
       return try lookup(exec: "clang")
     case .clang:
       return try lookup(exec: "clang")
+    case .swiftAutolinkExtract:
+      return try lookup(exec: "swift-autolink-extract")
     }
   }
 

Sources/SwiftDriver/Toolchains/Toolchain.swift

@@ -5,6 +5,7 @@ public enum Tool {
   case staticLinker
   case dynamicLinker
   case clang
+  case swiftAutolinkExtract
 }
 
 /// Describes a toolchain, which includes information about compilers, linkers

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -238,7 +238,11 @@ final class SwiftDriverTests: XCTestCase {
       let plannedJobs = try driver.planBuild()
 
       XCTAssertEqual(3, plannedJobs.count)
+      XCTAssertFalse(plannedJobs.contains { $0.kind == .autolinkExtract })
+
       let linkJob = plannedJobs[2]
+      XCTAssertEqual(linkJob.kind, .link)
+      
       let cmd = linkJob.commandLine
       XCTAssertTrue(cmd.contains(.flag("-dylib")))
       XCTAssertTrue(cmd.contains(.flag("-arch")))
@@ -257,7 +261,11 @@ final class SwiftDriverTests: XCTestCase {
       let plannedJobs = try driver.planBuild()
 
       XCTAssertEqual(3, plannedJobs.count)
+      XCTAssertFalse(plannedJobs.contains { $0.kind == .autolinkExtract })
+
       let linkJob = plannedJobs[2]
+      XCTAssertEqual(linkJob.kind, .link)
+
       let cmd = linkJob.commandLine
       XCTAssertTrue(cmd.contains(.flag("-dylib")))
       XCTAssertTrue(cmd.contains(.flag("-arch")))
@@ -276,7 +284,11 @@ final class SwiftDriverTests: XCTestCase {
       let plannedJobs = try driver.planBuild()
 
       XCTAssertEqual(3, plannedJobs.count)
+      XCTAssertFalse(plannedJobs.contains { $0.kind == .autolinkExtract })
+
       let linkJob = plannedJobs[2]
+      XCTAssertEqual(linkJob.kind, .link)
+
       let cmd = linkJob.commandLine
       XCTAssertTrue(cmd.contains(.flag("-dylib")))
       XCTAssertTrue(cmd.contains(.flag("-w")))
@@ -294,7 +306,11 @@ final class SwiftDriverTests: XCTestCase {
       let plannedJobs = try driver.planBuild()
 
       XCTAssertEqual(plannedJobs.count, 3)
+      XCTAssertFalse(plannedJobs.contains { $0.kind == .autolinkExtract })
+
       let linkJob = plannedJobs[2]
+      XCTAssertEqual(linkJob.kind, .link)
+
       let cmd = linkJob.commandLine
       XCTAssertTrue(cmd.contains(.flag("-static")))
       XCTAssertTrue(cmd.contains(.flag("-o")))
@@ -317,7 +333,11 @@ final class SwiftDriverTests: XCTestCase {
       var driver = try Driver(args: commonArgs + ["-emit-executable"])
       let plannedJobs = try driver.planBuild()
       XCTAssertEqual(3, plannedJobs.count)
+      XCTAssertFalse(plannedJobs.contains { $0.kind == .autolinkExtract })
+
       let linkJob = plannedJobs[2]
+      XCTAssertEqual(linkJob.kind, .link)
+
       let cmd = linkJob.commandLine
       XCTAssertTrue(cmd.contains(.flag("-o")))
       XCTAssertTrue(cmd.contains(.path(.temporary("foo.o"))))
@@ -334,8 +354,18 @@ final class SwiftDriverTests: XCTestCase {
       var driver = try Driver(args: commonArgs + ["-emit-library", "-target", "x86_64-unknown-linux"])
       let plannedJobs = try driver.planBuild()
 
-      XCTAssertEqual(plannedJobs.count, 3)
-      let linkJob = plannedJobs[2]
+      XCTAssertEqual(plannedJobs.count, 4)
+
+      let autolinkExtractJob = plannedJobs[2]
+      XCTAssertEqual(autolinkExtractJob.kind, .autolinkExtract)
+
+      let autolinkCmd = autolinkExtractJob.commandLine
+      XCTAssertTrue(autolinkCmd.contains(.path(.temporary("foo.o"))))
+      XCTAssertTrue(autolinkCmd.contains(.path(.temporary("bar.o"))))
+      XCTAssertTrue(autolinkCmd.contains(.path(.temporary("Test.autolink"))))
+
+      let linkJob = plannedJobs[3]
+      XCTAssertEqual(linkJob.kind, .link)
       let cmd = linkJob.commandLine
       XCTAssertTrue(cmd.contains(.flag("-o")))
       XCTAssertTrue(cmd.contains(.flag("-shared")))
@@ -352,8 +382,17 @@ final class SwiftDriverTests: XCTestCase {
       var driver = try Driver(args: commonArgs + ["-emit-library", "-static", "-target", "x86_64-unknown-linux"])
       let plannedJobs = try driver.planBuild()
 
-      XCTAssertEqual(plannedJobs.count, 3)
-      let linkJob = plannedJobs[2]
+      XCTAssertEqual(plannedJobs.count, 4)
+
+      let autolinkExtractJob = plannedJobs[2]
+      XCTAssertEqual(autolinkExtractJob.kind, .autolinkExtract)
+
+      let autolinkCmd = autolinkExtractJob.commandLine
+      XCTAssertTrue(autolinkCmd.contains(.path(.temporary("foo.o"))))
+      XCTAssertTrue(autolinkCmd.contains(.path(.temporary("bar.o"))))
+      XCTAssertTrue(autolinkCmd.contains(.path(.temporary("Test.autolink"))))
+
+      let linkJob = plannedJobs[3]
       let cmd = linkJob.commandLine
       // we'd expect "ar crs libTest.a foo.o bar.o"
       XCTAssertTrue(cmd.contains(.flag("crs")))