Skip to content

[Merge Modules] Omit merge-modules job when only one input is given. #577

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 1 commit into from
Apr 1, 2021
Merged

[Merge Modules] Omit merge-modules job when only one input is given. #577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions Sources/SwiftDriver/Jobs/Planning.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,16 @@ extension Driver {
!(moduleInputs.isEmpty && moduleInputsFromJobOutputs.isEmpty),
compilerMode.usesPrimaryFileInputs
else { return nil }

// If there is only 1 module input to this job and its path matches that which we intend
// to produce with this merge-modules job, skip it
let mergeOutput = moduleOutputInfo.output!.outputPath
if moduleInputs.count + moduleInputsFromJobOutputs.count == 1,
let soleInput = moduleInputs.first == nil ? moduleInputsFromJobOutputs.first : moduleInputs.first,
soleInput.fileHandle == mergeOutput {
return nil
}

return try mergeModuleJob(inputs: moduleInputs, inputsFromOutputs: moduleInputsFromJobOutputs)
}

Expand Down
37 changes: 27 additions & 10 deletions Tests/SwiftDriverTests/SwiftDriverTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1973,6 +1973,23 @@ final class SwiftDriverTests: XCTestCase {
XCTAssertEqual(plannedJobs[1].inputs[0].file, .temporary(RelativePath("input.swiftmodule")))
XCTAssertEqual(plannedJobs[1].outputs[0].file, .absolute(AbsolutePath("/tmp/test.swiftmodule")))
}

do {
// -g is specified
// (partial and final product module are saved to temporary directory so merge-modules is omitted)
var driver = try Driver(args: ["swiftc", "-g", "input.swift"])
let plannedJobs = try driver.planBuild()
print(plannedJobs)
XCTAssertEqual(plannedJobs.count, 3)
// No .mergeModule job
#if os(macOS)
XCTAssertEqual(plannedJobs.map { $0.kind }, [.compile, .link, .generateDSYM])
#endif
#if os(Linux)
XCTAssertEqual(plannedJobs.map { $0.kind }, [.compile, .autolinkExtract, .link])
#endif
XCTAssertTrue(plannedJobs[0].outputs.contains(TypedVirtualPath(file: VirtualPath.temporary(RelativePath("input.swiftmodule")).intern(), type: .swiftModule)))
}
}

func testEmitModuleSeparately() throws {
Expand Down Expand Up @@ -2015,16 +2032,16 @@ final class SwiftDriverTests: XCTestCase {
// swift-autolink-extract is not present
#if os(Linux)
do {
var driver = try Driver(args: ["swiftc", "-target", "x86_64-unknown-linux-gnu", "-g", "foo.swift"])
var driver = try Driver(args: ["swiftc", "-target", "x86_64-unknown-linux-gnu", "-g", "foo.swift", "bar.swift"])
let plannedJobs = try driver.planBuild()
XCTAssertEqual(plannedJobs.count, 5)
XCTAssertEqual(Set(plannedJobs.map { $0.kind }), Set([.compile, .mergeModule, .autolinkExtract, .moduleWrap, .link]))
XCTAssertEqual(plannedJobs.count, 6)
XCTAssertEqual(Set(plannedJobs.map { $0.kind }), Set([.compile, .compile, .mergeModule, .autolinkExtract, .moduleWrap, .link]))
let wrapJob = plannedJobs.filter {$0.kind == .moduleWrap} .first!
XCTAssertEqual(wrapJob.inputs.count, 1)
XCTAssertTrue(wrapJob.commandLine.contains(subsequence: ["-target", "x86_64-unknown-linux-gnu"]))
let mergeJob = plannedJobs.filter {$0.kind == .mergeModule} .first!
XCTAssertTrue(mergeJob.outputs.contains(wrapJob.inputs.first!))
XCTAssertTrue(plannedJobs[4].inputs.contains(wrapJob.outputs.first!))
XCTAssertTrue(plannedJobs[5].inputs.contains(wrapJob.outputs.first!))
}

do {
Expand All @@ -2038,19 +2055,19 @@ final class SwiftDriverTests: XCTestCase {
do {
var driver = try Driver(args: ["swiftc", "-target", "x86_64-unknown-linux-gnu", "-gdwarf-types", "foo.swift"])
let plannedJobs = try driver.planBuild()
XCTAssertEqual(plannedJobs.count, 4)
// Merge module, but no module wrapping.
XCTAssertEqual(Set(plannedJobs.map { $0.kind }), Set([.compile, .mergeModule, .autolinkExtract, .link]))
XCTAssertEqual(plannedJobs.count, 3)
// No merge module/module wrap jobs.
XCTAssertEqual(Set(plannedJobs.map { $0.kind }), Set([.compile, .autolinkExtract, .link]))
}
#endif
// dsymutil won't be found on other platforms
#if os(macOS)
do {
var driver = try Driver(args: ["swiftc", "-target", "x86_64-apple-macosx10.15", "-g", "foo.swift"])
var driver = try Driver(args: ["swiftc", "-target", "x86_64-apple-macosx10.15", "-g", "foo.swift", "bar.swift"])
let plannedJobs = try driver.planBuild()
XCTAssertEqual(plannedJobs.count, 4)
XCTAssertEqual(plannedJobs.count, 5)
// No module wrapping with Mach-O.
XCTAssertEqual(plannedJobs.map { $0.kind }, [.compile, .mergeModule, .link, .generateDSYM])
XCTAssertEqual(plannedJobs.map { $0.kind }, [.compile, .compile, .mergeModule, .link, .generateDSYM])
}
#endif
}
Expand Down