move more files to openpower-isa
[soc.git] / src / soc / fu / branch / test / test_pipe_caller.py
index a9b7cc0b2cd5c630d24a7325bac60ced57304881..f68374d13f423e02cda9c2d4bc94615b377bc270 100644 (file)
@@ -1,14 +1,18 @@
 from nmigen import Module, Signal
-from nmigen.back.pysim import Simulator, Delay, Settle
+
+# NOTE: to use cxxsim, export NMIGEN_SIM_MODE=cxxsim from the shell
+# Also, check out the cxxsim nmigen branch, and latest yosys from git
+from nmutil.sim_tmp_alternative import Simulator, Settle
+
 from nmigen.cli import rtlil
 import unittest
-from soc.decoder.isa.caller import ISACaller, special_sprs
-from soc.decoder.power_decoder import (create_pdecode)
-from soc.decoder.power_decoder2 import (PowerDecode2)
-from soc.decoder.power_enums import (XER_bits, Function, MicrOp)
-from soc.decoder.selectable_int import SelectableInt
-from soc.simulator.program import Program
-from soc.decoder.isa.all import ISA
+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, MicrOp)
+from openpower.decoder.selectable_int import SelectableInt
+from openpower.simulator.program import Program
+from openpower.decoder.isa.all import ISA
 from soc.regfile.regfiles import FastRegs
 from soc.config.endian import bigendian
 
@@ -17,8 +21,6 @@ from soc.fu.branch.pipeline import BranchBasePipe
 from soc.fu.branch.pipe_data import BranchPipeSpec
 import random
 
-from soc.regfile.util import fast_reg_to_spr  # HACK!
-
 
 def get_rec_width(rec):
     recwidth = 0
@@ -29,25 +31,6 @@ def get_rec_width(rec):
     return recwidth
 
 
-# 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
-
-
 def get_cu_inputs(dec2, sim):
     """naming (res) must conform to BranchFunctionUnit input regspec
     """
@@ -102,8 +85,8 @@ class BranchTestCase(TestAccumulatorBase):
             lst = [f"bc {bo}, {bi}, {bc}"]
             initial_sprs = {9: SelectableInt(ctr, 64)}
             self.add_case(Program(lst, bigendian),
-                                 initial_sprs=initial_sprs,
-                                 initial_cr=cr)
+                          initial_sprs=initial_sprs,
+                          initial_cr=cr)
 
     def case_bc_reg(self):
         # XXX: bcctr and bcctrl time out (irony: they're counters)
@@ -122,8 +105,32 @@ class BranchTestCase(TestAccumulatorBase):
                                 8: SelectableInt(lr, 64),
                                 815: SelectableInt(tar, 64)}
                 self.add_case(Program(lst, bigendian),
-                                     initial_sprs=initial_sprs,
-                                     initial_cr=cr)
+                              initial_sprs=initial_sprs,
+                              initial_cr=cr)
+
+    def case_bc_microwatt_1_regression(self):
+        """bc found to be testing ctr rather than (ctr-1)
+        11fb4:   08 00 49 40     bc      2,4*cr2+gt,0x11fbc
+        cr_file.vhdl:83:13:@136835ns:(report note): Reading CR 33209703
+        """
+        lst = ["bc 2, 9, 8"]
+        initial_regs = [0] * 32
+        cr = 0x33209703
+        self.add_case(Program(lst, bigendian), initial_regs,
+                              initial_cr=cr)
+
+    def case_bc_microwatt_2_regression(self):
+        """modified version, set CTR=1 so that it hits zero in BC
+        """
+        lst = ["bc 2, 9, 8"]
+        initial_regs = [0] * 32
+        cr = 0x33209703
+        ctr = 1
+        initial_sprs = {9: SelectableInt(ctr, 64),
+                        }
+        self.add_case(Program(lst, bigendian), initial_regs,
+                              initial_sprs=initial_sprs,
+                              initial_cr=cr)
 
     def case_ilang(self):
         pspec = BranchPipeSpec(id_wid=2)
@@ -134,23 +141,22 @@ class BranchTestCase(TestAccumulatorBase):
 
 
 class TestRunner(unittest.TestCase):
-    def __init__(self, test_data):
-        super().__init__("run_all")
-        self.test_data = test_data
-
-    def run_all(self):
+    def test_it(self):
+        test_data = BranchTestCase().test_data
         m = Module()
         comb = m.d.comb
         instruction = Signal(32)
 
-        pdecode = create_pdecode()
+        fn_name = "BRANCH"
+        opkls = BranchPipeSpec.opsubsetkls
 
-        m.submodules.pdecode2 = pdecode2 = PowerDecode2(pdecode)
+        m.submodules.pdecode2 = pdecode2 = PowerDecode2(None, opkls, fn_name)
+        pdecode = pdecode2.dec
 
         pspec = BranchPipeSpec(id_wid=2)
         m.submodules.branch = branch = BranchBasePipe(pspec)
 
-        comb += branch.p.data_i.ctx.op.eq_from_execute1(pdecode2.e)
+        comb += branch.p.data_i.ctx.op.eq_from_execute1(pdecode2.do)
         comb += branch.p.valid_i.eq(1)
         comb += branch.n.ready_i.eq(1)
         comb += pdecode2.dec.raw_opcode_in.eq(instruction)
@@ -159,56 +165,59 @@ class TestRunner(unittest.TestCase):
         sim.add_clock(1e-6)
 
         def process():
-            for test in self.test_data:
+            for test in test_data:
                 print(test.name)
                 program = test.program
-                self.subTest(test.name)
-                simulator = ISA(pdecode2, test.regs, test.sprs, test.cr,
-                                test.mem, test.msr,
-                                bigendian=bigendian)
-                initial_cia = 0x2000
-                simulator.set_pc(initial_cia)
-                gen = program.generate_instructions()
-                instructions = list(zip(gen, program.assembly.splitlines()))
-
-                pc = simulator.pc.CIA.value
-                msr = simulator.msr.value
-                index = (pc - initial_cia)//4
-                while index < len(instructions) and index >= 0:
-                    print(index)
-                    ins, code = instructions[index]
-
-                    print("0x{:X}".format(ins & 0xffffffff))
-                    print(code)
-
-                    # ask the decoder to decode this binary data (endian'd)
-                    yield pdecode2.dec.bigendian.eq(bigendian)  # little / big?
-                    yield pdecode2.msr.eq(msr)  # set MSR in pdecode2
-                    yield pdecode2.cia.eq(pc)  # set PC in pdecode2
-                    yield instruction.eq(ins)          # raw binary instr.
-                    # note, here, the op will need further decoding in order
-                    # to set the correct SPRs on SPR1/2/3.  op_bc* require
-                    # spr1 to be set to CTR, op_bctar require spr2 to be
-                    # set to TAR, op_bclr* require spr2 to be set to LR.
-                    # if op_sc*, op_rf* and op_hrfid are to be added here
-                    # then additional op-decoding is required, accordingly
-                    yield Settle()
-                    lk = yield pdecode2.e.do.lk
-                    print("lk:", lk)
-                    yield from self.set_inputs(branch, pdecode2, simulator)
-                    fn_unit = yield pdecode2.e.do.fn_unit
-                    self.assertEqual(fn_unit, Function.BRANCH.value, code)
-                    yield
-                    yield
-                    opname = code.split(' ')[0]
-                    prev_nia = simulator.pc.NIA.value
-                    yield from simulator.call(opname)
+                with self.subTest(test.name):
+                    simulator = ISA(pdecode2, test.regs, test.sprs, test.cr,
+                                    test.mem, test.msr,
+                                    bigendian=bigendian)
+                    initial_cia = 0x2000
+                    simulator.set_pc(initial_cia)
+                    gen = program.generate_instructions()
+                    instructions = list(
+                        zip(gen, program.assembly.splitlines()))
+
                     pc = simulator.pc.CIA.value
                     msr = simulator.msr.value
                     index = (pc - initial_cia)//4
-
-                    yield from self.assert_outputs(branch, pdecode2,
-                                                   simulator, prev_nia, code)
+                    while index < len(instructions) and index >= 0:
+                        print(index)
+                        ins, code = instructions[index]
+
+                        print("0x{:X}".format(ins & 0xffffffff))
+                        print(code)
+
+                        # ask the decoder to decode this binary data (endian'd)
+                        # little / big?
+                        yield pdecode2.dec.bigendian.eq(bigendian)
+                        yield pdecode2.state.msr.eq(msr)  # set MSR in pdecode2
+                        yield pdecode2.state.pc.eq(pc)  # set PC in pdecode2
+                        yield instruction.eq(ins)          # raw binary instr.
+                        # note, here, the op will need further decoding in order
+                        # to set the correct SPRs on SPR1/2/3.  op_bc* require
+                        # spr1 to be set to CTR, op_bctar require spr2 to be
+                        # set to TAR, op_bclr* require spr2 to be set to LR.
+                        # if op_sc*, op_rf* and op_hrfid are to be added here
+                        # then additional op-decoding is required, accordingly
+                        yield Settle()
+                        lk = yield pdecode2.e.do.lk
+                        print("lk:", lk)
+                        yield from self.set_inputs(branch, pdecode2, simulator)
+                        fn_unit = yield pdecode2.e.do.fn_unit
+                        self.assertEqual(fn_unit, Function.BRANCH.value, code)
+                        yield
+                        yield
+                        opname = code.split(' ')[0]
+                        prev_nia = simulator.pc.NIA.value
+                        yield from simulator.call(opname)
+                        pc = simulator.pc.CIA.value
+                        msr = simulator.msr.value
+                        index = (pc - initial_cia)//4
+
+                        yield from self.assert_outputs(branch, pdecode2,
+                                                       simulator, prev_nia,
+                                                       code)
 
         sim.add_sync_process(process)
         with sim.write_vcd("branch_simulator.vcd"):
@@ -244,9 +253,4 @@ class TestRunner(unittest.TestCase):
 
 
 if __name__ == "__main__":
-    unittest.main(exit=False)
-    suite = unittest.TestSuite()
-    suite.addTest(TestRunner(BranchTestCase().test_data))
-
-    runner = unittest.TextTestRunner()
-    runner.run(suite)
+    unittest.main()