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, floordiv, truediv, mod, or_, and_, xor,
   5                       neg, inv, 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 __floordiv__(self, b):
 173         return self._op(floordiv, b)
 174     def __truediv__(self, b):
 175         return self._op(truediv, b)
 176     def __mod__(self, b):
 177         return self._op(mod, b)
 178     def __and__(self, b):
 179         return self._op(and_, b)
 180     def __or__(self, b):
 181         return self._op(or_, b)
 182     def __xor__(self, b):
 183         return self._op(xor, b)
 184
 185     def __rsub__(self, b):
 186         if isinstance(b, int):
 187             b = SelectableInt(b, self.bits)
 188         b = check_extsign(self, b)
 189         assert b.bits == self.bits
 190         return SelectableInt(b.value - self.value, self.bits)
 191
 192     def __radd__(self, b):
 193         if isinstance(b, int):
 194             b = SelectableInt(b, self.bits)
 195         b = check_extsign(self, b)
 196         assert b.bits == self.bits
 197         return SelectableInt(b.value + self.value, self.bits)
 198
 199     def __rxor__(self, b):
 200         b = check_extsign(self, b)
 201         assert b.bits == self.bits
 202         return SelectableInt(self.value ^ b.value, self.bits)
 203
 204     def __invert__(self):
 205         return SelectableInt(~self.value, self.bits)
 206
 207     def __neg__(self):
 208         return SelectableInt(~self.value + 1, self.bits)
 209
 210     def __lshift__(self, b):
 211         b = check_extsign(self, b)
 212         return SelectableInt(self.value << b.value, self.bits)
 213
 214     def __rshift__(self, b):
 215         b = check_extsign(self, b)
 216         return SelectableInt(self.value >> b.value, self.bits)
 217
 218     def __getitem__(self, key):
 219         if isinstance(key, SelectableInt):
 220             key = key.value
 221         if isinstance(key, int):
 222             assert key < self.bits, "key %d accessing %d" % (key, self.bits)
 223             assert key >= 0
 224             # NOTE: POWER 3.0B annotation order!  see p4 1.3.2
 225             # MSB is indexed **LOWEST** (sigh)
 226             key = self.bits - (key + 1)
 227
 228             value = (self.value >> key) & 1
 229             return SelectableInt(value, 1)
 230         elif isinstance(key, slice):
 231             assert key.step is None or key.step == 1
 232             assert key.start < key.stop
 233             assert key.start >= 0
 234             assert key.stop <= self.bits
 235
 236             stop = self.bits - key.start
 237             start = self.bits - key.stop
 238
 239             bits = stop - start
 240             #print ("__getitem__ slice num bits", bits)
 241             mask = (1 << bits) - 1
 242             value = (self.value >> start) & mask
 243             return SelectableInt(value, bits)
 244
 245     def __setitem__(self, key, value):
 246         if isinstance(key, SelectableInt):
 247             key = key.value
 248         if isinstance(key, int):
 249             assert key < self.bits
 250             assert key >= 0
 251             key = self.bits - (key + 1)
 252             if isinstance(value, SelectableInt):
 253                 assert value.bits == 1
 254                 value = value.value
 255
 256             value = value << key
 257             mask = 1 << key
 258             self.value = (self.value & ~mask) | (value & mask)
 259         elif isinstance(key, slice):
 260             assert key.step is None or key.step == 1
 261             assert key.start < key.stop
 262             assert key.start >= 0
 263             assert key.stop <= self.bits
 264
 265             stop = self.bits - key.start
 266             start = self.bits - key.stop
 267
 268             bits = stop - start
 269             #print ("__setitem__ slice num bits", bits)
 270             if isinstance(value, SelectableInt):
 271                 assert value.bits == bits, "%d into %d" % (value.bits, bits)
 272                 value = value.value
 273             mask = ((1 << bits) - 1) << start
 274             value = value << start
 275             self.value = (self.value & ~mask) | (value & mask)
 276
 277     def __ge__(self, other):
 278         if isinstance(other, FieldSelectableInt):
 279             other = other.get_range()
 280         if isinstance(other, SelectableInt):
 281             other = check_extsign(self, other)
 282             assert other.bits == self.bits
 283             other = other.value
 284         if isinstance(other, int):
 285             return onebit(self.value >= other.value)
 286         assert False
 287
 288     def __le__(self, other):
 289         if isinstance(other, FieldSelectableInt):
 290             other = other.get_range()
 291         if isinstance(other, SelectableInt):
 292             other = check_extsign(self, other)
 293             assert other.bits == self.bits
 294             other = other.value
 295         if isinstance(other, int):
 296             return onebit(self.value <= other)
 297         assert False
 298
 299     def __gt__(self, other):
 300         if isinstance(other, FieldSelectableInt):
 301             other = other.get_range()
 302         if isinstance(other, SelectableInt):
 303             other = check_extsign(self, other)
 304             assert other.bits == self.bits
 305             other = other.value
 306         if isinstance(other, int):
 307             return onebit(self.value > other)
 308         assert False
 309
 310     def __lt__(self, other):
 311         if isinstance(other, FieldSelectableInt):
 312             other = other.get_range()
 313         if isinstance(other, SelectableInt):
 314             other = check_extsign(self, other)
 315             assert other.bits == self.bits
 316             other = other.value
 317         if isinstance(other, int):
 318             return onebit(self.value < other)
 319         assert False
 320
 321     def __eq__(self, other):
 322         print ("__eq__", self, other)
 323         if isinstance(other, FieldSelectableInt):
 324             other = other.get_range()
 325         if isinstance(other, SelectableInt):
 326             other = check_extsign(self, other)
 327             assert other.bits == self.bits
 328             other = other.value
 329         if isinstance(other, int):
 330             return onebit(other == self.value)
 331         assert False
 332
 333     def narrow(self, bits):
 334         assert bits <= self.bits
 335         return SelectableInt(self.value, bits)
 336
 337     def __bool__(self):
 338         return self.value != 0
 339
 340     def __repr__(self):
 341         return "SelectableInt(value=0x{:x}, bits={})".format(self.value,
 342                                                            self.bits)
 343
 344     def __len__(self):
 345         return self.bits
 346
 347     def asint(self):
 348         return self.value
 349
 350
 351 def onebit(bit):
 352     return SelectableInt(1 if bit else 0, 1)
 353
 354 def selectltu(lhs, rhs):
 355     """ less-than (unsigned)
 356     """
 357     if isinstance(rhs, SelectableInt):
 358         rhs = rhs.value
 359     return onebit(lhs.value < rhs)
 360
 361 def selectgtu(lhs, rhs):
 362     """ greater-than (unsigned)
 363     """
 364     if isinstance(rhs, SelectableInt):
 365         rhs = rhs.value
 366     return onebit(lhs.value > rhs)
 367
 368
 369 # XXX this probably isn't needed...
 370 def selectassign(lhs, idx, rhs):
 371     if isinstance(idx, tuple):
 372         if len(idx) == 2:
 373             lower, upper = idx
 374             step = None
 375         else:
 376             lower, upper, step = idx
 377         toidx = range(lower, upper, step)
 378         fromidx = range(0, upper-lower, step) # XXX eurgh...
 379     else:
 380         toidx = [idx]
 381         fromidx = [0]
 382     for t, f in zip(toidx, fromidx):
 383         lhs[t] = rhs[f]
 384
 385
 386 def selectconcat(*args, repeat=1):
 387     if repeat != 1 and len(args) == 1 and isinstance(args[0], int):
 388         args = [SelectableInt(args[0], 1)]
 389     if repeat != 1: # multiplies the incoming arguments
 390         tmp = []
 391         for i in range(repeat):
 392             tmp += args
 393         args = tmp
 394     res = copy(args[0])
 395     for i in args[1:]:
 396         if isinstance(i, FieldSelectableInt):
 397             i = i.si
 398         assert isinstance(i, SelectableInt), "can only concat SIs, sorry"
 399         res.bits += i.bits
 400         res.value = (res.value << i.bits) | i.value
 401     print ("concat", repeat, res)
 402     return res
 403
 404
 405 class SelectableIntTestCase(unittest.TestCase):
 406     def test_arith(self):
 407         a = SelectableInt(5, 8)
 408         b = SelectableInt(9, 8)
 409         c = a + b
 410         d = a - b
 411         e = a * b
 412         f = -a
 413         self.assertEqual(c.value, a.value + b.value)
 414         self.assertEqual(d.value, (a.value - b.value) & 0xFF)
 415         self.assertEqual(e.value, (a.value * b.value) & 0xFF)
 416         self.assertEqual(f.value, (-a.value) & 0xFF)
 417         self.assertEqual(c.bits, a.bits)
 418         self.assertEqual(d.bits, a.bits)
 419         self.assertEqual(e.bits, a.bits)
 420
 421     def test_logic(self):
 422         a = SelectableInt(0x0F, 8)
 423         b = SelectableInt(0xA5, 8)
 424         c = a & b
 425         d = a | b
 426         e = a ^ b
 427         f = ~a
 428         self.assertEqual(c.value, a.value & b.value)
 429         self.assertEqual(d.value, a.value | b.value)
 430         self.assertEqual(e.value, a.value ^ b.value)
 431         self.assertEqual(f.value, 0xF0)
 432
 433     def test_get(self):
 434         a = SelectableInt(0xa2, 8)
 435         # These should be big endian
 436         self.assertEqual(a[7], 0)
 437         self.assertEqual(a[0:4], 10)
 438         self.assertEqual(a[4:8], 2)
 439
 440     def test_set(self):
 441         a = SelectableInt(0x5, 8)
 442         a[7] = SelectableInt(0, 1)
 443         self.assertEqual(a, 4)
 444         a[4:8] = 9
 445         self.assertEqual(a, 9)
 446         a[0:4] = 3
 447         self.assertEqual(a, 0x39)
 448         a[0:4] = a[4:8]
 449         self.assertEqual(a, 0x99)
 450
 451     def test_concat(self):
 452         a = SelectableInt(0x1, 1)
 453         c = selectconcat(a, repeat=8)
 454         self.assertEqual(c, 0xff)
 455         self.assertEqual(c.bits, 8)
 456         a = SelectableInt(0x0, 1)
 457         c = selectconcat(a, repeat=8)
 458         self.assertEqual(c, 0x00)
 459         self.assertEqual(c.bits, 8)
 460
 461     def test_repr(self):
 462         for i in range(65536):
 463             a = SelectableInt(i, 16)
 464             b = eval(repr(a))
 465             self.assertEqual(a, b)
 466
 467     def test_cmp(self):
 468         a = SelectableInt(10, bits=8)
 469         b = SelectableInt(5, bits=8)
 470         self.assertTrue(a > b)
 471         self.assertFalse(a < b)
 472         self.assertTrue(a != b)
 473         self.assertFalse(a == b)
 474
 475     def test_unsigned(self):
 476         a = SelectableInt(0x80, bits=8)
 477         b = SelectableInt(0x7f, bits=8)
 478         self.assertTrue(a > b)
 479         self.assertFalse(a < b)
 480         self.assertTrue(a != b)
 481         self.assertFalse(a == b)
 482
 483 if __name__ == "__main__":
 484     unittest.main()