Add support for automatically emit API descriptor files

Author: zixu-w

Sources/SwiftDriver/Driver/Driver.swift

@@ -957,14 +957,26 @@ public struct Driver {
         outputFileMap: self.outputFileMap,
         moduleName: moduleOutputInfo.name)
 
-    self.apiDescriptorFilePath = try Self.computeSupplementaryOutputPath(
-        &parsedOptions, type: .jsonAPIDescriptor, isOutputOptions: [],
-        outputPath: .emitApiDescriptorPath,
-        compilerOutputType: compilerOutputType,
-        compilerMode: compilerMode,
-        emitModuleSeparately: emitModuleSeparately,
-        outputFileMap: self.outputFileMap,
-        moduleName: moduleOutputInfo.name)
+    let apiDescriptorDirectory: VirtualPath? = if let apiDescriptorDirectoryEnvVar = env["TAPI_SDKDB_OUTPUT_PATH"] {
+        try VirtualPath(path: apiDescriptorDirectoryEnvVar)
+    } else if let ldTraceFileEnvVar = env["LD_TRACE_FILE"] {
+        try VirtualPath(path: ldTraceFileEnvVar).parentDirectory.appending(component: "SDKDB")
+    } else { nil }
+
+    if let apiDescriptorDirectory {
+        self.apiDescriptorFilePath = apiDescriptorDirectory
+          .appending(component: "\(moduleOutputInfo.name).\(frontendTargetInfo.target.moduleTriple.triple).swift.sdkdb")
+          .intern()
+    } else {
+        self.apiDescriptorFilePath = try Self.computeSupplementaryOutputPath(
+            &parsedOptions, type: .jsonAPIDescriptor, isOutputOptions: [],
+            outputPath: .emitApiDescriptorPath,
+            compilerOutputType: compilerOutputType,
+            compilerMode: compilerMode,
+            emitModuleSeparately: emitModuleSeparately,
+            outputFileMap: self.outputFileMap,
+            moduleName: moduleOutputInfo.name)
+    }
 
     Self.validateDigesterArgs(&parsedOptions,
                               moduleOutputInfo: moduleOutputInfo,

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -7219,30 +7219,88 @@ final class SwiftDriverTests: XCTestCase {
 
   func testEmitAPIDescriptorEmitModule() throws {
     try withTemporaryDirectory { path in
-      let apiDescriptorPath = path.appending(component: "api.json").nativePathString(escaped: true)
-      var driver = try Driver(args: ["swiftc", "foo.swift", "bar.swift", "baz.swift",
-                                     "-emit-module", "-module-name", "Test",
-                                     "-emit-api-descriptor-path", apiDescriptorPath])
+      do {
+        let apiDescriptorPath = path.appending(component: "api.json").nativePathString(escaped: true)
+        var driver = try Driver(args: ["swiftc", "foo.swift", "bar.swift", "baz.swift",
+                                       "-emit-module", "-module-name", "Test",
+                                       "-emit-api-descriptor-path", apiDescriptorPath])
 
-      let jobs = try driver.planBuild().removingAutolinkExtractJobs()
-      let emitModuleJob = try jobs.findJob(.emitModule)
-      XCTAssert(emitModuleJob.commandLine.contains(.flag("-emit-api-descriptor-path")))
+        let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+        let emitModuleJob = try jobs.findJob(.emitModule)
+        XCTAssert(emitModuleJob.commandLine.contains(.flag("-emit-api-descriptor-path")))
+      }
+
+      do {
+        var env = ProcessEnv.vars
+        env["TAPI_SDKDB_OUTPUT_PATH"] = path.appending(component: "SDKDB").nativePathString(escaped: false)
+        var driver = try Driver(args: ["swiftc", "foo.swift", "bar.swift", "baz.swift",
+                                       "-emit-module", "-module-name", "Test"], env: env)
+        let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+        let emitModuleJob = try jobs.findJob(.emitModule)
+        XCTAssert(emitModuleJob.commandLine.contains(subsequence: [
+          .flag("-emit-api-descriptor-path"),
+          .path(.absolute(path.appending(components: "SDKDB", "Test.\(driver.frontendTargetInfo.target.moduleTriple.triple).swift.sdkdb"))),
+        ]))
+      }
+
+      do {
+        var env = ProcessEnv.vars
+        env["LD_TRACE_FILE"] = path.appending(component: ".LD_TRACE").nativePathString(escaped: false)
+        var driver = try Driver(args: ["swiftc", "foo.swift", "bar.swift", "baz.swift",
+                                       "-emit-module", "-module-name", "Test"], env: env)
+        let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+        let emitModuleJob = try jobs.findJob(.emitModule)
+        XCTAssert(emitModuleJob.commandLine.contains(subsequence: [
+          .flag("-emit-api-descriptor-path"),
+          .path(.absolute(path.appending(components: "SDKDB", "Test.\(driver.frontendTargetInfo.target.moduleTriple.triple).swift.sdkdb"))),
+        ]))
+      }
     }
   }
 
   func testEmitAPIDescriptorWholeModuleOptimization() throws {
     try withTemporaryDirectory { path in
-      let apiDescriptorPath = path.appending(component: "api.json").nativePathString(escaped: true)
-      var driver = try Driver(args: ["swiftc", "-whole-module-optimization",
-                                     "-driver-filelist-threshold=0",
-                                     "foo.swift", "bar.swift", "baz.swift",
-                                     "-module-name", "Test", "-emit-module",
-                                     "-emit-api-descriptor-path", apiDescriptorPath])
+      do {
+        let apiDescriptorPath = path.appending(component: "api.json").nativePathString(escaped: true)
+        var driver = try Driver(args: ["swiftc", "-whole-module-optimization",
+                                       "-driver-filelist-threshold=0",
+                                       "foo.swift", "bar.swift", "baz.swift",
+                                       "-module-name", "Test", "-emit-module",
+                                       "-emit-api-descriptor-path", apiDescriptorPath])
 
-      let jobs = try driver.planBuild().removingAutolinkExtractJobs()
-      let compileJob = try jobs.findJob(.compile)
-      let supplementaryOutputs = try XCTUnwrap(compileJob.commandLine.supplementaryOutputFilemap)
-      XCTAssertNotNil(supplementaryOutputs.entries.values.first?[.jsonAPIDescriptor])
+        let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+        let compileJob = try jobs.findJob(.compile)
+        let supplementaryOutputs = try XCTUnwrap(compileJob.commandLine.supplementaryOutputFilemap)
+        XCTAssertNotNil(supplementaryOutputs.entries.values.first?[.jsonAPIDescriptor])
+      }
+
+      do {
+        var env = ProcessEnv.vars
+        env["TAPI_SDKDB_OUTPUT_PATH"] = path.appending(component: "SDKDB").nativePathString(escaped: false)
+        var driver = try Driver(args: ["swiftc", "-whole-module-optimization",
+                                       "-driver-filelist-threshold=0",
+                                       "foo.swift", "bar.swift", "baz.swift",
+                                       "-module-name", "Test", "-emit-module"], env: env)
+
+        let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+        let compileJob = try jobs.findJob(.compile)
+        let supplementaryOutputs = try XCTUnwrap(compileJob.commandLine.supplementaryOutputFilemap)
+        XCTAssertNotNil(supplementaryOutputs.entries.values.first?[.jsonAPIDescriptor])
+      }
+
+      do {
+        var env = ProcessEnv.vars
+        env["LD_TRACE_FILE"] = path.appending(component: ".LD_TRACE").nativePathString(escaped: false)
+        var driver = try Driver(args: ["swiftc", "-whole-module-optimization",
+                                       "-driver-filelist-threshold=0",
+                                       "foo.swift", "bar.swift", "baz.swift",
+                                       "-module-name", "Test", "-emit-module"], env: env)
+
+        let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+        let compileJob = try jobs.findJob(.compile)
+        let supplementaryOutputs = try XCTUnwrap(compileJob.commandLine.supplementaryOutputFilemap)
+        XCTAssertNotNil(supplementaryOutputs.entries.values.first?[.jsonAPIDescriptor])
+      }
     }
   }
 }