ab-riscv-interpreter 0.0.4

Composable and generic RISC-V interpreter
Documentation
//! RV64 M extension

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

use crate::{ExecutableInstruction, ExecutionError, RegisterFile};
use ab_riscv_macros::instruction_execution;
use ab_riscv_primitives::prelude::*;
use core::ops::ControlFlow;

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

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

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