riscv-etrace 0.10.0

Decoder and tracer for RISC-V efficient instruction tracing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# This Makefile runs the simple example in testing mode against reference flow
# tests.
#
# Usage:
#
#       make -f test-reference.mk SUITE=<test suite dir>
#
# Where `test suite dir` is the suite directory produced when running the
# reference flow's `run_regression.sh` script, e.g. `itype3_basic` in a
# directory `regression_20250624_124010`.
#
# This Makefile will produce the parameter files `params_32.toml` and
# `params_64.toml` in the current working directory and run the simple
# example for all test files for which a trace file is present.

SPIKE := $(SUITE)/../spike/
TEST_FILE_DIR := $(SUITE)/../../tests/test_files/
PK := $(TEST_FILE_DIR)pk.riscv

TRACES ?= $(basename $(notdir $(wildcard $(SUITE)/*.te_inst_raw)))
REFERENCE_TRACES := $(addprefix reference/,$(TRACES))
NOSYNC_TRACES := $(addprefix nosync/,$(TRACES))
SYNC_TRACES := $(addprefix sync/,$(TRACES))

PROJ_DIR := $(dir $(real $(lastword $(MAKEFILE_LIST))))
EXAMPLES_DIR := $(PROJ_DIR)target/debug/examples/
DECODER := $(TARGETS_DIR)simple

CARGO ?= cargo
EGREP ?= egrep
FILEUTIL ?= file
MKDIR ?= mkdir -p

ELF_PARAMS = $(patsubst %-bit,params_%.toml,$(firstword \
	$(filter %-bit,$(shell $(FILEUTIL) -b $(1)))\
))

define DO_DECODER_RULE =
$(1): $(2) $(3) $(4) $(EXAMPLES_DIR)simple
	$(EXAMPLES_DIR)simple $(2) -p $(3) --spike-bootrom -r $(4) >> /dev/null
endef

DECODER_RULE = $(let base,$(basename $(notdir $(1))),$(let elf,\
	$(wildcard $(addprefix $(TEST_FILE_DIR)$(base),.riscv .pk)),\
	$(call DO_DECODER_RULE,$(1),\
		$(2)$(base).te_inst_raw \
		$(elf) $(if $(filter %.pk,$(elf)),$(TEST_FILE_DIR)pk.riscv),\
		$(call ELF_PARAMS,$(elf)),\
		$(SPIKE)$(base).spike_pc_trace\
	)\
))

define DO_ENCODER_RULE =
$(1): $(2) $(3) $(EXAMPLES_DIR)encoder
	@$(MKDIR) $(dir $(1))
	$(EXAMPLES_DIR)encoder $(2) -p $(3) -o $(1) $(4)
endef

ENCODER_RULE = $(let base,$(basename $(notdir $(1))),\
	$(call DO_ENCODER_RULE,\
		$(2)$(base).te_inst_raw,\
		$(SUITE)$(base).encoder_input,\
		$(call ELF_PARAMS,$(wildcard \
			$(addprefix $(TEST_FILE_DIR)$(base),.riscv .pk))\
		),\
		$(3)\
	)\
)

all: reference_tests nosync_tests sync_tests

clean:
	$(RM) $(PARAMS_FILES)
	$(RM) $(addsuffix .encoder_input,$(addprefix traces/,$(NOSYNC_TRACES)))
	$(RM) $(addsuffix .encoder_input,$(addprefix traces/,$(SYNC_TRACES)))

reference_tests: $(REFERENCE_TRACES)

$(foreach trace,$(REFERENCE_TRACES),$(eval $(call DECODER_RULE,$(trace),$(SUITE))))

nosync_tests: $(NOSYNC_TRACES)

$(foreach trace,$(NOSYNC_TRACES),\
	$(eval $(call ENCODER_RULE,$(trace),traces/nosync/))\
	$(eval $(call DECODER_RULE,$(trace),traces/nosync/))\
)

sync_tests: $(SYNC_TRACES)

$(foreach trace,$(SYNC_TRACES),\
	$(eval $(call ENCODER_RULE,$(trace),traces/sync/,--max-sync 1024))\
	$(eval $(call DECODER_RULE,$(trace),traces/sync/))\
)

PARAMS_FILES := params_32.toml params_64.toml

$(PARAMS_FILES): params_%.toml: $(SUITE)hardware_%.scf
	$(EGREP) -v '^[#[]' $^ > $@

$(EXAMPLES_DIR)%: .PHONY
	$(CARGO) build --all-features --example $(@F)

.PHONY: