+"""trap pipeline tests
+
+issues:
+* https://bugs.libre-soc.org/show_bug.cgi?id=629
+"""
+
from nmigen import Module, Signal
-from nmigen.back.pysim import Simulator, Delay, Settle
-from nmutil.formaltest import FHDLTestCase
+
+# 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, CryIn)
-from soc.decoder.selectable_int import SelectableInt
-from soc.simulator.program import Program
-from soc.decoder.isa.all import ISA
-from soc.config.endian import bigendian
-from soc.consts import MSR
-
-from soc.fu.test.common import (TestCase, ALUHelpers)
+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.decoder.isa.all import ISA
+from openpower.endian import bigendian
+from openpower.consts import MSR
+
+from openpower.test.common import TestAccumulatorBase, ALUHelpers
from soc.fu.trap.pipeline import TrapBasePipe
from soc.fu.trap.pipe_data import TrapPipeSpec
import random
+from openpower.test.trap.trap_cases import TrapTestCase
+
def get_cu_inputs(dec2, sim):
"""naming (res) must conform to TrapFunctionUnit input regspec
yield from ALUHelpers.get_sim_int_ra(res, sim, dec2) # RA
yield from ALUHelpers.get_sim_int_rb(res, sim, dec2) # RB
- yield from ALUHelpers.get_sim_fast_spr1(res, sim, dec2) # SPR1
- yield from ALUHelpers.get_sim_fast_spr2(res, sim, dec2) # SPR2
+ yield from ALUHelpers.get_sim_fast_spr1(res, sim, dec2) # SPR0
+ yield from ALUHelpers.get_sim_fast_spr2(res, sim, dec2) # SPR1
+ yield from ALUHelpers.get_sim_fast_spr3(res, sim, dec2) # SVSRR0
ALUHelpers.get_sim_cia(res, sim, dec2) # PC
ALUHelpers.get_sim_msr(res, sim, dec2) # MSR
def set_alu_inputs(alu, dec2, sim):
# TODO: see https://bugs.libre-soc.org/show_bug.cgi?id=305#c43
# detect the immediate here (with m.If(self.i.ctx.op.imm_data.imm_ok))
- # and place it into data_i.b
+ # and place it into i_data.b
inp = yield from get_cu_inputs(dec2, sim)
yield from ALUHelpers.set_int_ra(alu, dec2, inp)
yield from ALUHelpers.set_int_rb(alu, dec2, inp)
- yield from ALUHelpers.set_fast_spr1(alu, dec2, inp) # SPR1
+ yield from ALUHelpers.set_fast_spr1(alu, dec2, inp) # SPR0
yield from ALUHelpers.set_fast_spr2(alu, dec2, inp) # SPR1
+ yield from ALUHelpers.set_fast_spr3(alu, dec2, inp) # SVSRR0
# yield from ALUHelpers.set_cia(alu, dec2, inp)
# yield from ALUHelpers.set_msr(alu, dec2, inp)
return inp
-# 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 TrapTestCase 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 TrapTestCase(FHDLTestCase):
- test_data = []
-
- def __init__(self, name):
- super().__init__(name)
- self.test_name = name
-
- def run_tst_program(self, prog, initial_regs=None, initial_sprs=None,
- initial_msr=0):
- tc = TestCase(prog, self.test_name, initial_regs, initial_sprs,
- msr=initial_msr)
- self.test_data.append(tc)
-
- def test_1_rfid(self):
- lst = ["rfid"]
- initial_regs = [0] * 32
- initial_regs[1] = 1
- initial_sprs = {'SRR0': 0x12345678, 'SRR1': 0x5678}
- self.run_tst_program(Program(lst, bigendian),
- initial_regs, initial_sprs)
-
- def test_0_trap_eq_imm(self):
- insns = ["twi", "tdi"]
- for i in range(2):
- choice = random.choice(insns)
- lst = [f"{choice} 4, 1, %d" % i] # TO=4: trap equal
- initial_regs = [0] * 32
- initial_regs[1] = 1
- self.run_tst_program(Program(lst, bigendian), initial_regs)
-
- def test_0_trap_eq(self):
- insns = ["tw", "td"]
- for i in range(2):
- choice = insns[i]
- lst = [f"{choice} 4, 1, 2"] # TO=4: trap equal
- initial_regs = [0] * 32
- initial_regs[1] = 1
- initial_regs[2] = 1
- self.run_tst_program(Program(lst, bigendian), initial_regs)
-
- def test_3_mtmsr_0(self):
- lst = ["mtmsr 1,0"]
- initial_regs = [0] * 32
- initial_regs[1] = 0xffffffffffffffff
- self.run_tst_program(Program(lst, bigendian), initial_regs)
-
- def test_3_mtmsr_1(self):
- lst = ["mtmsr 1,1"]
- initial_regs = [0] * 32
- initial_regs[1] = 0xffffffffffffffff
- self.run_tst_program(Program(lst, bigendian), initial_regs)
-
- def test_4_mtmsrd_0(self):
- lst = ["mtmsrd 1,0"]
- initial_regs = [0] * 32
- initial_regs[1] = 0xffffffffffffffff
- self.run_tst_program(Program(lst, bigendian), initial_regs)
-
- def test_5_mtmsrd_1(self):
- lst = ["mtmsrd 1,1"]
- initial_regs = [0] * 32
- initial_regs[1] = 0xffffffffffffffff
- self.run_tst_program(Program(lst, bigendian), initial_regs)
-
- def test_6_mtmsr_priv_0(self):
- lst = ["mtmsr 1,0"]
- initial_regs = [0] * 32
- initial_regs[1] = 0xffffffffffffffff
- msr = 1 << MSR.PR # set in "problem state"
- self.run_tst_program(Program(lst, bigendian), initial_regs,
- initial_msr=msr)
-
- def test_7_rfid_priv_0(self):
- lst = ["rfid"]
- initial_regs = [0] * 32
- initial_regs[1] = 1
- initial_sprs = {'SRR0': 0x12345678, 'SRR1': 0x5678}
- msr = 1 << MSR.PR # set in "problem state"
- self.run_tst_program(Program(lst, bigendian),
- initial_regs, initial_sprs,
- initial_msr=msr)
-
- def test_8_mfmsr(self):
- lst = ["mfmsr 1"]
- initial_regs = [0] * 32
- msr = (~(1 << MSR.PR)) & 0xffffffffffffffff
- self.run_tst_program(Program(lst, bigendian), initial_regs,
- initial_msr=msr)
-
- def test_9_mfmsr_priv(self):
- lst = ["mfmsr 1"]
- initial_regs = [0] * 32
- msr = 1 << MSR.PR # set in "problem state"
- self.run_tst_program(Program(lst, bigendian), initial_regs,
- initial_msr=msr)
-
- def test_999_illegal(self):
- # ok, um this is a bit of a cheat: use an instruction we know
- # is not implemented by either ISACaller or the core
- lst = ["tbegin.",
- "mtmsr 1,1"] # should not get executed
- initial_regs = [0] * 32
- self.run_tst_program(Program(lst, bigendian), initial_regs)
-
- def test_ilang(self):
- pspec = TrapPipeSpec(id_wid=2)
+
+class TrapIlangCase(TestAccumulatorBase):
+
+ def case_ilang(self):
+ pspec = TrapPipeSpec(id_wid=2, parent_pspec=None)
alu = TrapBasePipe(pspec)
vl = rtlil.convert(alu, ports=alu.ports())
with open("trap_pipeline.il", "w") as f:
f.write(vl)
-class TestRunner(FHDLTestCase):
+class TestRunner(unittest.TestCase):
def __init__(self, test_data):
super().__init__("run_all")
self.test_data = test_data
+
+ def execute(self, alu, instruction, pdecode2, test):
+ program = test.program
+ sim = ISA(pdecode2, test.regs, test.sprs, test.cr,
+ test.mem, test.msr,
+ bigendian=bigendian)
+ gen = program.generate_instructions()
+ instructions = list(zip(gen, program.assembly.splitlines()))
+
+ msr = sim.msr.value
+ pc = sim.pc.CIA.value
+ print("starting msr, pc %08x, %08x" % (msr, pc))
+ index = pc//4
+ while index < len(instructions):
+ ins, code = instructions[index]
+
+ print("pc %08x msr %08x instr: %08x" % (pc, msr, ins))
+ print(code)
+ if 'XER' in sim.spr:
+ so = 1 if sim.spr['XER'][XER_bits['SO']] else 0
+ ov = 1 if sim.spr['XER'][XER_bits['OV']] else 0
+ ov32 = 1 if sim.spr['XER'][XER_bits['OV32']] else 0
+ print("before: so/ov/32", so, ov, ov32)
+
+ # ask the decoder to decode this binary data (endian'd)
+ yield pdecode2.dec.bigendian.eq(bigendian) # l/big?
+ yield pdecode2.state.msr.eq(msr) # set MSR in pdecode2
+ yield pdecode2.state.pc.eq(pc) # set CIA in pdecode2
+ yield instruction.eq(ins) # raw binary instr.
+ yield Settle()
+ fn_unit = yield pdecode2.e.do.fn_unit
+ asmcode = yield pdecode2.e.asmcode
+ dec_asmcode = yield pdecode2.dec.op.asmcode
+ print("asmcode", asmcode, dec_asmcode)
+ self.assertEqual(fn_unit, Function.TRAP.value)
+ alu_o = yield from set_alu_inputs(alu, pdecode2, sim)
+
+ # set valid for one cycle, propagate through pipeline...
+ yield alu.p.i_valid.eq(1)
+ yield
+ yield alu.p.i_valid.eq(0)
+
+ opname = code.split(' ')[0]
+ yield from sim.call(opname)
+ pc = sim.pc.CIA.value
+ index = pc//4
+ print("pc after %08x" % (pc))
+ msr = sim.msr.value
+ print("msr after %08x" % (msr))
+
+ vld = yield alu.n.o_valid
+ while not vld:
+ yield
+ vld = yield alu.n.o_valid
+ yield
+
+ yield from self.check_alu_outputs(alu, pdecode2, sim, code)
+ yield Settle()
+
def run_all(self):
m = Module()
comb = m.d.comb
m.submodules.pdecode2 = pdecode2 = PowerDecode2(pdecode)
- pspec = TrapPipeSpec(id_wid=2)
+ pspec = TrapPipeSpec(id_wid=2, parent_pspec=None)
m.submodules.alu = alu = TrapBasePipe(pspec)
- comb += alu.p.data_i.ctx.op.eq_from_execute1(pdecode2.e)
- comb += alu.p.valid_i.eq(1)
- 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)
for test in self.test_data:
print(test.name)
program = test.program
- self.subTest(test.name)
- sim = ISA(pdecode2, test.regs, test.sprs, test.cr,
- test.mem, test.msr,
- bigendian=bigendian)
- gen = program.generate_instructions()
- instructions = list(zip(gen, program.assembly.splitlines()))
-
- msr = sim.msr.value
- pc = sim.pc.CIA.value
- print("starting msr, pc %08x, %08x" % (msr, pc))
- index = pc//4
- while index < len(instructions):
- ins, code = instructions[index]
-
- print("pc %08x msr %08x instr: %08x" % (pc, msr, ins))
- print(code)
- if 'XER' in sim.spr:
- so = 1 if sim.spr['XER'][XER_bits['SO']] else 0
- ov = 1 if sim.spr['XER'][XER_bits['OV']] else 0
- ov32 = 1 if sim.spr['XER'][XER_bits['OV32']] else 0
- print("before: so/ov/32", so, ov, ov32)
-
- # 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 CIA in pdecode2
- yield instruction.eq(ins) # raw binary instr.
- yield Settle()
- fn_unit = yield pdecode2.e.do.fn_unit
- self.assertEqual(fn_unit, Function.TRAP.value)
- alu_o = yield from set_alu_inputs(alu, pdecode2, sim)
- yield
- opname = code.split(' ')[0]
- yield from sim.call(opname)
- pc = sim.pc.CIA.value
- index = pc//4
- print("pc after %08x" % (pc))
- msr = sim.msr.value
- print("msr after %08x" % (msr))
-
- vld = yield alu.n.valid_o
- while not vld:
- yield
- vld = yield alu.n.valid_o
- yield
-
- yield from self.check_alu_outputs(alu, pdecode2, sim, code)
+ with self.subTest(test.name):
+ yield from self.execute(alu, instruction, pdecode2, test)
sim.add_sync_process(process)
with sim.write_vcd("alu_simulator.vcd", "simulator.gtkw",
yield from ALUHelpers.get_int_o(res, alu, dec2)
yield from ALUHelpers.get_fast_spr1(res, alu, dec2)
yield from ALUHelpers.get_fast_spr2(res, alu, dec2)
+ yield from ALUHelpers.get_fast_spr3(res, alu, dec2)
yield from ALUHelpers.get_nia(res, alu, dec2)
yield from ALUHelpers.get_msr(res, alu, dec2)
yield from ALUHelpers.get_sim_int_o(sim_o, sim, dec2)
yield from ALUHelpers.get_wr_fast_spr1(sim_o, sim, dec2)
yield from ALUHelpers.get_wr_fast_spr2(sim_o, sim, dec2)
+ yield from ALUHelpers.get_wr_fast_spr3(sim_o, sim, dec2)
ALUHelpers.get_sim_nia(sim_o, sim, dec2)
ALUHelpers.get_sim_msr(sim_o, sim, dec2)
ALUHelpers.check_int_o(self, res, sim_o, code)
ALUHelpers.check_fast_spr1(self, res, sim_o, code)
ALUHelpers.check_fast_spr2(self, res, sim_o, code)
+ ALUHelpers.check_fast_spr3(self, res, sim_o, code)
ALUHelpers.check_nia(self, res, sim_o, code)
ALUHelpers.check_msr(self, res, sim_o, code)
if __name__ == "__main__":
unittest.main(exit=False)
suite = unittest.TestSuite()
- suite.addTest(TestRunner(TrapTestCase.test_data))
+ suite.addTest(TestRunner(TrapTestCase().test_data))
+ suite.addTest(TestRunner(TrapIlangCase().test_data))
runner = unittest.TextTestRunner()
runner.run(suite)