src/soc/simple/test/test_runner.py

   1 """TestRunner class, runs TestIssuer instructions
   2
   3 related bugs:
   4
   5  * https://bugs.libre-soc.org/show_bug.cgi?id=363
   6  * https://bugs.libre-soc.org/show_bug.cgi?id=686#c51
   7 """
   8 from nmigen import Module, Signal, Cat, ClockSignal
   9 from nmigen.hdl.xfrm import ResetInserter
  10 from copy import copy
  11
  12 # NOTE: to use cxxsim, export NMIGEN_SIM_MODE=cxxsim from the shell
  13 # Also, check out the cxxsim nmigen branch, and latest yosys from git
  14 from nmutil.sim_tmp_alternative import Simulator, Settle
  15
  16 from nmutil.formaltest import FHDLTestCase
  17 from nmutil.gtkw import write_gtkw
  18 from nmigen.cli import rtlil
  19 from openpower.decoder.isa.caller import special_sprs, SVP64State
  20 from openpower.decoder.isa.all import ISA
  21 from openpower.endian import bigendian
  22
  23 from openpower.decoder.power_decoder import create_pdecode
  24 from openpower.decoder.power_decoder2 import PowerDecode2
  25 from soc.regfile.regfiles import StateRegs
  26
  27 from soc.simple.issuer import TestIssuerInternal
  28
  29 from soc.config.test.test_loadstore import TestMemPspec
  30 from soc.simple.test.test_core import (setup_regs, check_regs, check_mem,
  31                                        wait_for_busy_clear,
  32                                        wait_for_busy_hi)
  33 from soc.fu.compunits.test.test_compunit import (setup_tst_memory,
  34                                                  check_sim_memory)
  35 from soc.debug.dmi import DBGCore, DBGCtrl, DBGStat
  36 from nmutil.util import wrap
  37 from soc.experiment.test.test_mmu_dcache import wb_get
  38 from openpower.test.state import TestState
  39
  40
  41 def setup_i_memory(imem, startaddr, instructions):
  42     mem = imem
  43     print("insn before, init mem", mem.depth, mem.width, mem,
  44           len(instructions))
  45     for i in range(mem.depth):
  46         yield mem._array[i].eq(0)
  47     yield Settle()
  48     startaddr //= 4  # instructions are 32-bit
  49     if mem.width == 32:
  50         mask = ((1 << 32)-1)
  51         for ins in instructions:
  52             if isinstance(ins, tuple):
  53                 insn, code = ins
  54             else:
  55                 insn, code = ins, ''
  56             insn = insn & 0xffffffff
  57             yield mem._array[startaddr].eq(insn)
  58             yield Settle()
  59             if insn != 0:
  60                 print("instr: %06x 0x%x %s" % (4*startaddr, insn, code))
  61             startaddr += 1
  62             startaddr = startaddr & mask
  63         return
  64
  65     # 64 bit
  66     mask = ((1 << 64)-1)
  67     for ins in instructions:
  68         if isinstance(ins, tuple):
  69             insn, code = ins
  70         else:
  71             insn, code = ins, ''
  72         insn = insn & 0xffffffff
  73         msbs = (startaddr >> 1) & mask
  74         val = yield mem._array[msbs]
  75         if insn != 0:
  76             print("before set", hex(4*startaddr),
  77                   hex(msbs), hex(val), hex(insn))
  78         lsb = 1 if (startaddr & 1) else 0
  79         val = (val | (insn << (lsb*32)))
  80         val = val & mask
  81         yield mem._array[msbs].eq(val)
  82         yield Settle()
  83         if insn != 0:
  84             print("after  set", hex(4*startaddr), hex(msbs), hex(val))
  85             print("instr: %06x 0x%x %s %08x" % (4*startaddr, insn, code, val))
  86         startaddr += 1
  87         startaddr = startaddr & mask
  88
  89
  90 def set_dmi(dmi, addr, data):
  91     yield dmi.req_i.eq(1)
  92     yield dmi.addr_i.eq(addr)
  93     yield dmi.din.eq(data)
  94     yield dmi.we_i.eq(1)
  95     while True:
  96         ack = yield dmi.ack_o
  97         if ack:
  98             break
  99         yield
 100     yield
 101     yield dmi.req_i.eq(0)
 102     yield dmi.addr_i.eq(0)
 103     yield dmi.din.eq(0)
 104     yield dmi.we_i.eq(0)
 105     yield
 106
 107
 108 def get_dmi(dmi, addr):
 109     yield dmi.req_i.eq(1)
 110     yield dmi.addr_i.eq(addr)
 111     yield dmi.din.eq(0)
 112     yield dmi.we_i.eq(0)
 113     while True:
 114         ack = yield dmi.ack_o
 115         if ack:
 116             break
 117         yield
 118     yield  # wait one
 119     data = yield dmi.dout  # get data after ack valid for 1 cycle
 120     yield dmi.req_i.eq(0)
 121     yield dmi.addr_i.eq(0)
 122     yield dmi.we_i.eq(0)
 123     yield
 124     return data
 125
 126
 127 def run_hdl_state(dut, test, issuer, pc_i, svstate_i, instructions):
 128     """run_hdl_state - runs a TestIssuer nmigen HDL simulation
 129     """
 130
 131     imem = issuer.imem._get_memory()
 132     core = issuer.core
 133     dmi = issuer.dbg.dmi
 134     pdecode2 = issuer.pdecode2
 135     l0 = core.l0
 136     hdl_states = []
 137
 138     # establish the TestIssuer context (mem, regs etc)
 139
 140     pc = 0  # start address
 141     counter = 0  # test to pause/start
 142
 143     yield from setup_i_memory(imem, pc, instructions)
 144     yield from setup_tst_memory(l0, test.mem)
 145     yield from setup_regs(pdecode2, core, test)
 146
 147     # set PC and SVSTATE
 148     yield pc_i.eq(pc)
 149     yield issuer.pc_i.ok.eq(1)
 150
 151     # copy initial SVSTATE
 152     initial_svstate = copy(test.svstate)
 153     if isinstance(initial_svstate, int):
 154         initial_svstate = SVP64State(initial_svstate)
 155     yield svstate_i.eq(initial_svstate.value)
 156     yield issuer.svstate_i.ok.eq(1)
 157     yield
 158
 159     print("instructions", instructions)
 160
 161     # run the loop of the instructions on the current test
 162     index = (yield issuer.cur_state.pc) // 4
 163     while index < len(instructions):
 164         ins, code = instructions[index]
 165
 166         print("hdl instr: 0x{:X}".format(ins & 0xffffffff))
 167         print(index, code)
 168
 169         if counter == 0:
 170             # start the core
 171             yield
 172             yield from set_dmi(dmi, DBGCore.CTRL,
 173                                1<<DBGCtrl.START)
 174             yield issuer.pc_i.ok.eq(0) # no change PC after this
 175             yield issuer.svstate_i.ok.eq(0) # ditto
 176             yield
 177             yield
 178
 179         counter = counter + 1
 180
 181         # wait until executed
 182         while not (yield issuer.insn_done):
 183             yield
 184
 185         yield Settle()
 186
 187         index = (yield issuer.cur_state.pc) // 4
 188
 189         terminated = yield issuer.dbg.terminated_o
 190         print("terminated", terminated)
 191
 192         if index < len(instructions):
 193             # Get HDL mem and state
 194             state = yield from TestState("hdl", core, dut,
 195                                          code)
 196             hdl_states.append(state)
 197
 198         if index >= len(instructions):
 199             print ("index over, send dmi stop")
 200             # stop at end
 201             yield from set_dmi(dmi, DBGCore.CTRL,
 202                                1<<DBGCtrl.STOP)
 203             yield
 204             yield
 205
 206         terminated = yield issuer.dbg.terminated_o
 207         print("terminated(2)", terminated)
 208         if terminated:
 209             break
 210
 211     return hdl_states
 212
 213
 214 def run_sim_state(dut, test, simdec2, instructions, gen, insncode):
 215     """run_sim_state - runs an ISACaller simulation
 216     """
 217
 218     sim_states = []
 219
 220     # set up the Simulator (which must track TestIssuer exactly)
 221     sim = ISA(simdec2, test.regs, test.sprs, test.cr, test.mem,
 222               test.msr,
 223               initial_insns=gen, respect_pc=True,
 224               disassembly=insncode,
 225               bigendian=bigendian,
 226               initial_svstate=test.svstate)
 227
 228     # run the loop of the instructions on the current test
 229     index = sim.pc.CIA.value//4
 230     while index < len(instructions):
 231         ins, code = instructions[index]
 232
 233         print("sim instr: 0x{:X}".format(ins & 0xffffffff))
 234         print(index, code)
 235
 236         # set up simulated instruction (in simdec2)
 237         try:
 238             yield from sim.setup_one()
 239         except KeyError:  # instruction not in imem: stop
 240             break
 241         yield Settle()
 242
 243         # call simulated operation
 244         print("sim", code)
 245         yield from sim.execute_one()
 246         yield Settle()
 247         index = sim.pc.CIA.value//4
 248
 249         # get sim register and memory TestState, add to list
 250         state = yield from TestState("sim", sim, dut, code)
 251         sim_states.append(state)
 252
 253     return sim_states
 254
 255
 256 class TestRunner(FHDLTestCase):
 257     def __init__(self, tst_data, microwatt_mmu=False, rom=None,
 258                         svp64=True, run_hdl=True):
 259         super().__init__("run_all")
 260         self.test_data = tst_data
 261         self.microwatt_mmu = microwatt_mmu
 262         self.rom = rom
 263         self.svp64 = svp64
 264         self.run_hdl = run_hdl
 265
 266     def run_all(self):
 267         m = Module()
 268         comb = m.d.comb
 269         pc_i = Signal(32)
 270         svstate_i = Signal(64)
 271
 272         if self.microwatt_mmu:
 273             ldst_ifacetype = 'test_mmu_cache_wb'
 274         else:
 275             ldst_ifacetype = 'test_bare_wb'
 276         imem_ifacetype = 'test_bare_wb'
 277
 278         pspec = TestMemPspec(ldst_ifacetype=ldst_ifacetype,
 279                              imem_ifacetype=imem_ifacetype,
 280                              addr_wid=48,
 281                              mask_wid=8,
 282                              imem_reg_wid=64,
 283                              # wb_data_width=32,
 284                              use_pll=False,
 285                              nocore=False,
 286                              xics=False,
 287                              gpio=False,
 288                              regreduce=True,
 289                              svp64=self.svp64,
 290                              mmu=self.microwatt_mmu,
 291                              reg_wid=64)
 292         if self.run_hdl:
 293             #hard_reset = Signal(reset_less=True)
 294             issuer = TestIssuerInternal(pspec)
 295             # use DMI RESET command instead, this does actually work though
 296             #issuer = ResetInserter({'coresync': hard_reset,
 297             #                        'sync': hard_reset})(issuer)
 298             m.submodules.issuer = issuer
 299             dmi = issuer.dbg.dmi
 300
 301         regreduce_en = pspec.regreduce_en == True
 302         simdec2 = PowerDecode2(None, regreduce_en=regreduce_en)
 303         m.submodules.simdec2 = simdec2  # pain in the neck
 304
 305         # run core clock at same rate as test clock
 306         intclk = ClockSignal("coresync")
 307         comb += intclk.eq(ClockSignal())
 308
 309         if self.run_hdl:
 310             comb += issuer.pc_i.data.eq(pc_i)
 311             comb += issuer.svstate_i.data.eq(svstate_i)
 312
 313         # nmigen Simulation
 314         sim = Simulator(m)
 315         sim.add_clock(1e-6)
 316
 317         def process():
 318
 319             if self.run_hdl:
 320                 # start in stopped
 321                 yield from set_dmi(dmi, DBGCore.CTRL, 1<<DBGCtrl.STOP)
 322                 yield
 323
 324             # get each test, completely reset the core, and run it
 325
 326             for test in self.test_data:
 327
 328                 if self.run_hdl:
 329                     # set up bigendian (TODO: don't do this, use MSR)
 330                     yield issuer.core_bigendian_i.eq(bigendian)
 331                     yield Settle()
 332
 333                     yield
 334                     yield
 335                     yield
 336                     yield
 337
 338                 print(test.name)
 339                 program = test.program
 340                 with self.subTest(test.name):
 341                     print("regs", test.regs)
 342                     print("sprs", test.sprs)
 343                     print("cr", test.cr)
 344                     print("mem", test.mem)
 345                     print("msr", test.msr)
 346                     print("assem", program.assembly)
 347                     gen = list(program.generate_instructions())
 348                     insncode = program.assembly.splitlines()
 349                     instructions = list(zip(gen, insncode))
 350
 351                     # Run two tests (TODO, move these to functions)
 352                     # * first the Simulator, collate a batch of results
 353                     # * then the HDL, likewise
 354                     #   (actually, the other way round because running
 355                     #    Simulator somehow modifies the test state!)
 356                     # * finally, compare all the results
 357
 358                     ##########
 359                     # 1. HDL
 360                     ##########
 361                     if self.run_hdl:
 362                         hdl_states = yield from run_hdl_state(self, test,
 363                                                               issuer,
 364                                                               pc_i, svstate_i,
 365                                                               instructions)
 366
 367                     ##########
 368                     # 2. Simulator
 369                     ##########
 370
 371                     sim_states = yield from run_sim_state(self, test, simdec2,
 372                                                           instructions, gen,
 373                                                           insncode)
 374
 375                     ###############
 376                     # 3. Compare
 377                     ###############
 378
 379                     last_sim = copy(sim_states[-1])
 380
 381                     if self.run_hdl:
 382                         for simstate, hdlstate in zip(sim_states, hdl_states):
 383                             simstate.compare(hdlstate)     # register check
 384                             simstate.compare_mem(hdlstate) # memory check
 385
 386                     if self.run_hdl:
 387                         print ("hdl_states")
 388                         for state in hdl_states:
 389                             print (state)
 390
 391                     print ("sim_states")
 392                     for state in sim_states:
 393                         print (state)
 394
 395                     # compare against expected results
 396                     if test.expected is not None:
 397                         # have to put these in manually
 398                         test.expected.to_test = test.expected
 399                         test.expected.dut = self
 400                         test.expected.state_type = "expected"
 401                         test.expected.code = 0
 402                         # do actual comparison, against last item
 403                         last_sim.compare(test.expected)
 404
 405                     if self.run_hdl:
 406                         self.assertTrue(len(hdl_states) == len(sim_states),
 407                                     "number of instructions run not the same")
 408
 409                 if self.run_hdl:
 410                     # stop at end
 411                     yield from set_dmi(dmi, DBGCore.CTRL, 1<<DBGCtrl.STOP)
 412                     yield
 413                     yield
 414
 415                     # TODO, here is where the static (expected) results
 416                     # can be checked: register check (TODO, memory check)
 417                     # see https://bugs.libre-soc.org/show_bug.cgi?id=686#c51
 418                     # yield from check_regs(self, sim, core, test, code,
 419                     #                       >>>expected_data<<<)
 420
 421                     # get CR
 422                     cr = yield from get_dmi(dmi, DBGCore.CR)
 423                     print("after test %s cr value %x" % (test.name, cr))
 424
 425                     # get XER
 426                     xer = yield from get_dmi(dmi, DBGCore.XER)
 427                     print("after test %s XER value %x" % (test.name, xer))
 428
 429                     # test of dmi reg get
 430                     for int_reg in range(32):
 431                         yield from set_dmi(dmi, DBGCore.GSPR_IDX, int_reg)
 432                         value = yield from get_dmi(dmi, DBGCore.GSPR_DATA)
 433
 434                         print("after test %s reg %2d value %x" %
 435                               (test.name, int_reg, value))
 436
 437                     # pull a reset
 438                     yield from set_dmi(dmi, DBGCore.CTRL, 1<<DBGCtrl.RESET)
 439                     yield
 440
 441         styles = {
 442             'dec': {'base': 'dec'},
 443             'bin': {'base': 'bin'},
 444             'closed': {'closed': True}
 445         }
 446
 447         traces = [
 448             'clk',
 449             ('state machines', 'closed', [
 450                 'fetch_pc_i_valid', 'fetch_pc_o_ready',
 451                 'fetch_fsm_state',
 452                 'fetch_insn_o_valid', 'fetch_insn_i_ready',
 453                 'pred_insn_i_valid', 'pred_insn_o_ready',
 454                 'fetch_predicate_state',
 455                 'pred_mask_o_valid', 'pred_mask_i_ready',
 456                 'issue_fsm_state',
 457                 'exec_insn_i_valid', 'exec_insn_o_ready',
 458                 'exec_fsm_state',
 459                 'exec_pc_o_valid', 'exec_pc_i_ready',
 460                 'insn_done', 'core_stop_o', 'pc_i_ok', 'pc_changed',
 461                 'is_last', 'dec2.no_out_vec']),
 462             {'comment': 'fetch and decode'},
 463             (None, 'dec', [
 464                 'cia[63:0]', 'nia[63:0]', 'pc[63:0]',
 465                 'cur_pc[63:0]', 'core_core_cia[63:0]']),
 466             'raw_insn_i[31:0]',
 467             'raw_opcode_in[31:0]', 'insn_type', 'dec2.dec2_exc_happened',
 468             ('svp64 decoding', 'closed', [
 469                 'svp64_rm[23:0]', ('dec2.extra[8:0]', 'bin'),
 470                 'dec2.sv_rm_dec.mode', 'dec2.sv_rm_dec.predmode',
 471                 'dec2.sv_rm_dec.ptype_in',
 472                 'dec2.sv_rm_dec.dstpred[2:0]', 'dec2.sv_rm_dec.srcpred[2:0]',
 473                 'dstmask[63:0]', 'srcmask[63:0]',
 474                 'dregread[4:0]', 'dinvert',
 475                 'sregread[4:0]', 'sinvert',
 476                 'core.int.pred__addr[4:0]', 'core.int.pred__data_o[63:0]',
 477                 'core.int.pred__ren']),
 478             ('register augmentation', 'dec', 'closed', [
 479                 {'comment': 'v3.0b registers'},
 480                 'dec2.dec_o.RT[4:0]',
 481                 'dec2.dec_a.RA[4:0]',
 482                 'dec2.dec_b.RB[4:0]',
 483                 ('Rdest', [
 484                     'dec2.o_svdec.reg_in[4:0]',
 485                     ('dec2.o_svdec.spec[2:0]', 'bin'),
 486                     'dec2.o_svdec.reg_out[6:0]']),
 487                 ('Rsrc1', [
 488                     'dec2.in1_svdec.reg_in[4:0]',
 489                     ('dec2.in1_svdec.spec[2:0]', 'bin'),
 490                     'dec2.in1_svdec.reg_out[6:0]']),
 491                 ('Rsrc1', [
 492                     'dec2.in2_svdec.reg_in[4:0]',
 493                     ('dec2.in2_svdec.spec[2:0]', 'bin'),
 494                     'dec2.in2_svdec.reg_out[6:0]']),
 495                 {'comment': 'SVP64 registers'},
 496                 'dec2.rego[6:0]', 'dec2.reg1[6:0]', 'dec2.reg2[6:0]'
 497             ]),
 498             {'comment': 'svp64 context'},
 499             'core_core_vl[6:0]', 'core_core_maxvl[6:0]',
 500             'core_core_srcstep[6:0]', 'next_srcstep[6:0]',
 501             'core_core_dststep[6:0]',
 502             {'comment': 'issue and execute'},
 503             'core.core_core_insn_type',
 504             (None, 'dec', [
 505                 'core_rego[6:0]', 'core_reg1[6:0]', 'core_reg2[6:0]']),
 506             'issue_i', 'busy_o',
 507             {'comment': 'dmi'},
 508             'dbg.dmi_req_i', 'dbg.dmi_ack_o',
 509             {'comment': 'instruction memory'},
 510             'imem.sram.rdport.memory(0)[63:0]',
 511             {'comment': 'registers'},
 512             # match with soc.regfile.regfiles.IntRegs port names
 513             'core.int.rp_src1.memory(0)[63:0]',
 514             'core.int.rp_src1.memory(1)[63:0]',
 515             'core.int.rp_src1.memory(2)[63:0]',
 516             'core.int.rp_src1.memory(3)[63:0]',
 517             'core.int.rp_src1.memory(4)[63:0]',
 518             'core.int.rp_src1.memory(5)[63:0]',
 519             'core.int.rp_src1.memory(6)[63:0]',
 520             'core.int.rp_src1.memory(7)[63:0]',
 521             'core.int.rp_src1.memory(9)[63:0]',
 522             'core.int.rp_src1.memory(10)[63:0]',
 523             'core.int.rp_src1.memory(13)[63:0]'
 524         ]
 525
 526         # PortInterface module path varies depending on MMU option
 527         if self.microwatt_mmu:
 528             pi_module = 'core.ldst0'
 529         else:
 530             pi_module = 'core.fus.ldst0'
 531
 532         traces += [('ld/st port interface', {'submodule': pi_module}, [
 533             'oper_r__insn_type',
 534             'ldst_port0_is_ld_i',
 535             'ldst_port0_is_st_i',
 536             'ldst_port0_busy_o',
 537             'ldst_port0_addr_i[47:0]',
 538             'ldst_port0_addr_i_ok',
 539             'ldst_port0_addr_ok_o',
 540             'ldst_port0_exc_happened',
 541             'ldst_port0_st_data_i[63:0]',
 542             'ldst_port0_st_data_i_ok',
 543             'ldst_port0_ld_data_o[63:0]',
 544             'ldst_port0_ld_data_o_ok',
 545             'exc_o_happened',
 546             'cancel'
 547         ])]
 548
 549         if self.microwatt_mmu:
 550             traces += [
 551                 {'comment': 'microwatt_mmu'},
 552                 'core.fus.mmu0.alu_mmu0.illegal',
 553                 'core.fus.mmu0.alu_mmu0.debug0[3:0]',
 554                 'core.fus.mmu0.alu_mmu0.mmu.state',
 555                 'core.fus.mmu0.alu_mmu0.mmu.pid[31:0]',
 556                 'core.fus.mmu0.alu_mmu0.mmu.prtbl[63:0]',
 557                 {'comment': 'wishbone_memory'},
 558                 'core.fus.mmu0.alu_mmu0.dcache.stb',
 559                 'core.fus.mmu0.alu_mmu0.dcache.cyc',
 560                 'core.fus.mmu0.alu_mmu0.dcache.we',
 561                 'core.fus.mmu0.alu_mmu0.dcache.ack',
 562                 'core.fus.mmu0.alu_mmu0.dcache.stall,'
 563             ]
 564
 565         write_gtkw("issuer_simulator.gtkw",
 566                    "issuer_simulator.vcd",
 567                    traces, styles, module='top.issuer')
 568
 569         # add run of instructions
 570         sim.add_sync_process(process)
 571
 572         # optionally, if a wishbone-based ROM is passed in, run that as an
 573         # extra emulated process
 574         if self.rom is not None:
 575             dcache = core.fus.fus["mmu0"].alu.dcache
 576             default_mem = self.rom
 577             sim.add_sync_process(wrap(wb_get(dcache, default_mem, "DCACHE")))
 578
 579         with sim.write_vcd("issuer_simulator.vcd"):
 580             sim.run()