Merge pull request #1296 from artemcm/BridgingHeaderDepScan

[Dependency Scanning] Pass the bridging header path to scanning action invocations

Author: artemcm

Sources/SwiftDriver/ExplicitModuleBuilds/ExplicitDependencyBuildPlanner.swift

@@ -248,7 +248,7 @@ public typealias ExternalTargetModuleDetailsMap = [ModuleDependencyId: ExternalT
     // Prohibit the frontend from implicitly building textual modules into binary modules.
     var swiftDependencyArtifacts: [SwiftModuleArtifactInfo] = []
     var clangDependencyArtifacts: [ClangModuleArtifactInfo] = []
-    try addModuleDependencies(moduleId: moduleId, pcmArgs: pcmArgs,
+    try addModuleDependencies(of: moduleId, pcmArgs: pcmArgs,
                               clangDependencyArtifacts: &clangDependencyArtifacts,
                               swiftDependencyArtifacts: &swiftDependencyArtifacts)
 
@@ -285,54 +285,64 @@ public typealias ExternalTargetModuleDetailsMap = [ModuleDependencyId: ExternalT
     }
   }
 
+  private mutating func addModuleDependency(of moduleId: ModuleDependencyId,
+                                            dependencyId: ModuleDependencyId, pcmArgs: [String],
+                                            clangDependencyArtifacts: inout [ClangModuleArtifactInfo],
+                                            swiftDependencyArtifacts: inout [SwiftModuleArtifactInfo]
+  ) throws {
+    switch dependencyId {
+      case .swift:
+        let dependencyInfo = try dependencyGraph.moduleInfo(of: dependencyId)
+        let swiftModulePath: TypedVirtualPath
+        let isFramework: Bool
+        swiftModulePath = .init(file: dependencyInfo.modulePath.path,
+                                type: .swiftModule)
+        isFramework = try dependencyGraph.swiftModuleDetails(of: dependencyId).isFramework ?? false
+        // Accumulate the required information about this dependency
+        // TODO: add .swiftdoc and .swiftsourceinfo for this module.
+        swiftDependencyArtifacts.append(
+          SwiftModuleArtifactInfo(name: dependencyId.moduleName,
+                                  modulePath: TextualVirtualPath(path: swiftModulePath.fileHandle),
+                                  isFramework: isFramework))
+      case .clang:
+        let dependencyInfo = try dependencyGraph.moduleInfo(of: dependencyId)
+        let dependencyClangModuleDetails =
+          try dependencyGraph.clangModuleDetails(of: dependencyId)
+        // Accumulate the required information about this dependency
+        clangDependencyArtifacts.append(
+          ClangModuleArtifactInfo(name: dependencyId.moduleName,
+                                  modulePath: TextualVirtualPath(path: dependencyInfo.modulePath.path),
+                                  moduleMapPath: dependencyClangModuleDetails.moduleMapPath))
+      case .swiftPrebuiltExternal:
+        let prebuiltModuleDetails = try dependencyGraph.swiftPrebuiltDetails(of: dependencyId)
+        let compiledModulePath = prebuiltModuleDetails.compiledModulePath
+        let isFramework = prebuiltModuleDetails.isFramework ?? false
+        let swiftModulePath: TypedVirtualPath =
+          .init(file: compiledModulePath.path, type: .swiftModule)
+        // Accumulate the required information about this dependency
+        // TODO: add .swiftdoc and .swiftsourceinfo for this module.
+        swiftDependencyArtifacts.append(
+          SwiftModuleArtifactInfo(name: dependencyId.moduleName,
+                                  modulePath: TextualVirtualPath(path: swiftModulePath.fileHandle),
+                                  isFramework: isFramework))
+      case .swiftPlaceholder:
+        fatalError("Unresolved placeholder dependencies at planning stage: \(dependencyId) of \(moduleId)")
+    }
+  }
+
   /// Add a specific module dependency as an input and a corresponding command
   /// line flag.
-  private mutating func addModuleDependencies(moduleId: ModuleDependencyId, pcmArgs: [String],
+  private mutating func addModuleDependencies(of moduleId: ModuleDependencyId, pcmArgs: [String],
                                               clangDependencyArtifacts: inout [ClangModuleArtifactInfo],
                                               swiftDependencyArtifacts: inout [SwiftModuleArtifactInfo]
   ) throws {
     guard let moduleDependencies = reachabilityMap[moduleId] else {
       fatalError("Expected reachability information for the module: \(moduleId.moduleName).")
     }
     for dependencyId in moduleDependencies {
-      switch dependencyId {
-        case .swift:
-          let dependencyInfo = try dependencyGraph.moduleInfo(of: dependencyId)
-          let swiftModulePath: TypedVirtualPath
-          let isFramework: Bool
-          swiftModulePath = .init(file: dependencyInfo.modulePath.path,
-                                  type: .swiftModule)
-          isFramework = try dependencyGraph.swiftModuleDetails(of: dependencyId).isFramework ?? false
-          // Accumulate the required information about this dependency
-          // TODO: add .swiftdoc and .swiftsourceinfo for this module.
-          swiftDependencyArtifacts.append(
-            SwiftModuleArtifactInfo(name: dependencyId.moduleName,
-                                    modulePath: TextualVirtualPath(path: swiftModulePath.fileHandle),
-                                    isFramework: isFramework))
-        case .clang:
-          let dependencyInfo = try dependencyGraph.moduleInfo(of: dependencyId)
-          let dependencyClangModuleDetails =
-            try dependencyGraph.clangModuleDetails(of: dependencyId)
-          // Accumulate the required information about this dependency
-          clangDependencyArtifacts.append(
-            ClangModuleArtifactInfo(name: dependencyId.moduleName,
-                                    modulePath: TextualVirtualPath(path: dependencyInfo.modulePath.path),
-                                    moduleMapPath: dependencyClangModuleDetails.moduleMapPath))
-        case .swiftPrebuiltExternal:
-          let prebuiltModuleDetails = try dependencyGraph.swiftPrebuiltDetails(of: dependencyId)
-          let compiledModulePath = prebuiltModuleDetails.compiledModulePath
-          let isFramework = prebuiltModuleDetails.isFramework ?? false
-          let swiftModulePath: TypedVirtualPath =
-            .init(file: compiledModulePath.path, type: .swiftModule)
-          // Accumulate the required information about this dependency
-          // TODO: add .swiftdoc and .swiftsourceinfo for this module.
-          swiftDependencyArtifacts.append(
-            SwiftModuleArtifactInfo(name: dependencyId.moduleName,
-                                    modulePath: TextualVirtualPath(path: swiftModulePath.fileHandle),
-                                    isFramework: isFramework))
-        case .swiftPlaceholder:
-          fatalError("Unresolved placeholder dependencies at planning stage: \(dependencyId) of \(moduleId)")
-      }
+      try addModuleDependency(of: moduleId, dependencyId: dependencyId, pcmArgs: pcmArgs,
+                              clangDependencyArtifacts: &clangDependencyArtifacts,
+                              swiftDependencyArtifacts: &swiftDependencyArtifacts)
     }
   }
 
@@ -370,6 +380,63 @@ public typealias ExternalTargetModuleDetailsMap = [ModuleDependencyId: ExternalT
                                           commandLine: &commandLine)
   }
 
+  /// Resolve all module dependencies of the main module and add them to the lists of
+  /// inputs and command line flags.
+  public mutating func resolveBridgingHeaderDependencies(inputs: inout [TypedVirtualPath],
+                                                         commandLine: inout [Job.ArgTemplate]) throws {
+    let mainModuleId: ModuleDependencyId = .swift(dependencyGraph.mainModuleName)
+    // Prohibit the frontend from implicitly building textual modules into binary modules.
+    commandLine.appendFlags("-disable-implicit-swift-modules",
+                            "-Xcc", "-fno-implicit-modules",
+                            "-Xcc", "-fno-implicit-module-maps")
+
+    var swiftDependencyArtifacts: [SwiftModuleArtifactInfo] = []
+    var clangDependencyArtifacts: [ClangModuleArtifactInfo] = []
+    let mainModuleDetails = try dependencyGraph.swiftModuleDetails(of: mainModuleId)
+
+    var addedDependencies: Set<ModuleDependencyId> = []
+    var dependenciesWorklist = mainModuleDetails.bridgingHeaderDependencies ?? []
+
+    while !dependenciesWorklist.isEmpty {
+      guard let bridgingHeaderDepID = dependenciesWorklist.popLast() else {
+        break
+      }
+      guard !addedDependencies.contains(bridgingHeaderDepID) else {
+        continue
+      }
+      addedDependencies.insert(bridgingHeaderDepID)
+      try addModuleDependency(of: mainModuleId, dependencyId: bridgingHeaderDepID, pcmArgs: [],
+                              clangDependencyArtifacts: &clangDependencyArtifacts,
+                              swiftDependencyArtifacts: &swiftDependencyArtifacts)
+      try addModuleDependencies(of: bridgingHeaderDepID, pcmArgs: [],
+                                clangDependencyArtifacts: &clangDependencyArtifacts,
+                                swiftDependencyArtifacts: &swiftDependencyArtifacts)
+      let depInfo = try dependencyGraph.moduleInfo(of: bridgingHeaderDepID)
+      dependenciesWorklist.append(contentsOf: depInfo.directDependencies ?? [])
+    }
+
+    // Clang module dependencies are specified on the command line explicitly
+    for moduleArtifactInfo in clangDependencyArtifacts {
+      let clangModulePath =
+        TypedVirtualPath(file: moduleArtifactInfo.clangModulePath.path,
+                         type: .pcm)
+      let clangModuleMapPath =
+        TypedVirtualPath(file: moduleArtifactInfo.clangModuleMapPath.path,
+                         type: .clangModuleMap)
+      inputs.append(clangModulePath)
+      inputs.append(clangModuleMapPath)
+    }
+
+    let dependencyFile =
+    try serializeModuleDependencies(for: mainModuleId,
+                                    swiftDependencyArtifacts: swiftDependencyArtifacts,
+                                    clangDependencyArtifacts: clangDependencyArtifacts)
+    commandLine.appendFlag("-explicit-swift-module-map-file")
+    commandLine.appendPath(dependencyFile)
+    inputs.append(TypedVirtualPath(file: dependencyFile.intern(),
+                                   type: .jsonSwiftArtifacts))
+  }
+
   /// Store the output file artifacts for a given module in a JSON file, return the file's path.
   private func serializeModuleDependencies(for moduleId: ModuleDependencyId,
                                            swiftDependencyArtifacts: [SwiftModuleArtifactInfo],

Sources/SwiftDriver/ExplicitModuleBuilds/InterModuleDependencies/InterModuleDependencyGraph.swift

@@ -97,6 +97,9 @@ public struct SwiftModuleDetails: Codable {
   /// The source files referenced by the bridging header.
   public var bridgingSourceFiles: [TextualVirtualPath]? = []
 
+  /// Modules that the bridging header specifically depends on
+  public var bridgingHeaderDependencies: [ModuleDependencyId]? = []
+
   /// Options to the compile command
   public var commandLine: [String]? = []
 

Sources/SwiftDriver/ExplicitModuleBuilds/ModuleDependencyScanning.swift

@@ -107,7 +107,7 @@ public extension Driver {
     commandLine.appendFlag("-frontend")
     commandLine.appendFlag("-scan-dependencies")
     try addCommonFrontendOptions(commandLine: &commandLine, inputs: &inputs,
-                                 bridgingHeaderHandling: .ignored,
+                                 bridgingHeaderHandling: .parsed,
                                  moduleDependencyGraphUse: .dependencyScan)
     // FIXME: MSVC runtime flags
 
@@ -337,7 +337,7 @@ public extension Driver {
     commandLine.appendFlag("-scan-dependencies")
     commandLine.appendFlag("-import-prescan")
     try addCommonFrontendOptions(commandLine: &commandLine, inputs: &inputs,
-                                 bridgingHeaderHandling: .ignored,
+                                 bridgingHeaderHandling: .parsed,
                                  moduleDependencyGraphUse: .dependencyScan)
     // FIXME: MSVC runtime flags
 

Sources/SwiftDriver/Jobs/FrontendJobHelpers.swift

@@ -53,7 +53,8 @@ extension Driver {
     commandLine: inout [Job.ArgTemplate],
     inputs: inout [TypedVirtualPath],
     bridgingHeaderHandling: BridgingHeaderHandling = .precompiled,
-    moduleDependencyGraphUse: ModuleDependencyGraphUse = .computed
+    moduleDependencyGraphUse: ModuleDependencyGraphUse = .computed,
+    isGeneratePCH: Bool = false
   ) throws {
     // Only pass -target to the REPL or immediate modes if it was explicitly
     // specified on the command line.
@@ -87,7 +88,11 @@ extension Driver {
     // May also be used for generation of the dependency graph itself in ExplicitModuleBuild mode.
     if (parsedOptions.contains(.driverExplicitModuleBuild) &&
           moduleDependencyGraphUse == .computed) {
-      try addExplicitModuleBuildArguments(inputs: &inputs, commandLine: &commandLine)
+      if isGeneratePCH {
+        try addExplicitPCHBuildArguments(inputs: &inputs, commandLine: &commandLine)
+      } else {
+        try addExplicitModuleBuildArguments(inputs: &inputs, commandLine: &commandLine)
+      }
     }
 
     if let variant = parsedOptions.getLastArgument(.targetVariant)?.asSingle {
@@ -579,6 +584,16 @@ extension Driver {
     try dependencyPlanner.resolveMainModuleDependencies(inputs: &inputs, commandLine: &commandLine)
   }
 
+  /// Adds all dependencies required for an explicit module build of the bridging header
+  /// to inputs and command line arguments of a compile job.
+  func addExplicitPCHBuildArguments(inputs: inout [TypedVirtualPath],
+                                    commandLine: inout [Job.ArgTemplate]) throws {
+    guard var dependencyPlanner = explicitDependencyBuildPlanner else {
+      fatalError("No dependency planner in Explicit Module Build mode.")
+    }
+    try dependencyPlanner.resolveBridgingHeaderDependencies(inputs: &inputs, commandLine: &commandLine)
+  }
+
   /// In Explicit Module Build mode, distinguish between main module jobs and intermediate dependency build jobs,
   /// such as Swift modules built from .swiftmodule files and Clang PCMs.
   public func isExplicitMainModuleJob(job: Job) -> Bool {

Sources/SwiftDriver/Jobs/GeneratePCHJob.swift

@@ -22,7 +22,7 @@ extension Driver {
     commandLine.appendFlag("-frontend")
 
     try addCommonFrontendOptions(
-      commandLine: &commandLine, inputs: &inputs, bridgingHeaderHandling: .parsed)
+      commandLine: &commandLine, inputs: &inputs, bridgingHeaderHandling: .parsed, isGeneratePCH: true)
 
     try commandLine.appendLast(.indexStorePath, from: &parsedOptions)
 

Sources/SwiftDriver/SwiftScan/DependencyGraphBuilder.swift

@@ -165,6 +165,9 @@ private extension SwiftScan {
     let bridgingSourceFiles =
       try getOptionalPathArrayDetail(from: moduleDetailsRef,
                                      using: api.swiftscan_swift_textual_detail_get_bridging_source_files)
+    let bridgingHeaderDependencies =
+      try getOptionalStringArrayDetail(from: moduleDetailsRef,
+                                       using: api.swiftscan_swift_textual_detail_get_bridging_module_dependencies)
     let commandLine =
       try getOptionalStringArrayDetail(from: moduleDetailsRef,
                                        using: api.swiftscan_swift_textual_detail_get_command_line)
@@ -181,6 +184,7 @@ private extension SwiftScan {
                               compiledModuleCandidates: compiledModuleCandidates,
                               bridgingHeaderPath: bridgingHeaderPath,
                               bridgingSourceFiles: bridgingSourceFiles,
+                              bridgingHeaderDependencies: bridgingHeaderDependencies?.map { .clang($0) },
                               commandLine: commandLine,
                               contextHash: contextHash,
                               extraPcmArgs: extraPcmArgs,

Tests/SwiftDriverTests/ExplicitModuleBuildTests.swift

@@ -269,6 +269,8 @@ final class ExplicitModuleBuildTests: XCTestCase {
       let cHeadersPath: AbsolutePath =
           testInputsPath.appending(component: "ExplicitModuleBuilds")
                         .appending(component: "CHeaders")
+      let bridgingHeaderpath: AbsolutePath =
+          cHeadersPath.appending(component: "Bridging.h")
       let swiftModuleInterfacesPath: AbsolutePath =
           testInputsPath.appending(component: "ExplicitModuleBuilds")
                         .appending(component: "Swift")
@@ -278,6 +280,7 @@ final class ExplicitModuleBuildTests: XCTestCase {
                                      "-I", cHeadersPath.nativePathString(escaped: true),
                                      "-I", swiftModuleInterfacesPath.nativePathString(escaped: true),
                                      "-explicit-module-build",
+                                     "-import-objc-header", bridgingHeaderpath.nativePathString(escaped: true),
                                      main.nativePathString(escaped: true)] + sdkArgumentsForTesting)
 
       let jobs = try driver.planBuild()
@@ -338,6 +341,10 @@ final class ExplicitModuleBuildTests: XCTestCase {
             try checkExplicitModuleBuildJob(job: job, moduleId: .clang("G"),
                                             dependencyGraph: dependencyGraph)
           }
+          else if relativeOutputPathFileName.starts(with: "F-") {
+            try checkExplicitModuleBuildJob(job: job, moduleId: .clang("F"),
+                                            dependencyGraph: dependencyGraph)
+          }
           else if relativeOutputPathFileName.starts(with: "SwiftShims-") {
             try checkExplicitModuleBuildJob(job: job, moduleId: .clang("SwiftShims"),
                                             dependencyGraph: dependencyGraph)
@@ -357,7 +364,8 @@ final class ExplicitModuleBuildTests: XCTestCase {
             case .temporary(_):
               let baseName = "testExplicitModuleBuildJobs"
               XCTAssertTrue(matchTemporary(outputFilePath, basename: baseName, fileExtension: "o") ||
-                            matchTemporary(outputFilePath, basename: baseName, fileExtension: "autolink"))
+                            matchTemporary(outputFilePath, basename: baseName, fileExtension: "autolink") ||
+                            matchTemporary(outputFilePath, basename: "Bridging-", fileExtension: "pch"))
             default:
               XCTFail("Unexpected module dependency build job output: \(outputFilePath)")
           }