README.md

Arrakis is a RISC-V simulator written in OCaml, primarly designed for education.

Features

• Fully supported RV32IM instruction set, with most pseudo instructions.

• Different type of environmental calls: either UNIX syscalls (default) or Venus environmental calls emulation.

• Partial GNU as assembler directives.

• A debugging system using breakpoints.

• Complete documentation, covering not only Arrakis usage but also serving as a general guide on how to write RISC-V assembly code.

• (WIP) A vim plugin to integrate Arrakis with your favorite text editor.

Installation

Since Arrakis is written in OCaml, it can be installed using opam, OCaml Package Manager.

Simply run:

$ opam install arrakis

Documentation

Documentation about Arrakis usage is available here

Development

The main branch is currently developped using OCaml 5.0 and Dune 3.10.

For contributions, please take a look at CONTRIBUTING.md.

Resources

• riscv-card, a comprehensive reference sheet for RISC-V.

• Venus, a RISC-V simulator written in Kotlin, which inspired Arrakis.

• CeCILL, Arrakis License.