https://github.com/valoran-m/arrakis

[mirror :-] RISC-V Simulator for education
https://github.com/valoran-m/arrakis

debugger disassembler education interpreter risc-v simulator

Last synced: about 2 months ago
JSON representation

[mirror :-] RISC-V Simulator for education

• Host: GitHub
• URL: https://github.com/valoran-m/arrakis
• Owner: valoran-M
• License: other
• Created: 2023-08-18T10:37:25.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-29T15:53:31.000Z (8 months ago)
• Last Synced: 2024-12-01T10:52:36.867Z (about 2 months ago)
• Topics: debugger, disassembler, education, interpreter, risc-v, simulator
• Language: OCaml
• Homepage: https://codeberg.org/Arrakis/arrakis
• Size: 988 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        




    Arrakis

    


    

    





[Arrakis](https://en.wikipedia.org/wiki/Arrakis) is a RISC-V simulator written

in OCaml, primarly designed for education.

## ✨ Features

* Fully supported RV32IM instruction set, with [pseudo instructions](https://codeberg.org/Arrakis/arrakis/wiki/RV_Pseudo-Instructions).

* Different type of environmental calls: either [UNIX syscalls](https://codeberg.org/Arrakis/arrakis/wiki/RV_Environment-call)

  (default) or

  [Venus environmental calls emulation](https://codeberg.org/Arrakis/arrakis/wiki/RV_Environment-call).

* GNU `as` [assembler directives](https://codeberg.org/Arrakis/arrakis/wiki/RV_Assembler-Directives)

  and syntax.

* A debugging system using breakpoints.

* Complete [documentation](https://codeberg.org/Arrakis/arrakis/wiki),

  covering not only Arrakis usage but also serving as a general guide on how to

  write RISC-V assembly code.

## 📦 Installation

Since Arrakis is written in OCaml, it can be installed using

[opam](https://opam.ocaml.org/), OCaml Package Manager:

`$ opam install arrakis`

## 📚 Documentation

Documentation about Arrakis usage is available

[here](https://codeberg.org/Arrakis/arrakis/wiki).

## 🧪 Development

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

For contributions, please take a look at [`CONTRIBUTING.md`](./CONTRIBUTING.md).

## ⚖️  License

Arrakis is distributed under the [CeCILL 2.1 license](./LICENSE).