Struct riscv_emu_rust::Emulator

pub struct Emulator { /* fields omitted */ }

RISC-V emulator. It emulates RISC-V CPU and peripheral devices.

Sample code to run the emulator.

// Creates an emulator with arbitary terminal
let mut emulator = Emulator::new(Box::new(DefaultTerminal::new()));
// Set up program content binary
emulator.setup_program(program_content);
// Set up Filesystem content binary
emulator.setup_filesystem(fs_content);
// Go!
emulator.run();

Implementations

impl Emulator

pub fn new(terminal: Box<dyn Terminal>) -> Self

Creates a new Emulator. Terminal is internally used for transferring input/output data to/from Emulator.

Arguments

• terminal

pub fn run(&mut self)

Runs program set by setup_program(). Calls run_test() if the program is riscv-tests. Otherwise calls run_program().

pub fn run_program(&mut self)

Runs program set by setup_program(). The emulator won't stop forever.

pub fn run_test(&mut self)

Method for running riscv-tests program. The differences from run_program() are

• Disassembles every instruction and dumps to terminal
• The emulator stops when the test finishes
• Displays the result message (pass/fail) to terminal

pub fn tick(&mut self)

Runs CPU one cycle

pub fn setup_program(&mut self, data: Vec<u8>)

Sets up program run by the program. This method analyzes the passed content and configure CPU properly. If the passed contend doesn't seem ELF file, it panics. This method is expected to be called only once.

Arguments

• data Program binary

pub fn setup_filesystem(&mut self, content: Vec<u8>)

Sets up filesystem. Use this method if program (e.g. Linux) uses filesystem. This method is expected to be called up to only once.

Arguments

• content File system content binary

pub fn setup_dtb(&mut self, content: Vec<u8>)

Sets up device tree. The emulator has default device tree configuration. If you want to override it, use this method. This method is expected to to be called up to only once.

Arguments

• content DTB content binary

pub fn update_xlen(&mut self, xlen: Xlen)

Updates XLEN (the width of an integer register in bits) in CPU.

Arguments

• xlen

pub fn get_mut_terminal(&mut self) -> &mut Box<dyn Terminal>

Returns mutable reference to Terminal.

pub fn get_cpu(&self) -> &Cpu

Returns immutable reference to Cpu.

pub fn get_mut_cpu(&mut self) -> &mut Cpu

Returns mutable reference to Cpu.