refactor(hw/sim): extract common cocotb make infrastructure into shared mk/ directory

- Split monolithic hw/sim/Makefile into modular include files (mk/cocotb-common.mk, mk/rtl-sources.mk)
- Add per-module test Makefiles (cam_core_banked, cam_read_noise, cam_write_noise, match_engine_pipeline, perf, top)
- Add missing simulation tools (yosys, graphviz, xdot) to devenv.nix
- Fix path handling in sweep_noise.py and test modules to be HASH_BITS-aware

devenv.nix

@@ -4,20 +4,26 @@
   config,
   inputs,
   ...
-}: let
+}:
+let
   pkgs-nixgl =
     (import inputs.nixpkgs {
       system = pkgs.stdenv.hostPlatform.system;
       config.allowUnfree = true;
       overlays = [ inputs.nixgl.overlay ];
-    }).nixgl.override {
+    }).nixgl.override
+      {
         nvidiaVersionFile = "/proc/driver/nvidia/version";
         nvidiaVersion = "580.126.09";
       };
-in {
+in
+{
   packages = with pkgs; [
     nil
     verilator
+    yosys
+    graphviz
+    xdot
   ];
 
   enterShell = ''

hw/sim/Makefile

@@ -1,90 +1,41 @@
-SIM ?= verilator
+MODULE_TESTS := cam_core_banked match_engine_pipeline cam_write_noise cam_read_noise
-TOPLEVEL_LANG ?= verilog
-TOPLEVEL ?= cam_top
 
-COCOTB_TEST_MODULES ?= tests.test_cam_basic
+.PHONY: help test-all test-top test-modules test-module test-model test-perf clean $(MODULE_TESTS:%=test-module-%)
 
-NUM_ROWS ?= 4096
+help:
-HASH_BITS ?= 512
+	@echo "Available hw/sim targets:"
-LANES ?= 8
+	@echo "  make test-model"
+	@echo "  make test-top"
+	@echo "  make test-module MODULE=cam_core_banked"
+	@echo "  make test-modules"
+	@echo "  make test-perf"
+	@echo "  make test-all"
+	@echo "  make clean"
 
-EXTRA_ARGS += +define+NUM_ROWS=$(NUM_ROWS) +define+HASH_BITS=$(HASH_BITS) +define+LANES=$(LANES)
+test-all: test-model test-top test-modules
 
-COMPILE_ARGS += -Wall -Wno-fatal
+test-top:
-COMPILE_ARGS += -I$(PWD)/../rtl -I$(PWD)/../rtl/core -I$(PWD)/../rtl/noise
+	$(MAKE) -C tests/top
-COMPILE_ARGS += +define+SIM_DEBUG
-COMPILE_ARGS += $(EXTRA_DEFINES)
 
-# Noise parameters — only passed when explicitly set (non-empty).
+test-modules: $(MODULE_TESTS:%=test-module-%)
-# For cam_noisy/cam_top tests, pass WRITE_NOISE_*=... READ_NOISE_*=...
-# For individual module tests, leave them unset to skip.
-WRITE_NOISE_EN          ?= $(NOISE_EN)
-WRITE_NOISE_RATE_NUM    ?= $(NOISE_RATE_NUM)
-WRITE_NOISE_RATE_DEN    ?= $(NOISE_RATE_DEN)
-WRITE_NOISE_BITS        ?= $(NOISE_BITS)
-READ_NOISE_EN           ?=
-READ_NOISE_RATE_NUM     ?=
-READ_NOISE_RATE_DEN     ?=
-READ_NOISE_BITS         ?=
 
-# Perf-test compatibility override: when running cam_perf, force deterministic
+test-module:
-# noise parameters so noise_mask_grouped.sv elaborates correctly for perf
+	@test -n "$(MODULE)" || (echo "Usage: make test-module MODULE=<name>"; exit 2)
-# sweep HASH_BITS values (64, 128, 192, 256, 320, 384, 448, 512 — all
+	$(MAKE) -C tests/modules/$(MODULE)
-# divisible by 64 such that HASH_BITS / NOISE_BITS == 64 in the RTL).
-# This is a testbench parameter, not a hardware performance/resource claim.
-ifeq ($(COCOTB_TEST_MODULES),tests.test_cam_perf)
-WRITE_NOISE_EN      := 0
-READ_NOISE_EN       := 0
-WRITE_NOISE_BITS    := $(shell echo $$(( $(HASH_BITS) / 64 )))
-READ_NOISE_BITS     := $(shell echo $$(( $(HASH_BITS) / 64 )))
-endif
 
-ifneq ($(strip $(WRITE_NOISE_EN)),)
+$(MODULE_TESTS:%=test-module-%):
-COMPILE_ARGS += -GWRITE_NOISE_EN=$(WRITE_NOISE_EN)
+	$(MAKE) -C tests/modules/$(@:test-module-%=%)
-endif
-ifneq ($(strip $(WRITE_NOISE_RATE_NUM)),)
-COMPILE_ARGS += -GWRITE_NOISE_RATE_NUM=$(WRITE_NOISE_RATE_NUM)
-endif
-ifneq ($(strip $(WRITE_NOISE_RATE_DEN)),)
-COMPILE_ARGS += -GWRITE_NOISE_RATE_DEN=$(WRITE_NOISE_RATE_DEN)
-endif
-ifneq ($(strip $(WRITE_NOISE_BITS)),)
-COMPILE_ARGS += -GWRITE_NOISE_BITS=$(WRITE_NOISE_BITS)
-endif
-ifneq ($(strip $(READ_NOISE_EN)),)
-COMPILE_ARGS += -GREAD_NOISE_EN=$(READ_NOISE_EN)
-endif
-ifneq ($(strip $(READ_NOISE_RATE_NUM)),)
-COMPILE_ARGS += -GREAD_NOISE_RATE_NUM=$(READ_NOISE_RATE_NUM)
-endif
-ifneq ($(strip $(READ_NOISE_RATE_DEN)),)
-COMPILE_ARGS += -GREAD_NOISE_RATE_DEN=$(READ_NOISE_RATE_DEN)
-endif
-ifneq ($(strip $(READ_NOISE_BITS)),)
-COMPILE_ARGS += -GREAD_NOISE_BITS=$(READ_NOISE_BITS)
-endif
 
-# Cleaner terminal output
+test-model:
-export QUIET ?= 1
+	uv run pytest tests/model -q
-export VERBOSE ?= 0
-export COCOTB_LOG_LEVEL ?= INFO
-export PYTHONWARNINGS ?= ignore::pytest.PytestDeprecationWarning
 
-# Optional temporary suppression
+test-perf:
-SUPPRESS_VERILATOR_WARNINGS ?= 0
+	$(MAKE) -C tests/perf
-ifeq ($(SUPPRESS_VERILATOR_WARNINGS),1)
-COMPILE_ARGS += -Wno-WIDTHEXPAND
-COMPILE_ARGS += -Wno-UNOPTFLAT
-endif
 
-VERILOG_SOURCES += $(PWD)/../rtl/random/random128.sv
+clean:
-VERILOG_SOURCES += $(PWD)/../rtl/noise/noise_mask_grouped.sv
+	$(MAKE) -C tests/top clean
-VERILOG_SOURCES += $(PWD)/../rtl/core/cam_core_banked.sv
+	@for module in $(MODULE_TESTS); do \
-VERILOG_SOURCES += $(PWD)/../rtl/noise/cam_write_noise.sv
+		$(MAKE) -C tests/modules/$$module clean || exit $$?; \
-VERILOG_SOURCES += $(PWD)/../rtl/noise/cam_read_noise.sv
+	done
-VERILOG_SOURCES += $(PWD)/../rtl/core/popcount_pipeline.sv
+	$(MAKE) -C tests/perf clean
-VERILOG_SOURCES += $(PWD)/../rtl/core/match_engine_pipeline.sv
+	rm -rf .pytest_cache tests/model/.pytest_cache
-VERILOG_SOURCES += $(PWD)/../rtl/cam_noisy.sv
-VERILOG_SOURCES += $(PWD)/../rtl/cam_top.sv
-
-include $(shell uv run cocotb-config --makefiles)/Makefile.sim

hw/sim/mk/cocotb-common.mk

@@ -0,0 +1,82 @@
+ifndef SIM_ROOT
+$(error SIM_ROOT must be set before including mk/cocotb-common.mk)
+endif
+
+ifndef RTL_ROOT
+$(error RTL_ROOT must be set before including mk/cocotb-common.mk)
+endif
+
+ifndef TOPLEVEL
+$(error TOPLEVEL must be set before including mk/cocotb-common.mk)
+endif
+
+ifndef COCOTB_TEST_MODULES
+$(error COCOTB_TEST_MODULES must be set before including mk/cocotb-common.mk)
+endif
+
+ifndef VERILOG_SOURCES
+$(error VERILOG_SOURCES must be set before including mk/cocotb-common.mk)
+endif
+
+SIM ?= verilator
+TOPLEVEL_LANG ?= verilog
+
+NUM_ROWS ?= 4096
+HASH_BITS ?= 512
+LANES ?= 8
+
+EXTRA_ARGS += +define+NUM_ROWS=$(NUM_ROWS) +define+HASH_BITS=$(HASH_BITS) +define+LANES=$(LANES)
+EXTRA_ARGS += --trace --trace-fst --trace-structs
+
+COMPILE_ARGS += -Wall -Wno-fatal
+COMPILE_ARGS += -I$(RTL_ROOT) -I$(RTL_ROOT)/core -I$(RTL_ROOT)/noise -I$(RTL_ROOT)/random
+COMPILE_ARGS += +define+SIM_DEBUG
+COMPILE_ARGS += $(EXTRA_DEFINES)
+
+WRITE_NOISE_EN          ?= $(NOISE_EN)
+WRITE_NOISE_RATE_NUM    ?= $(NOISE_RATE_NUM)
+WRITE_NOISE_RATE_DEN    ?= $(NOISE_RATE_DEN)
+WRITE_NOISE_BITS        ?= $(NOISE_BITS)
+READ_NOISE_EN           ?=
+READ_NOISE_RATE_NUM     ?=
+READ_NOISE_RATE_DEN     ?=
+READ_NOISE_BITS         ?=
+
+ifneq ($(strip $(WRITE_NOISE_EN)),)
+COMPILE_ARGS += -GWRITE_NOISE_EN=$(WRITE_NOISE_EN)
+endif
+ifneq ($(strip $(WRITE_NOISE_RATE_NUM)),)
+COMPILE_ARGS += -GWRITE_NOISE_RATE_NUM=$(WRITE_NOISE_RATE_NUM)
+endif
+ifneq ($(strip $(WRITE_NOISE_RATE_DEN)),)
+COMPILE_ARGS += -GWRITE_NOISE_RATE_DEN=$(WRITE_NOISE_RATE_DEN)
+endif
+ifneq ($(strip $(WRITE_NOISE_BITS)),)
+COMPILE_ARGS += -GWRITE_NOISE_BITS=$(WRITE_NOISE_BITS)
+endif
+ifneq ($(strip $(READ_NOISE_EN)),)
+COMPILE_ARGS += -GREAD_NOISE_EN=$(READ_NOISE_EN)
+endif
+ifneq ($(strip $(READ_NOISE_RATE_NUM)),)
+COMPILE_ARGS += -GREAD_NOISE_RATE_NUM=$(READ_NOISE_RATE_NUM)
+endif
+ifneq ($(strip $(READ_NOISE_RATE_DEN)),)
+COMPILE_ARGS += -GREAD_NOISE_RATE_DEN=$(READ_NOISE_RATE_DEN)
+endif
+ifneq ($(strip $(READ_NOISE_BITS)),)
+COMPILE_ARGS += -GREAD_NOISE_BITS=$(READ_NOISE_BITS)
+endif
+
+export PYTHONPATH := $(SIM_ROOT):$(PYTHONPATH)
+export QUIET ?= 1
+export VERBOSE ?= 0
+export COCOTB_LOG_LEVEL ?= INFO
+export PYTHONWARNINGS ?= ignore::pytest.PytestDeprecationWarning
+
+SUPPRESS_VERILATOR_WARNINGS ?= 0
+ifeq ($(SUPPRESS_VERILATOR_WARNINGS),1)
+COMPILE_ARGS += -Wno-WIDTHEXPAND
+COMPILE_ARGS += -Wno-UNOPTFLAT
+endif
+
+include $(shell uv run cocotb-config --makefiles)/Makefile.sim

hw/sim/mk/rtl-sources.mk

@@ -0,0 +1,23 @@
+ifndef RTL_ROOT
+$(error RTL_ROOT must be set before including mk/rtl-sources.mk)
+endif
+
+RTL_RANDOM := $(RTL_ROOT)/random/random128.sv
+
+RTL_NOISE_MASK := $(RTL_ROOT)/noise/noise_mask_grouped.sv
+RTL_WRITE_NOISE := $(RTL_NOISE_MASK) $(RTL_RANDOM) $(RTL_ROOT)/noise/cam_write_noise.sv
+RTL_READ_NOISE := $(RTL_NOISE_MASK) $(RTL_RANDOM) $(RTL_ROOT)/noise/cam_read_noise.sv
+
+RTL_CAM_CORE_BANKED := $(RTL_ROOT)/core/cam_core_banked.sv
+RTL_MATCH_ENGINE := \
+  $(RTL_ROOT)/core/popcount_pipeline.sv \
+  $(RTL_ROOT)/core/match_engine_pipeline.sv
+
+RTL_CAM_NOISY := \
+  $(RTL_CAM_CORE_BANKED) \
+  $(RTL_WRITE_NOISE) \
+  $(RTL_READ_NOISE) \
+  $(RTL_MATCH_ENGINE) \
+  $(RTL_ROOT)/cam_noisy.sv
+
+RTL_CAM_TOP := $(RTL_CAM_NOISY) $(RTL_ROOT)/cam_top.sv

hw/sim/scripts/sweep_noise.py

@@ -7,6 +7,12 @@ then queries the noisy rows and compares top-1 results against clean rows.
 from __future__ import annotations
 
 import argparse
+import sys
+from pathlib import Path
+
+SIM_ROOT = Path(__file__).resolve().parents[1]
+if str(SIM_ROOT) not in sys.path:
+    sys.path.insert(0, str(SIM_ROOT))
 
 import numpy as np
 from model.ref_model import (

hw/sim/tests/modules/cam_core_banked/Makefile

@@ -0,0 +1,9 @@
+SIM_ROOT := $(abspath ../../..)
+RTL_ROOT := $(abspath $(SIM_ROOT)/../rtl)
+include $(SIM_ROOT)/mk/rtl-sources.mk
+
+TOPLEVEL := cam_core_banked
+COCOTB_TEST_MODULES := tests.modules.cam_core_banked.test_cam_core_banked
+VERILOG_SOURCES := $(RTL_CAM_CORE_BANKED)
+
+include $(SIM_ROOT)/mk/cocotb-common.mk

hw/sim/tests/modules/cam_core_banked/test_cam_core_banked.py

@@ -24,8 +24,9 @@ async def banked_core_reads_aligned_eight_row_batch_after_one_cycle(dut):
     cocotb.start_soon(Clock(dut.clk, 10, unit="ns").start())
     await reset_core(dut)
 
-    LANES = 8
+    LANES = len(dut.rd_lane_valid_o)
     ROW_BITS = len(dut.rd_row_ids_o) // LANES
+    HASH_BITS = len(dut.rd_hashes_o) // LANES
 
     for row in range(LANES):
         dut.wr_valid.value = 1
@@ -43,6 +44,6 @@ async def banked_core_reads_aligned_eight_row_batch_after_one_cycle(dut):
     assert int(dut.rd_valid_o.value) == 1
     for lane in range(LANES):
         got_row = (int(dut.rd_row_ids_o.value) >> (lane * ROW_BITS)) & ((1 << ROW_BITS) - 1)
-        got_hash = (int(dut.rd_hashes_o.value) >> (lane * 512)) & ((1 << 512) - 1)
+        got_hash = (int(dut.rd_hashes_o.value) >> (lane * HASH_BITS)) & ((1 << HASH_BITS) - 1)
         assert got_row == lane
         assert got_hash == lane + 0x100

hw/sim/tests/modules/cam_read_noise/Makefile

@@ -0,0 +1,15 @@
+SIM_ROOT := $(abspath ../../..)
+RTL_ROOT := $(abspath $(SIM_ROOT)/../rtl)
+include $(SIM_ROOT)/mk/rtl-sources.mk
+
+TOPLEVEL := cam_read_noise
+COCOTB_TEST_MODULES := tests.modules.cam_read_noise.test_cam_read_noise
+VERILOG_SOURCES := $(RTL_READ_NOISE)
+
+HASH_BITS ?= 512
+READ_NOISE_EN ?= 0
+READ_NOISE_RATE_NUM ?= 0
+READ_NOISE_RATE_DEN ?= 100
+READ_NOISE_BITS ?= $(shell echo $$(( $(HASH_BITS) / 64 )))
+
+include $(SIM_ROOT)/mk/cocotb-common.mk

hw/sim/tests/modules/cam_read_noise/test_cam_read_noise.py

@@ -23,9 +23,10 @@ async def read_noise_disabled_forwards_hashes_after_one_stage(dut):
     cocotb.start_soon(Clock(dut.clk, 10, unit="ns").start())
     await reset_read_noise(dut)
 
-    LANES = 8
+    LANES = len(dut.lane_valid_i)
     ROW_BITS = len(dut.row_ids_i) // LANES
     HASH_BITS_PER_LANE = len(dut.hashes_i) // LANES
+    all_lanes_valid = (1 << LANES) - 1
 
     hashes = 0
     rows = 0
@@ -35,7 +36,7 @@ async def read_noise_disabled_forwards_hashes_after_one_stage(dut):
 
     dut.hashes_i.value = hashes
     dut.row_ids_i.value = rows
-    dut.lane_valid_i.value = 0xFF
+    dut.lane_valid_i.value = all_lanes_valid
     dut.valid_i.value = 1
     await RisingEdge(dut.clk)
     dut.valid_i.value = 0
@@ -45,4 +46,4 @@ async def read_noise_disabled_forwards_hashes_after_one_stage(dut):
     assert int(dut.valid_o.value) == 1
     assert int(dut.hashes_noisy_o.value) == hashes
     assert int(dut.row_ids_o.value) == rows
-    assert int(dut.lane_valid_o.value) == 0xFF
+    assert int(dut.lane_valid_o.value) == all_lanes_valid

hw/sim/tests/modules/cam_write_noise/Makefile

@@ -0,0 +1,15 @@
+SIM_ROOT := $(abspath ../../..)
+RTL_ROOT := $(abspath $(SIM_ROOT)/../rtl)
+include $(SIM_ROOT)/mk/rtl-sources.mk
+
+TOPLEVEL := cam_write_noise
+COCOTB_TEST_MODULES := tests.modules.cam_write_noise.test_cam_write_noise
+VERILOG_SOURCES := $(RTL_WRITE_NOISE)
+
+HASH_BITS ?= 512
+WRITE_NOISE_EN ?= 1
+WRITE_NOISE_RATE_NUM ?= 1
+WRITE_NOISE_RATE_DEN ?= 100
+WRITE_NOISE_BITS ?= $(shell echo $$(( $(HASH_BITS) / 64 )))
+
+include $(SIM_ROOT)/mk/cocotb-common.mk

hw/sim/tests/modules/cam_write_noise/test_cam_write_noise.py

@@ -34,6 +34,8 @@ async def write_noise_outputs_grouped_noisy_hash(dut):
         await RisingEdge(dut.clk)
 
     seed = 0xB504_F32D_B504_F32D
-    flip, _ = generate_write_flip_mask((seed << 64) | seed, 512, 8, 1, 100)
+    hash_bits = len(dut.wr_hash)
+    noise_bits = hash_bits // 64
+    flip, _ = generate_write_flip_mask((seed << 64) | seed, hash_bits, noise_bits, 1, 100)
     assert int(dut.core_wr_row.value) == 3
     assert int(dut.core_wr_hash.value) == (value ^ flip)

hw/sim/tests/modules/match_engine_pipeline/Makefile

@@ -0,0 +1,9 @@
+SIM_ROOT := $(abspath ../../..)
+RTL_ROOT := $(abspath $(SIM_ROOT)/../rtl)
+include $(SIM_ROOT)/mk/rtl-sources.mk
+
+TOPLEVEL := match_engine_pipeline
+COCOTB_TEST_MODULES := tests.modules.match_engine_pipeline.test_match_engine_pipeline
+VERILOG_SOURCES := $(RTL_MATCH_ENGINE)
+
+include $(SIM_ROOT)/mk/cocotb-common.mk

hw/sim/tests/modules/match_engine_pipeline/test_match_engine_pipeline.py

@@ -26,7 +26,7 @@ async def match_engine_returns_top1_after_pipeline_drain(dut):
     cocotb.start_soon(Clock(dut.clk, 10, unit="ns").start())
     await reset_match(dut)
 
-    LANES = 8
+    LANES = len(dut.rd_lane_valid_i)
     ROW_BITS = len(dut.rd_row_ids_i) // LANES
     HASH_BITS = len(dut.rd_hashes_i) // LANES
     NUM_ROWS = 1 << len(dut.rd_base_row_o)
@@ -51,7 +51,7 @@ async def match_engine_returns_top1_after_pipeline_drain(dut):
             hashes |= row_hash << (lane * HASH_BITS)
         dut.rd_row_ids_i.value = rows
         dut.rd_hashes_i.value = hashes
-        dut.rd_lane_valid_i.value = 0xFF
+        dut.rd_lane_valid_i.value = (1 << LANES) - 1
         dut.rd_valid_i.value = 1
         await RisingEdge(dut.clk)
         dut.rd_valid_i.value = 0

hw/sim/tests/perf/Makefile

@@ -0,0 +1,15 @@
+SIM_ROOT := $(abspath ../..)
+RTL_ROOT := $(abspath $(SIM_ROOT)/../rtl)
+include $(SIM_ROOT)/mk/rtl-sources.mk
+
+TOPLEVEL := cam_top
+COCOTB_TEST_MODULES := tests.perf.test_cam_perf
+VERILOG_SOURCES := $(RTL_CAM_TOP)
+
+HASH_BITS ?= 512
+WRITE_NOISE_EN := 0
+READ_NOISE_EN := 0
+WRITE_NOISE_BITS := $(shell echo $$(( $(HASH_BITS) / 64 )))
+READ_NOISE_BITS := $(shell echo $$(( $(HASH_BITS) / 64 )))
+
+include $(SIM_ROOT)/mk/cocotb-common.mk

hw/sim/tests/top/Makefile

@@ -0,0 +1,9 @@
+SIM_ROOT := $(abspath ../..)
+RTL_ROOT := $(abspath $(SIM_ROOT)/../rtl)
+include $(SIM_ROOT)/mk/rtl-sources.mk
+
+TOPLEVEL := cam_top
+COCOTB_TEST_MODULES := tests.top.test_cam_basic
+VERILOG_SOURCES := $(RTL_CAM_TOP)
+
+include $(SIM_ROOT)/mk/cocotb-common.mk