ETISS RISC-V Tests

Python script to run the official RISC-V instruction test suite in ETISS.

Prerequisites

Built ETISS with bare_etiss_processor, must be built with debug symbols
Built RISC-V test suite, see link above for instructions
Working gdb for your host platform
Python 3.7 or newer

Initial Steps

All steps assumed to be executed in the source directory of this project.

Create Python venv: python -m venv venv
Activate venv: source venv/bin/activate
Update venv: pip install --upgrade pip setuptools wheel
Install dependencies: pip install -r requirements.txt

Usage

$ ./test.py -h
usage: test.py [-h] [--arch [ARCH ...]] [--bits BITS] [--runlevel RUNLEVEL]
               [--ext EXT] [--virt VIRT] [--timeout TIMEOUT] [-j THREADS]
               tests_dir etiss_exe

positional arguments:
  tests_dir             Path containing the compiled RISC-V test binaries
  etiss_exe             Path to bare_etiss_processor binary

options:
  -h, --help            show this help message and exit
  --arch [ARCH ...]     The ETISS architecture(s) to test. Specify multiple
                        architectures as a space-separated list.
  --bits BITS           Tests of which bitness to run. Can be '3264' for 32
                        and 64 bits.
  --runlevel RUNLEVEL   List of runlevels to test. Can be 'm', 's', 'u' or any
                        combination.
  --ext EXT             List of standard extensions to test. Can be 'i', 'm',
                        'a', 'c', 'f', 'd', 'zfh' or any combination.
  --virt VIRT           Virtualization levels to test. Can be 'p', 'v' or
                        both.
  --timeout TIMEOUT     Timeout to complete a test run, exceeding the timeout
                        marks the test as failed.
  -j THREADS, --threads THREADS
                        Number of parallel threads to start. Assume CPU core
                        count if no value is provided.

Output

A directory with the naming schema results_<YYMMDD>_<hhmmss>_<ETISS_ARCH> is created. This directory can contain 3 types of files:

pass.txt: All passing tests are listed here
fail.txt: All failing tests are listed here. Tests can fail for 3 reasons: The test case itself indicates failure, ETISS terminates prematurely, or ETISS does not terminate within a given timeframe (see Usage). A test case reports failure as any number > 1. This return code can be matched back to the failing test case by right-shifting the value by one. The result indicates the failing test case of the respective test run.
<test-name>.stdout and <test-name>.stderr for each failing test, containing the output of ETISS and gdb on standard output and standard error, respectively.

Working Principle

The RISC-V test suite contains small assembly language test cases verifying the correctness of instructions. At the end of each test, a result value is written to a special address denoted as tohost in the final ELF output. This script builds a list of all available test cases, filters them according to user preferences and executes ETISS for all remaining tests. The tohost output address is set as logging address in ETISS' logging plugin. To stop program execution once a test completes, ETISS is run in debug mode under gdb supervision. A breakpoint in the logging plugin output function stops ETISS on test completion and reads the return value of the test.

tum-ei-eda / etiss_riscv_tests