add python simulation of alu
[soc.git] / src / experiment / cscore.py
index ecafe5d8b6d759aba96dc91f02c16bc3c7b7b7ea..f6f79d7a51f4f52bcd1727eb59a697b66e0e52fd 100644 (file)
 from nmigen.compat.sim import run_simulation
 from nmigen.cli import verilog, rtlil
-from nmigen import Module, Signal, Array, Elaboratable
+from nmigen import Module, Const, Signal, Array, Cat, Elaboratable
 
-from regfile.regfile import RegFileArray
+from regfile.regfile import RegFileArray, treereduce
 from scoreboard.fn_unit import IntFnUnit, FPFnUnit, LDFnUnit, STFnUnit
 from scoreboard.fu_fu_matrix import FUFUDepMatrix
+from scoreboard.fu_reg_matrix import FURegDepMatrix
+from scoreboard.global_pending import GlobalPending
+from scoreboard.group_picker import GroupPicker
+from scoreboard.issue_unit import IntFPIssueUnit
+
+from compalu import ComputationUnitNoDelay
+
+from alu_hier import ALU
+from nmutil.latch import SRLatch
+
+from random import randint
 
-from alu_hier import Adder, Subtractor
 
 class Scoreboard(Elaboratable):
-    def __init__(self, reg_width, reg_depth):
-        self.reg_width = reg_width
-        self.reg_depth = reg_depth
+    def __init__(self, rwid, n_regs):
+        """ Inputs:
+
+            * :rwid:   bit width of register file(s) - both FP and INT
+            * :n_regs: depth of register file(s) - number of FP and INT regs
+        """
+        self.rwid = rwid
+        self.n_regs = n_regs
 
         # Register Files
-        self.intregs = RegFileArray(reg_width, reg_depth)
-        self.int_dest = self.intregs.write_port()
-        self.int_src1 = self.intregs.read_port()
-        self.int_src2 = self.intregs.read_port()
+        self.intregs = RegFileArray(rwid, n_regs)
+        self.fpregs = RegFileArray(rwid, n_regs)
+
+        # inputs
+        self.int_store_i = Signal(reset_less=True) # instruction is a store
+        self.int_dest_i = Signal(max=n_regs, reset_less=True) # Dest R# in
+        self.int_src1_i = Signal(max=n_regs, reset_less=True) # oper1 R# in
+        self.int_src2_i = Signal(max=n_regs, reset_less=True) # oper2 R# in
 
-        self.fpregs = RegFileArray(reg_width, reg_depth)
-        self.fp_dest = self.fpregs.write_port()
-        self.fp_src1 = self.fpregs.read_port()
-        self.fp_src2 = self.fpregs.read_port()
+        self.issue_o = Signal(reset_less=True) # instruction was accepted
 
     def elaborate(self, platform):
         m = Module()
+
         m.submodules.intregs = self.intregs
         m.submodules.fpregs = self.fpregs
 
+        # register ports
+        int_dest = self.intregs.write_port("dest")
+        int_src1 = self.intregs.read_port("src1")
+        int_src2 = self.intregs.read_port("src2")
+
+        fp_dest = self.fpregs.write_port("dest")
+        fp_src1 = self.fpregs.read_port("src1")
+        fp_src2 = self.fpregs.read_port("src2")
+
         # Int ALUs
-        m.submodules.adder = adder = Adder(self.reg_width)
-        m.submodules.subtractor = subtractor = Subtractor(self.reg_width)
-        int_alus = [adder, subtractor]
+        add = ALU(self.rwid)
+        sub = ALU(self.rwid)
+        m.submodules.comp1 = comp1 = ComputationUnitNoDelay(self.rwid, 1, add)
+        m.submodules.comp2 = comp2 = ComputationUnitNoDelay(self.rwid, 1, sub)
+        int_alus = [comp1, comp2]
+
+        m.d.comb += comp1.oper_i.eq(Const(0)) # temporary/experiment: op=add
+        m.d.comb += comp2.oper_i.eq(Const(1)) # temporary/experiment: op=sub
 
         # Int FUs
-        il = []
+        if_l = []
+        int_src1_pend_v = []
+        int_src2_pend_v = []
+        int_rd_pend_v = []
+        int_wr_pend_v = []
         for i, a in enumerate(int_alus):
-            fu = IntFnUnit(self.reg_width, shadow_wid=0)
+            # set up Integer Function Unit, add to module (and python list)
+            fu = IntFnUnit(self.n_regs, shadow_wid=0)
             setattr(m.submodules, "intfu%d" % i, fu)
-            il.append(fu)
-        int_fus = Array(il)
+            if_l.append(fu)
+            # collate the read/write pending vectors (to go into global pending)
+            int_src1_pend_v.append(fu.src1_pend_o)
+            int_src2_pend_v.append(fu.src2_pend_o)
+            int_rd_pend_v.append(fu.int_rd_pend_o)
+            int_wr_pend_v.append(fu.int_wr_pend_o)
+        int_fus = Array(if_l)
+
+        # Count of number of FUs
+        n_int_fus = len(if_l)
+        n_fp_fus = 0 # for now
+
+        n_fus = n_int_fus + n_fp_fus # plus FP FUs
+
+        # XXX replaced by array of FUs? *FnUnit
+        # # Integer FU-FU Dep Matrix
+        # m.submodules.intfudeps = FUFUDepMatrix(n_int_fus, n_int_fus)
+        # Integer FU-Reg Dep Matrix
+        # intregdeps = FURegDepMatrix(self.n_regs, n_int_fus)
+        # m.submodules.intregdeps = intregdeps
+
+        # Integer Priority Picker 1: Adder + Subtractor
+        intpick1 = GroupPicker(2) # picks between add and sub
+        m.submodules.intpick1 = intpick1
+
+        # Global Pending Vectors (INT and FP)
+        # NOTE: number of vectors is NOT same as number of FUs.
+        g_int_src1_pend_v = GlobalPending(self.n_regs, int_src1_pend_v)
+        g_int_src2_pend_v = GlobalPending(self.n_regs, int_src2_pend_v)
+        g_int_rd_pend_v = GlobalPending(self.n_regs, int_rd_pend_v)
+        g_int_wr_pend_v = GlobalPending(self.n_regs, int_wr_pend_v)
+        m.submodules.g_int_src1_pend_v = g_int_src1_pend_v
+        m.submodules.g_int_src2_pend_v = g_int_src2_pend_v
+        m.submodules.g_int_rd_pend_v = g_int_rd_pend_v
+        m.submodules.g_int_wr_pend_v = g_int_wr_pend_v
+
+        # INT/FP Issue Unit
+        issueunit = IntFPIssueUnit(self.n_regs, n_int_fus, n_fp_fus)
+        m.submodules.issueunit = issueunit
+
+        #---------
+        # ok start wiring things together...
+        # "now hear de word of de looord... dem bones dem bones dem dryy bones"
+        # https://www.youtube.com/watch?v=pYb8Wm6-QfA
+        #---------
+
+        #---------
+        # Issue Unit is where it starts.  set up some in/outs for this module
+        #---------
+        m.d.comb += [issueunit.i.store_i.eq(self.int_store_i),
+                     issueunit.i.dest_i.eq(self.int_dest_i),
+                     issueunit.i.src1_i.eq(self.int_src1_i),
+                     issueunit.i.src2_i.eq(self.int_src2_i),
+                     self.issue_o.eq(issueunit.issue_o)
+                    ]
+        self.int_insn_i = issueunit.i.insn_i # enabled by instruction decode
+
+        # connect global rd/wr pending vectors
+        m.d.comb += issueunit.i.g_wr_pend_i.eq(g_int_wr_pend_v.g_pend_o)
+        # TODO: issueunit.f (FP)
+
+        # and int function issue / busy arrays, and dest/src1/src2
+        fn_issue_l = []
+        fn_busy_l = []
+        for i, fu in enumerate(if_l):
+            fn_issue_l.append(fu.issue_i)
+            fn_busy_l.append(fu.busy_o)
+            m.d.comb += fu.issue_i.eq(issueunit.i.fn_issue_o[i])
+            m.d.comb += fu.dest_i.eq(issueunit.i.dest_i)
+            m.d.comb += fu.src1_i.eq(issueunit.i.src1_i)
+            m.d.comb += fu.src2_i.eq(issueunit.i.src2_i)
+            # XXX sync, so as to stop a simulation infinite loop
+            m.d.sync += issueunit.i.busy_i[i].eq(fu.busy_o)
+
+        #---------
+        # connect Function Units
+        #---------
+
+        # XXX sync, again to avoid an infinite loop.  is it the right thing???
+
+        # Group Picker... done manually for now.  TODO: cat array of pick sigs
+        m.d.sync += if_l[0].go_rd_i.eq(intpick1.go_rd_o[0]) # add rd
+        m.d.comb += if_l[0].go_wr_i.eq(intpick1.go_wr_o[0]) # add wr
 
-        n_fus = len(il)
+        m.d.sync += if_l[1].go_rd_i.eq(intpick1.go_rd_o[1]) # subtract rd
+        m.d.comb += if_l[1].go_wr_i.eq(intpick1.go_wr_o[1]) # subtract wr
 
-        # FU Dep Matrix
-        m.submodules.fudeps = fudeps = FUFUDepMatrix(n_fus, n_fus)
+        # Connect INT Fn Unit global wr/rd pending
+        for fu in if_l:
+            m.d.comb += fu.g_int_wr_pend_i.eq(g_int_wr_pend_v.g_pend_o)
+            m.d.comb += fu.g_int_rd_pend_i.eq(g_int_rd_pend_v.g_pend_o)
 
+        # Connect Picker
+        #---------
+        m.d.comb += intpick1.req_rel_i[0].eq(int_alus[0].req_rel_o)
+        m.d.comb += intpick1.req_rel_i[1].eq(int_alus[1].req_rel_o)
+        m.d.comb += intpick1.readable_i[0].eq(if_l[0].int_readable_o) # add rd
+        m.d.comb += intpick1.writable_i[0].eq(if_l[0].int_writable_o) # add wr
+        m.d.comb += intpick1.readable_i[1].eq(if_l[1].int_readable_o) # sub rd
+        m.d.comb += intpick1.writable_i[1].eq(if_l[1].int_writable_o) # sub wr
+
+        #---------
+        # Connect Register File(s)
+        #---------
+        m.d.comb += int_dest.wen.eq(g_int_wr_pend_v.g_pend_o)
+        m.d.comb += int_src1.ren.eq(g_int_src1_pend_v.g_pend_o)
+        m.d.comb += int_src2.ren.eq(g_int_src2_pend_v.g_pend_o)
+
+        # merge (OR) all integer FU / ALU outputs to a single value
+        # bit of a hack: treereduce needs a list with an item named "dest_o"
+        dest_o = treereduce(int_alus)
+        m.d.comb += int_dest.data_i.eq(dest_o)
+
+        # connect ALUs
+        for i, alu in enumerate(int_alus):
+            m.d.comb += alu.go_rd_i.eq(if_l[i].go_rd_i) # chained from intpick
+            m.d.comb += alu.go_wr_i.eq(if_l[i].go_wr_i) # chained from intpick
+            m.d.comb += alu.issue_i.eq(fn_issue_l[i])
+            #m.d.comb += fn_busy_l[i].eq(alu.busy_o)  # XXX ignore, use fnissue
+            m.d.comb += alu.src1_i.eq(int_src1.data_o)
+            m.d.comb += alu.src2_i.eq(int_src2.data_o)
+            m.d.comb += if_l[i].req_rel_i.eq(alu.req_rel_o) # pipe out ready
 
         return m
 
+
     def __iter__(self):
         yield from self.intregs
         yield from self.fpregs
+        yield self.int_store_i
+        yield self.int_dest_i
+        yield self.int_src1_i
+        yield self.int_src2_i
+        yield self.issue_o
         #yield from self.int_src1
         #yield from self.int_dest
         #yield from self.int_src1
@@ -60,40 +216,117 @@ class Scoreboard(Elaboratable):
         #yield from self.fp_dest
         #yield from self.fp_src1
         #yield from self.fp_src2
-                
+
     def ports(self):
         return list(self)
 
+IADD = 0
+ISUB = 1
+
+class RegSim:
+    def __init__(self, rwidth, nregs):
+        self.rwidth = rwidth
+        self.regs = [0] * nregs
+
+    def op(self, op, src1, src2, dest):
+        src1 = self.regs[src1]
+        src2 = self.regs[src2]
+        if op == IADD:
+            val = (src1 + src2) & ((1<<(self.rwidth+1))-1)
+        elif op == ISUB:
+            val = (src1 - src2) & ((1<<(self.rwidth+1))-1)
+        self.regs[dest] = val
+
+    def setval(self, dest, val):
+        self.regs[dest] = val
+
+    def dump(self, dut):
+        for i, val in enumerate(self.regs):
+            reg = yield dut.intregs.regs[i].reg
+            okstr = "OK" if reg == val else "!ok"
+            print("reg %d expected %x received %x %s" % (i, val, reg, okstr))
+
+    def check(self, dut):
+        for i, val in enumerate(self.regs):
+            reg = yield dut.intregs.regs[i].reg
+            if reg != val:
+                print("reg %d expected %x received %x\n" % (i, val, reg))
+                yield from self.dump(dut)
+                assert False
+
+def int_instr(dut, alusim, op, src1, src2, dest):
+    for i in range(len(dut.int_insn_i)):
+        yield dut.int_insn_i[i].eq(0)
+    yield dut.int_dest_i.eq(dest)
+    yield dut.int_src1_i.eq(src1)
+    yield dut.int_src2_i.eq(src2)
+    yield dut.int_insn_i[op].eq(1)
+    alusim.op(op, src1, src2, dest)
 
-def scoreboard_sim(dut):
-    yield dut.dest_i.eq(1)
-    yield dut.issue_i.eq(1)
+
+def print_reg(dut, rnums):
+    rs = []
+    for rnum in rnums:
+        reg = yield dut.intregs.regs[rnum].reg
+        rs.append("%x" % reg)
+    rnums = map(str, rnums)
+    print ("reg %s: %s" % (','.join(rnums), ','.join(rs)))
+
+
+def scoreboard_sim(dut, alusim):
+    for i in range(1, dut.n_regs):
+        yield dut.intregs.regs[i].reg.eq(i)
+        alusim.setval(i, i)
+
+    yield from int_instr(dut, alusim, IADD, 4, 3, 5)
+    yield from print_reg(dut, [3,4,5])
     yield
-    yield dut.issue_i.eq(0)
+    yield from int_instr(dut, alusim, IADD, 5, 2, 5)
+    yield from print_reg(dut, [3,4,5])
     yield
-    yield dut.src1_i.eq(1)
-    yield dut.issue_i.eq(1)
+    yield from int_instr(dut, alusim, ISUB, 5, 1, 3)
+    yield from print_reg(dut, [3,4,5])
     yield
+    for i in range(len(dut.int_insn_i)):
+        yield dut.int_insn_i[i].eq(0)
+    yield from print_reg(dut, [3,4,5])
     yield
+    yield from print_reg(dut, [3,4,5])
     yield
-    yield dut.issue_i.eq(0)
+    yield from print_reg(dut, [3,4,5])
     yield
-    yield dut.go_read_i.eq(1)
+
+    yield from alusim.check(dut)
+
+    for i in range(100):
+        src1 = randint(0, dut.n_regs-1)
+        src2 = randint(0, dut.n_regs-1)
+        dest = randint(1, dut.n_regs-1)
+        op = randint(0, 1)
+        print ("random %d: %d %d %d %d\n" % (i, op, src1, src2, dest))
+        yield from int_instr(dut, alusim, op, src1, src2, dest)
+        yield
+
+    for i in range(len(dut.int_insn_i)):
+        yield dut.int_insn_i[i].eq(0)
+
     yield
-    yield dut.go_read_i.eq(0)
     yield
-    yield dut.go_write_i.eq(1)
     yield
-    yield dut.go_write_i.eq(0)
     yield
+    yield from alusim.check(dut)
+
 
 def test_scoreboard():
     dut = Scoreboard(32, 8)
+    alusim = RegSim(32, 8)
     vl = rtlil.convert(dut, ports=dut.ports())
     with open("test_scoreboard.il", "w") as f:
         f.write(vl)
 
-    run_simulation(dut, scoreboard_sim(dut), vcd_name='test_scoreboard.vcd')
+    run_simulation(dut, scoreboard_sim(dut, alusim),
+                        vcd_name='test_scoreboard.vcd')
+
 
 if __name__ == '__main__':
     test_scoreboard()