• RiESCUE
• Open Source Roadmap
• Installation and Usage
• Contributing
• RiescueC Supported Extensions

RiESCUE (pronounced "rescue") provides a Python library and command-line tools for generating, building, and compiling RISC-V test ELF files.

Check out the Intro to RiESCUE, RiescueD, and RiescueC on docs.tenstorrent.com for a more detailed introduction to RiESCUE. In short, it consists of:

• RiescueD - RiESCUE Directed Test Framework
• RiescueC - RiESCUE Compliance Test Generator
• CTK - RiESCUE Compliance Test Kit

Other Riescue projects include:

• CoreArchCoverage - RISC-V ISA Coverage from ISS (Separate Repository Available in the Future)
• coretp - RISC-V Core Test Plan - see riscv-coretp GitHub

RiescueD is a Python library and command-line tool (riescued) for creating directed test cases. It compiles assembly tests with pre-processor directives into ELF executables, provides a runtime environment, and simulates tests on an instruction set simulator (ISS).

Features include:

• OS code simulation
• Random address generation
• Memory management
• Page table generation
• Support for various privilege modes, paging modes, and virtualization modes

To get started writing RiescueD direct tests, check out the RiescueD User Guide. Source code is found in the riescue/dtest_framework directory.

RiescueC is a Python library and command-line tool (riescuec) that consists of a couple command line generation tools:

BringupMode or riescuec --mode bringup is the default RiescueC mode targeting datapath instruction compliance. It generates directed tests that:

• Multiple RISC-V extensions
  • Standard extensions (M, F, D, V, A, C)
  • Bit manipulation extensions (Zba, Zbb, Zbc, Zbs, Zb)
  • Half-precision floating point (Zfh, Zfbfmin)
• Self-checking test generation
• Configurable test constraints
• Comprehensive extension support

See the RiescueC documentation on docs.tenstorrent.com to get started with bringup mode. The source code can be found in the riescue/compliance directory.

Test Plan or riescuec --mode tp mode generates directed tests using TestPlans described in riscv-coretp.

TestScenarios provide a set of python data structures describing sequences of instructions and environmental configuration to test architectural and privilege scenarios. RiescueC consumes these scenarios and generates test ELFs using the underlying RiescueD framework.

More documentation and information to come in future updates

High-level tool used to generates a directory of tests given an ISA string (e.g. "rv64imfv"). Tests are ran using RiescueC to generate self-checking tests for a range of extensions.

• See the CTK Guide on docs.tenstorrent.com for a tutorial on running ctk.
• Just looking to generate a single extension of tests? See the User Guide on Generating a Vector Test Kit on docs.tenstorrent.com to see how a test kit can be generated for just vector tests.

For info on installing dependencies, see the Installation Guide on docs.tenstorrent.com

python3 -m pip install git+https://github.com/tenstorrent/riescue.git

This installs the command line scripts riescued, riescuec, and ctk, along with making the riescue Python package available for importing. This doesn't source some of the non-python requirements for Riescue.

The following non-Python dependencies must be installed before running:

• RISC-V GNU Toolchain - riscv-gnu-toolchain GitHub
• whisper - whisper GitHub
• spike - riscv-isa-sim GitHub See the Getting Started Guide for more information on sourcing dependencies.

See the RiescueD Getting Started Guide for more information on setting up RiescueD and running tests.

The documentation is hosted on docs.tenstorrent.com/riescue

We are excited to announce that we will be open-sourcing a suite of tools under the RiESCUE umbrella.

To develop or contribute, you need Apptainer (formerly Singularity).

See the Contributing page for information on setting up a developer environment.

The list of supported features can be found below. RiescueC is aiming to support mandatoy extensions of RVA23U64.