ab-riscv-interpreter 0.0.4

Composable and generic RISC-V interpreter
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

use crate::RegisterFile;
use crate::rv32::test_utils::{execute, initialize_state};
use ab_riscv_primitives::prelude::*;
// xperm4 tests

#[test]
fn test_xperm4_basic() {
    let mut state = initialize_state([Rv32ZbkxInstruction::Xperm4 {
        rd: Reg::A2,
        rs1: Reg::A0,
        rs2: Reg::A1,
    }]);

    // Nibbles 0–7 of rs1: nibble i = i
    state.regs.write(Reg::A0, 0x76543210u32);
    // Identity permutation
    state.regs.write(Reg::A1, 0x76543210u32);

    execute(&mut state).unwrap();

    assert_eq!(state.regs.read(Reg::A2), 0x76543210u32);
}

#[test]
fn test_xperm4_out_of_bounds_zeroed() {
    let mut state = initialize_state([Rv32ZbkxInstruction::Xperm4 {
        rd: Reg::A2,
        rs1: Reg::A0,
        rs2: Reg::A1,
    }]);

    state.regs.write(Reg::A0, 0x76543210u32);
    // Nibble indices: 0,1,2,3 (in), 8,9,10,11 (out of bounds for RV32)
    state.regs.write(Reg::A1, 0xBA983210u32);

    execute(&mut state).unwrap();

    // Lower nibbles: indices 0–3 -> values 0–3; upper nibbles: indices 8–11 -> 0
    assert_eq!(state.regs.read(Reg::A2), 0x00003210u32);
}

#[test]
fn test_xperm4_constant_index() {
    let mut state = initialize_state([Rv32ZbkxInstruction::Xperm4 {
        rd: Reg::A2,
        rs1: Reg::A0,
        rs2: Reg::A1,
    }]);

    // rs1 nibble 2 = 0xC
    state.regs.write(Reg::A0, 0x0000_0C00u32);
    // All 8 nibbles of rs2 are index 2
    state.regs.write(Reg::A1, 0x22222222u32);

    execute(&mut state).unwrap();

    assert_eq!(state.regs.read(Reg::A2), 0xCCCCCCCCu32);
}

#[test]
fn test_xperm4_max_in_bounds_index() {
    let mut state = initialize_state([Rv32ZbkxInstruction::Xperm4 {
        rd: Reg::A2,
        rs1: Reg::A0,
        rs2: Reg::A1,
    }]);

    // rs1 nibble 7 (highest in-bounds for RV32) = 0xA
    state.regs.write(Reg::A0, 0xA0000000u32);
    // All indices are 7 - the last valid index
    state.regs.write(Reg::A1, 0x77777777u32);

    execute(&mut state).unwrap();

    assert_eq!(state.regs.read(Reg::A2), 0xAAAAAAAAu32);
}

#[test]
fn test_xperm4_zero_lut() {
    let mut state = initialize_state([Rv32ZbkxInstruction::Xperm4 {
        rd: Reg::A2,
        rs1: Reg::A0,
        rs2: Reg::A1,
    }]);

    state.regs.write(Reg::A0, 0x0u32);
    state.regs.write(Reg::A1, 0x76543210u32);

    execute(&mut state).unwrap();

    assert_eq!(state.regs.read(Reg::A2), 0x0u32);
}

// xperm8 tests

#[test]
fn test_xperm8_basic() {
    let mut state = initialize_state([Rv32ZbkxInstruction::Xperm8 {
        rd: Reg::A2,
        rs1: Reg::A0,
        rs2: Reg::A1,
    }]);

    // rs1 bytes: 0->0x10, 1->0x20, 2->0x30, 3->0x40
    state.regs.write(Reg::A0, 0x40_30_20_10u32);
    // Select bytes 0,1,2,3 in order
    state.regs.write(Reg::A1, 0x03_02_01_00u32);

    execute(&mut state).unwrap();

    assert_eq!(state.regs.read(Reg::A2), 0x40_30_20_10u32);
}

#[test]
fn test_xperm8_out_of_bounds_zeroed() {
    let mut state = initialize_state([Rv32ZbkxInstruction::Xperm8 {
        rd: Reg::A2,
        rs1: Reg::A0,
        rs2: Reg::A1,
    }]);

    state.regs.write(Reg::A0, 0x04_03_02_01u32);
    // Indices: 0 (in), 4 (out), 255 (out), 0 (in)
    state.regs.write(Reg::A1, 0x00_FF_04_00u32);

    execute(&mut state).unwrap();

    // byte 0: index 0 -> 0x01, byte 1: index 4 -> 0x00, byte 2: index 255 -> 0x00, byte 3: index 0
    // -> 0x01
    assert_eq!(state.regs.read(Reg::A2), 0x01_00_00_01u32);
}

#[test]
fn test_xperm8_identity() {
    let mut state = initialize_state([Rv32ZbkxInstruction::Xperm8 {
        rd: Reg::A2,
        rs1: Reg::A0,
        rs2: Reg::A1,
    }]);

    let lut = 0xDE_AD_BE_EFu32;
    state.regs.write(Reg::A0, lut);
    state.regs.write(Reg::A1, 0x03_02_01_00u32);

    execute(&mut state).unwrap();

    assert_eq!(state.regs.read(Reg::A2), lut);
}

#[test]
fn test_xperm8_reverse() {
    let mut state = initialize_state([Rv32ZbkxInstruction::Xperm8 {
        rd: Reg::A2,
        rs1: Reg::A0,
        rs2: Reg::A1,
    }]);

    state.regs.write(Reg::A0, 0x04_03_02_01u32);
    state.regs.write(Reg::A1, 0x00_01_02_03u32);

    execute(&mut state).unwrap();

    assert_eq!(state.regs.read(Reg::A2), 0x01_02_03_04u32);
}