Skip to main content

Building with Ruyi Compilation Environment (Using Licheepi 4A as an Example)

This guide demonstrates the process of installing the Ruyi package manager, setting up a RISC-V compilation and simulation environment using Ruyi, and completing the local compilation of the CoreMark source code, followed by running it on the Licheepi 4A development board.

Environment Description​

  • Hardware Environment: Licheepi 4A Development Board (th1520)
  • Software Environment: Debian/openEuler for RISC-V

Installation of Ruyi Package Manager​

  1. Please refer to the RuyiSDK Package Manager Installation Guide to complete the installation of Ruyi.

    In this document, the hardware environment is a RISC-V device, and the downloaded and installed version of Ruyi is built for the riscv64 architecture.

Setting Up the Development Environment Using Ruyi Package Manager​

  1. View the software repository package index information
$ ruyi list --name-contains gnu-plct --category-is toolchain
  1. Install gnu: ruyi install <package-name>
# Install the compilation toolchain gnu-plct-xthead suitable for Licheepi 4A
$ ruyi install gnu-plct-xthead
  1. View predefined compilation environments
$ ruyi list profiles
  1. Create a Ruyi virtual environment venv-sipeed using the specified toolchain and simulator configuration.

    Note: When creating the virtual environment, ensure the correct compiler version and sysroot type are specified. If no version number is specified, the latest version from the software source is used by default, not the locally installed version.

# You can use the help command to view all available options
$ ruyi venv -h

# Create the virtual environment venv-sipeed
$ ruyi venv -t gnu-plct-xthead sipeed-lpi4a venv-sipeed 

# View the tools in the compilation environment
$ ls venv-sipeed/bin/ 

# Activate the virtual environment (The virtual environment can be understood as a container designed to isolate the runtime environment. After activation, the gnu-plct-xthead version toolchain is used within the venv-sipeed environment. Alternatively, without creating a virtual environment, you can configure the environment variable directly to use the gcc compiler located at /home/sipeed/.local/share/ruyi/binaries/riscv64/gnu-plct-xthead-2.8.0-ruyi.20240222/bin)
$ . venv-sipeed/bin/ruyi-activate 

# Verify if the gcc in the current virtual environment is usable
«Ruyi venv-sipeed» sipeed@lpi4a1590:~$ riscv64-plctxthead-linux-gnu-gcc --version
  1. Download and extract the CoreMark source code as the compilation target
# Create a directory to manage the extracted source code
$ mkdir coremark && cd coremark

# Extract the source code
$ ruyi extract coremark

# View the source code
$ ls -al

Cross-Compiling CoreMark​

  1. Configure the compilation settings in the CoreMark source code (Refer to the CoreMark repository README)
# Modify GCC according to the CoreMark project's build instructions
$ sed -i 's/\bgcc\b/riscv64-plctxthead-linux-gnu-gcc/g' linux64/core_portme.mak
  1. Perform cross-compilation and build to obtain the executable program coremark.exe
# Run the build
$ make PORT_DIR=linux64 link

$ ls -al    
# The executable program coremark.exe is newly generated
  1. View the file attribute information of the riscv64 executable program.
$ file coremark.exe
# The command output displays architecture-related information about the file

Running and Verification​

  1. Directly run the riscv64 CoreMark executable program
$ ./coremark.exe