[Explicit Module Builds] Refactor clang module dependency commandLine/input gathering to match swift

Author: artemcm

Sources/SwiftDriver/CMakeLists.txt

@@ -11,7 +11,7 @@ add_library(SwiftDriver
   "Explicit Module Builds/ExplicitModuleBuildHandler.swift"   
   "Explicit Module Builds/InterModuleDependencyGraph.swift"
   "Explicit Module Builds/ModuleDependencyScanning.swift"
-  "Explicit Module Builds/SwiftModuleArtifacts.swift"
+  "Explicit Module Builds/ModuleArtifacts.swift"
 
   Driver/CompilerMode.swift
   Driver/DebugInfo.swift

Sources/SwiftDriver/Explicit Module Builds/ExplicitModuleBuildHandler.swift

@@ -32,10 +32,14 @@ public struct ExplicitModuleBuildHandler {
   private let toolchain: Toolchain
 
   /// The file system which we should interact with.
+  /// FIXME: Our end goal is to not have any direct filesystem manipulation in here, but  that's dependent on getting the
+  /// dependency scanner/dependency job generation  moved into a Job.
   private let fileSystem: FileSystem
 
   /// Path to the directory that will contain the temporary files.
   /// e.g. Explicit Swift module artifact files
+  /// FIXME: Our end goal is to not have any direct filesystem manipulation in here, but  that's dependent on getting the
+  /// dependency scanner/dependency job generation  moved into a Job.
   private let temporaryDirectory: AbsolutePath
 
   public init(dependencyGraph: InterModuleDependencyGraph, toolchain: Toolchain,
@@ -236,43 +240,61 @@ public struct ExplicitModuleBuildHandler {
     commandLine.appendFlags("-disable-implicit-swift-modules", "-Xcc", "-Xclang", "-Xcc",
                             "-fno-implicit-modules")
     var swiftDependencyArtifacts: [SwiftModuleArtifactInfo] = []
-    try addModuleDependencies(moduleId: moduleId, pcmArgs: pcmArgs, inputs: &inputs,
-                              commandLine: &commandLine,
+    var clangDependencyArtifacts: [ClangModuleArtifactInfo] = []
+    try addModuleDependencies(moduleId: moduleId, pcmArgs: pcmArgs,
+                              clangDependencyArtifacts: &clangDependencyArtifacts,
                               swiftDependencyArtifacts: &swiftDependencyArtifacts)
 
+    // Swift Module dependencies are passed encoded in a JSON file as described by
+    // SwiftModuleArtifactInfo
     if !swiftDependencyArtifacts.isEmpty {
-      let dependencyFile = try serializeModuleDependencies(for: moduleId,
-                                                           dependencyArtifacts: swiftDependencyArtifacts)
+      let dependencyFile =
+        try serializeModuleDependencies(for: moduleId, dependencyArtifacts: swiftDependencyArtifacts)
       commandLine.appendFlag("-explicit-swift-module-map-file")
       commandLine.appendPath(dependencyFile)
       inputs.append(TypedVirtualPath(file: try VirtualPath(path: dependencyFile.pathString),
                                      type: .jsonSwiftArtifacts))
-      // Each individual moduel binary is still an "input" to ensure the build system gets the
+      // Each individual module binary is still an "input" to ensure the build system gets the
       // order correctly.
       for dependencyModule in swiftDependencyArtifacts {
         inputs.append(TypedVirtualPath(file: try VirtualPath(path: dependencyModule.modulePath),
                                        type: .swiftModule))
       }
     }
+    // Clang module depenencies are specified on the command line eplicitly
+    for moduleArtifactInfo in clangDependencyArtifacts {
+      let clangModulePath =
+        TypedVirtualPath(file: try VirtualPath(path: moduleArtifactInfo.modulePath),
+                         type: .pcm)
+      let clangModuleMapPath =
+        TypedVirtualPath(file: try VirtualPath(path: moduleArtifactInfo.moduleMapPath),
+                         type: .clangModuleMap)
+      commandLine.appendFlags("-Xcc", "-Xclang", "-Xcc",
+                              "-fmodule-file=\(clangModulePath.file.description)")
+      commandLine.appendFlags("-Xcc", "-Xclang", "-Xcc",
+                              "-fmodule-map-file=\(clangModuleMapPath.file.description)")
+      inputs.append(clangModulePath)
+      inputs.append(clangModuleMapPath)
+    }
   }
 
   /// Add a specific module dependency as an input and a corresponding command
   /// line flag. Dispatches to clang and swift-specific variants.
-  mutating private func addModuleDependencies(moduleId: ModuleDependencyId,
-                                              pcmArgs: [String],
-                                              inputs: inout [TypedVirtualPath],
-                                              commandLine: inout [Job.ArgTemplate],
+  mutating private func addModuleDependencies(moduleId: ModuleDependencyId, pcmArgs: [String],
+                                              clangDependencyArtifacts: inout [ClangModuleArtifactInfo],
                                               swiftDependencyArtifacts: inout [SwiftModuleArtifactInfo]
   ) throws {
     for dependencyId in try dependencyGraph.moduleInfo(of: moduleId).directDependencies {
       switch dependencyId {
         case .swift:
           try addSwiftModuleDependency(moduleId: moduleId, dependencyId: dependencyId,
-                                       pcmArgs: pcmArgs, inputs: &inputs, commandLine: &commandLine,
+                                       pcmArgs: pcmArgs,
+                                       clangDependencyArtifacts: &clangDependencyArtifacts,
                                        swiftDependencyArtifacts: &swiftDependencyArtifacts)
         case .clang:
           try addClangModuleDependency(moduleId: moduleId, dependencyId: dependencyId,
-                                       pcmArgs: pcmArgs, inputs: &inputs, commandLine: &commandLine,
+                                       pcmArgs: pcmArgs,
+                                       clangDependencyArtifacts: &clangDependencyArtifacts,
                                        swiftDependencyArtifacts: &swiftDependencyArtifacts)
       }
     }
@@ -285,8 +307,7 @@ public struct ExplicitModuleBuildHandler {
   mutating private func addSwiftModuleDependency(moduleId: ModuleDependencyId,
                                                  dependencyId: ModuleDependencyId,
                                                  pcmArgs: [String],
-                                                 inputs: inout [TypedVirtualPath],
-                                                 commandLine: inout [Job.ArgTemplate],
+                                                 clangDependencyArtifacts: inout [ClangModuleArtifactInfo],
                                                  swiftDependencyArtifacts: inout [SwiftModuleArtifactInfo]
   ) throws {
     // Generate a build job for the dependency module, if not already generated
@@ -300,15 +321,15 @@ public struct ExplicitModuleBuildHandler {
     let swiftModulePath = TypedVirtualPath(file: try VirtualPath(path: dependencyInfo.modulePath),
                                            type: .swiftModule)
 
-    // Collect the requried information about this module
+    // Collect the required information about this module
     // TODO: add .swiftdoc and .swiftsourceinfo for this module.
     swiftDependencyArtifacts.append(
       SwiftModuleArtifactInfo(name: dependencyId.moduleName,
                               modulePath: swiftModulePath.file.description))
 
     // Process all transitive dependencies as direct
     try addModuleDependencies(moduleId: dependencyId, pcmArgs: pcmArgs,
-                              inputs: &inputs, commandLine: &commandLine,
+                              clangDependencyArtifacts: &clangDependencyArtifacts,
                               swiftDependencyArtifacts: &swiftDependencyArtifacts)
   }
 
@@ -319,8 +340,7 @@ public struct ExplicitModuleBuildHandler {
   mutating private func addClangModuleDependency(moduleId: ModuleDependencyId,
                                                  dependencyId: ModuleDependencyId,
                                                  pcmArgs: [String],
-                                                 inputs: inout [TypedVirtualPath],
-                                                 commandLine: inout [Job.ArgTemplate],
+                                                 clangDependencyArtifacts: inout [ClangModuleArtifactInfo],
                                                  swiftDependencyArtifacts: inout [SwiftModuleArtifactInfo]
   ) throws {
     // Generate a build job for the dependency module at the given target, if not already generated
@@ -333,21 +353,17 @@ public struct ExplicitModuleBuildHandler {
     let dependencyInfo = try dependencyGraph.moduleInfo(of: dependencyId)
     let dependencyClangModuleDetails = try dependencyGraph.clangModuleDetails(of: dependencyId)
     let clangModulePath =
-      TypedVirtualPath(file: try ExplicitModuleBuildHandler.targetEncodedClangModuleFilePath(
-                        for: dependencyInfo, pcmArgs: pcmArgs), type: .pcm)
-    let clangModuleMapPath =
-      TypedVirtualPath(file: try VirtualPath(path: dependencyClangModuleDetails.moduleMapPath),
-                       type: .clangModuleMap)
-    commandLine.appendFlags("-Xcc", "-Xclang", "-Xcc",
-                            "-fmodule-map-file=\(clangModuleMapPath.file.description)")
-    commandLine.appendFlags("-Xcc", "-Xclang", "-Xcc",
-                            "-fmodule-file=\(clangModulePath.file.description)")
-    inputs.append(clangModulePath)
-    inputs.append(clangModuleMapPath)
+      try ExplicitModuleBuildHandler.targetEncodedClangModuleFilePath(for: dependencyInfo,
+                                                                      pcmArgs: pcmArgs)
+
+    // Collect the requried information about this module
+    clangDependencyArtifacts.append(
+      ClangModuleArtifactInfo(name: dependencyId.moduleName, modulePath: clangModulePath.description,
+                              moduleMapPath: dependencyClangModuleDetails.moduleMapPath))
 
     // Process all transitive dependencies as direct
     try addModuleDependencies(moduleId: dependencyId, pcmArgs: pcmArgs,
-                              inputs: &inputs, commandLine: &commandLine,
+                              clangDependencyArtifacts: &clangDependencyArtifacts,
                               swiftDependencyArtifacts: &swiftDependencyArtifacts)
   }
 }

Sources/SwiftDriver/Explicit Module Builds/SwiftModuleArtifacts.swift renamed to Sources/SwiftDriver/Explicit Module Builds/ModuleArtifacts.swift

@@ -33,3 +33,22 @@ public struct SwiftModuleArtifactInfo: Codable {
     self.sourceInfoPath = sourceInfoPath
   }
 }
+
+/// Describes a given Clang module's pre-built module artifacts:
+/// - Clang Module (name)
+/// - Clang Module (PCM) Path
+/// - Clang Module Map Path
+public struct ClangModuleArtifactInfo {
+  /// The module's name
+  public let moduleName: String
+  /// The path for the module's .pcm file
+  public let modulePath: String
+  /// The path for this module's .modulemap file
+  public let moduleMapPath: String
+
+  init(name: String, modulePath: String, moduleMapPath: String) {
+    self.moduleName = name
+    self.modulePath = modulePath
+    self.moduleMapPath = moduleMapPath
+  }
+}