[Explicit Module Builds] Add an instance of InterModuleDependencyGraph to the DriverExecutorWorkload

For possible clients to have access to the full module dependnecies info.

Author: artemcm

Sources/SwiftDriver/Driver/Driver.swift

@@ -315,6 +315,10 @@ public struct Driver {
   /// Set during planning because needs the jobs to look at outputs.
   @_spi(Testing) public private(set) var incrementalCompilationState: IncrementalCompilationState? = nil
 
+  /// Nil if not running in explicit module build mode.
+  /// Set during planning.
+  var interModuleDependencyGraph: InterModuleDependencyGraph? = nil
+
   /// The path of the SDK.
   public var absoluteSDKPath: AbsolutePath? {
     guard let path = frontendTargetInfo.sdkPath?.path else {
@@ -1674,6 +1678,7 @@ extension Driver {
     try executor.execute(
       workload: .init(allJobs,
                       incrementalCompilationState,
+                      interModuleDependencyGraph,
                       continueBuildingAfterErrors: continueBuildingAfterErrors),
       delegate: jobExecutionDelegate,
       numParallelJobs: numParallelJobs ?? 1,

Sources/SwiftDriver/Execution/DriverExecutor.swift

@@ -29,6 +29,7 @@ public protocol DriverExecutor {
 
   /// Execute multiple jobs, tracking job status using the provided execution delegate.
   /// Pass in the `IncrementalCompilationState` to allow for incremental compilation.
+  /// Pass in the `InterModuleDependencyGraph` to allow for module dependency tracking.
   func execute(workload: DriverExecutorWorkload,
                delegate: JobExecutionDelegate,
                numParallelJobs: Int,
@@ -58,20 +59,24 @@ public struct DriverExecutorWorkload {
     case all([Job])
     case incremental(IncrementalCompilationState)
   }
+
   public let kind: Kind
+  public let interModuleDependencyGraph: InterModuleDependencyGraph?
 
   public init(_ allJobs: [Job],
-       _ incrementalCompilationState: IncrementalCompilationState?,
-       continueBuildingAfterErrors: Bool
-  ) {
-      self.continueBuildingAfterErrors = continueBuildingAfterErrors
-      self.kind = incrementalCompilationState
-        .map {.incremental($0)}
-        ?? .all(allJobs)
+              _ incrementalCompilationState: IncrementalCompilationState?,
+              _ interModuleDependencyGraph: InterModuleDependencyGraph?,
+              continueBuildingAfterErrors: Bool) {
+    self.continueBuildingAfterErrors = continueBuildingAfterErrors
+    self.kind = incrementalCompilationState
+      .map {.incremental($0)}
+      ?? .all(allJobs)
+    self.interModuleDependencyGraph = interModuleDependencyGraph
   }
 
-  static public func all(_ jobs: [Job]) -> Self {
-    .init(jobs, nil, continueBuildingAfterErrors: false)
+  static public func all(_ jobs: [Job],
+                         _ interModuleDependencyGraph: InterModuleDependencyGraph? = nil) -> Self {
+    .init(jobs, nil, interModuleDependencyGraph, continueBuildingAfterErrors: false)
   }
 }
 
@@ -114,7 +119,7 @@ extension DriverExecutor {
     recordedInputModificationDates: [TypedVirtualPath: TimePoint]
   ) throws {
     try execute(
-      workload: .all(jobs),
+      workload: .all(jobs, nil),
       delegate: delegate,
       numParallelJobs: numParallelJobs,
       forceResponseFiles: forceResponseFiles,

Sources/SwiftDriver/IncrementalCompilation/IncrementalCompilationState.swift

@@ -53,8 +53,7 @@ public final class IncrementalCompilationState {
   internal init(
     driver: inout Driver,
     jobsInPhases: JobsInPhases,
-    initialState: InitialStateForPlanning,
-    interModuleDependencyGraph: InterModuleDependencyGraph?
+    initialState: InitialStateForPlanning
   ) throws {
     let reporter = initialState.incrementalOptions.contains(.showIncremental)
       ? Reporter(diagnosticEngine: driver.diagnosticEngine,
@@ -68,12 +67,12 @@ public final class IncrementalCompilationState {
       initialState: initialState,
       jobsInPhases: jobsInPhases,
       driver: driver,
-      interModuleDependencyGraph: interModuleDependencyGraph,
+      interModuleDependencyGraph: driver.interModuleDependencyGraph,
       reporter: reporter)
       .compute(batchJobFormer: &driver)
 
     self.info = initialState.graph.info
-    self.upToDateInterModuleDependencyGraph = interModuleDependencyGraph
+    self.upToDateInterModuleDependencyGraph = driver.interModuleDependencyGraph
     self.protectedState = ProtectedState(
       skippedCompileGroups: firstWave.initiallySkippedCompileGroups,
       initialState.graph,

Sources/SwiftDriver/Jobs/Planning.swift

@@ -103,7 +103,7 @@ extension Driver {
       try IncrementalCompilationState.computeIncrementalStateForPlanning(driver: &self)
 
     // For an explicit build, compute the inter-module dependency graph
-    let interModuleDependencyGraph = try computeInterModuleDependencyGraph(with: initialIncrementalState)
+    interModuleDependencyGraph = try computeInterModuleDependencyGraph(with: initialIncrementalState)
 
     // Compute the set of all jobs required to build this module
     let jobsInPhases = try computeJobsForPhasedStandardBuild(with: interModuleDependencyGraph)
@@ -115,8 +115,7 @@ extension Driver {
       incrementalCompilationState =
         try IncrementalCompilationState(driver: &self,
                                         jobsInPhases: jobsInPhases,
-                                        initialState: initialState,
-                                        interModuleDependencyGraph: interModuleDependencyGraph)
+                                        initialState: initialState)
     } else {
       incrementalCompilationState = nil
     }
@@ -139,19 +138,17 @@ extension Driver {
   private mutating func computeInterModuleDependencyGraph(with initialIncrementalState:
                                                           IncrementalCompilationState.InitialStateForPlanning?)
   throws -> InterModuleDependencyGraph? {
-    let interModuleDependencyGraph: InterModuleDependencyGraph?
     if (parsedOptions.contains(.driverExplicitModuleBuild) ||
         parsedOptions.contains(.explainModuleDependency)) &&
        inputFiles.contains(where: { $0.type.isPartOfSwiftCompilation }) {
       // If the incremental build record's module dependency graph is up-to-date, we
       // can skip dependency scanning entirely.
-      interModuleDependencyGraph =
+      return
         try initialIncrementalState?.upToDatePriorInterModuleDependencyGraph ??
             gatherModuleDependencies()
     } else {
-      interModuleDependencyGraph = nil
+      return nil
     }
-    return interModuleDependencyGraph
   }
 
   /// Construct a build plan consisting of *all* jobs required for building the current module (non-incrementally).

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

@@ -181,7 +181,7 @@ do {
       }
     }
     do {
-      try executor.execute(workload: DriverExecutorWorkload.init(jobs, nil, continueBuildingAfterErrors: true),
+      try executor.execute(workload: DriverExecutorWorkload.init(jobs, nil, nil, continueBuildingAfterErrors: true),
                            delegate: delegate, numParallelJobs: 128)
     } catch {
       // Only fail when critical failures happened.
@@ -191,7 +191,7 @@ do {
     }
     do {
       if !danglingJobs.isEmpty && delegate.shouldRunDanglingJobs {
-        try executor.execute(workload: DriverExecutorWorkload.init(danglingJobs, nil, continueBuildingAfterErrors: true), delegate: delegate, numParallelJobs: 128)
+        try executor.execute(workload: DriverExecutorWorkload.init(danglingJobs, nil, nil, continueBuildingAfterErrors: true), delegate: delegate, numParallelJobs: 128)
       }
     } catch {
       // Failing of dangling jobs don't fail the process.