Skip to content

Commit 545e76e

Browse files
etterlietterli
committed
[otbn,sim] Add simulator test cases for bignum vectorized instructions
This commit adds simple tests to test the simulator implementation of the vectorized instructions. Most of these tests are autogenerated when running a test using the generate_bn_simd_tests.py scripts. Signed-off-by: Pascal Etterli <[email protected]>
1 parent 7bb0711 commit 545e76e

File tree

10 files changed

+213
-2
lines changed

10 files changed

+213
-2
lines changed

‎hw/ip/otbn/doc/developing_otbn.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,5 +127,5 @@ command-line use otherwise.
127127
## Test the ISS
128128

129129
The ISS has a simple test suite, which runs various instructions and
130-
makes sure they behave as expected. You can find the tests in
131-
`dv/otbnsim/test` and can run them with `make -C dv/otbnsim test`.
130+
makes sure they behave as expected.
131+
See the [simulator page](../dv/otbnsim/README.md) for more details.

‎hw/ip/otbn/dv/otbnsim/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,9 @@ Trace entries from the simulated core (aka. from RTL) appear as a result of DPI
1818
To check correct behaviour, the two separate logs generated by the model and the RTL are compared.
1919
For more information about how OTBN RTL produces traces see the [Tracer README](../tracer/README.md).
2020
To see the C++ program that compares both traces, check the method `otbn_trace_checker.cc` in `../model/otbn_trace_entry`.
21+
22+
## Testing the simulator
23+
There is a simple test suite to check the simulator implementation.
24+
It tests diverse instruction as defined by the tests in `./test/simple/` as well as some autogenerated tests for the bignum SIMD extension (see `generate_bn_simd_test.py`).
25+
26+
All test can be run with `make test` (which also generates the SIMD tests) and a single test can be run using `pytest -vv -k <testname>.s`.

‎hw/ip/otbn/dv/otbnsim/test/simple/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Ignore all autogenerated Bignum SIMD test programs
2+
bn-simd-generated/*

hw/ip/otbn/dv/otbnsim/test/simple/insns/bnlid.exp renamed to hw/ip/otbn/dv/otbnsim/test/simple/insns/bn_lid.exp

File renamed without changes.

hw/ip/otbn/dv/otbnsim/test/simple/insns/bnlid.s renamed to hw/ip/otbn/dv/otbnsim/test/simple/insns/bn_lid.s

File renamed without changes.

‎hw/ip/otbn/dv/otbnsim/test/simple/insns/bn_pack.exp‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Copyright lowRISC contributors (OpenTitan project).
2+
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
w10 = 0xbbaaaabbaaaabbaaccddeeccddeeccddeeccddeeccddeeccddeeccddeeccddee
6+
w11 = 0x3333ff3333ff3333ff3333ff3333ff33aabbaaaabbaaaabbaaaabbaaaabbaaaa
7+
w12 = 0x77557777557777557777557777557777557777557777557733ff3333ff3333ff
8+
9+
INSN_CNT = 17

‎hw/ip/otbn/dv/otbnsim/test/simple/insns/bn_pack.s‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
/* Copyright lowRISC contributors (OpenTitan project). */
2+
/* Licensed under the Apache License, Version 2.0, see LICENSE for details. */
3+
/* SPDX-License-Identifier: Apache-2.0 */
4+
5+
.section .text.start
6+
/*
7+
Load the vectors
8+
*/
9+
addi x2, x0, 0
10+
11+
la x3, vecA
12+
bn.lid x2++, 0(x3)
13+
la x3, vecB
14+
bn.lid x2++, 0(x3)
15+
la x3, vecC
16+
bn.lid x2++, 0(x3)
17+
la x3, vecD
18+
bn.lid x2++, 0(x3)
19+
20+
/* Pack the vectors */
21+
bn.pack w10, w1, w0, 64
22+
bn.pack w11, w2, w1, 128
23+
bn.pack w12, w3, w2, 192
24+
25+
ecall
26+
27+
.section .data
28+
/*
29+
Vectors to pack to 24-bit elements (FE byte should be ignored)
30+
VecA = 0xFECCDDEE_FECCDDEE_FECCDDEE_FECCDDEE_FECCDDEE_FECCDDEE_FECCDDEE_FECCDDEE
31+
VecB = 0xFEAABBAA_FEAABBAA_FEAABBAA_FEAABBAA_FEAABBAA_FEAABBAA_FEAABBAA_FEAABBAA
32+
VecC = 0xFE33FF33_FE33FF33_FE33FF33_FE33FF33_FE33FF33_FE33FF33_FE33FF33_FE33FF33
33+
VecD = 0xFE775577_FE775577_FE775577_FE775577_FE775577_FE775577_FE775577_FE775577
34+
35+
WDR0, Bytes 0-23: Vector A (each element is CCDDEE)
36+
WDR0, Bytes 24-31: 1st part of vector B (each element is AABBAA)
37+
WDR1, Bytes 0-15: 2nd part of vector B
38+
WDR1, Bytes 16-31: 1st part of vector C (each element is 33FF33)
39+
WDR2, Bytes 0- 7: 2nd part of vector C
40+
WDR2, Bytes 8-31: Vector D (each element is 775577)
41+
42+
Expected results
43+
WDR0 = 0xBBAA_AABBAA_AABBAA_CCDDEE_CCDDEE_CCDDEE_CCDDEE_CCDDEE_CCDDEE_CCDDEE_CCDDEE
44+
0xBBAAAABBAAAABBAACCDDEECCDDEECCDDEECCDDEECCDDEECCDDEECCDDEECCDDEE
45+
WDR1 = 0x33_33FF33_33FF33_33FF33_33FF33_33FF33_AABBAA_AABBAA_AABBAA_AABBAA_AABBAA_AA
46+
0x3333FF3333FF3333FF3333FF3333FF33AABBAAAABBAAAABBAAAABBAAAABBAAAA
47+
WDR2 = 0x775577_775577_775577_775577_775577_775577_775577_775577_33FF33_33FF33_33FF
48+
0x77557777557777557777557777557777557777557777557733FF3333FF3333FF
49+
*/
50+
vecA:
51+
.word 0xFECCDDEE
52+
.word 0xFECCDDEE
53+
.word 0xFECCDDEE
54+
.word 0xFECCDDEE
55+
.word 0xFECCDDEE
56+
.word 0xFECCDDEE
57+
.word 0xFECCDDEE
58+
.word 0xFECCDDEE
59+
60+
vecB:
61+
.word 0xFEAABBAA
62+
.word 0xFEAABBAA
63+
.word 0xFEAABBAA
64+
.word 0xFEAABBAA
65+
.word 0xFEAABBAA
66+
.word 0xFEAABBAA
67+
.word 0xFEAABBAA
68+
.word 0xFEAABBAA
69+
70+
vecC:
71+
.word 0xFE33FF33
72+
.word 0xFE33FF33
73+
.word 0xFE33FF33
74+
.word 0xFE33FF33
75+
.word 0xFE33FF33
76+
.word 0xFE33FF33
77+
.word 0xFE33FF33
78+
.word 0xFE33FF33
79+
80+
vecD:
81+
.word 0xFE775577
82+
.word 0xFE775577
83+
.word 0xFE775577
84+
.word 0xFE775577
85+
.word 0xFE775577
86+
.word 0xFE775577
87+
.word 0xFE775577
88+
.word 0xFE775577

‎hw/ip/otbn/dv/otbnsim/test/simple/insns/bn_unpk.exp‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Copyright lowRISC contributors (OpenTitan project).
2+
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
w10 = 0x00ccddee00ccddee00ccddee00ccddee00ccddee00ccddee00ccddee00ccddee
6+
w11 = 0x00aabbaa00aabbaa00aabbaa00aabbaa00aabbaa00aabbaa00aabbaa00aabbaa
7+
w12 = 0x0033ff330033ff330033ff330033ff330033ff330033ff330033ff330033ff33
8+
w13 = 0x0077557700775577007755770077557700775577007755770077557700775577
9+
10+
INSN_CNT = 15

‎hw/ip/otbn/dv/otbnsim/test/simple/insns/bn_unpk.s‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
/* Copyright lowRISC contributors (OpenTitan project). */
2+
/* Licensed under the Apache License, Version 2.0, see LICENSE for details. */
3+
/* SPDX-License-Identifier: Apache-2.0 */
4+
5+
.section .text.start
6+
/*
7+
Load the vectors
8+
*/
9+
addi x2, x0, 0
10+
11+
la x3, vec1
12+
bn.lid x2++, 0(x3)
13+
la x3, vec2
14+
bn.lid x2++, 0(x3)
15+
la x3, vec3
16+
bn.lid x2++, 0(x3)
17+
18+
/* Unpack the vectors */
19+
bn.unpk w10, w1, w0, 0
20+
bn.unpk w11, w1, w0, 192
21+
bn.unpk w12, w2, w1, 128
22+
bn.unpk w13, w2, w2, 64
23+
24+
ecall
25+
26+
.section .data
27+
/*
28+
Vectors to unpack 24-bit elements from
29+
WDR0, Bytes 0-23: Vector A (each element is CCDDEE)
30+
WDR0, Bytes 24-31: 1st part of vector B (each element is AABBAA)
31+
WDR1, Bytes 0-15: 2nd part of vector B
32+
WDR1, Bytes 16-31: 1st part of vector C (each element is 33FF33)
33+
WDR2, Bytes 0- 7: 2nd part of vector C
34+
WDR2, Bytes 8-31: Vector D (each element is 775577)
35+
36+
WDR0 = 0xBBAA_AABBAA_AABBAA_CCDDEE_CCDDEE_CCDDEE_CCDDEE_CCDDEE_CCDDEE_CCDDEE_CCDDEE
37+
0xBBAAAABBAAAABBAACCDDEECCDDEECCDDEECCDDEECCDDEECCDDEECCDDEECCDDEE
38+
WDR1 = 0x33_33FF33_33FF33_33FF33_33FF33_33FF33_AABBAA_AABBAA_AABBAA_AABBAA_AABBAA_AA
39+
0x3333FF3333FF3333FF3333FF3333FF33AABBAAAABBAAAABBAAAABBAAAABBAAAA
40+
WDR2 = 0x775577_775577_775577_775577_775577_775577_775577_775577_33FF33_33FF33_33FF
41+
0x77557777557777557777557777557777557777557777557733FF3333FF3333FF
42+
43+
Expected results
44+
VecA = 0x00CCDDEE_00CCDDEE_00CCDDEE_00CCDDEE_00CCDDEE_00CCDDEE_00CCDDEE_00CCDDEE
45+
VecB = 0x00AABBAA_00AABBAA_00AABBAA_00AABBAA_00AABBAA_00AABBAA_00AABBAA_00AABBAA
46+
VecC = 0x0033FF33_0033FF33_0033FF33_0033FF33_0033FF33_0033FF33_0033FF33_0033FF33
47+
VecD = 0x00775577_00775577_00775577_00775577_00775577_00775577_00775577_00775577
48+
*/
49+
vec1:
50+
.word 0xEECCDDEE
51+
.word 0xDDEECCDD
52+
.word 0xCCDDEECC
53+
.word 0xEECCDDEE
54+
.word 0xDDEECCDD
55+
.word 0xCCDDEECC
56+
.word 0xAAAABBAA
57+
.word 0xBBAAAABB
58+
59+
vec2:
60+
.word 0xAABBAAAA
61+
.word 0xAAAABBAA
62+
.word 0xBBAAAABB
63+
.word 0xAABBAAAA
64+
.word 0x3333FF33
65+
.word 0xFF3333FF
66+
.word 0x33FF3333
67+
.word 0x3333FF33
68+
69+
vec3:
70+
.word 0xFF3333FF
71+
.word 0x33FF3333
72+
.word 0x77775577
73+
.word 0x55777755
74+
.word 0x77557777
75+
.word 0x77775577
76+
.word 0x55777755
77+
.word 0x77557777

‎hw/ip/otbn/dv/otbnsim/test/simple_test.py‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,24 @@
1818
from testutil import asm_and_link_one_file, SIM_DIR
1919
from shared.reg_dump import parse_reg_dump
2020

21+
BN_SIMD_DIR_NAME = 'bn-simd-generated'
22+
BN_SIMD_GENERATOR_SCRIPT = 'generate_bn_simd_tests.py'
23+
24+
25+
def generate_bn_simd_tests() -> None:
26+
'''Generate most of the BN SIMD tests by calling the generator script.'''
27+
28+
script_path = os.path.join(os.path.dirname(__file__), BN_SIMD_GENERATOR_SCRIPT)
29+
output_dir = os.path.join(os.path.dirname(__file__), 'simple', BN_SIMD_DIR_NAME)
30+
31+
# Delete and re-create the output directory
32+
if os.path.exists(output_dir):
33+
subprocess.run(['rm', '-rf', output_dir], check=True)
34+
os.makedirs(output_dir)
35+
36+
cmd = ['python3', script_path, '-o', output_dir]
37+
subprocess.run(cmd, check=True)
38+
2139

2240
def find_simple_tests() -> List[Tuple[str, str]]:
2341
'''Find all tests below ./simple (relative to this file)
@@ -103,6 +121,7 @@ def test_count(tmpdir: py.path.local,
103121

104122
def pytest_generate_tests(metafunc: Any) -> None:
105123
if metafunc.function is test_count:
124+
generate_bn_simd_tests()
106125
tests = find_simple_tests()
107126
test_ids = [os.path.basename(e[0]) for e in tests]
108127
metafunc.parametrize("asm_file,expected_file", tests, ids=test_ids)

0 commit comments

Comments
 (0)