fixup: share code between perf and analysis instrument

Author: not-matthias

src/instruments/analysis.zig

@@ -1,55 +1,6 @@
-const std = @import("std");
-const runner_fifo = @import("../runner_fifo.zig");
 const shared = @import("../shared.zig");
+const helper = @import("helper.zig");
 
-pub const AnalysisInstrument = struct {
-    fifo: runner_fifo.RunnerFifo,
+const AnalysisError = error{ModeError};
 
-    const Self = @This();
-
-    pub fn init(allocator: std.mem.Allocator) !Self {
-        var fifo = try runner_fifo.RunnerFifo.init(allocator);
-
-        // Get the instrumentation mode from the runner
-        const mode = fifo.get_integration_mode() catch |err| {
-            fifo.deinit();
-            return err;
-        };
-
-        // Only accept if the runner is in Analysis mode
-        if (mode != .Analysis) {
-            fifo.deinit();
-            return error.NotAnalysisMode;
-        }
-
-        return Self{ .fifo = fifo };
-    }
-
-    pub fn deinit(self: *Self) void {
-        self.fifo.deinit();
-    }
-
-    pub fn send_version(self: *Self, protocol_version: u64) !void {
-        try self.fifo.send_version(protocol_version);
-    }
-
-    pub fn start_benchmark(self: *Self) !void {
-        try self.fifo.start_benchmark();
-    }
-
-    pub fn stop_benchmark(self: *Self) !void {
-        try self.fifo.stop_benchmark();
-    }
-
-    pub fn set_executed_benchmark(self: *Self, pid: u32, uri: [*c]const u8) !void {
-        try self.fifo.set_executed_benchmark(pid, uri);
-    }
-
-    pub fn set_integration(self: *Self, name: [*c]const u8, version: [*c]const u8) !void {
-        try self.fifo.set_integration(name, version);
-    }
-
-    pub fn add_marker(self: *Self, pid: u32, marker: shared.MarkerType) !void {
-        try self.fifo.add_marker(pid, marker);
-    }
-};
+pub const AnalysisInstrument = helper.FifoInstrument(.Analysis, AnalysisError);

src/instruments/helper.zig

@@ -0,0 +1,58 @@
+const std = @import("std");
+const runner_fifo = @import("../runner_fifo.zig");
+const shared = @import("../shared.zig");
+
+/// Creates a complete FIFO-based instrument struct that validates a specific integration mode
+pub fn FifoInstrument(comptime mode: shared.IntegrationMode, comptime error_type: anytype) type {
+    return struct {
+        fifo: runner_fifo.RunnerFifo,
+
+        const Self = @This();
+
+        pub fn init(allocator: std.mem.Allocator) !Self {
+            var fifo = try runner_fifo.RunnerFifo.init(allocator);
+
+            // Get the instrumentation mode from the runner
+            const detected_mode = fifo.get_integration_mode() catch |err| {
+                fifo.deinit();
+                return err;
+            };
+
+            // Only accept if the runner is in the correct mode
+            if (detected_mode != mode) {
+                fifo.deinit();
+                return error_type.ModeError;
+            }
+
+            return Self{ .fifo = fifo };
+        }
+
+        pub fn deinit(self: *Self) void {
+            self.fifo.deinit();
+        }
+
+        pub fn send_version(self: *Self, protocol_version: u64) !void {
+            try self.fifo.send_version(protocol_version);
+        }
+
+        pub fn start_benchmark(self: *Self) !void {
+            try self.fifo.start_benchmark();
+        }
+
+        pub fn stop_benchmark(self: *Self) !void {
+            try self.fifo.stop_benchmark();
+        }
+
+        pub fn set_executed_benchmark(self: *Self, pid: u32, uri: [*c]const u8) !void {
+            try self.fifo.set_executed_benchmark(pid, uri);
+        }
+
+        pub fn set_integration(self: *Self, name: [*c]const u8, version: [*c]const u8) !void {
+            try self.fifo.set_integration(name, version);
+        }
+
+        pub fn add_marker(self: *Self, pid: u32, marker: shared.MarkerType) !void {
+            try self.fifo.add_marker(pid, marker);
+        }
+    };
+}

src/instruments/perf.zig

@@ -1,55 +1,6 @@
-const std = @import("std");
-const runner_fifo = @import("../runner_fifo.zig");
 const shared = @import("../shared.zig");
+const helper = @import("helper.zig");
 
-pub const PerfInstrument = struct {
-    fifo: runner_fifo.RunnerFifo,
+const PerfError = error{ModeError};
 
-    const Self = @This();
-
-    pub fn init(allocator: std.mem.Allocator) !Self {
-        var fifo = try runner_fifo.RunnerFifo.init(allocator);
-
-        // Get the instrumentation mode from the runner
-        const mode = fifo.get_integration_mode() catch |err| {
-            fifo.deinit();
-            return err;
-        };
-
-        // Only accept if the runner is in Perf mode
-        if (mode != .Perf) {
-            fifo.deinit();
-            return error.NotPerfMode;
-        }
-
-        return Self{ .fifo = fifo };
-    }
-
-    pub fn deinit(self: *Self) void {
-        self.fifo.deinit();
-    }
-
-    pub fn send_version(self: *Self, protocol_version: u64) !void {
-        try self.fifo.send_version(protocol_version);
-    }
-
-    pub fn start_benchmark(self: *Self) !void {
-        try self.fifo.start_benchmark();
-    }
-
-    pub fn stop_benchmark(self: *Self) !void {
-        try self.fifo.stop_benchmark();
-    }
-
-    pub fn set_executed_benchmark(self: *Self, pid: u32, uri: [*c]const u8) !void {
-        try self.fifo.set_executed_benchmark(pid, uri);
-    }
-
-    pub fn set_integration(self: *Self, name: [*c]const u8, version: [*c]const u8) !void {
-        try self.fifo.set_integration(name, version);
-    }
-
-    pub fn add_marker(self: *Self, pid: u32, marker: shared.MarkerType) !void {
-        try self.fifo.add_marker(pid, marker);
-    }
-};
+pub const PerfInstrument = helper.FifoInstrument(.Perf, PerfError);

src/instruments/root.zig

@@ -7,6 +7,8 @@ const ValgrindInstrument = valgrind.ValgrindInstrument;
 const PerfInstrument = perf.PerfInstrument;
 const AnalysisInstrument = analysis.AnalysisInstrument;
 
+// TODO: Should we merge perf and analysis? -> Could just be a FifoInstrument
+
 pub const InstrumentHooks = union(enum) {
     valgrind: ValgrindInstrument,
     perf: PerfInstrument,