Log information about discovered Swift modules

Author: nkcsgexi

Sources/SwiftDriver/Jobs/PrebuiltModulesJob.swift

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 import TSCBasic
 import SwiftOptions
+import Foundation
 
 @_spi(Testing) public func isIosMacInterface(_ path: VirtualPath) throws -> Bool {
   let data = try localFileSystem.readFileContents(path).cString
@@ -241,6 +242,41 @@ public struct PrebuiltModuleInput {
   }
 }
 
+public class SwiftAdopter: Codable {
+  let name: String
+  let moduleDir: String
+  let hasInterface: Bool
+  let hasModule: Bool
+  let isFramework: Bool
+  let isPrivateFramework: Bool
+  init(_ name: String, _ moduleDir: AbsolutePath, _ hasInterface: AbsolutePath?, _ hasModule: AbsolutePath?) {
+    self.name = name
+    self.moduleDir = SwiftAdopter.relativeToSDK(moduleDir)
+    self.hasInterface = hasInterface != nil
+    self.hasModule = hasModule != nil
+    self.isFramework = self.moduleDir.contains("\(name).framework")
+    self.isPrivateFramework = self.moduleDir.contains("PrivateFrameworks")
+  }
+  static func relativeToSDK(_ fullPath: AbsolutePath) -> String {
+    var SDKDir: AbsolutePath = fullPath
+    while(SDKDir.extension != "sdk") {
+      SDKDir = SDKDir.parentDirectory
+    }
+    assert(SDKDir.extension == "sdk")
+    SDKDir = SDKDir.parentDirectory
+    return fullPath.relative(to: SDKDir).pathString
+  }
+
+  static public func emitSummary(_ adopters: [SwiftAdopter], to logDir: AbsolutePath?) throws {
+    guard let logDir = logDir else { return }
+    let data = try JSONEncoder().encode(adopters)
+    if let json = try? JSONSerialization.jsonObject(with: data, options: .mutableContainers),
+       let jsonData = try? JSONSerialization.data(withJSONObject: json, options: .prettyPrinted) {
+      try localFileSystem.writeFileContents(logDir.appending(component: "adopters.json"), bytes: ByteString(jsonData))
+    }
+  }
+}
+
 typealias PrebuiltModuleOutput = PrebuiltModuleInput
 
 public struct SDKPrebuiltModuleInputsCollector {
@@ -298,7 +334,8 @@ public struct SDKPrebuiltModuleInputsCollector {
     }
   }
 
-  public func collectSwiftInterfaceMap() throws -> [String: [PrebuiltModuleInput]] {
+  public func collectSwiftInterfaceMap() throws -> (inputMap: [String: [PrebuiltModuleInput]], adopters: [SwiftAdopter]) {
+    var allSwiftAdopters: [SwiftAdopter] = []
     var results: [String: [PrebuiltModuleInput]] = [:]
 
     func updateResults(_ dir: AbsolutePath) throws {
@@ -309,7 +346,8 @@ public struct SDKPrebuiltModuleInputsCollector {
       if results[moduleName] == nil {
         results[moduleName] = []
       }
-
+      var hasInterface: AbsolutePath?
+      var hasModule: AbsolutePath?
       // Search inside a .swiftmodule directory for any .swiftinterface file, and
       // add the files into the dictionary.
       // Duplicate entries are discarded, otherwise llbuild will complain.
@@ -322,11 +360,14 @@ public struct SDKPrebuiltModuleInputsCollector {
           if !results[moduleName]!.contains(where: { $0.path.file.basenameWithoutExt == currentBaseName }) {
             results[moduleName]!.append(PrebuiltModuleInput(interfacePath))
           }
+          hasInterface = currentFile
         }
         if currentFile.extension == "swiftmodule" {
           diagEngine.emit(warning: "found \(currentFile)")
+          hasModule = currentFile
         }
       }
+      allSwiftAdopters.append(SwiftAdopter(moduleName, dir, hasInterface, hasModule))
     }
     // Search inside framework dirs in an SDK to find .swiftmodule directories.
     for dir in frameworkDirs {
@@ -358,7 +399,7 @@ public struct SDKPrebuiltModuleInputsCollector {
         }
       }
     }
-    return sanitizeInterfaceMap(results)
+    return (inputMap: sanitizeInterfaceMap(results), adopters: allSwiftAdopters)
   }
 }
 

Sources/swift-build-sdk-interfaces/main.swift

@@ -67,6 +67,7 @@ do {
     diagnosticsEngine.emit(error: "cannot find sdk: \(sdkPath.pathString)")
     exit(1)
   }
+  let logDir = try getArgumentAsPath("-log-path")
   let collector = SDKPrebuiltModuleInputsCollector(sdkPath, diagnosticsEngine)
   var outputDir = try VirtualPath(path: rawOutputDir).absolutePath!
   // if the given output dir ends with 'prebuilt-modules', we should
@@ -108,7 +109,11 @@ do {
                               .appending(component: "SystemVersion.plist"),
                            to: sysVersionFile)
   let processSet = ProcessSet()
-  let inputMap = try collector.collectSwiftInterfaceMap()
+  let inputTuple = try collector.collectSwiftInterfaceMap()
+  let allAdopters = inputTuple.adopters
+  let currentABIDir = try getArgumentAsPath("-current-abi-dir")
+  try SwiftAdopter.emitSummary(allAdopters, to: currentABIDir)
+  let inputMap = inputTuple.inputMap
   let allModules = coreMode ? ["Foundation"] : Array(inputMap.keys)
   try withTemporaryFile(suffix: ".swift") {
     let tempPath = $0.path
@@ -131,8 +136,6 @@ do {
       args.append(mcpFlag)
       args.append(mcp)
     }
-    let logDir = try getArgumentAsPath("-log-path")
-    let currentABIDir = try getArgumentAsPath("-current-abi-dir")
     let baselineABIDir = try getArgumentAsPath("-baseline-abi-dir")
     var driver = try Driver(args: args,
                             diagnosticsEngine: diagnosticsEngine,

Tests/SwiftDriverTests/ExplicitModuleBuildTests.swift

@@ -1310,7 +1310,7 @@ final class ExplicitModuleBuildTests: XCTestCase {
         testInputsPath.appending(component: "mock-sdk.sdk").pathString
     let diagnosticEnging = DiagnosticsEngine()
     let collector = try SDKPrebuiltModuleInputsCollector(VirtualPath(path: mockSDKPath).absolutePath!, diagnosticEnging)
-    let interfaceMap = try collector.collectSwiftInterfaceMap()
+    let interfaceMap = try collector.collectSwiftInterfaceMap().inputMap
 
     // Check interface map always contain everything
     XCTAssertTrue(interfaceMap["Swift"]!.count == 3)
@@ -1486,7 +1486,7 @@ final class ExplicitModuleBuildTests: XCTestCase {
     let baselineABIPath: String =
         testInputsPath.appending(component: "ABIBaselines").pathString
     let collector = try SDKPrebuiltModuleInputsCollector(VirtualPath(path: mockSDKPath).absolutePath!, DiagnosticsEngine())
-    let interfaceMap = try collector.collectSwiftInterfaceMap()
+    let interfaceMap = try collector.collectSwiftInterfaceMap().inputMap
     try withTemporaryDirectory { path in
       let main = path.appending(component: "testPrebuiltModuleGenerationJobs.swift")
       try localFileSystem.writeFileContents(main) {
@@ -1514,7 +1514,7 @@ final class ExplicitModuleBuildTests: XCTestCase {
     let mockSDKPath = testInputsPath.appending(component: "mock-sdk.Internal.sdk")
     let mockSDKPathStr: String = mockSDKPath.pathString
     let collector = try SDKPrebuiltModuleInputsCollector(VirtualPath(path: mockSDKPathStr).absolutePath!, DiagnosticsEngine())
-    let interfaceMap = try collector.collectSwiftInterfaceMap()
+    let interfaceMap = try collector.collectSwiftInterfaceMap().inputMap
     try withTemporaryDirectory { path in
       let main = path.appending(component: "testPrebuiltModuleGenerationJobs.swift")
       try localFileSystem.writeFileContents(main) {