src/soc/decoder/selectable_int.py

   1 import unittest
   2 from copy import copy
   3 from soc.decoder.power_fields import BitRange
   4 from operator import (add, sub, mul, truediv, mod, or_, and_, xor, neg, inv,
   5                       lshift, rshift)
   6
   7
   8 def check_extsign(a, b):
   9     if isinstance(b, FieldSelectableInt):
  10         b = b.get_range()
  11     if isinstance(b, int):
  12         return SelectableInt(b, a.bits)
  13     if b.bits != 256:
  14         return b
  15     return SelectableInt(b.value, a.bits)
  16
  17
  18 class FieldSelectableInt:
  19     """FieldSelectableInt: allows bit-range selection onto another target
  20     """
  21     def __init__(self, si, br):
  22         self.si = si # target selectable int
  23         if isinstance(br, list) or isinstance(br, tuple):
  24             _br = BitRange()
  25             for i, v in enumerate(br):
  26                 _br[i] = v
  27             br = _br
  28         self.br = br # map of indices.
  29
  30     def eq(self, b):
  31         if isinstance(b, SelectableInt):
  32             for i in range(b.bits):
  33                 self[i] = b[i]
  34         else:
  35             self.si = copy(b.si)
  36             self.br = copy(b.br)
  37
  38     def _op(self, op, b):
  39         vi = self.get_range()
  40         vi = op(vi, b)
  41         return self.merge(vi)
  42
  43     def _op1(self, op):
  44         vi = self.get_range()
  45         vi = op(vi)
  46         return self.merge(vi)
  47
  48     def __getitem__(self, key):
  49         print ("getitem", key, self.br)
  50         if isinstance(key, SelectableInt):
  51             key = key.value
  52         if isinstance(key, int):
  53             key = self.br[key] # don't do POWER 1.3.4 bit-inversion
  54             return self.si[key]
  55         if isinstance(key, slice):
  56             key = self.br[key]
  57             return selectconcat(*[self.si[x] for x in key])
  58
  59     def __setitem__(self, key, value):
  60         if isinstance(key, SelectableInt):
  61             key = key.value
  62         key = self.br[key] # don't do POWER 1.3.4 bit-inversion
  63         if isinstance(key, int):
  64             return self.si.__setitem__(key, value)
  65         else:
  66             if not isinstance(value, SelectableInt):
  67                 value = SelectableInt(value, bits=len(key))
  68             for i, k in enumerate(key):
  69                 self.si[k] = value[i]
  70
  71     def __negate__(self):
  72         return self._op1(negate)
  73     def __invert__(self):
  74         return self._op1(inv)
  75     def __add__(self, b):
  76         return self._op(add, b)
  77     def __sub__(self, b):
  78         return self._op(sub, b)
  79     def __mul__(self, b):
  80         return self._op(mul, b)
  81     def __div__(self, b):
  82         return self._op(truediv, b)
  83     def __mod__(self, b):
  84         return self._op(mod, b)
  85     def __and__(self, b):
  86         return self._op(and_, b)
  87     def __or__(self, b):
  88         return self._op(or_, b)
  89     def __xor__(self, b):
  90         return self._op(xor, b)
  91
  92     def get_range(self):
  93         vi = SelectableInt(0, len(self.br))
  94         for k, v in self.br.items():
  95             vi[k] = self.si[v]
  96         return vi
  97
  98     def merge(self, vi):
  99         fi = copy(self)
 100         for i, v in fi.br.items():
 101             fi.si[v] = vi[i]
 102         return fi
 103
 104     def __repr__(self):
 105         return "FieldSelectableInt(si=%s, br=%s)" % (self.si, self.br)
 106
 107
 108 class FieldSelectableIntTestCase(unittest.TestCase):
 109     def test_arith(self):
 110         a = SelectableInt(0b10101, 5)
 111         b = SelectableInt(0b011, 3)
 112         br = BitRange()
 113         br[0] = 0
 114         br[1] = 2
 115         br[2] = 3
 116         fs = FieldSelectableInt(a, br)
 117         c = fs + b
 118         print (c)
 119         #self.assertEqual(c.value, a.value + b.value)
 120
 121     def test_select(self):
 122         a = SelectableInt(0b00001111, 8)
 123         br = BitRange()
 124         br[0] = 0
 125         br[1] = 1
 126         br[2] = 4
 127         br[3] = 5
 128         fs = FieldSelectableInt(a, br)
 129
 130         self.assertEqual(fs.get_range(), 0b0011)
 131
 132     def test_select_range(self):
 133         a = SelectableInt(0b00001111, 8)
 134         br = BitRange()
 135         br[0] = 0
 136         br[1] = 1
 137         br[2] = 4
 138         br[3] = 5
 139         fs = FieldSelectableInt(a, br)
 140
 141         self.assertEqual(fs[2:4], 0b11)
 142
 143         fs[0:2] = 0b10
 144         self.assertEqual(fs.get_range(), 0b1011)
 145
 146
 147 class SelectableInt:
 148     def __init__(self, value, bits):
 149         if isinstance(value, SelectableInt):
 150             value = value.value
 151         mask = (1 << bits) - 1
 152         self.value = value & mask
 153         self.bits = bits
 154
 155     def eq(self, b):
 156         self.value = b.value
 157         self.bits = b.bits
 158
 159     def _op(self, op, b):
 160         if isinstance(b, int):
 161             b = SelectableInt(b, self.bits)
 162         b = check_extsign(self, b)
 163         assert b.bits == self.bits
 164         return SelectableInt(op(self.value, b.value), self.bits)
 165
 166     def __add__(self, b):
 167         return self._op(add, b)
 168     def __sub__(self, b):
 169         return self._op(sub, b)
 170     def __mul__(self, b):
 171         return self._op(mul, b)
 172     def __div__(self, b):
 173         return self._op(truediv, b)
 174     def __mod__(self, b):
 175         return self._op(mod, b)
 176     def __and__(self, b):
 177         return self._op(and_, b)
 178     def __or__(self, b):
 179         return self._op(or_, b)
 180     def __xor__(self, b):
 181         return self._op(xor, b)
 182
 183     def __rsub__(self, b):
 184         if isinstance(b, int):
 185             b = SelectableInt(b, self.bits)
 186         b = check_extsign(self, b)
 187         assert b.bits == self.bits
 188         return SelectableInt(b.value - self.value, self.bits)
 189
 190     def __radd__(self, b):
 191         if isinstance(b, int):
 192             b = SelectableInt(b, self.bits)
 193         b = check_extsign(self, b)
 194         assert b.bits == self.bits
 195         return SelectableInt(b.value + self.value, self.bits)
 196
 197     def __rxor__(self, b):
 198         b = check_extsign(self, b)
 199         assert b.bits == self.bits
 200         return SelectableInt(self.value ^ b.value, self.bits)
 201
 202     def __invert__(self):
 203         return SelectableInt(~self.value, self.bits)
 204
 205     def __neg__(self):
 206         return SelectableInt(~self.value + 1, self.bits)
 207
 208     def __lshift__(self, b):
 209         b = check_extsign(self, b)
 210         return SelectableInt(self.value << b.value, self.bits)
 211
 212     def __rshift__(self, b):
 213         b = check_extsign(self, b)
 214         return SelectableInt(self.value >> b.value, self.bits)
 215
 216     def __getitem__(self, key):
 217         if isinstance(key, SelectableInt):
 218             key = key.value
 219         if isinstance(key, int):
 220             assert key < self.bits, "key %d accessing %d" % (key, self.bits)
 221             assert key >= 0
 222             # NOTE: POWER 3.0B annotation order!  see p4 1.3.2
 223             # MSB is indexed **LOWEST** (sigh)
 224             key = self.bits - (key + 1)
 225
 226             value = (self.value >> key) & 1
 227             return SelectableInt(value, 1)
 228         elif isinstance(key, slice):
 229             assert key.step is None or key.step == 1
 230             assert key.start < key.stop
 231             assert key.start >= 0
 232             assert key.stop <= self.bits
 233
 234             stop = self.bits - key.start
 235             start = self.bits - key.stop
 236
 237             bits = stop - start
 238             #print ("__getitem__ slice num bits", bits)
 239             mask = (1 << bits) - 1
 240             value = (self.value >> start) & mask
 241             return SelectableInt(value, bits)
 242
 243     def __setitem__(self, key, value):
 244         if isinstance(key, SelectableInt):
 245             key = key.value
 246         if isinstance(key, int):
 247             assert key < self.bits
 248             assert key >= 0
 249             key = self.bits - (key + 1)
 250             if isinstance(value, SelectableInt):
 251                 assert value.bits == 1
 252                 value = value.value
 253
 254             value = value << key
 255             mask = 1 << key
 256             self.value = (self.value & ~mask) | (value & mask)
 257         elif isinstance(key, slice):
 258             assert key.step is None or key.step == 1
 259             assert key.start < key.stop
 260             assert key.start >= 0
 261             assert key.stop <= self.bits
 262
 263             stop = self.bits - key.start
 264             start = self.bits - key.stop
 265
 266             bits = stop - start
 267             #print ("__setitem__ slice num bits", bits)
 268             if isinstance(value, SelectableInt):
 269                 assert value.bits == bits, "%d into %d" % (value.bits, bits)
 270                 value = value.value
 271             mask = ((1 << bits) - 1) << start
 272             value = value << start
 273             self.value = (self.value & ~mask) | (value & mask)
 274
 275     def __ge__(self, other):
 276         if isinstance(other, FieldSelectableInt):
 277             other = other.get_range()
 278         if isinstance(other, SelectableInt):
 279             other = check_extsign(self, other)
 280             assert other.bits == self.bits
 281             other = other.value
 282         if isinstance(other, int):
 283             return onebit(self.value >= other.value)
 284         assert False
 285
 286     def __le__(self, other):
 287         if isinstance(other, FieldSelectableInt):
 288             other = other.get_range()
 289         if isinstance(other, SelectableInt):
 290             other = check_extsign(self, other)
 291             assert other.bits == self.bits
 292             other = other.value
 293         if isinstance(other, int):
 294             return onebit(self.value <= other)
 295         assert False
 296
 297     def __gt__(self, other):
 298         if isinstance(other, FieldSelectableInt):
 299             other = other.get_range()
 300         if isinstance(other, SelectableInt):
 301             other = check_extsign(self, other)
 302             assert other.bits == self.bits
 303             other = other.value
 304         if isinstance(other, int):
 305             return onebit(self.value > other)
 306         assert False
 307
 308     def __lt__(self, other):
 309         if isinstance(other, FieldSelectableInt):
 310             other = other.get_range()
 311         if isinstance(other, SelectableInt):
 312             other = check_extsign(self, other)
 313             assert other.bits == self.bits
 314             other = other.value
 315         if isinstance(other, int):
 316             return onebit(self.value < other)
 317         assert False
 318
 319     def __eq__(self, other):
 320         print ("__eq__", self, other)
 321         if isinstance(other, FieldSelectableInt):
 322             other = other.get_range()
 323         if isinstance(other, SelectableInt):
 324             other = check_extsign(self, other)
 325             assert other.bits == self.bits
 326             other = other.value
 327         if isinstance(other, int):
 328             return onebit(other == self.value)
 329         assert False
 330
 331     def narrow(self, bits):
 332         assert bits <= self.bits
 333         return SelectableInt(self.value, bits)
 334
 335     def __bool__(self):
 336         return self.value != 0
 337
 338     def __repr__(self):
 339         return "SelectableInt(value=0x{:x}, bits={})".format(self.value,
 340                                                            self.bits)
 341
 342     def __len__(self):
 343         return self.bits
 344
 345     def asint(self):
 346         return self.value
 347
 348
 349 def onebit(bit):
 350     return SelectableInt(1 if bit else 0, 1)
 351
 352 def selectltu(lhs, rhs):
 353     """ less-than (unsigned)
 354     """
 355     if isinstance(rhs, SelectableInt):
 356         rhs = rhs.value
 357     return onebit(lhs.value < rhs)
 358
 359 def selectgtu(lhs, rhs):
 360     """ greater-than (unsigned)
 361     """
 362     if isinstance(rhs, SelectableInt):
 363         rhs = rhs.value
 364     return onebit(lhs.value > rhs)
 365
 366
 367 # XXX this probably isn't needed...
 368 def selectassign(lhs, idx, rhs):
 369     if isinstance(idx, tuple):
 370         if len(idx) == 2:
 371             lower, upper = idx
 372             step = None
 373         else:
 374             lower, upper, step = idx
 375         toidx = range(lower, upper, step)
 376         fromidx = range(0, upper-lower, step) # XXX eurgh...
 377     else:
 378         toidx = [idx]
 379         fromidx = [0]
 380     for t, f in zip(toidx, fromidx):
 381         lhs[t] = rhs[f]
 382
 383
 384 def selectconcat(*args, repeat=1):
 385     if repeat != 1 and len(args) == 1 and isinstance(args[0], int):
 386         args = [SelectableInt(args[0], 1)]
 387     if repeat != 1: # multiplies the incoming arguments
 388         tmp = []
 389         for i in range(repeat):
 390             tmp += args
 391         args = tmp
 392     res = copy(args[0])
 393     for i in args[1:]:
 394         if isinstance(i, FieldSelectableInt):
 395             i = i.si
 396         assert isinstance(i, SelectableInt), "can only concat SIs, sorry"
 397         res.bits += i.bits
 398         res.value = (res.value << i.bits) | i.value
 399     print ("concat", repeat, res)
 400     return res
 401
 402
 403 class SelectableIntTestCase(unittest.TestCase):
 404     def test_arith(self):
 405         a = SelectableInt(5, 8)
 406         b = SelectableInt(9, 8)
 407         c = a + b
 408         d = a - b
 409         e = a * b
 410         f = -a
 411         self.assertEqual(c.value, a.value + b.value)
 412         self.assertEqual(d.value, (a.value - b.value) & 0xFF)
 413         self.assertEqual(e.value, (a.value * b.value) & 0xFF)
 414         self.assertEqual(f.value, (-a.value) & 0xFF)
 415         self.assertEqual(c.bits, a.bits)
 416         self.assertEqual(d.bits, a.bits)
 417         self.assertEqual(e.bits, a.bits)
 418
 419     def test_logic(self):
 420         a = SelectableInt(0x0F, 8)
 421         b = SelectableInt(0xA5, 8)
 422         c = a & b
 423         d = a | b
 424         e = a ^ b
 425         f = ~a
 426         self.assertEqual(c.value, a.value & b.value)
 427         self.assertEqual(d.value, a.value | b.value)
 428         self.assertEqual(e.value, a.value ^ b.value)
 429         self.assertEqual(f.value, 0xF0)
 430
 431     def test_get(self):
 432         a = SelectableInt(0xa2, 8)
 433         # These should be big endian
 434         self.assertEqual(a[7], 0)
 435         self.assertEqual(a[0:4], 10)
 436         self.assertEqual(a[4:8], 2)
 437
 438     def test_set(self):
 439         a = SelectableInt(0x5, 8)
 440         a[7] = SelectableInt(0, 1)
 441         self.assertEqual(a, 4)
 442         a[4:8] = 9
 443         self.assertEqual(a, 9)
 444         a[0:4] = 3
 445         self.assertEqual(a, 0x39)
 446         a[0:4] = a[4:8]
 447         self.assertEqual(a, 0x99)
 448
 449     def test_concat(self):
 450         a = SelectableInt(0x1, 1)
 451         c = selectconcat(a, repeat=8)
 452         self.assertEqual(c, 0xff)
 453         self.assertEqual(c.bits, 8)
 454         a = SelectableInt(0x0, 1)
 455         c = selectconcat(a, repeat=8)
 456         self.assertEqual(c, 0x00)
 457         self.assertEqual(c.bits, 8)
 458
 459     def test_repr(self):
 460         for i in range(65536):
 461             a = SelectableInt(i, 16)
 462             b = eval(repr(a))
 463             self.assertEqual(a, b)
 464
 465     def test_cmp(self):
 466         a = SelectableInt(10, bits=8)
 467         b = SelectableInt(5, bits=8)
 468         self.assertTrue(a > b)
 469         self.assertFalse(a < b)
 470         self.assertTrue(a != b)
 471         self.assertFalse(a == b)
 472
 473     def test_unsigned(self):
 474         a = SelectableInt(0x80, bits=8)
 475         b = SelectableInt(0x7f, bits=8)
 476         self.assertTrue(a > b)
 477         self.assertFalse(a < b)
 478         self.assertTrue(a != b)
 479         self.assertFalse(a == b)
 480
 481 if __name__ == "__main__":
 482     unittest.main()