3 * https://bugs.libre-soc.org/show_bug.cgi?id=361
6 from contextlib
import contextmanager
12 from openpower
.decoder
.power_enums
import XER_bits
, CryIn
, spr_dict
13 from openpower
.util
import LogKind
, log
, \
14 fast_reg_to_spr
, slow_reg_to_spr
# HACK!
15 from openpower
.consts
import XERRegsEnum
18 # TODO: make this a util routine (somewhere)
19 def mask_extend(x
, nbits
, repeat
):
21 extended
= (1<<repeat
)-1
22 for i
in range(nbits
):
24 res |
= extended
<< (i
*repeat
)
28 class SkipCase(Exception):
29 """Raise this exception to skip a test case.
31 Usually you'd use one of the skip_case* decorators.
33 For use with TestAccumulatorBase
38 """identity function"""
42 def skip_case(reason
):
44 Unconditionally skip a test case.
47 @skip_case("my reason for skipping")
55 For use with TestAccumulatorBase
58 assert not isinstance(item
, type), \
59 "can't use skip_case to decorate types"
61 @functools.wraps(item
)
62 def wrapper(*args
, **kwargs
):
63 raise SkipCase(reason
)
65 if isinstance(reason
, types
.FunctionType
):
68 return decorator(item
)
72 def skip_case_if(condition
, reason
):
74 Conditionally skip a test case.
77 @skip_case_if(should_i_skip(), "my reason for skipping")
81 For use with TestAccumulatorBase
84 return skip_case(reason
)
88 class TestAccumulatorBase
:
89 __test__
= False # pytest should ignore this class
92 self
.__subtest
_args
= {}
95 # automatically identifies anything starting with "case_" and
96 # runs it. very similar to unittest auto-identification except
97 # we need a different system
98 for n
, v
in self
.__class
__.__dict
__.items():
99 if n
.startswith("case_") and callable(v
):
102 except SkipCase
as e
:
103 # TODO(programmerjake): translate to final test sending
104 # skip signal to unittest. for now, just print the skipped
106 log(f
"SKIPPED({n}):", str(e
), kind
=LogKind
.SkipCase
)
109 def subTest(self
, **kwargs
):
110 old_subtest_args
= self
.__subtest
_args
112 self
.__subtest
_args
= old_subtest_args
.copy()
113 self
.__subtest
_args
.update(**kwargs
)
116 self
.__subtest
_args
= old_subtest_args
118 def add_case(self
, prog
, initial_regs
=None, initial_sprs
=None,
119 initial_cr
=0, initial_msr
=0,
127 # name of caller of this function
128 test_name
= inspect
.stack()[1 + src_loc_at
][3]
129 # name of file containing test case
130 test_file
= os
.path
.splitext(os
.path
.basename(
131 inspect
.stack()[1][1]))[0]
132 tc
= TestCase(prog
, test_name
,
133 regs
=initial_regs
, sprs
=initial_sprs
, cr
=initial_cr
,
136 svstate
=initial_svstate
,
138 stop_at_pc
=stop_at_pc
,
140 subtest_args
=self
.__subtest
_args
.copy(),
143 self
.test_data
.append(tc
)
147 __test__
= False # pytest should ignore this class
149 def __init__(self
, program
, name
, regs
=None, sprs
=None, cr
=0, mem
=None,
152 extra_break_addr
=None,
160 self
.program
= program
178 self
.extra_break_addr
= extra_break_addr
179 self
.svstate
= svstate
180 self
.expected
= expected
# expected results from the test
181 self
.stop_at_pc
= stop_at_pc
# hard-stop address (do not attempt to run)
182 self
.test_file
= test_file
183 self
.subtest_args
= {} if subtest_args
is None else dict(subtest_args
)
188 def get_sim_fast_reg(res
, sim
, dec2
, reg
, name
):
189 spr_sel
= fast_reg_to_spr(reg
)
190 spr_data
= sim
.spr
[spr_sel
].value
193 def get_sim_cia(res
, sim
, dec2
):
194 res
['cia'] = sim
.pc
.CIA
.value
196 # use this *after* the simulation has run a step (it returns CIA)
197 def get_sim_nia(res
, sim
, dec2
):
198 res
['nia'] = sim
.pc
.CIA
.value
200 def get_sim_msr(res
, sim
, dec2
):
201 res
['msr'] = sim
.msr
.value
203 def get_sim_slow_spr1(res
, sim
, dec2
):
204 spr1_en
= yield dec2
.e
.read_spr1
.ok
206 spr1_sel
= yield dec2
.e
.read_spr1
.data
207 spr1_sel
= slow_reg_to_spr(spr1_sel
)
208 spr1_data
= sim
.spr
[spr1_sel
].value
209 res
['spr1'] = spr1_data
211 def get_sim_fast_spr1(res
, sim
, dec2
):
212 fast1_en
= yield dec2
.e
.read_fast1
.ok
214 fast1_sel
= yield dec2
.e
.read_fast1
.data
215 spr1_sel
= fast_reg_to_spr(fast1_sel
)
216 spr1_data
= sim
.spr
[spr1_sel
].value
217 res
['fast1'] = spr1_data
219 def get_sim_fast_spr2(res
, sim
, dec2
):
220 fast2_en
= yield dec2
.e
.read_fast2
.ok
222 fast2_sel
= yield dec2
.e
.read_fast2
.data
223 spr2_sel
= fast_reg_to_spr(fast2_sel
)
224 spr2_data
= sim
.spr
[spr2_sel
].value
225 res
['fast2'] = spr2_data
227 def get_sim_fast_spr3(res
, sim
, dec2
):
228 fast3_en
= yield dec2
.e
.read_fast3
.ok
230 fast3_sel
= yield dec2
.e
.read_fast3
.data
231 spr3_sel
= fast_reg_to_spr(fast3_sel
)
232 spr3_data
= sim
.spr
[spr3_sel
].value
233 res
['fast3'] = spr3_data
235 def get_sim_cr_a(res
, sim
, dec2
):
236 cridx_ok
= yield dec2
.e
.read_cr1
.ok
238 cridx
= yield dec2
.e
.read_cr1
.data
239 res
['cr_a'] = sim
.crl
[cridx
].get_range().value
241 def get_sim_cr_b(res
, sim
, dec2
):
242 cridx_ok
= yield dec2
.e
.read_cr2
.ok
244 cridx
= yield dec2
.e
.read_cr2
.data
245 res
['cr_b'] = sim
.crl
[cridx
].get_range().value
247 def get_sim_cr_c(res
, sim
, dec2
):
248 cridx_ok
= yield dec2
.e
.read_cr3
.ok
250 cridx
= yield dec2
.e
.read_cr3
.data
251 res
['cr_c'] = sim
.crl
[cridx
].get_range().value
253 def get_sim_int_ra(res
, sim
, dec2
):
254 # TODO: immediate RA zero
255 reg1_ok
= yield dec2
.e
.read_reg1
.ok
257 data1
= yield dec2
.e
.read_reg1
.data
258 res
['ra'] = sim
.gpr(data1
).value
260 def get_sim_int_rb(res
, sim
, dec2
):
261 reg2_ok
= yield dec2
.e
.read_reg2
.ok
263 data
= yield dec2
.e
.read_reg2
.data
264 res
['rb'] = sim
.gpr(data
).value
266 def get_sim_int_rc(res
, sim
, dec2
):
267 reg3_ok
= yield dec2
.e
.read_reg3
.ok
269 data
= yield dec2
.e
.read_reg3
.data
270 res
['rc'] = sim
.gpr(data
).value
272 def get_rd_sim_xer_ca(res
, sim
, dec2
):
273 cry_in
= yield dec2
.e
.do
.input_carry
274 xer_in
= yield dec2
.e
.xer_in
275 if (xer_in
& (1<<XERRegsEnum
.CA
)) or cry_in
== CryIn
.CA
.value
:
276 expected_carry
= 1 if sim
.spr
['XER'][XER_bits
['CA']] else 0
277 expected_carry32
= 1 if sim
.spr
['XER'][XER_bits
['CA32']] else 0
278 res
['xer_ca'] = expected_carry |
(expected_carry32
<< 1)
280 def set_int_ra(alu
, dec2
, inp
):
281 # TODO: immediate RA zero.
283 yield alu
.p
.i_data
.ra
.eq(inp
['ra'])
285 yield alu
.p
.i_data
.ra
.eq(0)
287 def set_int_rb(alu
, dec2
, inp
):
288 yield alu
.p
.i_data
.rb
.eq(0)
290 yield alu
.p
.i_data
.rb
.eq(inp
['rb'])
291 if not hasattr(dec2
.e
.do
, "imm_data"):
293 # If there's an immediate, set the B operand to that
294 imm_ok
= yield dec2
.e
.do
.imm_data
.ok
296 data2
= yield dec2
.e
.do
.imm_data
.data
297 yield alu
.p
.i_data
.rb
.eq(data2
)
299 def set_int_rc(alu
, dec2
, inp
):
301 yield alu
.p
.i_data
.rc
.eq(inp
['rc'])
303 yield alu
.p
.i_data
.rc
.eq(0)
305 def set_xer_ca(alu
, dec2
, inp
):
307 yield alu
.p
.i_data
.xer_ca
.eq(inp
['xer_ca'])
308 print("extra inputs: CA/32", bin(inp
['xer_ca']))
310 def set_xer_ov(alu
, dec2
, inp
):
312 yield alu
.p
.i_data
.xer_ov
.eq(inp
['xer_ov'])
313 print("extra inputs: OV/32", bin(inp
['xer_ov']))
315 def set_xer_so(alu
, dec2
, inp
):
318 print("extra inputs: so", so
)
319 yield alu
.p
.i_data
.xer_so
.eq(so
)
321 def set_msr(alu
, dec2
, inp
):
322 print("TODO: deprecate set_msr")
324 yield alu
.p
.i_data
.msr
.eq(inp
['msr'])
326 def set_cia(alu
, dec2
, inp
):
327 print("TODO: deprecate set_cia")
329 yield alu
.p
.i_data
.cia
.eq(inp
['cia'])
331 def set_slow_spr1(alu
, dec2
, inp
):
333 yield alu
.p
.i_data
.spr1
.eq(inp
['spr1'])
335 def set_slow_spr2(alu
, dec2
, inp
):
337 yield alu
.p
.i_data
.spr2
.eq(inp
['spr2'])
339 def set_fast_spr1(alu
, dec2
, inp
):
341 yield alu
.p
.i_data
.fast1
.eq(inp
['fast1'])
343 def set_fast_spr2(alu
, dec2
, inp
):
345 yield alu
.p
.i_data
.fast2
.eq(inp
['fast2'])
347 def set_fast_spr3(alu
, dec2
, inp
):
349 yield alu
.p
.i_data
.fast3
.eq(inp
['fast3'])
351 def set_cr_a(alu
, dec2
, inp
):
353 yield alu
.p
.i_data
.cr_a
.eq(inp
['cr_a'])
355 def set_cr_b(alu
, dec2
, inp
):
357 yield alu
.p
.i_data
.cr_b
.eq(inp
['cr_b'])
359 def set_cr_c(alu
, dec2
, inp
):
361 yield alu
.p
.i_data
.cr_c
.eq(inp
['cr_c'])
363 def set_full_cr(alu
, dec2
, inp
):
365 full_reg
= yield dec2
.dec_cr_in
.whole_reg
.data
366 full_reg_ok
= yield dec2
.dec_cr_in
.whole_reg
.ok
367 full_cr_mask
= mask_extend(full_reg
, 8, 4)
368 yield alu
.p
.i_data
.full_cr
.eq(inp
['full_cr'] & full_cr_mask
)
370 yield alu
.p
.i_data
.full_cr
.eq(0)
372 def get_slow_spr1(res
, alu
, dec2
):
373 spr1_valid
= yield alu
.n
.o_data
.spr1
.ok
375 res
['spr1'] = yield alu
.n
.o_data
.spr1
.data
377 def get_slow_spr2(res
, alu
, dec2
):
378 spr2_valid
= yield alu
.n
.o_data
.spr2
.ok
380 res
['spr2'] = yield alu
.n
.o_data
.spr2
.data
382 def get_fast_spr1(res
, alu
, dec2
):
383 spr1_valid
= yield alu
.n
.o_data
.fast1
.ok
385 res
['fast1'] = yield alu
.n
.o_data
.fast1
.data
387 def get_fast_spr2(res
, alu
, dec2
):
388 spr2_valid
= yield alu
.n
.o_data
.fast2
.ok
390 res
['fast2'] = yield alu
.n
.o_data
.fast2
.data
392 def get_fast_spr3(res
, alu
, dec2
):
393 spr3_valid
= yield alu
.n
.o_data
.fast3
.ok
395 res
['fast3'] = yield alu
.n
.o_data
.fast3
.data
397 def get_cia(res
, alu
, dec2
):
398 res
['cia'] = yield alu
.p
.i_data
.cia
400 def get_nia(res
, alu
, dec2
):
401 nia_valid
= yield alu
.n
.o_data
.nia
.ok
403 res
['nia'] = yield alu
.n
.o_data
.nia
.data
405 def get_msr(res
, alu
, dec2
):
406 msr_valid
= yield alu
.n
.o_data
.msr
.ok
408 res
['msr'] = yield alu
.n
.o_data
.msr
.data
410 def get_int_o1(res
, alu
, dec2
):
411 out_reg_valid
= yield dec2
.e
.write_ea
.ok
413 res
['o1'] = yield alu
.n
.o_data
.o1
.data
415 def get_int_o(res
, alu
, dec2
):
416 out_reg_valid
= yield dec2
.e
.write_reg
.ok
418 res
['o'] = yield alu
.n
.o_data
.o
.data
420 def get_cr_a(res
, alu
, dec2
):
421 cridx_ok
= yield dec2
.e
.write_cr
.ok
423 res
['cr_a'] = yield alu
.n
.o_data
.cr0
.data
425 def get_xer_so(res
, alu
, dec2
):
426 oe
= yield dec2
.e
.do
.oe
.oe
427 oe_ok
= yield dec2
.e
.do
.oe
.ok
428 xer_out
= yield dec2
.e
.xer_out
429 if not (yield alu
.n
.o_data
.xer_so
.ok
):
431 if xer_out
or (oe
and oe_ok
):
432 res
['xer_so'] = yield alu
.n
.o_data
.xer_so
.data
[0]
434 def get_xer_ov(res
, alu
, dec2
):
435 oe
= yield dec2
.e
.do
.oe
.oe
436 oe_ok
= yield dec2
.e
.do
.oe
.ok
437 xer_out
= yield dec2
.e
.xer_out
438 if not (yield alu
.n
.o_data
.xer_ov
.ok
):
440 if xer_out
or (oe
and oe_ok
):
441 res
['xer_ov'] = yield alu
.n
.o_data
.xer_ov
.data
443 def get_xer_ca(res
, alu
, dec2
):
444 cry_out
= yield dec2
.e
.do
.output_carry
445 xer_out
= yield dec2
.e
.xer_out
446 if not (yield alu
.n
.o_data
.xer_ca
.ok
):
448 if xer_out
or (cry_out
):
449 res
['xer_ca'] = yield alu
.n
.o_data
.xer_ca
.data
451 def get_sim_int_o(res
, sim
, dec2
):
452 out_reg_valid
= yield dec2
.e
.write_reg
.ok
454 write_reg_idx
= yield dec2
.e
.write_reg
.data
455 res
['o'] = sim
.gpr(write_reg_idx
).value
457 def get_sim_int_o1(res
, sim
, dec2
):
458 out_reg_valid
= yield dec2
.e
.write_ea
.ok
460 write_reg_idx
= yield dec2
.e
.write_ea
.data
461 res
['o1'] = sim
.gpr(write_reg_idx
).value
463 def get_wr_sim_cr_a(res
, sim
, dec2
):
464 cridx_ok
= yield dec2
.e
.write_cr
.ok
466 cridx
= yield dec2
.e
.write_cr
.data
467 res
['cr_a'] = sim
.crl
[cridx
].get_range().value
469 def get_wr_fast_spr3(res
, sim
, dec2
):
470 ok
= yield dec2
.e
.write_fast3
.ok
472 spr_num
= yield dec2
.e
.write_fast3
.data
473 spr_num
= fast_reg_to_spr(spr_num
)
474 spr_name
= spr_dict
[spr_num
].SPR
475 res
['fast3'] = sim
.spr
[spr_name
].value
477 def get_wr_fast_spr2(res
, sim
, dec2
):
478 ok
= yield dec2
.e
.write_fast2
.ok
480 spr_num
= yield dec2
.e
.write_fast2
.data
481 spr_num
= fast_reg_to_spr(spr_num
)
482 spr_name
= spr_dict
[spr_num
].SPR
483 res
['fast2'] = sim
.spr
[spr_name
].value
485 def get_wr_fast_spr1(res
, sim
, dec2
):
486 ok
= yield dec2
.e
.write_fast1
.ok
488 spr_num
= yield dec2
.e
.write_fast1
.data
489 spr_num
= fast_reg_to_spr(spr_num
)
490 spr_name
= spr_dict
[spr_num
].SPR
491 res
['fast1'] = sim
.spr
[spr_name
].value
493 def get_wr_slow_spr1(res
, sim
, dec2
):
494 ok
= yield dec2
.e
.write_spr
.ok
496 spr_num
= yield dec2
.e
.write_spr
.data
497 spr_num
= slow_reg_to_spr(spr_num
)
498 spr_name
= spr_dict
[spr_num
].SPR
499 res
['spr1'] = sim
.spr
[spr_name
].value
501 def get_wr_sim_xer_ca(res
, sim
, dec2
):
502 # if not (yield alu.n.o_data.xer_ca.ok):
504 cry_out
= yield dec2
.e
.do
.output_carry
505 xer_out
= yield dec2
.e
.xer_out
506 if cry_out
or xer_out
:
507 expected_carry
= 1 if sim
.spr
['XER'][XER_bits
['CA']] else 0
508 expected_carry32
= 1 if sim
.spr
['XER'][XER_bits
['CA32']] else 0
509 res
['xer_ca'] = expected_carry |
(expected_carry32
<< 1)
511 def get_wr_sim_xer_ov(res
, sim
, alu
, dec2
):
512 oe
= yield dec2
.e
.do
.oe
.oe
513 oe_ok
= yield dec2
.e
.do
.oe
.ok
514 xer_out
= yield dec2
.e
.xer_out
515 print("get_wr_sim_xer_ov", xer_out
)
516 if not (yield alu
.n
.o_data
.xer_ov
.ok
):
518 if xer_out
or (oe
and oe_ok
):
519 expected_ov
= 1 if sim
.spr
['XER'][XER_bits
['OV']] else 0
520 expected_ov32
= 1 if sim
.spr
['XER'][XER_bits
['OV32']] else 0
521 res
['xer_ov'] = expected_ov |
(expected_ov32
<< 1)
523 def get_wr_sim_xer_so(res
, sim
, alu
, dec2
):
524 oe
= yield dec2
.e
.do
.oe
.oe
525 oe_ok
= yield dec2
.e
.do
.oe
.ok
526 xer_out
= yield dec2
.e
.xer_out
527 if not (yield alu
.n
.o_data
.xer_so
.ok
):
529 if xer_out
or (oe
and oe_ok
):
530 res
['xer_so'] = 1 if sim
.spr
['XER'][XER_bits
['SO']] else 0
532 def get_sim_xer_ov(res
, sim
, dec2
):
533 oe
= yield dec2
.e
.do
.oe
.oe
534 oe_ok
= yield dec2
.e
.do
.oe
.ok
535 xer_in
= yield dec2
.e
.xer_in
536 print("get_sim_xer_ov", xer_in
)
537 if (xer_in
& (1<<XERRegsEnum
.OV
)) or (oe
and oe_ok
):
538 expected_ov
= 1 if sim
.spr
['XER'][XER_bits
['OV']] else 0
539 expected_ov32
= 1 if sim
.spr
['XER'][XER_bits
['OV32']] else 0
540 res
['xer_ov'] = expected_ov |
(expected_ov32
<< 1)
542 def get_sim_xer_so(res
, sim
, dec2
):
543 print ("XER", sim
.spr
.__class
__, sim
.spr
, sim
.spr
['XER'])
544 oe
= yield dec2
.e
.do
.oe
.oe
545 oe_ok
= yield dec2
.e
.do
.oe
.ok
546 xer_in
= yield dec2
.e
.xer_in
547 rc
= yield dec2
.e
.do
.rc
.rc
548 rc_ok
= yield dec2
.e
.do
.rc
.ok
549 if (xer_in
& (1<<XERRegsEnum
.SO
)) or (oe
and oe_ok
) or (rc
and rc_ok
):
550 res
['xer_so'] = 1 if sim
.spr
['XER'][XER_bits
['SO']] else 0
552 def check_slow_spr1(dut
, res
, sim_o
, msg
):
554 expected
= sim_o
['spr1']
555 alu_out
= res
['spr1']
556 print(f
"expected {expected:x}, actual: {alu_out:x}")
557 dut
.assertEqual(expected
, alu_out
, msg
)
559 def check_fast_spr1(dut
, res
, sim_o
, msg
):
561 expected
= sim_o
['fast1']
562 alu_out
= res
['fast1']
563 print(f
"expected {expected:x}, actual: {alu_out:x}")
564 dut
.assertEqual(expected
, alu_out
, msg
)
566 def check_fast_spr2(dut
, res
, sim_o
, msg
):
568 expected
= sim_o
['fast2']
569 alu_out
= res
['fast2']
570 print(f
"expected {expected:x}, actual: {alu_out:x}")
571 dut
.assertEqual(expected
, alu_out
, msg
)
573 def check_fast_spr3(dut
, res
, sim_o
, msg
):
575 expected
= sim_o
['fast3']
576 alu_out
= res
['fast3']
577 print(f
"expected {expected:x}, actual: {alu_out:x}")
578 dut
.assertEqual(expected
, alu_out
, msg
)
580 def check_int_o1(dut
, res
, sim_o
, msg
):
582 expected
= sim_o
['o1']
584 print(f
"expected {expected:x}, actual: {alu_out:x}")
585 dut
.assertEqual(expected
, alu_out
, msg
)
587 def check_int_o(dut
, res
, sim_o
, msg
):
589 expected
= sim_o
['o']
591 print(f
"expected int sim {expected:x}, actual: {alu_out:x}")
592 dut
.assertEqual(expected
, alu_out
, msg
)
594 def check_msr(dut
, res
, sim_o
, msg
):
596 expected
= sim_o
['msr']
598 print(f
"expected {expected:x}, actual: {alu_out:x}")
599 dut
.assertEqual(expected
, alu_out
, msg
)
601 def check_nia(dut
, res
, sim_o
, msg
):
603 expected
= sim_o
['nia']
605 print(f
"expected {expected:x}, actual: {alu_out:x}")
606 dut
.assertEqual(expected
, alu_out
, msg
)
608 def check_cr_a(dut
, res
, sim_o
, msg
):
610 cr_expected
= sim_o
['cr_a']
611 cr_actual
= res
['cr_a']
612 print("CR", cr_expected
, cr_actual
)
613 dut
.assertEqual(cr_expected
, cr_actual
, msg
)
615 def check_xer_ca(dut
, res
, sim_o
, msg
):
617 ca_expected
= sim_o
['xer_ca']
618 ca_actual
= res
['xer_ca']
619 print("CA", ca_expected
, ca_actual
)
620 dut
.assertEqual(ca_expected
, ca_actual
, msg
)
622 def check_xer_ov(dut
, res
, sim_o
, msg
):
624 ov_expected
= sim_o
['xer_ov']
625 ov_actual
= res
['xer_ov']
626 print("OV", ov_expected
, ov_actual
)
627 dut
.assertEqual(ov_expected
, ov_actual
, msg
)
629 def check_xer_so(dut
, res
, sim_o
, msg
):
631 so_expected
= sim_o
['xer_so']
632 so_actual
= res
['xer_so']
633 print("SO", so_expected
, so_actual
)
634 dut
.assertEqual(so_expected
, so_actual
, msg
)