riscv-vp-plusplus

(β˜… 59)

RISCV-VP++ is a extended and improved successor of the RISC-V based Virtual Prototype (VP) RISC-V VP. It is maintained at the Institute for Complex Systems, Johannes Kepler University, Linz.

  • .clang-format
  • .dockerignore
  • .gitignore
  • .gitlab-ci.yml
  • .gitmodules
  • Dockerfile
  • LICENSE
  • Makefile
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/ics-jku/riscv-vp-plusplus

Downloads the entire project code from GitHub to your computer.

cd riscv-vp-plusplus

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
sudo apt install cmake autoconf automake autotools-dev clang-format-19 curl libmpc-dev libmpfr-dev libgmp-dev gawk build-essential bison flex texinfo libgoogle-perftools-dev libtool patchutils bc zlib1g-dev libexpat-dev libboost-iostreams-dev libboost-program-options-dev libboost-log-dev qtbase5-dev qt5-qmake libvncserver-dev nlohmann-json3-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t riscv-vp-plusplus .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 riscv-vp-plusplus

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
sudo apt install cmake autoconf automake autotools-dev clang-format-19 curl libmpc-dev libmpfr-dev libgmp-dev gawk build-essential bison flex texinfo libgoogle-perftools-dev libtool patchutils bc zlib1g-dev libexpat-dev libboost-iostreams-dev libboost-program-options-dev libboost-log-dev qtbase5-dev qt5-qmake libvncserver-dev nlohmann-json3-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo dnf install autoconf automake curl libmpc-devel mpfr-devel gmp-devel gawk bison flex texinfo gperf libtool patchutils bc zlib-devel expat-devel cmake boost-devel qt5-qtbase qt5-qtbase-devel libvncserver-devel json-devel

Type this command into your terminal and run it.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make -j$(nproc)

Compiles the code based on the generated build configuration to produce an executable.

make # (requires RISC-V GNU toolchain in PATH)

Compiles the code based on the generated build configuration to produce an executable.

make sim # (requires *riscv32-vp*, i.e. *vp/build/bin/riscv32-vp*, executable in PATH)

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation