Fix PartitionedSignal.neg and its test case
[ieee754fpu.git] / src / ieee754 / part / test / test_partsig.py
index cc881be307cc44c6030b3f5fce4865413bd0c31b..7d87eceebac77801362179bdb4a8ca50140ded55 100644 (file)
@@ -3,8 +3,8 @@
 # See Notices.txt for copyright information
 
 from nmigen import Signal, Module, Elaboratable
-from nmigen.back.pysim import Simulator, Delay, Tick, Passive
-from nmigen.cli import verilog, rtlil
+from nmigen.back.pysim import Simulator, Delay
+from nmigen.cli import rtlil
 
 from ieee754.part.partsig import PartitionedSignal
 from ieee754.part_mux.part_mux import PMux
@@ -12,6 +12,21 @@ from ieee754.part_mux.part_mux import PMux
 from random import randint
 import unittest
 import itertools
+import math
+
+def first_zero(x):
+    res = 0
+    for i in range(16):
+        if x & (1<<i):
+            return res
+        res += 1
+
+def count_bits(x):
+    res = 0
+    for i in range(16):
+        if x & (1<<i):
+            res += 1
+    return res
 
 
 def perms(k):
@@ -26,17 +41,84 @@ def create_ilang(dut, traces, test_name):
 
 def create_simulator(module, traces, test_name):
     create_ilang(module, traces, test_name)
-    return Simulator(module,
-                     vcd_file=open(test_name + ".vcd", "w"),
-                     gtkw_file=open(test_name + ".gtkw", "w"),
-                     traces=traces)
+    return Simulator(module)
+
+
+# XXX this is for coriolis2 experimentation
+class TestAddMod2(Elaboratable):
+    def __init__(self, width, partpoints):
+        self.partpoints = partpoints
+        self.a = PartitionedSignal(partpoints, width)
+        self.b = PartitionedSignal(partpoints, width)
+        self.bsig = Signal(width)
+        self.add_output = Signal(width)
+        self.ls_output = Signal(width) # left shift
+        self.ls_scal_output = Signal(width) # left shift
+        self.rs_output = Signal(width) # right shift
+        self.rs_scal_output = Signal(width) # right shift
+        self.sub_output = Signal(width)
+        self.eq_output = Signal(len(partpoints)+1)
+        self.gt_output = Signal(len(partpoints)+1)
+        self.ge_output = Signal(len(partpoints)+1)
+        self.ne_output = Signal(len(partpoints)+1)
+        self.lt_output = Signal(len(partpoints)+1)
+        self.le_output = Signal(len(partpoints)+1)
+        self.mux_sel = Signal(len(partpoints)+1)
+        self.mux_out = Signal(width)
+        self.carry_in = Signal(len(partpoints)+1)
+        self.add_carry_out = Signal(len(partpoints)+1)
+        self.sub_carry_out = Signal(len(partpoints)+1)
+        self.neg_output = Signal(width)
+
+    def elaborate(self, platform):
+        m = Module()
+        comb = m.d.comb
+        sync = m.d.sync
+        self.a.set_module(m)
+        self.b.set_module(m)
+        # compares
+        sync += self.lt_output.eq(self.a < self.b)
+        sync += self.ne_output.eq(self.a != self.b)
+        sync += self.le_output.eq(self.a <= self.b)
+        sync += self.gt_output.eq(self.a > self.b)
+        sync += self.eq_output.eq(self.a == self.b)
+        sync += self.ge_output.eq(self.a >= self.b)
+        # add
+        add_out, add_carry = self.a.add_op(self.a, self.b,
+                                           self.carry_in)
+        sync += self.add_output.eq(add_out)
+        sync += self.add_carry_out.eq(add_carry)
+        # sub
+        sub_out, sub_carry = self.a.sub_op(self.a, self.b,
+                                           self.carry_in)
+        sync += self.sub_output.eq(sub_out)
+        sync += self.sub_carry_out.eq(sub_carry)
+        # neg
+        sync += self.neg_output.eq(-self.a)
+        # left shift
+        sync += self.ls_output.eq(self.a << self.b)
+        sync += self.rs_output.eq(self.a >> self.b)
+        ppts = self.partpoints
+        sync += self.mux_out.eq(PMux(m, ppts, self.mux_sel, self.a, self.b))
+        # scalar left shift
+        comb += self.bsig.eq(self.b.sig)
+        sync += self.ls_scal_output.eq(self.a << self.bsig)
+        sync += self.rs_scal_output.eq(self.a >> self.bsig)
+
+        return m
+
 
 class TestAddMod(Elaboratable):
     def __init__(self, width, partpoints):
         self.partpoints = partpoints
         self.a = PartitionedSignal(partpoints, width)
         self.b = PartitionedSignal(partpoints, width)
+        self.bsig = Signal(width)
         self.add_output = Signal(width)
+        self.ls_output = Signal(width) # left shift
+        self.ls_scal_output = Signal(width) # left shift
+        self.rs_output = Signal(width) # right shift
+        self.rs_scal_output = Signal(width) # right shift
         self.sub_output = Signal(width)
         self.eq_output = Signal(len(partpoints)+1)
         self.gt_output = Signal(len(partpoints)+1)
@@ -53,28 +135,41 @@ class TestAddMod(Elaboratable):
 
     def elaborate(self, platform):
         m = Module()
+        comb = m.d.comb
+        sync = m.d.sync
         self.a.set_module(m)
         self.b.set_module(m)
-        m.d.comb += self.lt_output.eq(self.a < self.b)
-        m.d.comb += self.ne_output.eq(self.a != self.b)
-        m.d.comb += self.le_output.eq(self.a <= self.b)
-        m.d.comb += self.gt_output.eq(self.a > self.b)
-        m.d.comb += self.eq_output.eq(self.a == self.b)
-        m.d.comb += self.ge_output.eq(self.a >= self.b)
+        # compares
+        comb += self.lt_output.eq(self.a < self.b)
+        comb += self.ne_output.eq(self.a != self.b)
+        comb += self.le_output.eq(self.a <= self.b)
+        comb += self.gt_output.eq(self.a > self.b)
+        comb += self.eq_output.eq(self.a == self.b)
+        comb += self.ge_output.eq(self.a >= self.b)
         # add
         add_out, add_carry = self.a.add_op(self.a, self.b,
                                            self.carry_in)
-        m.d.comb += self.add_output.eq(add_out)
-        m.d.comb += self.add_carry_out.eq(add_carry)
-        if hasattr(self.a, "sub_op"): # TODO, remove this
-            # sub
-            sub_out, sub_carry = self.a.sub_op(self.a, self.b,
-                                               self.carry_in)
-            m.d.comb += self.sub_output.eq(sub_out)
-            m.d.comb += self.sub_carry_out.eq(add_carry)
-        m.d.comb += self.neg_output.eq(-self.a)
+        comb += self.add_output.eq(add_out)
+        comb += self.add_carry_out.eq(add_carry)
+        # sub
+        sub_out, sub_carry = self.a.sub_op(self.a, self.b,
+                                           self.carry_in)
+        comb += self.sub_output.eq(sub_out)
+        comb += self.sub_carry_out.eq(sub_carry)
+        # neg
+        comb += self.neg_output.eq(-self.a)
+        # left shift
+        comb += self.ls_output.eq(self.a << self.b)
+        # right shift
+        comb += self.rs_output.eq(self.a >> self.b)
         ppts = self.partpoints
-        m.d.comb += self.mux_out.eq(PMux(m, ppts, self.mux_sel, self.a, self.b))
+        # mux
+        comb += self.mux_out.eq(PMux(m, ppts, self.mux_sel, self.a, self.b))
+        # scalar left shift
+        comb += self.bsig.eq(self.b.sig)
+        comb += self.ls_scal_output.eq(self.a << self.bsig)
+        # scalar right shift
+        comb += self.rs_scal_output.eq(self.a >> self.bsig)
 
         return m
 
@@ -82,34 +177,118 @@ class TestAddMod(Elaboratable):
 class TestPartitionPoints(unittest.TestCase):
     def test(self):
         width = 16
-        part_mask = Signal(4) # divide into 4-bits
+        part_mask = Signal(4)  # divide into 4-bits
         module = TestAddMod(width, part_mask)
 
-        sim = create_simulator(module,
-                              [part_mask,
-                               module.a.sig,
-                               module.b.sig,
-                               module.add_output,
-                               module.eq_output],
-                              "part_sig_add")
+        test_name = "part_sig_add"
+        traces = [part_mask,
+                  module.a.sig,
+                  module.b.sig,
+                  module.add_output,
+                  module.eq_output]
+        sim = create_simulator(module, traces, test_name)
+
         def async_process():
 
+            def test_ls_scal_fn(carry_in, a, b, mask):
+                # reduce range of b
+                bits = count_bits(mask)
+                newb = b & ((bits-1))
+                print ("%x %x %x bits %d trunc %x" % \
+                        (a, b, mask, bits, newb))
+                b = newb
+                # TODO: carry
+                carry_in = 0
+                lsb = mask & ~(mask-1) if carry_in else 0
+                sum = ((a & mask) << b)
+                result = mask & sum
+                carry = (sum & mask) != sum
+                carry = 0
+                print("res", hex(a), hex(b), hex(sum), hex(mask), hex(result))
+                return result, carry
+
+            def test_rs_scal_fn(carry_in, a, b, mask):
+                # reduce range of b
+                bits = count_bits(mask)
+                newb = b & ((bits-1))
+                print ("%x %x %x bits %d trunc %x" % \
+                        (a, b, mask, bits, newb))
+                b = newb
+                # TODO: carry
+                carry_in = 0
+                lsb = mask & ~(mask-1) if carry_in else 0
+                sum = ((a & mask) >> b)
+                result = mask & sum
+                carry = (sum & mask) != sum
+                carry = 0
+                print("res", hex(a), hex(b), hex(sum), hex(mask), hex(result))
+                return result, carry
+
+            def test_ls_fn(carry_in, a, b, mask):
+                # reduce range of b
+                bits = count_bits(mask)
+                fz = first_zero(mask)
+                newb = b & ((bits-1)<<fz)
+                print ("%x %x %x bits %d zero %d trunc %x" % \
+                        (a, b, mask, bits, fz, newb))
+                b = newb
+                # TODO: carry
+                carry_in = 0
+                lsb = mask & ~(mask-1) if carry_in else 0
+                b = (b & mask)
+                b = b >>fz
+                sum = ((a & mask) << b)
+                result = mask & sum
+                carry = (sum & mask) != sum
+                carry = 0
+                print("res", hex(a), hex(b), hex(sum), hex(mask), hex(result))
+                return result, carry
+
+            def test_rs_fn(carry_in, a, b, mask):
+                # reduce range of b
+                bits = count_bits(mask)
+                fz = first_zero(mask)
+                newb = b & ((bits-1)<<fz)
+                print ("%x %x %x bits %d zero %d trunc %x" % \
+                        (a, b, mask, bits, fz, newb))
+                b = newb
+                # TODO: carry
+                carry_in = 0
+                lsb = mask & ~(mask-1) if carry_in else 0
+                b = (b & mask)
+                b = b >>fz
+                sum = ((a & mask) >> b)
+                result = mask & sum
+                carry = (sum & mask) != sum
+                carry = 0
+                print("res", hex(a), hex(b), hex(sum), hex(mask), hex(result))
+                return result, carry
+
             def test_add_fn(carry_in, a, b, mask):
                 lsb = mask & ~(mask-1) if carry_in else 0
-                return mask & ((a & mask) + (b & mask) + lsb)
+                sum = (a & mask) + (b & mask) + lsb
+                result = mask & sum
+                carry = (sum & mask) != sum
+                print(a, b, sum, mask)
+                return result, carry
 
             def test_sub_fn(carry_in, a, b, mask):
                 lsb = mask & ~(mask-1) if carry_in else 0
-                return mask & ((a & mask) + (~b & mask) + lsb)
+                sum = (a & mask) + (~b & mask) + lsb
+                result = mask & sum
+                carry = (sum & mask) != sum
+                return result, carry
 
             def test_neg_fn(carry_in, a, b, mask):
-                lsb = mask & ~(mask-1) if carry_in else 0
-                return mask & ((a & mask) + (~0 & mask)) 
+                lsb = mask & ~(mask - 1)  # has only LSB of mask set
+                pos = lsb.bit_length() - 1  # find bit position
+                a = (a & mask) >> pos  # shift it to the beginning
+                return ((-a) << pos) & mask, 0  # negate and shift it back
 
             def test_op(msg_prefix, carry, test_fn, mod_attr, *mask_list):
                 rand_data = []
                 for i in range(100):
-                    a, b = randint(0, 1<<16), randint(0, 1<<16)
+                    a, b = randint(0, 1 << 16), randint(0, 1 << 16)
                     rand_data.append((a, b))
                 for a, b in [(0x0000, 0x0000),
                              (0x1234, 0x1234),
@@ -124,16 +303,33 @@ class TestPartitionPoints(unittest.TestCase):
                     yield module.carry_in.eq(carry_sig)
                     yield Delay(0.1e-6)
                     y = 0
+                    carry_result = 0
                     for i, mask in enumerate(mask_list):
-                        y |= test_fn(carry, a, b, mask)
+                        print ("i/mask", i, hex(mask))
+                        res, c = test_fn(carry, a, b, mask)
+                        y |= res
+                        lsb = mask & ~(mask - 1)
+                        bit_set = int(math.log2(lsb))
+                        carry_result |= c << int(bit_set/4)
                     outval = (yield getattr(module, "%s_output" % mod_attr))
                     # TODO: get (and test) carry output as well
                     print(a, b, outval, carry)
-                    msg = f"{msg_prefix}: 0x{a:X} + 0x{b:X}" + \
+                    msg = f"{msg_prefix}: 0x{a:X} {mod_attr} 0x{b:X}" + \
                         f" => 0x{y:X} != 0x{outval:X}"
                     self.assertEqual(y, outval, msg)
-
-            for (test_fn, mod_attr) in ((test_add_fn, "add"),
+                    if hasattr(module, "%s_carry_out" % mod_attr):
+                        c_outval = (yield getattr(module,
+                                                  "%s_carry_out" % mod_attr))
+                        msg = f"{msg_prefix}: 0x{a:X} {mod_attr} 0x{b:X}" + \
+                            f" => 0x{carry_result:X} != 0x{c_outval:X}"
+                        self.assertEqual(carry_result, c_outval, msg)
+
+            for (test_fn, mod_attr) in (
+                                        (test_ls_scal_fn, "ls_scal"),
+                                        (test_ls_fn, "ls"),
+                                        (test_rs_scal_fn, "rs_scal"),
+                                        (test_rs_fn, "rs"),
+                                        (test_add_fn, "add"),
                                         (test_sub_fn, "sub"),
                                         (test_neg_fn, "neg"),
                                         ):
@@ -142,14 +338,14 @@ class TestPartitionPoints(unittest.TestCase):
                 yield from test_op("16-bit", 0, test_fn, mod_attr, 0xFFFF)
                 yield part_mask.eq(0b10)
                 yield from test_op("8-bit", 0, test_fn, mod_attr,
-                                               0xFF00, 0x00FF)
-                yield from test_op("8-bit", 1, test_fn, mod_attr, 
-                                               0xFF00, 0x00FF)
+                                   0xFF00, 0x00FF)
+                yield from test_op("8-bit", 1, test_fn, mod_attr,
+                                   0xFF00, 0x00FF)
                 yield part_mask.eq(0b1111)
                 yield from test_op("4-bit", 0, test_fn, mod_attr,
-                                               0xF000, 0x0F00, 0x00F0, 0x000F)
-                yield from test_op("4-bit", 1, test_fn, mod_attr, 
-                                               0xF000, 0x0F00, 0x00F0, 0x000F)
+                                   0xF000, 0x0F00, 0x00F0, 0x000F)
+                yield from test_op("4-bit", 1, test_fn, mod_attr,
+                                   0xF000, 0x0F00, 0x00F0, 0x000F)
 
             def test_ne_fn(a, b, mask):
                 return (a & mask) != (b & mask)
@@ -188,7 +384,7 @@ class TestPartitionPoints(unittest.TestCase):
                     for mb in maskbit_list:
                         v = 0
                         for i in range(4):
-                            if mb & (1<<i):
+                            if mb & (1 << i):
                                 v |= 0xf << (i*4)
                         mask_list.append(v)
                     y = 0
@@ -201,7 +397,7 @@ class TestPartitionPoints(unittest.TestCase):
                     outval = (yield getattr(module, "%s_output" % mod_attr))
                     msg = f"{msg_prefix}: {mod_attr} 0x{a:X} == 0x{b:X}" + \
                         f" => 0x{y:X} != 0x{outval:X}, masklist %s"
-                    print ((msg % str(maskbit_list)).format(locals()))
+                    print((msg % str(maskbit_list)).format(locals()))
                     self.assertEqual(y, outval, msg % str(maskbit_list))
 
             for (test_fn, mod_attr) in ((test_eq_fn, "eq"),
@@ -233,7 +429,7 @@ class TestPartitionPoints(unittest.TestCase):
                     for mb in maskbit_list:
                         v = 0
                         for i in range(4):
-                            if mb & (1<<i):
+                            if mb & (1 << i):
                                 v |= 0xf << (i*4)
                         mask_list.append(v)
 
@@ -263,7 +459,7 @@ class TestPartitionPoints(unittest.TestCase):
                         msg = f"{msg_prefix}: mux " + \
                             f"0x{sel:X} ? 0x{a:X} : 0x{b:X}" + \
                             f" => 0x{y:X} != 0x{outval:X}, masklist %s"
-                        #print ((msg % str(maskbit_list)).format(locals()))
+                        # print ((msg % str(maskbit_list)).format(locals()))
                         self.assertEqual(y, outval, msg % str(maskbit_list))
 
             yield part_mask.eq(0)
@@ -274,8 +470,12 @@ class TestPartitionPoints(unittest.TestCase):
             yield from test_muxop("4-bit", 0b1000, 0b0100, 0b0010, 0b0001)
 
         sim.add_process(async_process)
-        sim.run()
+        with sim.write_vcd(
+                vcd_file=open(test_name + ".vcd", "w"),
+                gtkw_file=open(test_name + ".gtkw", "w"),
+                traces=traces):
+            sim.run()
+
 
 if __name__ == '__main__':
     unittest.main()
-