Skip to content

Commit 8ed7a80

Browse files
artemcmartemcm
committed
[Explicit Module Builds] Get source locations from the dependency scanner and emit diagnostics with them
- Adopt new libSwiftScan API to get source location for each emitted diagnostic: buffer identifier, line number, column number.
1 parent f6c8f86 commit 8ed7a80

File tree

6 files changed

+182
-15
lines changed

6 files changed

+182
-15
lines changed

‎Sources/CSwiftScan/include/swiftscan_header.h‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ typedef struct swiftscan_dependency_info_s *swiftscan_dependency_info_t;
4444
typedef struct swiftscan_dependency_graph_s *swiftscan_dependency_graph_t;
4545
typedef struct swiftscan_import_set_s *swiftscan_import_set_t;
4646
typedef struct swiftscan_diagnostic_info_s *swiftscan_diagnostic_info_t;
47+
typedef struct swiftscan_source_location_s *swiftscan_source_location_t;
4748

4849
typedef enum {
4950
SWIFTSCAN_DIAGNOSTIC_SEVERITY_ERROR = 0,
@@ -270,9 +271,19 @@ typedef struct {
270271
(*swiftscan_diagnostic_get_message)(swiftscan_diagnostic_info_t);
271272
swiftscan_diagnostic_severity_t
272273
(*swiftscan_diagnostic_get_severity)(swiftscan_diagnostic_info_t);
274+
swiftscan_source_location_t
275+
(*swiftscan_diagnostic_get_source_location)(swiftscan_diagnostic_info_t);
273276
void
274277
(*swiftscan_diagnostics_set_dispose)(swiftscan_diagnostic_set_t*);
275278

279+
//=== Source Location -----------------------------------------------------===//
280+
swiftscan_string_ref_t
281+
(*swiftscan_source_location_get_buffer_identifier)(swiftscan_source_location_t);
282+
int64_t
283+
(*swiftscan_source_location_get_line_number)(swiftscan_source_location_t);
284+
int64_t
285+
(*swiftscan_source_location_get_column_number)(swiftscan_source_location_t);
286+
276287
//=== Scanner Cache Functions ---------------------------------------------===//
277288
void (*swiftscan_scanner_cache_serialize)(swiftscan_scanner_t scanner, const char * path);
278289
bool (*swiftscan_scanner_cache_load)(swiftscan_scanner_t scanner, const char * path);

‎Sources/SwiftDriver/ExplicitModuleBuilds/InterModuleDependencies/InterModuleDependencyOracle.swift‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,13 @@ public class InterModuleDependencyOracle {
167167
return swiftScan.canQueryPerScanDiagnostics
168168
}
169169

170+
@_spi(Testing) public func supportsDiagnosticSourceLocations() throws -> Bool {
171+
guard let swiftScan = swiftScanLibInstance else {
172+
fatalError("Attempting to query supported scanner API with no scanner instance.")
173+
}
174+
return swiftScan.supportsDiagnosticSourceLocations
175+
}
176+
170177
@_spi(Testing) public func getScannerDiagnostics() throws -> [ScannerDiagnosticPayload]? {
171178
guard let swiftScan = swiftScanLibInstance else {
172179
fatalError("Attempting to reset scanner cache with no scanner instance.")

‎Sources/SwiftDriver/ExplicitModuleBuilds/ModuleDependencyScanning.swift‎

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ import class Foundation.JSONEncoder
2222
import class Foundation.JSONDecoder
2323
import var Foundation.EXIT_SUCCESS
2424

25+
private extension String {
26+
func stripNewline() -> String {
27+
return self.hasSuffix("\n") ? String(self.dropLast()) : self
28+
}
29+
}
30+
2531
extension Diagnostic.Message {
2632
static func warn_scan_dylib_not_found() -> Diagnostic.Message {
2733
.warning("Unable to locate libSwiftScan. Fallback to `swift-frontend` dependency scanner invocation.")
@@ -33,16 +39,16 @@ extension Diagnostic.Message {
3339
.error("Swift Caching enabled - libSwiftScan load failed (\(libPath)).")
3440
}
3541
static func scanner_diagnostic_error(_ message: String) -> Diagnostic.Message {
36-
.error(message)
42+
return .error(message.stripNewline())
3743
}
3844
static func scanner_diagnostic_warn(_ message: String) -> Diagnostic.Message {
39-
.warning(message)
45+
.warning(message.stripNewline())
4046
}
4147
static func scanner_diagnostic_note(_ message: String) -> Diagnostic.Message {
42-
.note(message)
48+
.note(message.stripNewline())
4349
}
4450
static func scanner_diagnostic_remark(_ message: String) -> Diagnostic.Message {
45-
.remark(message)
51+
.remark(message.stripNewline())
4652
}
4753
}
4854

@@ -247,15 +253,20 @@ public extension Driver {
247253
for diagnostic in diagnostics {
248254
switch diagnostic.severity {
249255
case .error:
250-
diagnosticEngine.emit(.scanner_diagnostic_error(diagnostic.message))
256+
diagnosticEngine.emit(.scanner_diagnostic_error(diagnostic.message),
257+
location: diagnostic.sourceLocation)
251258
case .warning:
252-
diagnosticEngine.emit(.scanner_diagnostic_warn(diagnostic.message))
259+
diagnosticEngine.emit(.scanner_diagnostic_warn(diagnostic.message),
260+
location: diagnostic.sourceLocation)
253261
case .note:
254-
diagnosticEngine.emit(.scanner_diagnostic_note(diagnostic.message))
262+
diagnosticEngine.emit(.scanner_diagnostic_note(diagnostic.message),
263+
location: diagnostic.sourceLocation)
255264
case .remark:
256-
diagnosticEngine.emit(.scanner_diagnostic_remark(diagnostic.message))
265+
diagnosticEngine.emit(.scanner_diagnostic_remark(diagnostic.message),
266+
location: diagnostic.sourceLocation)
257267
case .ignored:
258-
diagnosticEngine.emit(.scanner_diagnostic_error(diagnostic.message))
268+
diagnosticEngine.emit(.scanner_diagnostic_error(diagnostic.message),
269+
location: diagnostic.sourceLocation)
259270
}
260271
}
261272
}

‎Sources/SwiftDriver/SwiftScan/SwiftScan.swift‎

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import struct Foundation.Data
2121
import protocol TSCBasic.DiagnosticData
2222
import struct TSCBasic.AbsolutePath
2323
import struct TSCBasic.Diagnostic
24+
import protocol TSCBasic.DiagnosticLocation
2425

2526
public enum DependencyScanningError: LocalizedError, DiagnosticData, Equatable {
2627
case missingRequiredSymbol(String)
@@ -70,9 +71,19 @@ public enum DependencyScanningError: LocalizedError, DiagnosticData, Equatable {
7071
}
7172
}
7273

73-
@_spi(Testing) public struct ScannerDiagnosticPayload {
74-
@_spi(Testing) public let severity: Diagnostic.Behavior
75-
@_spi(Testing) public let message: String
74+
public struct ScannerDiagnosticSourceLocation : DiagnosticLocation {
75+
public var description: String {
76+
return "\(bufferIdentifier):\(lineNumber):\(columnNumber)"
77+
}
78+
public let bufferIdentifier: String
79+
public let lineNumber: Int
80+
public let columnNumber: Int
81+
}
82+
83+
public struct ScannerDiagnosticPayload {
84+
public let severity: Diagnostic.Behavior
85+
public let message: String
86+
public let sourceLocation: ScannerDiagnosticSourceLocation?
7687
}
7788

7889
internal extension swiftscan_diagnostic_severity_t {
@@ -345,6 +356,13 @@ internal extension swiftscan_diagnostic_severity_t {
345356
api.swiftscan_import_set_get_diagnostics != nil
346357
}
347358

359+
@_spi(Testing) public var supportsDiagnosticSourceLocations : Bool {
360+
return api.swiftscan_diagnostic_get_source_location != nil &&
361+
api.swiftscan_source_location_get_buffer_identifier != nil &&
362+
api.swiftscan_source_location_get_line_number != nil &&
363+
api.swiftscan_source_location_get_column_number != nil
364+
}
365+
348366
func serializeScannerCache(to path: AbsolutePath) {
349367
api.swiftscan_scanner_cache_serialize(scanner,
350368
path.description.cString(using: String.Encoding.utf8))
@@ -369,7 +387,22 @@ internal extension swiftscan_diagnostic_severity_t {
369387
}
370388
let message = try toSwiftString(api.swiftscan_diagnostic_get_message(diagnosticRef))
371389
let severity = api.swiftscan_diagnostic_get_severity(diagnosticRef)
372-
result.append(ScannerDiagnosticPayload(severity: severity.toDiagnosticBehavior(), message: message))
390+
391+
var sourceLoc: ScannerDiagnosticSourceLocation? = nil
392+
if supportsDiagnosticSourceLocations {
393+
let sourceLocRefOrNull = api.swiftscan_diagnostic_get_source_location(diagnosticRef)
394+
if let sourceLocRef = sourceLocRefOrNull {
395+
let bufferName = try toSwiftString(api.swiftscan_source_location_get_buffer_identifier(sourceLocRef))
396+
let lineNumber = api.swiftscan_source_location_get_line_number(sourceLocRef)
397+
let columnNumber = api.swiftscan_source_location_get_column_number(sourceLocRef)
398+
sourceLoc = ScannerDiagnosticSourceLocation(bufferIdentifier: bufferName,
399+
lineNumber: Int(lineNumber),
400+
columnNumber: Int(columnNumber))
401+
}
402+
}
403+
result.append(ScannerDiagnosticPayload(severity: severity.toDiagnosticBehavior(),
404+
message: message,
405+
sourceLocation: sourceLoc))
373406
}
374407
return result
375408
}
@@ -597,6 +630,11 @@ private extension swiftscan_functions_t {
597630
self.swiftscan_cache_replay_result_get_stderr = try loadOptional("swiftscan_cache_replay_result_get_stderr")
598631
self.swiftscan_cache_replay_result_dispose = try loadOptional("swiftscan_cache_replay_result_dispose")
599632

633+
self.swiftscan_diagnostic_get_source_location = try loadOptional("swiftscan_diagnostic_get_source_location")
634+
self.swiftscan_source_location_get_buffer_identifier = try loadOptional("swiftscan_source_location_get_buffer_identifier")
635+
self.swiftscan_source_location_get_line_number = try loadOptional("swiftscan_source_location_get_line_number")
636+
self.swiftscan_source_location_get_column_number = try loadOptional("swiftscan_source_location_get_column_number")
637+
600638
// Swift Overlay Dependencies
601639
self.swiftscan_swift_textual_detail_get_swift_overlay_dependencies =
602640
try loadOptional("swiftscan_swift_textual_detail_get_swift_overlay_dependencies")

‎Sources/swift-driver/main.swift‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,13 @@ do {
120120
}
121121

122122
let jobs = try driver.planBuild()
123+
124+
// Planning may result in further errors emitted
125+
// due to dependency scanning failures.
126+
guard !driver.diagnosticEngine.hasErrors else {
127+
throw Driver.ErrorDiagnostics.emitted
128+
}
129+
123130
try driver.run(jobs: jobs)
124131

125132
if driver.diagnosticEngine.hasErrors {

‎Tests/SwiftDriverTests/ExplicitModuleBuildTests.swift‎

Lines changed: 95 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1408,6 +1408,7 @@ final class ExplicitModuleBuildTests: XCTestCase {
14081408
throw XCTSkip("libSwiftScan does not support diagnostics query.")
14091409
}
14101410

1411+
// Missing Swift Interface dependency
14111412
try withTemporaryDirectory { path in
14121413
let main = path.appending(component: "testDependencyScanning.swift")
14131414
try localFileSystem.writeFileContents(main, bytes: "import S;")
@@ -1450,8 +1451,22 @@ final class ExplicitModuleBuildTests: XCTestCase {
14501451
XCTAssertEqual(potentialDiags?.count, 5)
14511452
let diags = try XCTUnwrap(potentialDiags)
14521453
let error = diags[0]
1453-
XCTAssertEqual(error.message, "Unable to find module dependency: 'unknown_module'")
14541454
XCTAssertEqual(error.severity, .error)
1455+
if try dependencyOracle.supportsDiagnosticSourceLocations() {
1456+
XCTAssertEqual(error.message,
1457+
"""
1458+
Unable to find module dependency: 'unknown_module'
1459+
import unknown_module
1460+
^
1461+
1462+
""")
1463+
let sourceLoc = try XCTUnwrap(error.sourceLocation)
1464+
XCTAssertTrue(sourceLoc.bufferIdentifier.hasSuffix("I.swiftinterface"))
1465+
XCTAssertEqual(sourceLoc.lineNumber, 3)
1466+
XCTAssertEqual(sourceLoc.columnNumber, 8)
1467+
} else {
1468+
XCTAssertEqual(error.message, "Unable to find module dependency: 'unknown_module'")
1469+
}
14551470
let noteI = diags[1]
14561471
XCTAssertTrue(noteI.message.starts(with: "a dependency of Swift module 'I':"))
14571472
XCTAssertEqual(noteI.severity, .note)
@@ -1462,7 +1477,85 @@ final class ExplicitModuleBuildTests: XCTestCase {
14621477
XCTAssertTrue(noteS.message.starts(with: "a dependency of Swift module 'S':"))
14631478
XCTAssertEqual(noteS.severity, .note)
14641479
let noteTest = diags[4]
1465-
XCTAssertEqual(noteTest.message, "a dependency of main module 'testDependencyScanning'")
1480+
if try dependencyOracle.supportsDiagnosticSourceLocations() {
1481+
XCTAssertEqual(noteTest.message,
1482+
"""
1483+
a dependency of main module 'testDependencyScanning'
1484+
import unknown_module
1485+
^
1486+
1487+
"""
1488+
)
1489+
} else {
1490+
XCTAssertEqual(noteTest.message, "a dependency of main module 'testDependencyScanning'")
1491+
}
1492+
XCTAssertEqual(noteTest.severity, .note)
1493+
}
1494+
1495+
// Missing main module dependency
1496+
try withTemporaryDirectory { path in
1497+
let main = path.appending(component: "testDependencyScanning.swift")
1498+
try localFileSystem.writeFileContents(main, bytes: "import FooBar")
1499+
let sdkArgumentsForTesting = (try? Driver.sdkArgumentsForTesting()) ?? []
1500+
var driver = try Driver(args: ["swiftc",
1501+
"-I", stdlibPath.nativePathString(escaped: true),
1502+
"-I", shimsPath.nativePathString(escaped: true),
1503+
"-explicit-module-build",
1504+
"-working-directory", path.nativePathString(escaped: true),
1505+
"-disable-clang-target",
1506+
main.nativePathString(escaped: true)] + sdkArgumentsForTesting,
1507+
env: ProcessEnv.vars)
1508+
let resolver = try ArgsResolver(fileSystem: localFileSystem)
1509+
var scannerCommand = try driver.dependencyScannerInvocationCommand().1.map { try resolver.resolve($0) }
1510+
if scannerCommand.first == "-frontend" {
1511+
scannerCommand.removeFirst()
1512+
}
1513+
var scanDiagnostics: [ScannerDiagnosticPayload] = []
1514+
let _ =
1515+
try dependencyOracle.getDependencies(workingDirectory: path,
1516+
commandLine: scannerCommand,
1517+
diagnostics: &scanDiagnostics)
1518+
let potentialDiags: [ScannerDiagnosticPayload]?
1519+
if try dependencyOracle.supportsPerScanDiagnostics() {
1520+
potentialDiags = scanDiagnostics
1521+
print("Using Per-Scan diagnostics")
1522+
} else {
1523+
potentialDiags = try dependencyOracle.getScannerDiagnostics()
1524+
print("Using Scanner-Global diagnostics")
1525+
}
1526+
XCTAssertEqual(potentialDiags?.count, 2)
1527+
let diags = try XCTUnwrap(potentialDiags)
1528+
let error = diags[0]
1529+
XCTAssertEqual(error.severity, .error)
1530+
if try dependencyOracle.supportsDiagnosticSourceLocations() {
1531+
XCTAssertEqual(error.message,
1532+
"""
1533+
Unable to find module dependency: 'FooBar'
1534+
import FooBar
1535+
^
1536+
1537+
""")
1538+
1539+
let sourceLoc = try XCTUnwrap(error.sourceLocation)
1540+
XCTAssertTrue(sourceLoc.bufferIdentifier.hasSuffix("testDependencyScanning.swift"))
1541+
XCTAssertEqual(sourceLoc.lineNumber, 1)
1542+
XCTAssertEqual(sourceLoc.columnNumber, 8)
1543+
} else {
1544+
XCTAssertEqual(error.message, "Unable to find module dependency: 'FooBar'")
1545+
}
1546+
let noteTest = diags[1]
1547+
if try dependencyOracle.supportsDiagnosticSourceLocations() {
1548+
XCTAssertEqual(noteTest.message,
1549+
"""
1550+
a dependency of main module 'testDependencyScanning'
1551+
import FooBar
1552+
^
1553+
1554+
"""
1555+
)
1556+
} else {
1557+
XCTAssertEqual(noteTest.message, "a dependency of main module 'testDependencyScanning'")
1558+
}
14661559
XCTAssertEqual(noteTest.severity, .note)
14671560
}
14681561
}

0 commit comments

Comments
 (0)