improve debug for test_sim.py
[soc.git] / src / soc / simulator / test_sim.py
index 1fc2a46d5db106c80fc1253e57b45da69c167bde..e6b09667da10fe77f0eaf49c28ab066b0296f00a 100644 (file)
@@ -12,6 +12,7 @@ from soc.decoder.power_decoder2 import (PowerDecode2)
 from soc.simulator.program import Program
 from soc.simulator.qemu import run_program
 from soc.decoder.isa.all import ISA
+from soc.fu.test.common import TestCase
 
 
 class Register:
@@ -19,49 +20,15 @@ class Register:
         self.num = num
 
 
-class DecoderTestCase(FHDLTestCase):
+class GeneralTestCases(FHDLTestCase):
+    test_data = []
 
-    def run_tst(self, generator, initial_mem=None):
-        m = Module()
-        comb = m.d.comb
-        instruction = Signal(32)
-
-        pdecode = create_pdecode()
-
-        m.submodules.pdecode2 = pdecode2 = PowerDecode2(pdecode)
-
-        simulator = ISA(pdecode2, [0] * 32, {}, 0, initial_mem, 0)
-        comb += pdecode2.dec.raw_opcode_in.eq(instruction)
-        comb += pdecode2.dec.bigendian.eq(0)
-        gen = generator.generate_instructions()
-        instructions = list(zip(gen, generator.assembly.splitlines()))
-
-        sim = Simulator(m)
-        def process():
+    def __init__(self, name="general"):
+        super().__init__(name)
+        self.test_name = name
 
-            index = simulator.pc.CIA.value//4
-            while index < len(instructions):
-                ins, code = instructions[index]
-
-                print("0x{:X}".format(ins & 0xffffffff))
-                print(code)
-
-                yield instruction.eq(ins)
-                yield Delay(1e-6)
-
-                opname = code.split(' ')[0]
-                yield from simulator.call(opname)
-                index = simulator.pc.CIA.value//4
-
-
-        sim.add_process(process)
-        with sim.write_vcd("simulator.vcd", "simulator.gtkw",
-                           traces=[]):
-            sim.run()
-
-        return simulator
-
-    def _tst0_cmp(self):
+    @unittest.skip("disable")
+    def test_0_cmp(self):
         lst = ["addi 6, 0, 0x10",
                "addi 7, 0, 0x05",
                "subf. 1, 6, 7",
@@ -70,7 +37,8 @@ class DecoderTestCase(FHDLTestCase):
         with Program(lst) as program:
             self.run_tst_program(program, [1])
 
-    def _tstexample(self):
+    @unittest.skip("disable")
+    def test_example(self):
         lst = ["addi 1, 0, 0x5678",
                "addi 2, 0, 0x1234",
                "add  3, 1, 2",
@@ -78,7 +46,8 @@ class DecoderTestCase(FHDLTestCase):
         with Program(lst) as program:
             self.run_tst_program(program, [1, 2, 3, 4])
 
-    def _tstldst(self):
+    @unittest.skip("disable")
+    def test_ldst(self):
         lst = ["addi 1, 0, 0x5678",
                "addi 2, 0, 0x1234",
                "stw  1, 0(2)",
@@ -92,7 +61,28 @@ class DecoderTestCase(FHDLTestCase):
                                  [1, 2, 3],
                                  initial_mem)
 
-    def _tstldst_extended(self):
+    @unittest.skip("disable")
+    def test_ld_rev_ext(self):
+        lst = ["addi 1, 0, 0x5678",
+               "addi 2, 0, 0x1234",
+               "addi 4, 0, 0x40",
+               "stw  1, 0x40(2)",
+               "lwbrx  3, 4, 2"]
+        with Program(lst) as program:
+            self.run_tst_program(program, [1, 2, 3])
+
+    @unittest.skip("disable")
+    def test_st_rev_ext(self):
+        lst = ["addi 1, 0, 0x5678",
+               "addi 2, 0, 0x1234",
+               "addi 4, 0, 0x40",
+               "stwbrx  1, 4, 2",
+               "lwzx  3, 4, 2"]
+        with Program(lst) as program:
+            self.run_tst_program(program, [1, 2, 3])
+
+    @unittest.skip("disable")
+    def test_ldst_extended(self):
         lst = ["addi 1, 0, 0x5678",
                "addi 2, 0, 0x1234",
                "addi 4, 0, 0x40",
@@ -101,7 +91,8 @@ class DecoderTestCase(FHDLTestCase):
         with Program(lst) as program:
             self.run_tst_program(program, [1, 2, 3])
 
-    def _tst0_ldst_widths(self):
+    @unittest.skip("disable")
+    def test_0_ldst_widths(self):
         lst = ["addis 1, 0, 0xdead",
                "ori 1, 1, 0xbeef",
                "addi 2, 0, 0x1000",
@@ -115,7 +106,8 @@ class DecoderTestCase(FHDLTestCase):
         with Program(lst) as program:
             self.run_tst_program(program, [1, 2, 3, 4, 5])
 
-    def _tstsub(self):
+    @unittest.skip("disable")
+    def test_sub(self):
         lst = ["addi 1, 0, 0x1234",
                "addi 2, 0, 0x5678",
                "subf 3, 1, 2",
@@ -124,7 +116,8 @@ class DecoderTestCase(FHDLTestCase):
         with Program(lst) as program:
             self.run_tst_program(program, [1, 2, 3, 4, 5])
 
-    def _tstadd_with_carry(self):
+    @unittest.skip("disable")
+    def test_add_with_carry(self):
         lst = ["addi 1, 0, 5",
                "neg 1, 1",
                "addi 2, 0, 7",
@@ -135,7 +128,8 @@ class DecoderTestCase(FHDLTestCase):
         with Program(lst) as program:
             self.run_tst_program(program, [1, 2, 3])
 
-    def _tstaddis(self):
+    @unittest.skip("disable")
+    def test_addis(self):
         lst = ["addi 1, 0, 0x0FFF",
                "addis 1, 1, 0x0F"
                ]
@@ -143,13 +137,33 @@ class DecoderTestCase(FHDLTestCase):
             self.run_tst_program(program, [1])
 
     @unittest.skip("broken")
-    def _tstmulli(self):
+    def test_mulli(self):
         lst = ["addi 1, 0, 3",
                "mulli 1, 1, 2"
                ]
         with Program(lst) as program:
             self.run_tst_program(program, [1])
 
+    @unittest.skip("disable")
+    def test_2_load_store(self):
+        lst = ["addi 1, 0, 0x1004",
+               "addi 2, 0, 0x1008",
+               "addi 3, 0, 0x00ee",
+               "stb 3, 1(2)",
+               "lbz 4, 1(2)",
+        ]
+        initial_regs = [0] * 32
+        initial_regs[1] = 0x1004
+        initial_regs[2] = 0x1008
+        initial_regs[3] = 0x00ee
+        initial_mem = {0x1000: (0x5432123412345678, 8),
+                       0x1008: (0xabcdef0187654321, 8),
+                       0x1020: (0x1828384822324252, 8),
+                        }
+        with Program(lst) as program:
+            self.run_tst_program(program, [3,4], initial_mem)
+
+    @unittest.skip("disable")
     def test_3_load_store(self):
         lst = ["addi 1, 0, 0x1004",
                "addi 2, 0, 0x1002",
@@ -157,8 +171,8 @@ class DecoderTestCase(FHDLTestCase):
                "sth 4, 0(2)",
                "lhz 4, 0(2)"]
         initial_regs = [0] * 32
-        initial_regs[1] = 0x0004
-        initial_regs[2] = 0x0002
+        initial_regs[1] = 0x1004
+        initial_regs[2] = 0x1002
         initial_regs[3] = 0x15eb
         initial_mem = {0x1000: (0x5432123412345678, 8),
                        0x1008: (0xabcdef0187654321, 8),
@@ -167,13 +181,81 @@ class DecoderTestCase(FHDLTestCase):
         with Program(lst) as program:
             self.run_tst_program(program, [1,2,3,4], initial_mem)
 
+    def test_loop(self):
+        """in godbolt.org:
+        register unsigned long i asm ("r12");
+        void square(void) {
+            i = 5;
+            do {
+                i = i - 1;
+            } while (i != 0);
+        }
+        """
+        lst = ["addi 9, 0, 0x10", # i = 16
+               "addi 9,9,-1",    # i = i - 1
+               "cmpi 0,1,9,12",     # compare 9 to value 0, store in CR2
+               "bc 4,0,-8"         # branch if CR2 "test was != 0"
+               ]
+        with Program(lst) as program:
+            self.run_tst_program(program, [9], initial_mem={})
+
+    def run_tst_program(self, prog, initial_regs=None, initial_sprs=None,
+                                    initial_mem=None):
+        initial_regs = [0] * 32
+        tc = TestCase(prog, self.test_name, initial_regs, initial_sprs, 0,
+                                            initial_mem, 0)
+        self.test_data.append(tc)
+
+
+class DecoderBase:
+
+    def run_tst(self, generator, initial_mem=None, initial_pc=0):
+        m = Module()
+        comb = m.d.comb
+
+        gen = list(generator.generate_instructions())
+        insn_code = generator.assembly.splitlines()
+        instructions = list(zip(gen, insn_code))
+
+        pdecode = create_pdecode()
+        m.submodules.pdecode2 = pdecode2 = PowerDecode2(pdecode)
+
+        # place program at requested address
+        gen = (initial_pc, gen)
+
+        simulator = ISA(pdecode2, [0] * 32, {}, 0, initial_mem, 0,
+                        initial_insns=gen, respect_pc=True,
+                        disassembly=insn_code,
+                        initial_pc=initial_pc)
+
+        sim = Simulator(m)
+
+        def process():
+            while True:
+                try:
+                    yield from simulator.setup_one()
+                except KeyError: # indicates instruction not in imem: stop
+                    break
+                yield Settle()
+                yield from simulator.execute_one()
+                yield Settle()
+
+
+        sim.add_process(process)
+        with sim.write_vcd("simulator.vcd", "simulator.gtkw",
+                           traces=[]):
+            sim.run()
+
+        return simulator
+
     def run_tst_program(self, prog, reglist, initial_mem=None):
         import sys
-        simulator = self.run_tst(prog, initial_mem=initial_mem)
+        simulator = self.run_tst(prog, initial_mem=initial_mem,
+                                 initial_pc=0x20000000)
         prog.reset()
         with run_program(prog, initial_mem) as q:
             self.qemu_register_compare(simulator, q, reglist)
-            self.qemu_mem_compare(simulator, q, reglist)
+            self.qemu_mem_compare(simulator, q, True)
         print(simulator.gpr.dump())
 
     def qemu_mem_compare(self, sim, qemu, check=True):
@@ -203,14 +285,21 @@ class DecoderTestCase(FHDLTestCase):
         print("qemu pc", hex(qpc))
         print("qemu cr", hex(qcr))
         print("qemu xer", bin(qxer))
+        print("sim nia", hex(sim.pc.NIA.value))
         print("sim pc", hex(sim.pc.CIA.value))
         print("sim cr", hex(sim_cr))
         print("sim xer", hex(sim_xer))
         self.assertEqual(qcr, sim_cr)
+        self.assertEqual(qpc, sim_pc)
         for reg in regs:
             qemu_val = qemu.get_register(reg)
             sim_val = sim.gpr(reg).value
-            self.assertEqual(qemu_val, sim_val)
+            self.assertEqual(qemu_val, sim_val,
+                             "expect %x got %x" % (qemu_val, sim_val))
+
+
+class DecoderTestCase(DecoderBase, GeneralTestCases):
+    pass
 
 
 if __name__ == "__main__":