RISC-V Vector Automatic Tests Generator

Branches Descriptions

This repository has two available branches:

• master: generates tests that contain self-checking.

• new_test_format: generates tests that are used for the RISCOF framework (no self-checking, use signature for verification).

The test content is the same in both of them.

Prerequisite

1. RVV Compiler

   1. Set gcc,objdump, and riscof directory's path variables in file: scripts/constants.py

2. VLEN config

   1. scripts/create_test_floating/create_test_common.py _vlen = change it to your vlen

3. Spike

   1. Install Latest https://github.com/riscv-software-src/riscv-isa-sim.
   2. Add <spike_path>/build to your PATH

   If the terminal can find spike command then it's successful

4. RISCV-ISAC RVV Support

   1. git clone https://github.com/hushenwei2000/riscv-isac-rvv
   2. cd riscv-isac-rvv
   3. git checkout vetcor !!!IMPORTANT!!!
   4. pip install . --prefix=~/.local # Anywhere you want
   5. Add ~/.local to your PATH

   If the terminal can find riscv_isac command then it's successful

5. Sail Reference Model (If you want to run RISCOF to test)

   1. Intall sail-riscv with vector support https://github.com/riscv/sail-riscv. master branch
      1. sail version should be 0.16
      2. Note that you should modify vlen and elen in riscv_sys_control.sail after init_pmp() before building. Add these two lines for example:

      vlen = 0b0011;
      elen = 0b1;
      

      vlen and elen encoding can be found in riscv_vlen.sail.

Usage

Generate One Instruction

python run.py -i <instruction> -t <type> [--vlen VLEN] [--vsew VSEW]

---

• The type shall be consistent with the instruction: i (integer), f (floating point), m (mask), p (permute), x (fix point), l (load store)
• Supported instruction and type can be seen in cgfs/<type>/<instruction>.yaml
• vlen VLEN Vector Register Length: 32, 64, 128(default), 256, 512, 1024
• vsew VSEW Selected Element Width: 8, 16, 32(default), 64

Generate All Tests

python generate_all.py

• This will use default parameter configuration to generate all integer instructions tests.
• Modify runcommand_<type> function to run different parameter.
• Modyfy main function to run different type of instructions.

After genering, run python move_generate_all_elf.py, this will check if generated file is valid. If you see

• No first.S for vXX is OK, ignore it
• No RVMODEL_DATA_END for vXX then it means vXX you should use generate one instruction method to regenerate it. Regenerate all of them and rerun move_generate_all_elf.py until no No RVMODEL_DATA_END appear.
• All tests will in generate_all folder.

Run Tests On RISCOF

1. Modify riscof_files/env/test_macros_vector.h, you can select your prefered configuration and copy from env/macros/vsewXX_lmulXX and paste to riscof_files/env/test_macros_vector.h

2. cd riscof_files

3. Modify your reference model and DUT to be testes in config.ini, in current file, we use sail as reference and spike as DUT

4. Modify GCC in sail_cSim/riscof_sail_cSim.py and spike/riscof_spike.py

5. copy the .S test files to test_suite

6. Modify VLEN and ELEN argument in riscof_files/spike/riscof_spike.py line 166: -varch=vlen:512,elen:64

7. run riscof run --config=config.ini --suite=test_suite --env=env

Known Bugs

• Not support floating-point vsew=16
• Lack of vmerge tests
• Lack of load store eew=64 tests
• SEGMENT load and store signature problem: if eew > sew, only the first register will be signatured
• mask instructions lack of test different registers tests

Support Configuration

Parameter	Numbers	Current Support	Note
FLEN	FP16, BF16, 32, 64	32, 64
vlen	128 ~ 2^16	128 ~ 1024	Spike now support largest 4096
vsew	8, 16, 32, 64	All
lmul	1/8, 1/4, 1/2, 1, 2, 4, 8	All	lmul=8 except load/store， 1/8 except eew>=32 loadstore
vta	0, 1	0
vma	0, 1	0

Notice of Failure Tests

• elen = 64 for default

  • vsew should <= elen * lmul
  • So, when lmul = 0.125, load/store eew=32+ cannot test.

• If there are failure tests, most probably is because that configuration can not be tested on that instruction. For example test widen instruction when vsew=64, or test floating point when vsew=8/16, or the elen related restriction above.

Signature

1. For arithmetic instructions that has vv, vx, vi types, each type tests store signature into x12, x20, x24, respectively.