ab-riscv-interpreter 0.0.2

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

//! RV64 M extension

#[cfg(test)]
mod tests;
pub mod zmmul;

use crate::{ExecutableInstruction, ExecutionError, InterpreterState};
use ab_riscv_macros::instruction_execution;
use ab_riscv_primitives::instructions::rv64::m::Rv64MInstruction;
use ab_riscv_primitives::registers::general_purpose::Register;
use core::ops::ControlFlow;

#[instruction_execution]
impl<Reg, ExtState, Memory, PC, InstructionHandler, CustomError>
    ExecutableInstruction<
        InterpreterState<Reg, ExtState, Memory, PC, InstructionHandler, CustomError>,
        CustomError,
    > for Rv64MInstruction<Reg>
where
    Reg: Register<Type = u64>,
    [(); Reg::N]:,
{
    #[inline(always)]
    fn execute(
        self,
        state: &mut InterpreterState<Reg, ExtState, Memory, PC, InstructionHandler, CustomError>,
    ) -> Result<ControlFlow<()>, ExecutionError<Reg::Type, CustomError>> {
        match self {
            Self::Mul { rd, rs1, rs2 } => {
                let value = state.regs.read(rs1).wrapping_mul(state.regs.read(rs2));
                state.regs.write(rd, value);
            }
            Self::Mulh { rd, rs1, rs2 } => {
                // Signed × signed: widen to i128, take upper 64 bits
                let (_lo, prod) = state
                    .regs
                    .read(rs1)
                    .cast_signed()
                    .widening_mul(state.regs.read(rs2).cast_signed());
                state.regs.write(rd, prod.cast_unsigned());
            }
            Self::Mulhsu { rd, rs1, rs2 } => {
                // Signed × unsigned: widen to i128, take upper 64 bits
                let prod = i128::from(state.regs.read(rs1).cast_signed())
                    * i128::from(state.regs.read(rs2));
                let value = prod >> 64;
                state.regs.write(rd, value.cast_unsigned() as u64);
            }
            Self::Mulhu { rd, rs1, rs2 } => {
                // Unsigned × unsigned: widen to u128, take upper 64 bits
                let prod = u128::from(state.regs.read(rs1)) * u128::from(state.regs.read(rs2));
                let value = prod >> 64;
                state.regs.write(rd, value as u64);
            }
            Self::Div { rd, rs1, rs2 } => {
                let dividend = state.regs.read(rs1).cast_signed();
                let divisor = state.regs.read(rs2).cast_signed();
                let value = if divisor == 0 {
                    -1i64
                } else if dividend == i64::MIN && divisor == -1 {
                    i64::MIN
                } else {
                    dividend / divisor
                };
                state.regs.write(rd, value.cast_unsigned());
            }
            Self::Divu { rd, rs1, rs2 } => {
                let dividend = state.regs.read(rs1);
                let divisor = state.regs.read(rs2);
                let value = dividend.checked_div(divisor).unwrap_or(u64::MAX);
                state.regs.write(rd, value);
            }
            Self::Rem { rd, rs1, rs2 } => {
                let dividend = state.regs.read(rs1).cast_signed();
                let divisor = state.regs.read(rs2).cast_signed();
                let value = if divisor == 0 {
                    dividend
                } else if dividend == i64::MIN && divisor == -1 {
                    0
                } else {
                    dividend % divisor
                };
                state.regs.write(rd, value.cast_unsigned());
            }
            Self::Remu { rd, rs1, rs2 } => {
                let dividend = state.regs.read(rs1);
                let divisor = state.regs.read(rs2);
                let value = if divisor == 0 {
                    dividend
                } else {
                    dividend % divisor
                };
                state.regs.write(rd, value);
            }

            // RV64 R-type W
            Self::Mulw { rd, rs1, rs2 } => {
                let prod = (state.regs.read(rs1) as i32).wrapping_mul(state.regs.read(rs2) as i32);
                state.regs.write(rd, (prod as i64).cast_unsigned());
            }
            Self::Divw { rd, rs1, rs2 } => {
                let dividend = state.regs.read(rs1) as i32;
                let divisor = state.regs.read(rs2) as i32;
                let value = if divisor == 0 {
                    -1i64
                } else if dividend == i32::MIN && divisor == -1 {
                    i64::from(i32::MIN)
                } else {
                    i64::from(dividend / divisor)
                };
                state.regs.write(rd, value.cast_unsigned());
            }
            Self::Divuw { rd, rs1, rs2 } => {
                let dividend = state.regs.read(rs1) as u32;
                let divisor = state.regs.read(rs2) as u32;
                let value = dividend.checked_div(divisor).map_or(u64::MAX, |value| {
                    i64::from(value.cast_signed()).cast_unsigned()
                });
                state.regs.write(rd, value);
            }
            Self::Remw { rd, rs1, rs2 } => {
                let dividend = state.regs.read(rs1) as i32;
                let divisor = state.regs.read(rs2) as i32;
                let value = if divisor == 0 {
                    (dividend as i64).cast_unsigned()
                } else if dividend == i32::MIN && divisor == -1 {
                    0
                } else {
                    ((dividend % divisor) as i64).cast_unsigned()
                };
                state.regs.write(rd, value);
            }
            Self::Remuw { rd, rs1, rs2 } => {
                let dividend = state.regs.read(rs1) as u32;
                let divisor = state.regs.read(rs2) as u32;
                let value = if divisor == 0 {
                    dividend.cast_signed() as i64
                } else {
                    (dividend % divisor).cast_signed() as i64
                };
                state.regs.write(rd, value.cast_unsigned());
            }
        }

        Ok(ControlFlow::Continue(()))
    }
}