Introduce -emit-api-descriptor-path option.

This option and its argument, when specified on the driver command line, should
be passed through to jobs that emit modules and have access to the whole
module.

Resolves rdar://116538520

Author: tshortli

Sources/SwiftDriver/Driver/Driver.swift

@@ -347,6 +347,9 @@ public struct Driver {
   /// Path to the module's digester baseline file.
   let digesterBaselinePath: VirtualPath.Handle?
 
+  /// Path to the emitted API descriptor file.
+  let apiDescriptorFilePath: VirtualPath.Handle?
+
   /// The mode the API digester should run in.
   let digesterMode: DigesterMode
 
@@ -954,6 +957,15 @@ 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)
+
     Self.validateDigesterArgs(&parsedOptions,
                               moduleOutputInfo: moduleOutputInfo,
                               digesterMode: self.digesterMode,

Sources/SwiftDriver/Jobs/CompileJob.swift

@@ -97,7 +97,7 @@ extension Driver {
          .moduleTrace, .yamlOptimizationRecord, .bitstreamOptimizationRecord, .pcm, .pch,
          .clangModuleMap, .jsonCompilerFeatures, .jsonTargetInfo, .jsonSwiftArtifacts,
          .indexUnitOutputPath, .modDepCache, .jsonAPIBaseline, .jsonABIBaseline,
-         .swiftConstValues, nil:
+         .swiftConstValues, .jsonAPIDescriptor, nil:
       return false
     }
   }
@@ -364,7 +364,6 @@ extension Driver {
     }
 
     let expirementalFeatures = parsedOptions.arguments(for: .enableExperimentalFeature)
-    let embeddedEnabled = expirementalFeatures.map(\.argument).map(\.asSingle).contains("Embedded")
 
     try commandLine.appendLast(.trackSystemDependencies, from: &parsedOptions)
     try commandLine.appendLast(.CrossModuleOptimization, from: &parsedOptions)
@@ -467,7 +466,7 @@ extension FileType {
          .bitstreamOptimizationRecord, .swiftInterface, .privateSwiftInterface,
          .swiftSourceInfoFile, .clangModuleMap, .jsonSwiftArtifacts,
          .indexUnitOutputPath, .modDepCache, .jsonAPIBaseline, .jsonABIBaseline,
-         .swiftConstValues:
+         .swiftConstValues, .jsonAPIDescriptor:
       fatalError("Output type can never be a primary output")
     }
   }

Sources/SwiftDriver/Jobs/EmitModuleJob.swift

@@ -34,6 +34,7 @@ extension Driver {
     addSupplementalOutput(path: swiftPrivateInterfacePath, flag: "-emit-private-module-interface-path", type: .privateSwiftInterface)
     addSupplementalOutput(path: objcGeneratedHeaderPath, flag: "-emit-objc-header-path", type: .objcHeader)
     addSupplementalOutput(path: tbdPath, flag: "-emit-tbd-path", type: .tbd)
+    addSupplementalOutput(path: apiDescriptorFilePath, flag: "-emit-api-descriptor-path", type: .jsonAPIDescriptor)
 
     if isMergeModule {
       return

Sources/SwiftDriver/Jobs/FrontendJobHelpers.swift

@@ -592,6 +592,12 @@ extension Driver {
                           input: nil,
                           flag: "-emit-abi-descriptor-path")
         }
+
+        try addOutputOfType(
+          outputType: .jsonAPIDescriptor,
+          finalOutputPath: apiDescriptorFilePath,
+          input: nil,
+          flag: "-emit-api-descriptor-path")
       }
     }
 

Sources/SwiftDriver/Utilities/FileType.swift

@@ -151,6 +151,9 @@ public enum FileType: String, Hashable, CaseIterable, Codable {
 
   /// ABI baseline JSON
   case jsonABIBaseline = "abi.json"
+
+  /// API descriptor JSON
+  case jsonAPIDescriptor
 }
 
 extension FileType: CustomStringConvertible {
@@ -235,6 +238,9 @@ extension FileType: CustomStringConvertible {
 
     case .swiftConstValues:
       return "const-values"
+
+    case .jsonAPIDescriptor:
+      return "api-descriptor-json"
     }
   }
 }
@@ -254,7 +260,7 @@ extension FileType {
          .swiftInterface, .privateSwiftInterface, .swiftSourceInfoFile,
          .jsonDependencies, .clangModuleMap, .jsonTargetInfo, .jsonCompilerFeatures,
          .jsonSwiftArtifacts, .indexUnitOutputPath, .modDepCache, .jsonAPIBaseline,
-         .jsonABIBaseline, .swiftConstValues:
+         .jsonABIBaseline, .swiftConstValues, .jsonAPIDescriptor:
       return false
     }
   }
@@ -359,6 +365,8 @@ extension FileType {
       return "abi-baseline-json"
     case .swiftConstValues:
       return "const-values"
+    case .jsonAPIDescriptor:
+      return "api-descriptor-json"
     }
   }
 }
@@ -370,7 +378,8 @@ extension FileType {
          .raw_sil, .llvmIR,.objcHeader, .autolink, .importedModules, .tbd,
          .moduleTrace, .yamlOptimizationRecord, .swiftInterface, .privateSwiftInterface,
          .jsonDependencies, .clangModuleMap, .jsonCompilerFeatures, .jsonTargetInfo,
-         .jsonSwiftArtifacts, .jsonAPIBaseline, .jsonABIBaseline, .swiftConstValues:
+         .jsonSwiftArtifacts, .jsonAPIBaseline, .jsonABIBaseline, .swiftConstValues,
+         .jsonAPIDescriptor:
       return true
     case .image, .object, .dSYM, .pch, .sib, .raw_sib, .swiftModule,
          .swiftDocumentation, .swiftSourceInfoFile, .llvmBitcode, .diagnostics,
@@ -393,7 +402,8 @@ extension FileType {
          .importedModules, .tbd, .moduleTrace, .indexData, .yamlOptimizationRecord,
          .modDepCache, .bitstreamOptimizationRecord, .pcm, .pch, .jsonDependencies,
          .clangModuleMap, .jsonCompilerFeatures, .jsonTargetInfo, .jsonSwiftArtifacts,
-         .indexUnitOutputPath, .jsonAPIBaseline, .jsonABIBaseline, .swiftConstValues:
+         .indexUnitOutputPath, .jsonAPIBaseline, .jsonABIBaseline, .swiftConstValues,
+         .jsonAPIDescriptor:
       return false
     }
   }

Sources/SwiftOptions/Options.swift

@@ -273,6 +273,7 @@ extension Option {
   public static let embedBitcode: Option = Option("-embed-bitcode", .flag, attributes: [.frontend, .noInteractive], helpText: "Embed LLVM IR bitcode as data")
   public static let embedTbdForModule: Option = Option("-embed-tbd-for-module", .separate, attributes: [.frontend], helpText: "Embed symbols from the module in the emitted tbd file")
   public static let emitAbiDescriptorPath: Option = Option("-emit-abi-descriptor-path", .separate, attributes: [.frontend, .noDriver, .cacheInvariant], metaVar: "<path>", helpText: "Output the ABI descriptor of current module to <path>")
+  public static let emitApiDescriptorPath: Option = Option("-emit-api-descriptor-path", .separate, attributes: [.frontend, .noInteractive, .argumentIsPath, .supplementaryOutput, .cacheInvariant], metaVar: "<path>", helpText: "Output the API descriptor of current module to <path>")
   public static let emitAssembly: Option = Option("-emit-assembly", .flag, attributes: [.frontend, .noInteractive, .doesNotAffectIncrementalBuild, .cacheInvariant], helpText: "Emit assembly file(s) (-S)", group: .modes)
   public static let emitAst: Option = Option("-emit-ast", .flag, alias: Option.dumpAst, attributes: [.frontend, .noInteractive, .doesNotAffectIncrementalBuild])
   public static let emitBc: Option = Option("-emit-bc", .flag, attributes: [.frontend, .noInteractive, .doesNotAffectIncrementalBuild, .cacheInvariant], helpText: "Emit LLVM BC file(s)", group: .modes)
@@ -1070,6 +1071,7 @@ extension Option {
       Option.embedBitcode,
       Option.embedTbdForModule,
       Option.emitAbiDescriptorPath,
+      Option.emitApiDescriptorPath,
       Option.emitAssembly,
       Option.emitAst,
       Option.emitBc,

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -7325,6 +7325,35 @@ final class SwiftDriverTests: XCTestCase {
     let emitModuleJob = try XCTUnwrap(jobs.first(where: {$0.kind == .emitModule}))
     XCTAssertTrue(emitModuleJob.commandLine.contains(.flag("-experimental-lazy-typecheck")))
   }
+  
+  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])
+
+      let jobs = try driver.planBuild().removingAutolinkExtractJobs()
+      let emitModuleJob = try XCTUnwrap(jobs.first(where: {$0.kind == .emitModule}))
+      XCTAssert(emitModuleJob.commandLine.contains(.flag("-emit-api-descriptor-path")))
+    }
+  }
+
+  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",
+                                     "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 XCTUnwrap(jobs.first(where: {$0.kind == .compile}))
+
+      let supplementaryOutputs = try XCTUnwrap(compileJob.commandLine.supplementaryOutputFilemap)
+      XCTAssertNotNil(supplementaryOutputs.entries.values.first?[.jsonAPIDescriptor])
+    }
+  }
 }
 
 func assertString(
@@ -7394,4 +7423,19 @@ private extension Array where Element == Job.ArgTemplate {
       }
     }
   }
+
+  var supplementaryOutputFilemap: OutputFileMap? {
+    get throws {
+      guard let argIdx = firstIndex(where: { $0 == .flag("-supplementary-output-file-map") }) else {
+        return nil
+      }
+      let supplementaryOutputs = self[argIdx + 1]
+      guard case let .path(path) = supplementaryOutputs,
+            case let .fileList(_, fileList) = path,
+            case let .outputFileMap(outputFileMap) = fileList else {
+        throw StringError("Unexpected argument for output file map")
+      }
+      return outputFileMap
+    }
+  }
 }