Crate rmachine 

R-Machine

A simple 32-bit RISC CPU emulator and assembler written in Rust.

Overview

R-Machine is an educational project that implements a minimal RISC (Reduced Instruction Set Computer) architecture. It includes:

• A 32-bit CPU emulator with 16 registers
• An assembler that converts assembly code to machine code
• A debugger for step-by-step execution
• Support for basic arithmetic, logical, and control flow operations

Features

• Simple Architecture: 16 32-bit registers with clear purposes
• Rich Instruction Set: 23 instructions covering arithmetic, logic, branching, and memory operations
• Development Tools: Includes assembler (rasm), debugger (rmon), and disassembler (rdis)
• Educational Focus: Clean, understandable implementation ideal for learning about CPU design

Installation

cargo install rmachine

Or build from source:

git clone https://github.com/aleury/rmachine
cd rmachine
cargo build --release

Usage

Assembler (rasm)

Assemble source code into executable format:

rasm input.s              # Creates input (executable without extension)
rasm input.s -o output    # Specify custom output file

Debugger (rmon)

Run programs with debugging support:

rmon program.rmx       # Run with debugger
rmon program.rmx -d    # Start in debug mode

Disassembler (rdis)

Disassemble executable files:

rdis program.rmx

Examples

The examples/ directory contains sample R-Machine assembly programs:

• ex1.s - Hello World program demonstrating system calls

Run an example:

rasm examples/ex1.s -o hello.rmx
rmon hello.rmx

Documentation

• Architecture and Instruction Set
• Todo List

License

This project is dual-licensed under MIT OR Apache-2.0.

Modules

prelude

The rmachine prelude - commonly used types and traits.

Functions

build_exe

Builds an executable from input.

try_image_from_bytes

Creates a memory image from a byte slice.