llbuild: Support is-mutated/is-command-timestamp nodes (#7020)

Dependency of #7010.

Added per the llbuild documentation at https://github.com/apple/swift-llbuild/blob/a3b8d34be319f1b3ba8de53c434386419dec1f4f/docs/buildsystem.rst#L387 and a corresponding test at https://github.com/apple/swift-llbuild/blob/a3b8d34be319f1b3ba8de53c434386419dec1f4f/tests/BuildSystem/Build/mutable-outputs.llbuild#L66.

Newly introduced attributes are not used anywhere yet in this PR, so technically it is NFC.

I also took the opportunity to get rid of deprecated TSC dependencies in `ManifestWriter.swift`, replacing it with string interpolation instead.

Author: MaxDesiatov

Sources/Build/BuildManifest/LLBuildManifestBuilder+Swift.swift

@@ -17,7 +17,7 @@ import struct Basics.AbsolutePath
 import struct Basics.RelativePath
 import struct Basics.TSCAbsolutePath
 import struct LLBuildManifest.Node
-import struct LLBuildManifest.BuildManifest
+import struct LLBuildManifest.LLBuildManifest
 import struct SPMBuildCore.BuildParameters
 import class PackageGraph.ResolvedTarget
 import protocol TSCBasic.FileSystem

Sources/Build/BuildManifest/LLBuildManifestBuilder.swift

@@ -47,7 +47,7 @@ public class LLBuildManifestBuilder {
     /// ObservabilityScope with which to emit diagnostics
     public let observabilityScope: ObservabilityScope
 
-    public internal(set) var manifest: BuildManifest = .init()
+    public internal(set) var manifest: LLBuildManifest = .init()
 
     var buildConfig: String { self.buildParameters.configuration.dirname }
     var buildParameters: BuildParameters { self.plan.buildParameters }
@@ -73,7 +73,7 @@ public class LLBuildManifestBuilder {
 
     /// Generate manifest at the given path.
     @discardableResult
-    public func generateManifest(at path: AbsolutePath) throws -> BuildManifest {
+    public func generateManifest(at path: AbsolutePath) throws -> LLBuildManifest {
         self.swiftGetVersionFiles.removeAll()
 
         self.manifest.createTarget(TargetKind.main.targetName)
@@ -109,7 +109,7 @@ public class LLBuildManifestBuilder {
             try self.createProductCommand(description)
         }
 
-        try ManifestWriter(fileSystem: self.fileSystem).write(self.manifest, at: path)
+        try LLBuildManifestWriter.write(self.manifest, at: path, fileSystem: self.fileSystem)
         return self.manifest
     }
 

Sources/Build/BuildOperation.swift

@@ -164,7 +164,7 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
         }
     }
 
-    public func getBuildManifest() throws -> LLBuildManifest.BuildManifest {
+    public func getBuildManifest() throws -> LLBuildManifest {
         return try self.plan().manifest
     }
 
@@ -418,7 +418,7 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
     }
 
     /// Create the build plan and return the build description.
-    private func plan() throws -> (description: BuildDescription, manifest: LLBuildManifest.BuildManifest) {
+    private func plan() throws -> (description: BuildDescription, manifest: LLBuildManifest) {
         // Load the package graph.
         let graph = try getPackageGraph()
 
@@ -703,7 +703,7 @@ extension BuildOperation {
 }
 
 extension BuildDescription {
-    static func create(with plan: BuildPlan, disableSandboxForPluginCommands: Bool, fileSystem: Basics.FileSystem, observabilityScope: ObservabilityScope) throws -> (BuildDescription, LLBuildManifest.BuildManifest) {
+    static func create(with plan: BuildPlan, disableSandboxForPluginCommands: Bool, fileSystem: Basics.FileSystem, observabilityScope: ObservabilityScope) throws -> (BuildDescription, LLBuildManifest) {
         // Generate the llbuild manifest.
         let llbuild = LLBuildManifestBuilder(plan, disableSandboxForPluginCommands: disableSandboxForPluginCommands, fileSystem: fileSystem, observabilityScope: observabilityScope)
         let buildManifest = try llbuild.generateManifest(at: plan.buildParameters.llbuildManifest)

Sources/Build/BuildOperationBuildSystemDelegateHandler.swift

@@ -108,7 +108,7 @@ final class TestDiscoveryCommand: CustomLLBuildCommand, TestBuildCommand {
         try fileSystem.writeFileContents(path, string: content)
     }
 
-    private func execute(fileSystem: Basics.FileSystem, tool: LLBuildManifest.TestDiscoveryTool) throws {
+    private func execute(fileSystem: Basics.FileSystem, tool: TestDiscoveryTool) throws {
         let index = self.context.buildParameters.indexStore
         let api = try self.context.indexStoreAPI.get()
         let store = try IndexStore.open(store: TSCAbsolutePath(index), api: api)
@@ -120,7 +120,7 @@ final class TestDiscoveryCommand: CustomLLBuildCommand, TestBuildCommand {
         let testsByModule = Dictionary(grouping: tests, by: { $0.module.spm_mangledToC99ExtendedIdentifier() })
 
         func isMainFile(_ path: AbsolutePath) -> Bool {
-            path.basename == LLBuildManifest.TestDiscoveryTool.mainFileName
+            path.basename == TestDiscoveryTool.mainFileName
         }
 
         var maybeMainFile: AbsolutePath?
@@ -152,7 +152,7 @@ final class TestDiscoveryCommand: CustomLLBuildCommand, TestBuildCommand {
         }
 
         guard let mainFile = maybeMainFile else {
-            throw InternalError("main output (\(LLBuildManifest.TestDiscoveryTool.mainFileName)) not found")
+            throw InternalError("main output (\(TestDiscoveryTool.mainFileName)) not found")
         }
 
         let testsKeyword = tests.isEmpty ? "let" : "var"
@@ -200,7 +200,7 @@ final class TestDiscoveryCommand: CustomLLBuildCommand, TestBuildCommand {
 }
 
 final class TestEntryPointCommand: CustomLLBuildCommand, TestBuildCommand {
-    private func execute(fileSystem: Basics.FileSystem, tool: LLBuildManifest.TestEntryPointTool) throws {
+    private func execute(fileSystem: Basics.FileSystem, tool: TestEntryPointTool) throws {
         // Find the inputs, which are the names of the test discovery module(s)
         let inputs = tool.inputs.compactMap { try? AbsolutePath(validating: $0.name) }
         let discoveryModuleNames = inputs.map(\.basenameWithoutExt)
@@ -209,9 +209,9 @@ final class TestEntryPointCommand: CustomLLBuildCommand, TestBuildCommand {
 
         // Find the main output file
         guard let mainFile = outputs.first(where: { path in
-            path.basename == LLBuildManifest.TestEntryPointTool.mainFileName
+            path.basename == TestEntryPointTool.mainFileName
         }) else {
-            throw InternalError("main file output (\(LLBuildManifest.TestEntryPointTool.mainFileName)) not found")
+            throw InternalError("main file output (\(TestEntryPointTool.mainFileName)) not found")
         }
 
         let testObservabilitySetup: String
@@ -290,22 +290,22 @@ public struct BuildDescription: Codable {
     public typealias CommandLineFlag = String
 
     /// The Swift compiler invocation targets.
-    let swiftCommands: [BuildManifest.CmdName: SwiftCompilerTool]
+    let swiftCommands: [LLBuildManifest.CmdName: SwiftCompilerTool]
 
     /// The Swift compiler frontend invocation targets.
-    let swiftFrontendCommands: [BuildManifest.CmdName: SwiftFrontendTool]
+    let swiftFrontendCommands: [LLBuildManifest.CmdName: SwiftFrontendTool]
 
     /// The map of test discovery commands.
-    let testDiscoveryCommands: [BuildManifest.CmdName: LLBuildManifest.TestDiscoveryTool]
+    let testDiscoveryCommands: [LLBuildManifest.CmdName: TestDiscoveryTool]
 
     /// The map of test entry point commands.
-    let testEntryPointCommands: [BuildManifest.CmdName: LLBuildManifest.TestEntryPointTool]
+    let testEntryPointCommands: [LLBuildManifest.CmdName: TestEntryPointTool]
 
     /// The map of copy commands.
-    let copyCommands: [BuildManifest.CmdName: LLBuildManifest.CopyTool]
+    let copyCommands: [LLBuildManifest.CmdName: CopyTool]
 
     /// The map of write commands.
-    let writeCommands: [BuildManifest.CmdName: LLBuildManifest.WriteAuxiliaryFile]
+    let writeCommands: [LLBuildManifest.CmdName: WriteAuxiliaryFile]
 
     /// A flag that indicates this build should perform a check for whether targets only import
     /// their explicitly-declared dependencies
@@ -328,12 +328,12 @@ public struct BuildDescription: Codable {
 
     public init(
         plan: BuildPlan,
-        swiftCommands: [BuildManifest.CmdName: SwiftCompilerTool],
-        swiftFrontendCommands: [BuildManifest.CmdName: SwiftFrontendTool],
-        testDiscoveryCommands: [BuildManifest.CmdName: LLBuildManifest.TestDiscoveryTool],
-        testEntryPointCommands: [BuildManifest.CmdName: LLBuildManifest.TestEntryPointTool],
-        copyCommands: [BuildManifest.CmdName: LLBuildManifest.CopyTool],
-        writeCommands: [BuildManifest.CmdName: LLBuildManifest.WriteAuxiliaryFile],
+        swiftCommands: [LLBuildManifest.CmdName: SwiftCompilerTool],
+        swiftFrontendCommands: [LLBuildManifest.CmdName: SwiftFrontendTool],
+        testDiscoveryCommands: [LLBuildManifest.CmdName: TestDiscoveryTool],
+        testEntryPointCommands: [LLBuildManifest.CmdName: TestEntryPointTool],
+        copyCommands: [LLBuildManifest.CmdName: CopyTool],
+        writeCommands: [LLBuildManifest.CmdName: WriteAuxiliaryFile],
         pluginDescriptions: [PluginDescription]
     ) throws {
         self.swiftCommands = swiftCommands

Sources/Commands/Utilities/DOTManifestSerializer.swift

@@ -18,10 +18,10 @@ import protocol TSCBasic.OutputByteStream
 public struct DOTManifestSerializer {
     var kindCounter = [String: Int]()
     var hasEmittedStyling = Set<String>()
-    let manifest: LLBuildManifest.BuildManifest
+    let manifest: LLBuildManifest
 
     /// Creates a serializer that will serialize the given manifest.
-    public init(manifest: LLBuildManifest.BuildManifest) {
+    public init(manifest: LLBuildManifest) {
         self.manifest = manifest
     }
 

Sources/LLBuildManifest/CMakeLists.txt

@@ -7,9 +7,9 @@
 # See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 
 add_library(LLBuildManifest STATIC
-  BuildManifest.swift
   Command.swift
-  ManifestWriter.swift
+  LLBuildManifest.swift
+  LLBuildManifestWriter.swift
   Node.swift
   Target.swift
   Tools.swift)

Sources/LLBuildManifest/BuildManifest.swift renamed to Sources/LLBuildManifest/LLBuildManifest.swift

@@ -161,7 +161,7 @@ public enum WriteAuxiliary {
     }
 }
 
-public struct BuildManifest {
+public struct LLBuildManifest {
     public typealias TargetName = String
     public typealias CmdName = String