initial: known good

Author: donn

Package.swift

@@ -6,12 +6,13 @@ import PackageDescription
 let package = Package(
     name: "Fault",
     platforms: [
-        .macOS(.v13)  // Regex features only available in Ventura+
+        .macOS(.v13), // Regex features only available in Ventura+
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
         .package(
-            url: "https://github.com/apple/swift-collections.git", .upToNextMajor(from: "1.0.0")),
+            url: "https://github.com/apple/swift-collections.git", .upToNextMajor(from: "1.0.0")
+        ),
         .package(url: "https://github.com/pvieito/PythonKit", from: "0.5.0"),
         .package(url: "https://github.com/donn/Defile.git", from: "5.2.1"),
         .package(url: "https://github.com/attaswift/BigInt.git", from: "5.2.1"),
@@ -36,10 +37,10 @@ let package = Package(
             dependencies: [],
             path: "Sources/CThreadPool",
             sources: [
-                "thpool.c"
+                "thpool.c",
             ],
             cSettings: [
-                .headerSearchPath("Sources/CThreadPool/include")
+                .headerSearchPath("Sources/CThreadPool/include"),
             ]
         ),
     ]

Sources/Fault/Entries/asm.swift

@@ -13,31 +13,31 @@
 // limitations under the License.
 
 import ArgumentParser
+import BigInt
 import CoreFoundation
 import Defile
 import Foundation
 import PythonKit
-import BigInt
 
 extension Fault {
     struct Assemble: ParsableCommand {
         static let configuration = CommandConfiguration(
             commandName: "asm",
             abstract: "Assemble test vectors and golden outputs from JSON and Verilog files."
         )
-        
+
         @Option(name: [.customShort("o"), .long], help: "Path to the output vector file.")
         var output: String?
-        
+
         @Option(name: [.customShort("O"), .long], help: "Path to the golden output file.")
         var goldenOutput: String?
-        
+
         @Argument(help: "JSON file (.json).")
         var json: String
-        
+
         @Argument(help: "Verilog file (.v)")
         var verilog: String
-        
+
         mutating func run() throws {
             // Validate input files
             guard FileManager.default.fileExists(atPath: verilog) else {
@@ -46,52 +46,56 @@ extension Fault {
             guard FileManager.default.fileExists(atPath: json) else {
                 throw ValidationError("JSON file '\(json)' not found.")
             }
-            
+
             let vectorOutput = output ?? json.replacingExtension(".json", with: ".bin")
             let goldenOutput = goldenOutput ?? json.replacingExtension(".tv.json", with: ".au.bin")
-            
+
             print("Loading JSON data…")
             guard let data = try? Data(contentsOf: URL(fileURLWithPath: json)) else {
                 throw ValidationError("Failed to open test vector JSON file.")
             }
-            
+
             let decoder = JSONDecoder()
             guard let tvinfo = try? decoder.decode(TVInfo.self, from: data) else {
                 throw ValidationError("Test vector JSON file is invalid.")
             }
-            
+
             // Extract chain metadata
             let (chain, _, _) = ChainMetadata.extract(file: verilog)
-            
+
             let order = chain.filter { $0.kind != .output }.sorted { $0.ordinal < $1.ordinal }
             let outputOrder = chain.filter { $0.kind != .input }.sorted { $0.ordinal < $1.ordinal }
-            
+
             let jsInputOrder = tvinfo.inputs
             let jsOutputOrder = tvinfo.outputs
-            
+
             var inputMap: [String: Int] = [:]
             var outputMap: [String: Int] = [:]
-            
+
             // Check input order
             let chainOrder = order.filter { $0.kind != .bypassInput }
             guard chainOrder.count == jsInputOrder.count else {
-                throw ValidationError("Number of inputs in the test-vector JSON file (\(jsInputOrder.count)) does not match scan-chain registers (\(chainOrder.count)): Found \(Set(chainOrder.map { $0.name }).symmetricDifference(jsInputOrder.map { $0.name })).")
+                throw ValidationError(
+                    "Number of inputs in the test-vector JSON file (\(jsInputOrder.count)) does not match scan-chain registers (\(chainOrder.count)): Found \(Set(chainOrder.map(\.name)).symmetricDifference(jsInputOrder.map(\.name)))."
+                )
             }
-            
+
             for (i, input) in jsInputOrder.enumerated() {
                 let name = input.name.hasPrefix("\\") ? String(input.name.dropFirst()) : input.name
                 inputMap[name] = i
                 guard chainOrder[i].name == name else {
-                    throw ValidationError("Ordinal mismatch between TV input \(name) and scan-chain register \(chainOrder[i].name).")
+                    throw ValidationError(
+                        "Ordinal mismatch between TV input \(name) and scan-chain register \(chainOrder[i].name)."
+                    )
                 }
             }
-            
+
             for (i, output) in jsOutputOrder.enumerated() {
                 var name = output.name.hasPrefix("\\") ? String(output.name.dropFirst()) : output.name
                 name = name.hasSuffix(".d") ? String(name.dropLast(2)) : name
                 outputMap[name] = i
             }
-            
+
             var outputDecimal: [[BigUInt]] = []
             for tvcPair in tvinfo.coverageList {
                 guard let hex = BigUInt(tvcPair.goldenOutput, radix: 16) else {
@@ -105,13 +109,13 @@ extension Fault {
                 for output in jsOutputOrder {
                     let start = outputBinary.index(outputBinary.startIndex, offsetBy: pointer)
                     let end = outputBinary.index(start, offsetBy: output.width)
-                    let value = String(outputBinary[start..<end])
+                    let value = String(outputBinary[start ..< end])
                     list.append(BigUInt(value, radix: 2)!)
                     pointer += output.width
                 }
                 outputDecimal.append(list)
             }
-            
+
             var binFileVec = "// test-vector \n"
             var binFileOut = "// fault-free-response \n"
             for (i, tvcPair) in tvinfo.coverageList.enumerated() {
@@ -136,26 +140,29 @@ extension Fault {
                     } else if element.kind == .bypassOutput {
                         outputBinary += String(repeating: "x", count: element.width)
                     } else {
-                        throw ValidationError("Mismatch between output port \(element.name) and chained netlist.")
+                        throw ValidationError(
+                            "Mismatch between output port \(element.name) and chained netlist.")
                     }
                 }
                 binFileVec += binaryString + "\n"
                 binFileOut += outputBinary + " \n"
             }
-            
+
             let vectorCount = tvinfo.coverageList.count
             let vectorLength = order.reduce(0) { $0 + $1.width }
-            
+
             let vecMetadata = binMetadata(count: vectorCount, length: vectorLength)
-            let outMetadata = binMetadata(count: vectorCount, length: outputOrder.reduce(0) { $0 + $1.width })
-            
+            let outMetadata = binMetadata(
+                count: vectorCount, length: outputOrder.reduce(0) { $0 + $1.width }
+            )
+
             guard let vecMetadataString = vecMetadata.toJSON() else {
                 throw ValidationError("Could not generate metadata string.")
             }
             guard let outMetadataString = outMetadata.toJSON() else {
                 throw ValidationError("Could not generate metadata string.")
             }
-            
+
             try File.open(vectorOutput, mode: .write) {
                 try $0.print(String.boilerplate)
                 try $0.print("/* FAULT METADATA: '\(vecMetadataString)' END FAULT METADATA */")
@@ -166,7 +173,7 @@ extension Fault {
                 try $0.print("/* FAULT METADATA: '\(outMetadataString)' END FAULT METADATA */")
                 try $0.print(binFileOut, terminator: "")
             }
-            
+
             print("Test vectors and golden outputs assembled successfully.")
         }
     }