raki 1.3.2

RISC-V instruction decoder written in Rust.
Documentation
pub mod bit_32 {
    use super::super::{DecodeUtil, DecodingError};
    use crate::instruction::zicfiss_extension::ZicfissOpcode;

    pub fn parse_opcode(inst: u32) -> Result<ZicfissOpcode, DecodingError> {
        let opmap: u8 = u8::try_from(inst.slice(6, 0)).unwrap();
        let funct3: u8 = u8::try_from(inst.slice(14, 12)).unwrap();
        let rs1: u8 = u8::try_from(inst.slice(19, 15)).unwrap();
        let funct7_rs2: u16 = u16::try_from(inst.slice(31, 20)).unwrap();

        match opmap {
            0b111_0011 => match funct3 {
                0b100 => match funct7_rs2 {
                    0b1100_1110_0001 | 0b1100_1110_0101 => Ok(ZicfissOpcode::SSPUSH),
                    0b1100_1101_1100 => match rs1 {
                        0b0_0000 => Ok(ZicfissOpcode::SSRDP),
                        _ => Ok(ZicfissOpcode::SSPOPCHK),
                    },
                    _ => Err(DecodingError::InvalidOpcode),
                },
                _ => Err(DecodingError::InvalidFunct3),
            },
            0b010_1111 => match funct3 {
                0b010 => Ok(ZicfissOpcode::SSAMOSWAP_W),
                0b011 => Ok(ZicfissOpcode::SSAMOSWAP_D),
                _ => Err(DecodingError::InvalidFunct3),
            },
            _ => Err(DecodingError::InvalidOpcode),
        }
    }

    #[allow(clippy::unnecessary_wraps)]
    pub fn parse_rd(inst: u32, opkind: &ZicfissOpcode) -> Option<usize> {
        let rd: usize = inst.slice(11, 7) as usize;
        match opkind {
            ZicfissOpcode::SSPUSH | ZicfissOpcode::SSPOPCHK => Some(0),
            ZicfissOpcode::SSRDP | ZicfissOpcode::SSAMOSWAP_W | ZicfissOpcode::SSAMOSWAP_D => {
                Some(rd)
            }
            ZicfissOpcode::C_SSPUSH | ZicfissOpcode::C_SSPOPCHK => unreachable!(),
        }
    }

    #[allow(clippy::unnecessary_wraps)]
    pub fn parse_rs1(inst: u32, opkind: &ZicfissOpcode) -> Option<usize> {
        let rs1: usize = inst.slice(19, 15) as usize;
        match opkind {
            ZicfissOpcode::SSPUSH => Some(0),
            ZicfissOpcode::SSPOPCHK | ZicfissOpcode::SSAMOSWAP_W | ZicfissOpcode::SSAMOSWAP_D => {
                Some(rs1)
            }
            ZicfissOpcode::SSRDP => None,
            ZicfissOpcode::C_SSPUSH | ZicfissOpcode::C_SSPOPCHK => unreachable!(),
        }
    }

    #[allow(clippy::unnecessary_wraps)]
    pub fn parse_rs2(inst: u32, opkind: &ZicfissOpcode) -> Option<usize> {
        let rs2: usize = inst.slice(24, 20) as usize;
        match opkind {
            ZicfissOpcode::SSPUSH | ZicfissOpcode::SSAMOSWAP_W | ZicfissOpcode::SSAMOSWAP_D => {
                Some(rs2)
            }
            ZicfissOpcode::SSPOPCHK | ZicfissOpcode::SSRDP => None,
            ZicfissOpcode::C_SSPUSH | ZicfissOpcode::C_SSPOPCHK => unreachable!(),
        }
    }

    #[allow(clippy::cast_possible_wrap, clippy::unnecessary_wraps)]
    pub fn parse_imm(_inst: u32, opkind: &ZicfissOpcode) -> Option<i32> {
        match opkind {
            ZicfissOpcode::SSPUSH
            | ZicfissOpcode::SSPOPCHK
            | ZicfissOpcode::SSRDP
            | ZicfissOpcode::SSAMOSWAP_W
            | ZicfissOpcode::SSAMOSWAP_D => None,
            ZicfissOpcode::C_SSPUSH | ZicfissOpcode::C_SSPOPCHK => unreachable!(),
        }
    }
}

pub mod bit_16 {
    use super::super::DecodingError;
    use crate::instruction::zicfiss_extension::ZicfissOpcode;
    use crate::Isa;

    pub fn parse_opcode(inst: u16, _isa: Isa) -> Result<ZicfissOpcode, DecodingError> {
        match inst {
            0b0110_0000_1000_0001 => Ok(ZicfissOpcode::C_SSPUSH),
            0b0110_0010_1000_0001 => Ok(ZicfissOpcode::C_SSPOPCHK),
            _ => Err(DecodingError::InvalidOpcode),
        }
    }

    #[allow(clippy::unnecessary_wraps)]
    pub fn parse_rd(_inst: u16, opkind: &ZicfissOpcode) -> Option<usize> {
        match opkind {
            ZicfissOpcode::C_SSPUSH => Some(1),
            ZicfissOpcode::C_SSPOPCHK => Some(5),
            _ => unreachable!(),
        }
    }

    #[allow(clippy::unnecessary_wraps)]
    pub fn parse_rs1(_inst: u16, _opkind: &ZicfissOpcode) -> Option<usize> {
        None
    }

    #[allow(clippy::unnecessary_wraps)]
    pub fn parse_rs2(_inst: u16, _opkind: &ZicfissOpcode) -> Option<usize> {
        None
    }

    #[allow(clippy::cast_possible_wrap, clippy::unnecessary_wraps)]
    pub fn parse_imm(_inst: u16, _opkind: &ZicfissOpcode) -> Option<i32> {
        None
    }
}

#[cfg(test)]
#[allow(unused_variables)]
mod test_zicfiss {
    #[test]
    #[allow(overflowing_literals)]
    fn zicfiss_32bit_decode_test() {
        use crate::decode::inst_32::test_32_in_rv64;
        use crate::instruction::zicfiss_extension::ZicfissOpcode;
        use crate::OpcodeKind;

        test_32_in_rv64(
            0b1100_1110_0101_0000_0100_0000_0111_0011,
            OpcodeKind::Zicfiss(ZicfissOpcode::SSPUSH),
            Some(0),
            Some(0),
            Some(5),
            None,
        );

        test_32_in_rv64(
            0b1100_1110_0001_0000_0100_0000_0111_0011,
            OpcodeKind::Zicfiss(ZicfissOpcode::SSPUSH),
            Some(0),
            Some(0),
            Some(1),
            None,
        );

        test_32_in_rv64(
            0b1100_1101_1100_0000_1100_0000_0111_0011,
            OpcodeKind::Zicfiss(ZicfissOpcode::SSPOPCHK),
            Some(0),
            Some(1),
            None,
            None,
        );

        test_32_in_rv64(
            0b1100_1101_1100_0010_1100_0000_0111_0011,
            OpcodeKind::Zicfiss(ZicfissOpcode::SSPOPCHK),
            Some(0),
            Some(5),
            None,
            None,
        );

        test_32_in_rv64(
            0b0100_1000_1100_0010_1010_0001_1010_1111,
            OpcodeKind::Zicfiss(ZicfissOpcode::SSAMOSWAP_W),
            Some(3),
            Some(5),
            Some(12),
            None,
        );

        test_32_in_rv64(
            0b0100_1000_1100_0111_0011_0001_1010_1111,
            OpcodeKind::Zicfiss(ZicfissOpcode::SSAMOSWAP_D),
            Some(3),
            Some(14),
            Some(12),
            None,
        );

        test_32_in_rv64(
            0xcdc0c073,
            OpcodeKind::Zicfiss(ZicfissOpcode::SSPOPCHK),
            Some(0),
            Some(1),
            None,
            None,
        );
    }

    #[test]
    #[allow(overflowing_literals)]
    fn zicfiss_16() {
        use crate::instruction::zicfiss_extension::ZicfissOpcode;
        use crate::{Decode, Isa, OpcodeKind};
        let test_16 = |inst_16: u16,
                       op: OpcodeKind,
                       rd: Option<usize>,
                       rs1: Option<usize>,
                       rs2: Option<usize>,
                       imm: Option<i32>| {
            let op_16 = inst_16.parse_opcode(Isa::Rv64).unwrap();
            assert!(matches!(&op_16, op));
            assert_eq!(inst_16.parse_rd(&op_16).unwrap(), rd);
            assert_eq!(inst_16.parse_rs1(&op_16).unwrap(), rs1);
            assert_eq!(inst_16.parse_rs2(&op_16).unwrap(), rs2);
            assert_eq!(inst_16.parse_imm(&op_16, Isa::Rv64).unwrap(), imm);
        };

        test_16(
            0x6081,
            OpcodeKind::Zicfiss(ZicfissOpcode::C_SSPUSH),
            Some(1),
            None,
            None,
            None,
        );

        test_16(
            0x6281,
            OpcodeKind::Zicfiss(ZicfissOpcode::C_SSPOPCHK),
            Some(5),
            None,
            None,
            None,
        );
    }
}