Allow the formal engine to perform a same-cycle result in the ALU
[soc.git] / src / soc / fu / cr / test / test_pipe_caller.py
index 6cc441fc913b3f50c1930a6127863a7747566fe9..9a92d2d6dbdacfdf1478ac99a82ce839245d97ef 100644 (file)
@@ -6,231 +6,25 @@ from nmutil.sim_tmp_alternative import Simulator, Settle
 
 from nmigen.cli import rtlil
 import unittest
-from openpower.decoder.isa.caller import ISACaller, special_sprs
 from openpower.decoder.power_decoder import (create_pdecode)
 from openpower.decoder.power_decoder2 import (PowerDecode2)
-from openpower.decoder.power_enums import (XER_bits, Function)
-from openpower.decoder.selectable_int import SelectableInt
-from openpower.simulator.program import Program
+from openpower.decoder.power_enums import Function
 from openpower.decoder.isa.all import ISA
 from openpower.endian import bigendian
 
-from openpower.test.common import TestAccumulatorBase, TestCase, ALUHelpers
+from openpower.test.common import TestAccumulatorBase, ALUHelpers
 from openpower.util import mask_extend
 from soc.fu.cr.pipeline import CRBasePipe
 from soc.fu.cr.pipe_data import CRPipeSpec
 import random
 
+from openpower.test.cr.cr_cases import CRTestCase
 
-# This test bench is a bit different than is usual. Initially when I
-# was writing it, I had all of the tests call a function to create a
-# device under test and simulator, initialize the dut, run the
-# simulation for ~2 cycles, and assert that the dut output what it
-# should have. However, this was really slow, since it needed to
-# create and tear down the dut and simulator for every test case.
-
-# Now, instead of doing that, every test case in ALUTestCase puts some
-# data into the test_data list below, describing the instructions to
-# be tested and the initial state. Once all the tests have been run,
-# test_data gets passed to TestRunner which then sets up the DUT and
-# simulator once, runs all the data through it, and asserts that the
-# results match the pseudocode sim at every cycle.
-
-# By doing this, I've reduced the time it takes to run the test suite
-# massively. Before, it took around 1 minute on my computer, now it
-# takes around 3 seconds
-
-
-class CRTestCase(TestAccumulatorBase):
-
-    def case_crop(self):
-        insns = ["crand", "cror", "crnand", "crnor", "crxor", "creqv",
-                 "crandc", "crorc"]
-        for i in range(40):
-            choice = random.choice(insns)
-            ba = random.randint(0, 31)
-            bb = random.randint(0, 31)
-            bt = random.randint(0, 31)
-            lst = [f"{choice} {ba}, {bb}, {bt}"]
-            cr = random.randint(0, (1 << 32)-1)
-            self.add_case(Program(lst, bigendian), initial_cr=cr)
-
-    def case_crand(self):
-        for i in range(20):
-            lst = ["crand 0, 11, 13"]
-            cr = random.randint(0, (1 << 32)-1)
-            self.add_case(Program(lst, bigendian), initial_cr=cr)
-
-    def case_1_mcrf(self):
-        for i in range(20):
-            src = random.randint(0, 7)
-            dst = random.randint(0, 7)
-            lst = [f"mcrf {src}, {dst}"]
-            cr = random.randint(0, (1 << 32)-1)
-        self.add_case(Program(lst, bigendian), initial_cr=cr)
-
-    def case_0_mcrf(self):
-        for i in range(8):
-            lst = [f"mcrf 5, {i}"]
-            cr = 0xfeff0001
-            self.add_case(Program(lst, bigendian), initial_cr=cr)
-
-    def case_mtcrf(self):
-        for i in range(1):
-            mask = random.randint(0, 255)
-            lst = [f"mtcrf {mask}, 2"]
-            cr = random.randint(0, (1 << 32)-1)
-            initial_regs = [0] * 32
-            initial_regs[2] = random.randint(0, (1 << 32)-1)
-            self.add_case(Program(lst, bigendian), initial_regs=initial_regs,
-                          initial_cr=cr)
-
-    def case_mtocrf(self):
-        for i in range(20):
-            mask = 1 << random.randint(0, 7)
-            lst = [f"mtocrf {mask}, 2"]
-            cr = random.randint(0, (1 << 32)-1)
-            initial_regs = [0] * 32
-            initial_regs[2] = random.randint(0, (1 << 32)-1)
-            self.add_case(Program(lst, bigendian), initial_regs=initial_regs,
-                          initial_cr=cr)
-
-    def case_mfcr(self):
-        for i in range(1):
-            lst = ["mfcr 2"]
-            cr = random.randint(0, (1 << 32)-1)
-            self.add_case(Program(lst, bigendian), initial_cr=cr)
-
-    def case_cror_regression(self):
-        """another bad hack!
-        """
-        dis = ["cror 28, 5, 11"]
-        lst = bytes([0x83, 0x5b, 0x75, 0x4f]) # 4f855b83
-        cr = 0x35055058
-        p = Program(lst, bigendian)
-        p.assembly = '\n'.join(dis)+'\n'
-        self.add_case(p, initial_cr=cr)
-
-    def case_mfocrf_regression(self):
-        """bit of a bad hack.  comes from microwatt 1.bin instruction 0x106d0
-        as the mask is non-standard, gnu-as barfs.  so we fake it up directly
-        from the binary
-        """
-        mask = 0b10000111
-        dis = [f"mfocrf 2, {mask}"]
-        lst = bytes([0x26, 0x78, 0xb8, 0x7c]) # 0x7cb87826
-        cr = 0x5F9E080E
-        p = Program(lst, bigendian)
-        p.assembly = '\n'.join(dis)+'\n'
-        self.add_case(p, initial_cr=cr)
-
-    def case_mtocrf_regression(self):
-        """microwatt 1.bin regression, same hack as above.
-           106b4:   21 d9 96 7d     .long 0x7d96d921   # mtocrf 12, 0b01101101
-        """
-        mask = 0b01101101
-        dis = [f"mtocrf 12, {mask}"]
-        lst = bytes([0x21, 0xd9, 0x96, 0x7d]) # 0x7d96d921
-        cr = 0x529e08fe
-        initial_regs = [0] * 32
-        initial_regs[12] = 0xffffffffffffffff
-        p = Program(lst, bigendian)
-        p.assembly = '\n'.join(dis)+'\n'
-        self.add_case(p, initial_regs=initial_regs, initial_cr=cr)
-
-    def case_mtocrf_regression_2(self):
-        """microwatt 1.bin regression, zero fxm
-           mtocrf 0,16     14928:   21 09 10 7e     .long 0x7e100921
-        """
-        dis = ["mtocrf 16, 0"]
-        lst = bytes([0x21, 0x09, 0x10, 0x7e]) # 0x7e100921
-        cr = 0x3F089F7F
-        initial_regs = [0] * 32
-        initial_regs[16] = 0x0001C020
-        p = Program(lst, bigendian)
-        p.assembly = '\n'.join(dis)+'\n'
-        self.add_case(p, initial_regs=initial_regs, initial_cr=cr)
-
-    def case_mfocrf_1(self):
-        lst = [f"mfocrf 2, 1"]
-        cr = 0x1234
-        self.add_case(Program(lst, bigendian), initial_cr=cr)
-
-    def case_mfocrf(self):
-        for i in range(1):
-            mask = 1 << random.randint(0, 7)
-            lst = [f"mfocrf 2, {mask}"]
-            cr = random.randint(0, (1 << 32)-1)
-            self.add_case(Program(lst, bigendian), initial_cr=cr)
-
-    def case_isel_0(self):
-        lst = [ "isel 4, 1, 2, 31"
-               ]
-        initial_regs = [0] * 32
-        initial_regs[1] = 0x1004
-        initial_regs[2] = 0x1008
-        cr= 0x1ee
-        self.add_case(Program(lst, bigendian),
-                      initial_regs=initial_regs, initial_cr=cr)
-
-    def case_isel_1(self):
-        lst = [ "isel 4, 1, 2, 30"
-               ]
-        initial_regs = [0] * 32
-        initial_regs[1] = 0x1004
-        initial_regs[2] = 0x1008
-        cr= 0x1ee
-        self.add_case(Program(lst, bigendian),
-                      initial_regs=initial_regs, initial_cr=cr)
-
-    def case_isel_2(self):
-        lst = [ "isel 4, 1, 2, 2"
-               ]
-        initial_regs = [0] * 32
-        initial_regs[1] = 0x1004
-        initial_regs[2] = 0x1008
-        cr= 0x1ee
-        self.add_case(Program(lst, bigendian),
-                      initial_regs=initial_regs, initial_cr=cr)
-
-    def case_isel_3(self):
-        lst = [ "isel 1, 2, 3, 13"
-               ]
-        initial_regs = [0] * 32
-        initial_regs[2] = 0x1004
-        initial_regs[3] = 0x1008
-        cr= 0x5d677571b8229f1
-        cr= 0x1b8229f1
-        self.add_case(Program(lst, bigendian),
-                      initial_regs=initial_regs, initial_cr=cr)
-
-    def case_isel(self):
-        for i in range(20):
-            bc = random.randint(0, 31)
-            lst = [f"isel 1, 2, 3, {bc}"]
-            cr = random.randint(0, (1 << 64)-1)
-            initial_regs = [0] * 32
-            #initial_regs[2] = random.randint(0, (1 << 64)-1)
-            #initial_regs[3] = random.randint(0, (1 << 64)-1)
-            initial_regs[2] = i*2+1
-            initial_regs[3] = i*2+2
-            self.add_case(Program(lst, bigendian),
-                          initial_regs=initial_regs, initial_cr=cr)
-
-    def case_setb(self):
-        for i in range(20):
-            bfa = random.randint(0, 7)
-            lst = [f"setb 1, {bfa}"]
-            cr = random.randint(0, (1 << 32)-1)
-            self.add_case(Program(lst, bigendian), initial_cr=cr)
-
-    def case_regression_setb(self):
-        lst = [f"setb 1, 6"]
-        cr = random.randint(0, 0x66f6b106)
-        self.add_case(Program(lst, bigendian), initial_cr=cr)
+
+class CRIlangCase(TestAccumulatorBase):
 
     def case_ilang(self):
-        pspec = CRPipeSpec(id_wid=2)
+        pspec = CRPipeSpec(id_wid=2, parent_pspec=None)
         alu = CRBasePipe(pspec)
         vl = rtlil.convert(alu, ports=alu.ports())
         with open("cr_pipeline.il", "w") as f:
@@ -282,10 +76,10 @@ class TestRunner(unittest.TestCase):
 
         cr_en = yield dec2.e.write_cr.ok
         if whole_reg_ok:
-            full_cr = yield alu.n.data_o.full_cr.data & full_cr_mask
+            full_cr = yield alu.n.o_data.full_cr.data & full_cr_mask
             expected_cr = simulator.cr.value
-            print("CR whole: expected %x, actual: %x mask: %x" % \
-                (expected_cr, full_cr, full_cr_mask))
+            print("CR whole: expected %x, actual: %x mask: %x" %
+                  (expected_cr, full_cr, full_cr_mask))
             # HACK: only look at the bits that we expected to change
             self.assertEqual(expected_cr & full_cr_mask, full_cr, code)
         elif cr_en:
@@ -293,10 +87,10 @@ class TestRunner(unittest.TestCase):
             expected_cr = simulator.cr.value
             print(f"CR whole: {expected_cr:x}, sel {cr_sel}")
             expected_cr = simulator.crl[cr_sel].get_range().value
-            real_cr = yield alu.n.data_o.cr.data
+            real_cr = yield alu.n.o_data.cr.data
             print(f"CR part: expected {expected_cr:x}, actual: {real_cr:x}")
             self.assertEqual(expected_cr, real_cr, code)
-        alu_out = yield alu.n.data_o.o.data
+        alu_out = yield alu.n.o_data.o.data
         out_reg_valid = yield dec2.e.write_reg.ok
         if out_reg_valid:
             write_reg_idx = yield dec2.e.write_reg.data
@@ -324,7 +118,7 @@ class TestRunner(unittest.TestCase):
             yield instruction.eq(ins)          # raw binary instr.
             yield Settle()
             yield from self.set_inputs(alu, pdecode2, sim)
-            yield alu.p.valid_i.eq(1)
+            yield alu.p.i_valid.eq(1)
             fn_unit = yield pdecode2.e.do.fn_unit
             self.assertEqual(fn_unit, Function.CR.value, code)
             yield
@@ -332,10 +126,10 @@ class TestRunner(unittest.TestCase):
             yield from sim.call(opname)
             index = sim.pc.CIA.value//4
 
-            vld = yield alu.n.valid_o
+            vld = yield alu.n.o_valid
             while not vld:
                 yield
-                vld = yield alu.n.valid_o
+                vld = yield alu.n.o_valid
             yield
             yield from self.assert_outputs(alu, pdecode2, sim, code)
 
@@ -350,11 +144,11 @@ class TestRunner(unittest.TestCase):
         m.submodules.pdecode2 = pdecode2 = PowerDecode2(None, opkls, fn_name)
         pdecode = pdecode2.dec
 
-        pspec = CRPipeSpec(id_wid=2)
+        pspec = CRPipeSpec(id_wid=2, parent_pspec=None)
         m.submodules.alu = alu = CRBasePipe(pspec)
 
-        comb += alu.p.data_i.ctx.op.eq_from_execute1(pdecode2.do)
-        comb += alu.n.ready_i.eq(1)
+        comb += alu.p.i_data.ctx.op.eq_from_execute1(pdecode2.do)
+        comb += alu.n.i_ready.eq(1)
         comb += pdecode2.dec.raw_opcode_in.eq(instruction)
         sim = Simulator(m)
 
@@ -375,6 +169,7 @@ if __name__ == "__main__":
     unittest.main(exit=False)
     suite = unittest.TestSuite()
     suite.addTest(TestRunner(CRTestCase().test_data))
+    suite.addTest(TestRunner(CRIlangCase().test_data))
 
     runner = unittest.TextTestRunner()
     runner.run(suite)