https://github.com/tum-ei-eda/etiss_riscv_tests
https://github.com/tum-ei-eda/etiss_riscv_tests
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tum-ei-eda/etiss_riscv_tests
- Owner: tum-ei-eda
- License: apache-2.0
- Created: 2022-02-09T23:39:05.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-06-18T09:01:12.000Z (5 months ago)
- Last Synced: 2025-06-18T10:19:24.030Z (5 months ago)
- Language: C++
- Size: 63.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ETISS RISC-V Tests
Python script to run the [official RISC-V instruction test suite](https://github.com/riscv-software-src/riscv-tests) 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.
1) Create Python venv: `python -m venv venv`
2) Activate venv: `source venv/bin/activate`
3) Update venv: `pip install --upgrade pip setuptools wheel`
4) 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___` is created. This directory can contain 3 types of files:
1) `pass.txt`: All passing tests are listed here
2) `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.
3) `.stdout` and `.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.