Installation

We provide two ways of building R-Visor:

• Installing with git: This requires you to set up the various dependencies
• Installing with docker: This is a quick and easy way to get started with R-Visor

---

With Git

The following dependencies are required to build R-Visor from git:

• QEMU
• RISC-V Glibc toolchain
• RISC-V Newlib toolchain

The steps to build each of these dependencies are shown below. However if you already have them installed, you can skip to Setting Up R-Visor

Setting Up QEMU

QEMU is an open-source emulator and virtualizer that allows you to run software for one hardware architecture on another. It is commonly used for system emulation, enabling developers to test, debug, and run software in a virtualized environment without needing physical hardware.

Our setup uses QEMU to emulate a RISC-V architecture, in order to use R-Visor on other architectures such as x86 or AArch64.

1. First install the prerequisites
2. First install the prerequisites

   sudo apt update
   sudo apt install libglib2.0-dev libpixman-1-dev ninja-build git make gcc
   

3. Pull the QEMU sources from github

   git clone https://github.com/qemu/qemu
   cd qemu 
   git checkout v7.0.0
   

4. Build QEMU

   ./configure --target-list=riscv64-softmmu
   make -j $(nproc --ignore=1) 
   sudo make -j $(nproc --ignore=1) install 
   cd ..
   

Setting Up The RISC-V Glibc Toolchain

1. First install the prerequisites

   sudo apt update 
   sudo apt install gcc-riscv64-linux-gnu binutils-riscv64-linux-gnu gawk texinfo libexpat1-dev 
   

2. Next get the sources from GitHub

   git clone --recursive https://github.com/riscv/riscv-gnu-toolchain.git 
   cd riscv-gnu-toolchain 
   

3. Update the submodules

   git checkout rvv-0.8 
   git submodule update 
   

4. Create the install directory

   sudo mkdir -p /opt/riscv_imafd
   sudo chown -R $(echo "$USER") /opt/riscv_imafd 
   

5. Build the Glibc toolchain for RISC-V

   ./configure --prefix=/opt/riscv_imafd --with-arch=rv64imafd --with-abi=lp64d 
   sudo make linux -j $(nproc --ignore=1) 
   

6. Add the toolchain to path

   export PATH=$PATH:/opt/riscv_ima/bin 
   sed -i "$ a export PATH=\$PATH:/opt/riscv_imafd/bin" ~/.bashrc 
   cd ..
   

Setting Up The RISC-V Newlib Toolchain

1. To setup the RISC-V newlib toolchain, follow steps 1 to 4 from Setting Up The RISC-V Glibc Toolchain
2. Next, build the Newlib toolchain for RISC-V

   ./configure --prefix=/opt/riscv_newlib --with-arch=rv64imafd --with-abi=lp64d 
   sudo make -j $(nproc --ignore=1) 
   

Additional information can be found on the RISC-V GNU ToolChain's GitHub

Setting up R-Visor

First clone the R-Visor project from Github

git clone https://github.com/stamcenter/r-visor
cd r-visor

Next build the project using CMake

cmake .
make

Running this would create a binary named tlrvisor_bb in bin/. In order to execute the routine, run it with the target binary as an argument.

qemu-riscv64 qemu-riscv64 qemu-riscv64 ./bin/tlrvisor_bb embench/aha-mont64

The output of the binary is printed out to the terminal and the resulting logs are stored in bb_frequency_logs.

---

With Docker

R-Visor's Docker image is a great way to get up and running in a few minutes, as it comes with all dependencies pre-installed. We include a dockerfile in the Github repo.

First clone the R-Visor project from Github

git clone https://github.com/stamcenter/r-visor
cd r-visor

Build the image from the dockerfile

docker build -t rvisor .

Run the image

docker run --rm -it rvisor bash