armagnac 0.3.0

A simple ARM emulation library for simulating embedded systems
Documentation
//! Implements PUSH (Push Multiple Registers) instruction.

use super::Encoding::{self, T1, T2, T3};
use super::{stmdb::Stmdb, unpredictable, Instruction};
use super::{
    ArmVersion::{V6M, V7EM, V7M, V8M},
    Pattern,
};
use crate::{
    core::{Effect, Processor, RunError},
    decoder::DecodeError,
    instructions::ItState,
    registers::{MainRegisterList, RegisterIndex},
};

/// PUSH instruction.
pub struct Push {
    /// Registers to be pushed to the stack.
    registers: MainRegisterList,
}

impl Instruction for Push {
    fn patterns() -> &'static [Pattern] {
        // TODO: fix support for ArmV8-M
        &[
            Pattern {
                encoding: T1,
                versions: &[V6M, V7M, V7EM, V8M],
                expression: "1011010xxxxxxxxx",
            },
            Pattern {
                encoding: T2,
                versions: &[V7M, V7EM, V8M],
                expression: "1110100100101101(0)x(0)xxxxxxxxxxxxx",
            },
            Pattern {
                encoding: T3,
                versions: &[V7M, V7EM, V8M],
                expression: "1111100001001101xxxx110100000100",
            },
        ]
    }

    fn try_decode(encoding: Encoding, ins: u32, _state: ItState) -> Result<Self, DecodeError> {
        Ok(match encoding {
            T1 => {
                let registers =
                    MainRegisterList::new(((((ins >> 8) & 1) << 14) | ins & 0xff) as u16);
                unpredictable(registers.is_empty())?;
                Self { registers }
            }
            T2 => {
                let registers = MainRegisterList::new((ins & 0x5fff) as u16);
                unpredictable(registers.len() < 2)?;
                Self { registers }
            }
            T3 => {
                let rt = (ins >> 12) & 0xf;
                let registers = MainRegisterList::new((1 << rt) as u16);
                let rt = RegisterIndex::new_main(rt);
                unpredictable(rt.is_sp_or_pc())?;
                Self { registers }
            }
            _ => panic!(),
        })
    }

    fn execute(&self, proc: &mut Processor) -> Result<Effect, RunError> {
        // PUSH is equivalent to STMDB if Rn is SP and wback is true.
        // We use the STMDB implementation.
        let stmdb = Stmdb {
            rn: RegisterIndex::Sp,
            wback: true,
            registers: self.registers,
        };
        stmdb.execute(proc)
    }

    fn name(&self) -> String {
        "push".into()
    }

    fn args(&self, _pc: u32) -> String {
        format!("{{{}}}", self.registers)
    }
}