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