move more files to openpower-isa
[soc.git] / src / soc / fu / test / common.py
index 359c7d6de31d0641dfc78aa40f27a5c8203ec597..c5b6069779c7b1b1483e3d57a17d6a9ceb4c1445 100644 (file)
@@ -1,558 +1,7 @@
-"""
-Bugreports:
-* https://bugs.libre-soc.org/show_bug.cgi?id=361
-"""
+# moved to openpower-isa
+# https://git.libre-soc.org/?p=openpower-isa.git;a=summary
+# wildcard imports here ONLY to support migration
 
-import inspect
-import functools
-import types
-from openpower.decoder.power_enums import XER_bits, CryIn, spr_dict
-from soc.regfile.util import fast_reg_to_spr, slow_reg_to_spr  # HACK!
-from soc.regfile.regfiles import XERRegs, FastRegs
+from openpower.test.common import *
+from openpower.util import mask_extend
 
-
-# TODO: make this a util routine (somewhere)
-def mask_extend(x, nbits, repeat):
-    res = 0
-    extended = (1<<repeat)-1
-    for i in range(nbits):
-        if x & (1<<i):
-            res |= extended << (i*repeat)
-    return res
-
-
-class SkipCase(Exception):
-    """Raise this exception to skip a test case.
-
-    Usually you'd use one of the skip_case* decorators.
-
-    For use with TestAccumulatorBase
-    """
-
-
-def _id(obj):
-    """identity function"""
-    return obj
-
-
-def skip_case(reason):
-    """
-    Unconditionally skip a test case.
-
-    Use like:
-        @skip_case("my reason for skipping")
-        def case_abc(self):
-            ...
-    or:
-        @skip_case
-        def case_def(self):
-            ...
-
-    For use with TestAccumulatorBase
-    """
-    def decorator(item):
-        assert not isinstance(item, type), \
-            "can't use skip_case to decorate types"
-
-        @functools.wraps(item)
-        def wrapper(*args, **kwargs):
-            raise SkipCase(reason)
-        return wrapper
-    if isinstance(reason, types.FunctionType):
-        item = reason
-        reason = ""
-        return decorator(item)
-    return decorator
-
-
-def skip_case_if(condition, reason):
-    """
-    Conditionally skip a test case.
-
-    Use like:
-        @skip_case_if(should_i_skip(), "my reason for skipping")
-        def case_abc(self):
-            ...
-
-    For use with TestAccumulatorBase
-    """
-    if condition:
-        return skip_case(reason)
-    return _id
-
-
-class TestAccumulatorBase:
-
-    def __init__(self):
-        self.test_data = []
-        # automatically identifies anything starting with "case_" and
-        # runs it.  very similar to unittest auto-identification except
-        # we need a different system
-        for n, v in self.__class__.__dict__.items():
-            if n.startswith("case_") and callable(v):
-                try:
-                    v(self)
-                except SkipCase as e:
-                    # TODO(programmerjake): translate to final test sending
-                    # skip signal to unittest. for now, just print the skipped
-                    # reason and ignore
-                    print(f"SKIPPED({n}):", str(e))
-
-    def add_case(self, prog, initial_regs=None, initial_sprs=None,
-                 initial_cr=0, initial_msr=0,
-                 initial_mem=None,
-                 initial_svstate=0):
-
-        test_name = inspect.stack()[1][3]  # name of caller of this function
-        tc = TestCase(prog, test_name,
-                      regs=initial_regs, sprs=initial_sprs, cr=initial_cr,
-                      msr=initial_msr,
-                      mem=initial_mem,
-                      svstate=initial_svstate)
-
-        self.test_data.append(tc)
-
-
-class TestCase:
-    def __init__(self, program, name, regs=None, sprs=None, cr=0, mem=None,
-                 msr=0,
-                 do_sim=True,
-                 extra_break_addr=None,
-                 svstate=0):
-
-        self.program = program
-        self.name = name
-
-        if regs is None:
-            regs = [0] * 32
-        if sprs is None:
-            sprs = {}
-        if mem is None:
-            mem = {}
-        self.regs = regs
-        self.sprs = sprs
-        self.cr = cr
-        self.mem = mem
-        self.msr = msr
-        self.do_sim = do_sim
-        self.extra_break_addr = extra_break_addr
-        self.svstate = svstate
-
-
-class ALUHelpers:
-
-    def get_sim_fast_reg(res, sim, dec2, reg, name):
-        spr_sel = fast_reg_to_spr(reg)
-        spr_data = sim.spr[spr_sel].value
-        res[name] = spr_data
-
-    def get_sim_cia(res, sim, dec2):
-        res['cia'] = sim.pc.CIA.value
-
-    # use this *after* the simulation has run a step (it returns CIA)
-    def get_sim_nia(res, sim, dec2):
-        res['nia'] = sim.pc.CIA.value
-
-    def get_sim_msr(res, sim, dec2):
-        res['msr'] = sim.msr.value
-
-    def get_sim_slow_spr1(res, sim, dec2):
-        spr1_en = yield dec2.e.read_spr1.ok
-        if spr1_en:
-            spr1_sel = yield dec2.e.read_spr1.data
-            spr1_sel = slow_reg_to_spr(spr1_sel)
-            spr1_data = sim.spr[spr1_sel].value
-            res['spr1'] = spr1_data
-
-    def get_sim_fast_spr1(res, sim, dec2):
-        fast1_en = yield dec2.e.read_fast1.ok
-        if fast1_en:
-            fast1_sel = yield dec2.e.read_fast1.data
-            spr1_sel = fast_reg_to_spr(fast1_sel)
-            spr1_data = sim.spr[spr1_sel].value
-            res['fast1'] = spr1_data
-
-    def get_sim_fast_spr2(res, sim, dec2):
-        fast2_en = yield dec2.e.read_fast2.ok
-        if fast2_en:
-            fast2_sel = yield dec2.e.read_fast2.data
-            spr2_sel = fast_reg_to_spr(fast2_sel)
-            spr2_data = sim.spr[spr2_sel].value
-            res['fast2'] = spr2_data
-
-    def get_sim_cr_a(res, sim, dec2):
-        cridx_ok = yield dec2.e.read_cr1.ok
-        if cridx_ok:
-            cridx = yield dec2.e.read_cr1.data
-            res['cr_a'] = sim.crl[cridx].get_range().value
-
-    def get_sim_cr_b(res, sim, dec2):
-        cridx_ok = yield dec2.e.read_cr2.ok
-        if cridx_ok:
-            cridx = yield dec2.e.read_cr2.data
-            res['cr_b'] = sim.crl[cridx].get_range().value
-
-    def get_sim_cr_c(res, sim, dec2):
-        cridx_ok = yield dec2.e.read_cr3.ok
-        if cridx_ok:
-            cridx = yield dec2.e.read_cr3.data
-            res['cr_c'] = sim.crl[cridx].get_range().value
-
-    def get_sim_int_ra(res, sim, dec2):
-        # TODO: immediate RA zero
-        reg1_ok = yield dec2.e.read_reg1.ok
-        if reg1_ok:
-            data1 = yield dec2.e.read_reg1.data
-            res['ra'] = sim.gpr(data1).value
-
-    def get_sim_int_rb(res, sim, dec2):
-        reg2_ok = yield dec2.e.read_reg2.ok
-        if reg2_ok:
-            data = yield dec2.e.read_reg2.data
-            res['rb'] = sim.gpr(data).value
-
-    def get_sim_int_rc(res, sim, dec2):
-        reg3_ok = yield dec2.e.read_reg3.ok
-        if reg3_ok:
-            data = yield dec2.e.read_reg3.data
-            res['rc'] = sim.gpr(data).value
-
-    def get_rd_sim_xer_ca(res, sim, dec2):
-        cry_in = yield dec2.e.do.input_carry
-        xer_in = yield dec2.e.xer_in
-        if (xer_in & (1<<XERRegs.CA)) or cry_in == CryIn.CA.value:
-            expected_carry = 1 if sim.spr['XER'][XER_bits['CA']] else 0
-            expected_carry32 = 1 if sim.spr['XER'][XER_bits['CA32']] else 0
-            res['xer_ca'] = expected_carry | (expected_carry32 << 1)
-
-    def set_int_ra(alu, dec2, inp):
-        # TODO: immediate RA zero.
-        if 'ra' in inp:
-            yield alu.p.data_i.ra.eq(inp['ra'])
-        else:
-            yield alu.p.data_i.ra.eq(0)
-
-    def set_int_rb(alu, dec2, inp):
-        yield alu.p.data_i.rb.eq(0)
-        if 'rb' in inp:
-            yield alu.p.data_i.rb.eq(inp['rb'])
-        if not hasattr(dec2.e.do, "imm_data"):
-            return
-        # If there's an immediate, set the B operand to that
-        imm_ok = yield dec2.e.do.imm_data.ok
-        if imm_ok:
-            data2 = yield dec2.e.do.imm_data.data
-            yield alu.p.data_i.rb.eq(data2)
-
-    def set_int_rc(alu, dec2, inp):
-        if 'rc' in inp:
-            yield alu.p.data_i.rc.eq(inp['rc'])
-        else:
-            yield alu.p.data_i.rc.eq(0)
-
-    def set_xer_ca(alu, dec2, inp):
-        if 'xer_ca' in inp:
-            yield alu.p.data_i.xer_ca.eq(inp['xer_ca'])
-            print("extra inputs: CA/32", bin(inp['xer_ca']))
-
-    def set_xer_ov(alu, dec2, inp):
-        if 'xer_ov' in inp:
-            yield alu.p.data_i.xer_ov.eq(inp['xer_ov'])
-            print("extra inputs: OV/32", bin(inp['xer_ov']))
-
-    def set_xer_so(alu, dec2, inp):
-        if 'xer_so' in inp:
-            so = inp['xer_so']
-            print("extra inputs: so", so)
-            yield alu.p.data_i.xer_so.eq(so)
-
-    def set_msr(alu, dec2, inp):
-        print("TODO: deprecate set_msr")
-        if 'msr' in inp:
-            yield alu.p.data_i.msr.eq(inp['msr'])
-
-    def set_cia(alu, dec2, inp):
-        print("TODO: deprecate set_cia")
-        if 'cia' in inp:
-            yield alu.p.data_i.cia.eq(inp['cia'])
-
-    def set_slow_spr1(alu, dec2, inp):
-        if 'spr1' in inp:
-            yield alu.p.data_i.spr1.eq(inp['spr1'])
-
-    def set_slow_spr2(alu, dec2, inp):
-        if 'spr2' in inp:
-            yield alu.p.data_i.spr2.eq(inp['spr2'])
-
-    def set_fast_spr1(alu, dec2, inp):
-        if 'fast1' in inp:
-            yield alu.p.data_i.fast1.eq(inp['fast1'])
-
-    def set_fast_spr2(alu, dec2, inp):
-        if 'fast2' in inp:
-            yield alu.p.data_i.fast2.eq(inp['fast2'])
-
-    def set_cr_a(alu, dec2, inp):
-        if 'cr_a' in inp:
-            yield alu.p.data_i.cr_a.eq(inp['cr_a'])
-
-    def set_cr_b(alu, dec2, inp):
-        if 'cr_b' in inp:
-            yield alu.p.data_i.cr_b.eq(inp['cr_b'])
-
-    def set_cr_c(alu, dec2, inp):
-        if 'cr_c' in inp:
-            yield alu.p.data_i.cr_c.eq(inp['cr_c'])
-
-    def set_full_cr(alu, dec2, inp):
-        if 'full_cr' in inp:
-            full_reg = yield dec2.dec_cr_in.whole_reg.data
-            full_reg_ok = yield dec2.dec_cr_in.whole_reg.ok
-            full_cr_mask = mask_extend(full_reg, 8, 4)
-            yield alu.p.data_i.full_cr.eq(inp['full_cr'] & full_cr_mask)
-        else:
-            yield alu.p.data_i.full_cr.eq(0)
-
-    def get_slow_spr1(res, alu, dec2):
-        spr1_valid = yield alu.n.data_o.spr1.ok
-        if spr1_valid:
-            res['spr1'] = yield alu.n.data_o.spr1.data
-
-    def get_slow_spr2(res, alu, dec2):
-        spr2_valid = yield alu.n.data_o.spr2.ok
-        if spr2_valid:
-            res['spr2'] = yield alu.n.data_o.spr2.data
-
-    def get_fast_spr1(res, alu, dec2):
-        spr1_valid = yield alu.n.data_o.fast1.ok
-        if spr1_valid:
-            res['fast1'] = yield alu.n.data_o.fast1.data
-
-    def get_fast_spr2(res, alu, dec2):
-        spr2_valid = yield alu.n.data_o.fast2.ok
-        if spr2_valid:
-            res['fast2'] = yield alu.n.data_o.fast2.data
-
-    def get_cia(res, alu, dec2):
-        res['cia'] = yield alu.p.data_i.cia
-
-    def get_nia(res, alu, dec2):
-        nia_valid = yield alu.n.data_o.nia.ok
-        if nia_valid:
-            res['nia'] = yield alu.n.data_o.nia.data
-
-    def get_msr(res, alu, dec2):
-        msr_valid = yield alu.n.data_o.msr.ok
-        if msr_valid:
-            res['msr'] = yield alu.n.data_o.msr.data
-
-    def get_int_o1(res, alu, dec2):
-        out_reg_valid = yield dec2.e.write_ea.ok
-        if out_reg_valid:
-            res['o1'] = yield alu.n.data_o.o1.data
-
-    def get_int_o(res, alu, dec2):
-        out_reg_valid = yield dec2.e.write_reg.ok
-        if out_reg_valid:
-            res['o'] = yield alu.n.data_o.o.data
-
-    def get_cr_a(res, alu, dec2):
-        cridx_ok = yield dec2.e.write_cr.ok
-        if cridx_ok:
-            res['cr_a'] = yield alu.n.data_o.cr0.data
-
-    def get_xer_so(res, alu, dec2):
-        oe = yield dec2.e.do.oe.oe
-        oe_ok = yield dec2.e.do.oe.ok
-        xer_out = yield dec2.e.xer_out
-        if not (yield alu.n.data_o.xer_so.ok):
-            return
-        if xer_out or (oe and oe_ok):
-            res['xer_so'] = yield alu.n.data_o.xer_so.data[0]
-
-    def get_xer_ov(res, alu, dec2):
-        oe = yield dec2.e.do.oe.oe
-        oe_ok = yield dec2.e.do.oe.ok
-        xer_out = yield dec2.e.xer_out
-        if not (yield alu.n.data_o.xer_ov.ok):
-            return
-        if xer_out or (oe and oe_ok):
-            res['xer_ov'] = yield alu.n.data_o.xer_ov.data
-
-    def get_xer_ca(res, alu, dec2):
-        cry_out = yield dec2.e.do.output_carry
-        xer_out = yield dec2.e.xer_out
-        if not (yield alu.n.data_o.xer_ca.ok):
-            return
-        if xer_out or (cry_out):
-            res['xer_ca'] = yield alu.n.data_o.xer_ca.data
-
-    def get_sim_int_o(res, sim, dec2):
-        out_reg_valid = yield dec2.e.write_reg.ok
-        if out_reg_valid:
-            write_reg_idx = yield dec2.e.write_reg.data
-            res['o'] = sim.gpr(write_reg_idx).value
-
-    def get_sim_int_o1(res, sim, dec2):
-        out_reg_valid = yield dec2.e.write_ea.ok
-        if out_reg_valid:
-            write_reg_idx = yield dec2.e.write_ea.data
-            res['o1'] = sim.gpr(write_reg_idx).value
-
-    def get_wr_sim_cr_a(res, sim, dec2):
-        cridx_ok = yield dec2.e.write_cr.ok
-        if cridx_ok:
-            cridx = yield dec2.e.write_cr.data
-            res['cr_a'] = sim.crl[cridx].get_range().value
-
-    def get_wr_fast_spr2(res, sim, dec2):
-        ok = yield dec2.e.write_fast2.ok
-        if ok:
-            spr_num = yield dec2.e.write_fast2.data
-            spr_num = fast_reg_to_spr(spr_num)
-            spr_name = spr_dict[spr_num].SPR
-            res['fast2'] = sim.spr[spr_name].value
-
-    def get_wr_fast_spr1(res, sim, dec2):
-        ok = yield dec2.e.write_fast1.ok
-        if ok:
-            spr_num = yield dec2.e.write_fast1.data
-            spr_num = fast_reg_to_spr(spr_num)
-            spr_name = spr_dict[spr_num].SPR
-            res['fast1'] = sim.spr[spr_name].value
-
-    def get_wr_slow_spr1(res, sim, dec2):
-        ok = yield dec2.e.write_spr.ok
-        if ok:
-            spr_num = yield dec2.e.write_spr.data
-            spr_num = slow_reg_to_spr(spr_num)
-            spr_name = spr_dict[spr_num].SPR
-            res['spr1'] = sim.spr[spr_name].value
-
-    def get_wr_sim_xer_ca(res, sim, dec2):
-        # if not (yield alu.n.data_o.xer_ca.ok):
-        #    return
-        cry_out = yield dec2.e.do.output_carry
-        xer_out = yield dec2.e.xer_out
-        if cry_out or xer_out:
-            expected_carry = 1 if sim.spr['XER'][XER_bits['CA']] else 0
-            expected_carry32 = 1 if sim.spr['XER'][XER_bits['CA32']] else 0
-            res['xer_ca'] = expected_carry | (expected_carry32 << 1)
-
-    def get_wr_sim_xer_ov(res, sim, alu, dec2):
-        oe = yield dec2.e.do.oe.oe
-        oe_ok = yield dec2.e.do.oe.ok
-        xer_out = yield dec2.e.xer_out
-        print("get_wr_sim_xer_ov", xer_out)
-        if not (yield alu.n.data_o.xer_ov.ok):
-            return
-        if xer_out or (oe and oe_ok):
-            expected_ov = 1 if sim.spr['XER'][XER_bits['OV']] else 0
-            expected_ov32 = 1 if sim.spr['XER'][XER_bits['OV32']] else 0
-            res['xer_ov'] = expected_ov | (expected_ov32 << 1)
-
-    def get_wr_sim_xer_so(res, sim, alu, dec2):
-        oe = yield dec2.e.do.oe.oe
-        oe_ok = yield dec2.e.do.oe.ok
-        xer_out = yield dec2.e.xer_out
-        if not (yield alu.n.data_o.xer_so.ok):
-            return
-        if xer_out or (oe and oe_ok):
-            res['xer_so'] = 1 if sim.spr['XER'][XER_bits['SO']] else 0
-
-    def get_sim_xer_ov(res, sim, dec2):
-        oe = yield dec2.e.do.oe.oe
-        oe_ok = yield dec2.e.do.oe.ok
-        xer_in = yield dec2.e.xer_in
-        print("get_sim_xer_ov", xer_in)
-        if (xer_in & (1<<XERRegs.OV)) or (oe and oe_ok):
-            expected_ov = 1 if sim.spr['XER'][XER_bits['OV']] else 0
-            expected_ov32 = 1 if sim.spr['XER'][XER_bits['OV32']] else 0
-            res['xer_ov'] = expected_ov | (expected_ov32 << 1)
-
-    def get_sim_xer_so(res, sim, dec2):
-        print ("XER", sim.spr.__class__, sim.spr, sim.spr['XER'])
-        oe = yield dec2.e.do.oe.oe
-        oe_ok = yield dec2.e.do.oe.ok
-        xer_in = yield dec2.e.xer_in
-        rc = yield dec2.e.do.rc.rc
-        rc_ok = yield dec2.e.do.rc.ok
-        if (xer_in & (1<<XERRegs.SO)) or (oe and oe_ok) or (rc and rc_ok):
-            res['xer_so'] = 1 if sim.spr['XER'][XER_bits['SO']] else 0
-
-    def check_slow_spr1(dut, res, sim_o, msg):
-        if 'spr1' in res:
-            expected = sim_o['spr1']
-            alu_out = res['spr1']
-            print(f"expected {expected:x}, actual: {alu_out:x}")
-            dut.assertEqual(expected, alu_out, msg)
-
-    def check_fast_spr1(dut, res, sim_o, msg):
-        if 'fast1' in res:
-            expected = sim_o['fast1']
-            alu_out = res['fast1']
-            print(f"expected {expected:x}, actual: {alu_out:x}")
-            dut.assertEqual(expected, alu_out, msg)
-
-    def check_fast_spr2(dut, res, sim_o, msg):
-        if 'fast2' in res:
-            expected = sim_o['fast2']
-            alu_out = res['fast2']
-            print(f"expected {expected:x}, actual: {alu_out:x}")
-            dut.assertEqual(expected, alu_out, msg)
-
-    def check_int_o1(dut, res, sim_o, msg):
-        if 'o1' in res:
-            expected = sim_o['o1']
-            alu_out = res['o1']
-            print(f"expected {expected:x}, actual: {alu_out:x}")
-            dut.assertEqual(expected, alu_out, msg)
-
-    def check_int_o(dut, res, sim_o, msg):
-        if 'o' in res:
-            expected = sim_o['o']
-            alu_out = res['o']
-            print(f"expected int sim {expected:x}, actual: {alu_out:x}")
-            dut.assertEqual(expected, alu_out, msg)
-
-    def check_msr(dut, res, sim_o, msg):
-        if 'msr' in res:
-            expected = sim_o['msr']
-            alu_out = res['msr']
-            print(f"expected {expected:x}, actual: {alu_out:x}")
-            dut.assertEqual(expected, alu_out, msg)
-
-    def check_nia(dut, res, sim_o, msg):
-        if 'nia' in res:
-            expected = sim_o['nia']
-            alu_out = res['nia']
-            print(f"expected {expected:x}, actual: {alu_out:x}")
-            dut.assertEqual(expected, alu_out, msg)
-
-    def check_cr_a(dut, res, sim_o, msg):
-        if 'cr_a' in res:
-            cr_expected = sim_o['cr_a']
-            cr_actual = res['cr_a']
-            print("CR", cr_expected, cr_actual)
-            dut.assertEqual(cr_expected, cr_actual, msg)
-
-    def check_xer_ca(dut, res, sim_o, msg):
-        if 'xer_ca' in res:
-            ca_expected = sim_o['xer_ca']
-            ca_actual = res['xer_ca']
-            print("CA", ca_expected, ca_actual)
-            dut.assertEqual(ca_expected, ca_actual, msg)
-
-    def check_xer_ov(dut, res, sim_o, msg):
-        if 'xer_ov' in res:
-            ov_expected = sim_o['xer_ov']
-            ov_actual = res['xer_ov']
-            print("OV", ov_expected, ov_actual)
-            dut.assertEqual(ov_expected, ov_actual, msg)
-
-    def check_xer_so(dut, res, sim_o, msg):
-        if 'xer_so' in res:
-            so_expected = sim_o['xer_so']
-            so_actual = res['xer_so']
-            print("SO", so_expected, so_actual)
-            dut.assertEqual(so_expected, so_actual, msg)