feat: Implemented SIMD version of poseidon2 (#29)

Author: ch4r10t33r

.github/workflows/performance-benchmark.yml

@@ -27,20 +27,30 @@ jobs:
       - name: Verify Zig installation
         run: zig version
 
+      - name: Setup Zig cache directory
+        run: |
+          mkdir -p ~/.cache/zig
+          chmod 755 ~/.cache/zig
+          echo "Zig cache directory created and permissions set"
+      
       - name: Build current version
         run: |
+          echo "Building current version..."
           zig build -Doptimize=ReleaseFast
           echo "Current version built successfully"
+          ls -la zig-out/bin/ || echo "No binary output directory found"
       
       - name: Benchmark current version
         id: current_benchmark
         run: |
           echo "Running performance benchmark for current version..."
-          if zig build benchmark -Doptimize=ReleaseFast; then
+          if zig build simd-benchmark -Doptimize=ReleaseFast; then
+            ./zig-out/bin/hash-zig-simd-benchmark > current_results.txt 2>&1
+          elif zig build benchmark -Doptimize=ReleaseFast; then
             ./zig-out/bin/hash-zig-benchmark > current_results.txt 2>&1
           elif [ -f scripts/benchmark.zig ]; then
-            echo "No 'benchmark' build step; compiling scripts/benchmark.zig directly"
-            zig build-exe scripts/benchmark.zig -OReleaseFast --dep hash-zig -Mhash-zig=src/root.zig -obenchmark_current
+            echo "No benchmark build step; compiling scripts/benchmark.zig directly"
+            zig build-exe scripts/benchmark.zig -OReleaseFast --dep hash-zig -Mhash-zig=src/root.zig --name benchmark_current
             ./benchmark_current > current_results.txt 2>&1
           else
             echo "No benchmark target or script found; skipping current metrics"
@@ -89,20 +99,30 @@ jobs:
           git checkout ${{ steps.base_commit.outputs.base_sha }}
           echo "Checked out base version"
       
+      - name: Setup Zig cache directory (base)
+        run: |
+          mkdir -p ~/.cache/zig
+          chmod 755 ~/.cache/zig
+          echo "Zig cache directory created and permissions set for base version"
+      
       - name: Build base version
         run: |
+          echo "Building base version..."
           zig build -Doptimize=ReleaseFast
           echo "Base version built successfully"
+          ls -la zig-out/bin/ || echo "No binary output directory found"
       
       - name: Benchmark base version
         id: base_benchmark
         run: |
           echo "Running performance benchmark for base version..."
-          if zig build benchmark -Doptimize=ReleaseFast; then
+          if zig build simd-benchmark -Doptimize=ReleaseFast; then
+            ./zig-out/bin/hash-zig-simd-benchmark > base_results.txt 2>&1
+          elif zig build benchmark -Doptimize=ReleaseFast; then
             ./zig-out/bin/hash-zig-benchmark > base_results.txt 2>&1
           elif [ -f scripts/benchmark.zig ]; then
-            echo "No 'benchmark' build step on base; compiling scripts/benchmark.zig directly"
-            zig build-exe scripts/benchmark.zig -OReleaseFast --dep hash-zig -Mhash-zig=src/root.zig -obenchmark_base
+            echo "No benchmark build step on base; compiling scripts/benchmark.zig directly"
+            zig build-exe scripts/benchmark.zig -OReleaseFast --dep hash-zig -Mhash-zig=src/root.zig --name benchmark_base
             ./benchmark_base > base_results.txt 2>&1
           else
             echo "No benchmark target or script found on base; skipping base metrics"

build.zig

@@ -101,6 +101,59 @@ pub fn build(b: *std.Build) void {
     const benchmark_step = b.step("benchmark", "Run performance benchmark");
     benchmark_step.dependOn(&run_benchmark.step);
 
+    // Add SIMD modules
+    const simd_winternitz_module = b.addModule("simd_winternitz", .{
+        .root_source_file = b.path("src/simd_winternitz.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const simd_poseidon2_module = b.addModule("simd_poseidon2", .{
+        .root_source_file = b.path("src/poseidon2/simd_poseidon2.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const simd_montgomery_module = b.addModule("simd_montgomery", .{
+        .root_source_file = b.path("src/poseidon2/fields/koalabear/simd_montgomery.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const simd_signature_module = b.addModule("simd_signature", .{
+        .root_source_file = b.path("src/simd_signature.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    // Set up module dependencies
+    simd_signature_module.addImport("simd_winternitz", simd_winternitz_module);
+    simd_signature_module.addImport("simd_poseidon2", simd_poseidon2_module);
+    simd_signature_module.addImport("params", hash_zig_module);
+
+    simd_winternitz_module.addImport("simd_montgomery", simd_montgomery_module);
+    simd_winternitz_module.addImport("simd_poseidon2", simd_poseidon2_module);
+
+    simd_poseidon2_module.addImport("simd_montgomery", simd_montgomery_module);
+
+    // SIMD benchmark executable
+    const simd_benchmark = b.addExecutable(.{
+        .name = "hash-zig-simd-benchmark",
+        .root_source_file = b.path("examples/simd_benchmark.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+    simd_benchmark.root_module.addImport("hash-zig", hash_zig_module);
+    simd_benchmark.root_module.addImport("simd_signature", simd_signature_module);
+    simd_benchmark.root_module.addImport("simd_winternitz", simd_winternitz_module);
+    simd_benchmark.root_module.addImport("simd_poseidon2", simd_poseidon2_module);
+    simd_benchmark.root_module.addImport("simd_montgomery", simd_montgomery_module);
+    b.installArtifact(simd_benchmark);
+
+    const run_simd_benchmark = b.addRunArtifact(simd_benchmark);
+    const simd_benchmark_step = b.step("simd-benchmark", "Run SIMD performance benchmark");
+    simd_benchmark_step.dependOn(&run_simd_benchmark.step);
+
     // Optimized benchmark executable (commented out for now)
     // const optimized_benchmark_module = b.createModule(.{
     //     .root_source_file = b.path("examples/optimized_benchmark.zig"),
@@ -124,16 +177,12 @@ pub fn build(b: *std.Build) void {
     // const optimized_benchmark_step = b.step("optimized-benchmark", "Run optimized performance benchmark");
     // optimized_benchmark_step.dependOn(&run_optimized_benchmark.step);
 
-    // Documentation (separate from main library build)
-    const docs_obj = b.addObject(.{
-        .name = "hash-zig-docs",
-        .root_module = hash_zig_module,
-    });
+    // Documentation
+    const docs_step = b.step("docs", "Generate documentation");
     const install_docs = b.addInstallDirectory(.{
-        .source_dir = docs_obj.getEmittedDocs(),
+        .source_dir = lib.getEmittedDocs(),
         .install_dir = .prefix,
         .install_subdir = "docs",
     });
-    const docs_step = b.step("docs", "Generate documentation");
     docs_step.dependOn(&install_docs.step);
 }

examples/basic_usage.zig

@@ -5,8 +5,8 @@ const hash_sig = @import("hash-zig");
 
 pub fn main() !void {
     // zlinter-disable-next-line no_deprecated - Standard allocator pattern for examples
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer _ = gpa.deinit();
+    var gpa = std.heap.ArenaAllocator.init(std.heap.page_allocator);
+    defer gpa.deinit();
     const allocator = gpa.allocator();
 
     std.debug.print("Hash-Sig Example\n", .{});

examples/optimized_benchmark.zig

@@ -4,8 +4,8 @@ const optimized_signature = @import("optimized_signature");
 const params = hash_zig.params;
 
 pub fn main() !void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
-    defer _ = gpa.deinit();
+    var gpa = std.heap.ArenaAllocator.init(std.heap.page_allocator);
+    defer gpa.deinit();
     const allocator = gpa.allocator();
 
     std.debug.print("Optimized Hash-Zig Performance Benchmark\n", .{});