Skip to content

Add support for automatically emit API descriptor files #1478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 3, 2023
Merged

Add support for automatically emit API descriptor files #1478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c008446
Add support for automatically emit API descriptor files
zixu-w Nov 1, 2023
13a3bbf
Refactor to remove new language features for compatibility
zixu-w Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions Sources/SwiftDriver/Driver/Driver.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
var apiDescriptorDirectory: VirtualPath? = nil
if let apiDescriptorDirectoryEnvVar = env["TAPI_SDKDB_OUTPUT_PATH"] {
apiDescriptorDirectory = try VirtualPath(path: apiDescriptorDirectoryEnvVar)
} else if let ldTraceFileEnvVar = env["LD_TRACE_FILE"] {
apiDescriptorDirectory = try VirtualPath(path: ldTraceFileEnvVar).parentDirectory.appending(component: "SDKDB")
}
if let apiDescriptorDirectory = 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,
Expand Down
92 changes: 75 additions & 17 deletions Tests/SwiftDriverTests/SwiftDriverTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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])
}
}
}
}
Expand Down