src/soc/decoder/isa/caller.py

   1 from functools import wraps
   2 from soc.decoder.orderedset import OrderedSet
   3 from soc.decoder.selectable_int import (FieldSelectableInt, SelectableInt,
   4                                         selectconcat)
   5 from soc.decoder.power_enums import spr_dict, XER_bits
   6 from soc.decoder.helpers import exts
   7 from collections import namedtuple
   8 import math
   9
  10 instruction_info = namedtuple('instruction_info',
  11                               'func read_regs uninit_regs write_regs ' + \
  12                               'special_regs op_fields form asmregs')
  13
  14 special_sprs = {
  15     'LR': 8,
  16     'CTR': 9,
  17     'TAR': 815,
  18     'XER': 1,
  19     'VRSAVE': 256}
  20
  21
  22 def create_args(reglist, extra=None):
  23     args = OrderedSet()
  24     for reg in reglist:
  25         args.add(reg)
  26     args = list(args)
  27     if extra:
  28         args = [extra] + args
  29     return args
  30
  31
  32 class Mem:
  33
  34     def __init__(self, bytes_per_word=8, initial_mem=None):
  35         self.mem = {}
  36         self.bytes_per_word = bytes_per_word
  37         self.word_log2 = math.ceil(math.log2(bytes_per_word))
  38         if not initial_mem:
  39             return
  40         print ("Sim-Mem", initial_mem, self.bytes_per_word)
  41         for addr, (val, width) in initial_mem.items():
  42             self.st(addr, val, width)
  43
  44     def _get_shifter_mask(self, wid, remainder):
  45         shifter = ((self.bytes_per_word - wid) - remainder) * \
  46             8  # bits per byte
  47         mask = (1 << (wid * 8)) - 1
  48         print ("width,rem,shift,mask", wid, remainder, hex(shifter), hex(mask))
  49         return shifter, mask
  50
  51     # TODO: Implement ld/st of lesser width
  52     def ld(self, address, width=8):
  53         print("ld from addr 0x{:x} width {:d}".format(address, width))
  54         remainder = address & (self.bytes_per_word - 1)
  55         address = address >> self.word_log2
  56         assert remainder & (width - 1) == 0, "Unaligned access unsupported!"
  57         if address in self.mem:
  58             val = self.mem[address]
  59         else:
  60             val = 0
  61         print("mem @ 0x{:x} rem {:d} : 0x{:x}".format(address, remainder, val))
  62
  63         if width != self.bytes_per_word:
  64             shifter, mask = self._get_shifter_mask(width, remainder)
  65             print ("masking", hex(val), hex(mask<<shifter), shifter)
  66             val = val & (mask << shifter)
  67             val >>= shifter
  68         print("Read 0x{:x} from addr 0x{:x}".format(val, address))
  69         return val
  70
  71     def st(self, addr, v, width=8):
  72         remainder = addr & (self.bytes_per_word - 1)
  73         addr = addr >> self.word_log2
  74         print("Writing 0x{:x} to addr 0x{:x}/{:x}".format(v, addr, remainder))
  75         assert remainder & (width - 1) == 0, "Unaligned access unsupported!"
  76         if width != self.bytes_per_word:
  77             if addr in self.mem:
  78                 val = self.mem[addr]
  79             else:
  80                 val = 0
  81             shifter, mask = self._get_shifter_mask(width, remainder)
  82             val &= ~(mask << shifter)
  83             val |= v << shifter
  84             self.mem[addr] = val
  85         else:
  86             self.mem[addr] = v
  87         print("mem @ 0x{:x}: 0x{:x}".format(addr, self.mem[addr]))
  88
  89     def __call__(self, addr, sz):
  90         val = self.ld(addr.value, sz)
  91         print ("memread", addr, sz, val)
  92         return SelectableInt(val, sz*8)
  93
  94     def memassign(self, addr, sz, val):
  95         print ("memassign", addr, sz, val)
  96         self.st(addr.value, val.value, sz)
  97
  98
  99 class GPR(dict):
 100     def __init__(self, decoder, regfile):
 101         dict.__init__(self)
 102         self.sd = decoder
 103         for i in range(32):
 104             self[i] = SelectableInt(regfile[i], 64)
 105
 106     def __call__(self, ridx):
 107         return self[ridx]
 108
 109     def set_form(self, form):
 110         self.form = form
 111
 112     def getz(self, rnum):
 113         #rnum = rnum.value # only SelectableInt allowed
 114         print("GPR getzero", rnum)
 115         if rnum == 0:
 116             return SelectableInt(0, 64)
 117         return self[rnum]
 118
 119     def _get_regnum(self, attr):
 120         getform = self.sd.sigforms[self.form]
 121         rnum = getattr(getform, attr)
 122         return rnum
 123
 124     def ___getitem__(self, attr):
 125         print("GPR getitem", attr)
 126         rnum = self._get_regnum(attr)
 127         return self.regfile[rnum]
 128
 129     def dump(self):
 130         for i in range(0, len(self), 8):
 131             s = []
 132             for j in range(8):
 133                 s.append("%08x" % self[i+j].value)
 134             s = ' '.join(s)
 135             print("reg", "%2d" % i, s)
 136
 137 class PC:
 138     def __init__(self, pc_init=0):
 139         self.CIA = SelectableInt(pc_init, 64)
 140         self.NIA = self.CIA + SelectableInt(4, 64)
 141
 142     def update(self, namespace):
 143         self.CIA = namespace['NIA'].narrow(64)
 144         self.NIA = self.CIA + SelectableInt(4, 64)
 145         namespace['CIA'] = self.CIA
 146         namespace['NIA'] = self.NIA
 147
 148
 149 class SPR(dict):
 150     def __init__(self, dec2, initial_sprs={}):
 151         self.sd = dec2
 152         dict.__init__(self)
 153         self.update(initial_sprs)
 154
 155     def __getitem__(self, key):
 156         # if key in special_sprs get the special spr, otherwise return key
 157         if isinstance(key, SelectableInt):
 158             key = key.value
 159         key = special_sprs.get(key, key)
 160         if key in self:
 161             return dict.__getitem__(self, key)
 162         else:
 163             info = spr_dict[key]
 164             dict.__setitem__(self, key, SelectableInt(0, info.length))
 165             return dict.__getitem__(self, key)
 166
 167     def __setitem__(self, key, value):
 168         if isinstance(key, SelectableInt):
 169             key = key.value
 170         key = special_sprs.get(key, key)
 171         dict.__setitem__(self, key, value)
 172
 173     def __call__(self, ridx):
 174         return self[ridx]
 175
 176
 177
 178 class ISACaller:
 179     # decoder2 - an instance of power_decoder2
 180     # regfile - a list of initial values for the registers
 181     def __init__(self, decoder2, regfile, initial_sprs=None, initial_cr=0,
 182                        initial_mem=None, initial_msr=0):
 183         if initial_sprs is None:
 184             initial_sprs = {}
 185         if initial_mem is None:
 186             initial_mem = {}
 187         self.gpr = GPR(decoder2, regfile)
 188         self.mem = Mem(initial_mem=initial_mem)
 189         self.pc = PC()
 190         self.spr = SPR(decoder2, initial_sprs)
 191         self.msr = SelectableInt(initial_msr, 64) # underlying reg
 192         # TODO, needed here:
 193         # FPR (same as GPR except for FP nums)
 194         # 4.2.2 p124 FPSCR (definitely "separate" - not in SPR)
 195         #            note that mffs, mcrfs, mtfsf "manage" this FPSCR
 196         # 2.3.1 CR (and sub-fields CR0..CR6 - CR0 SO comes from XER.SO)
 197         #         note that mfocrf, mfcr, mtcr, mtocrf, mcrxrx "manage" CRs
 198         #         -- Done
 199         # 2.3.2 LR   (actually SPR #8) -- Done
 200         # 2.3.3 CTR  (actually SPR #9) -- Done
 201         # 2.3.4 TAR  (actually SPR #815)
 202         # 3.2.2 p45 XER  (actually SPR #1) -- Done
 203         # 3.2.3 p46 p232 VRSAVE (actually SPR #256)
 204
 205         # create CR then allow portions of it to be "selectable" (below)
 206         self._cr = SelectableInt(initial_cr, 64) # underlying reg
 207         self.cr = FieldSelectableInt(self._cr, list(range(32,64)))
 208
 209         # "undefined", just set to variable-bit-width int (use exts "max")
 210         self.undefined = SelectableInt(0, 256) # TODO, not hard-code 256!
 211
 212         self.namespace = {'GPR': self.gpr,
 213                           'MEM': self.mem,
 214                           'SPR': self.spr,
 215                           'memassign': self.memassign,
 216                           'NIA': self.pc.NIA,
 217                           'CIA': self.pc.CIA,
 218                           'CR': self.cr,
 219                           'MSR': self.msr,
 220                           'undefined': self.undefined,
 221                           'mode_is_64bit': True,
 222                           'SO': XER_bits['SO']
 223                           }
 224
 225         # field-selectable versions of Condition Register TODO check bitranges?
 226         self.crl = []
 227         for i in range(8):
 228             bits = tuple(range(i*4, (i+1)*4))# errr... maybe?
 229             _cr = FieldSelectableInt(self.cr, bits)
 230             self.crl.append(_cr)
 231             self.namespace["CR%d" % i] = _cr
 232
 233         self.decoder = decoder2.dec
 234         self.dec2 = decoder2
 235
 236     def TRAP(self, trap_addr=0x700):
 237         print ("TRAP: TODO")
 238         # store CIA(+4?) in SRR0, set NIA to 0x700
 239         # store MSR in SRR1, set MSR to um errr something, have to check spec
 240
 241     def memassign(self, ea, sz, val):
 242         self.mem.memassign(ea, sz, val)
 243
 244     def prep_namespace(self, formname, op_fields):
 245         # TODO: get field names from form in decoder*1* (not decoder2)
 246         # decoder2 is hand-created, and decoder1.sigform is auto-generated
 247         # from spec
 248         # then "yield" fields only from op_fields rather than hard-coded
 249         # list, here.
 250         fields = self.decoder.sigforms[formname]
 251         for name in op_fields:
 252             if name == 'spr':
 253                 sig = getattr(fields, name.upper())
 254             else:
 255                 sig = getattr(fields, name)
 256             val = yield sig
 257             if name in ['BF', 'BFA']:
 258                 self.namespace[name] = val
 259             else:
 260                 self.namespace[name] = SelectableInt(val, sig.width)
 261
 262         self.namespace['XER'] = self.spr['XER']
 263         self.namespace['CA'] = self.spr['XER'][XER_bits['CA']].value
 264         self.namespace['CA32'] = self.spr['XER'][XER_bits['CA32']].value
 265
 266     def handle_carry_(self, inputs, outputs, already_done):
 267         inv_a = yield self.dec2.e.invert_a
 268         if inv_a:
 269             inputs[0] = ~inputs[0]
 270
 271         imm_ok = yield self.dec2.e.imm_data.ok
 272         if imm_ok:
 273             imm = yield self.dec2.e.imm_data.data
 274             inputs.append(SelectableInt(imm, 64))
 275         assert len(outputs) >= 1
 276         output = outputs[0]
 277         gts = [(x > output) for x in inputs]
 278         print(gts)
 279         cy = 1 if any(gts) else 0
 280         if not (1 & already_done):
 281             self.spr['XER'][XER_bits['CA']] = cy
 282
 283         print ("inputs", inputs)
 284         # 32 bit carry
 285         gts = [(x[32:64] > output[32:64]) == SelectableInt(1, 1)
 286                for x in inputs]
 287         cy32 = 1 if any(gts) else 0
 288         if not (2 & already_done):
 289             self.spr['XER'][XER_bits['CA32']] = cy32
 290
 291     def handle_overflow(self, inputs, outputs):
 292         inv_a = yield self.dec2.e.invert_a
 293         if inv_a:
 294             inputs[0] = ~inputs[0]
 295
 296         imm_ok = yield self.dec2.e.imm_data.ok
 297         if imm_ok:
 298             imm = yield self.dec2.e.imm_data.data
 299             inputs.append(SelectableInt(imm, 64))
 300         assert len(outputs) >= 1
 301         if len(inputs) >= 2:
 302             output = outputs[0]
 303
 304             # OV (64-bit)
 305             input_sgn = [exts(x.value, x.bits) < 0 for x in inputs]
 306             output_sgn = exts(output.value, output.bits) < 0
 307             ov = 1 if input_sgn[0] == input_sgn[1] and \
 308                 output_sgn != input_sgn[0] else 0
 309
 310             # OV (32-bit)
 311             input32_sgn = [exts(x.value, 32) < 0 for x in inputs]
 312             output32_sgn = exts(output.value, 32) < 0
 313             ov32 = 1 if input32_sgn[0] == input32_sgn[1] and \
 314                 output32_sgn != input32_sgn[0] else 0
 315
 316             self.spr['XER'][XER_bits['OV']] = ov
 317             self.spr['XER'][XER_bits['OV32']] = ov32
 318             so = self.spr['XER'][XER_bits['SO']]
 319             so = so | ov
 320             self.spr['XER'][XER_bits['SO']] = so
 321
 322
 323
 324     def handle_comparison(self, outputs):
 325         out = outputs[0]
 326         out = exts(out.value, out.bits)
 327         zero = SelectableInt(out == 0, 1)
 328         positive = SelectableInt(out > 0, 1)
 329         negative = SelectableInt(out < 0, 1)
 330         SO = self.spr['XER'][XER_bits['SO']]
 331         cr_field = selectconcat(negative, positive, zero, SO)
 332         self.crl[0].eq(cr_field)
 333
 334     def set_pc(self, pc_val):
 335         self.namespace['NIA'] = SelectableInt(pc_val, 64)
 336         self.pc.update(self.namespace)
 337
 338
 339     def call(self, name):
 340         # TODO, asmregs is from the spec, e.g. add RT,RA,RB
 341         # see http://bugs.libre-riscv.org/show_bug.cgi?id=282
 342         info = self.instrs[name]
 343         yield from self.prep_namespace(info.form, info.op_fields)
 344
 345         # preserve order of register names
 346         input_names = create_args(list(info.read_regs) + list(info.uninit_regs))
 347         print(input_names)
 348
 349         # main registers (RT, RA ...)
 350         inputs = []
 351         for name in input_names:
 352             regnum = yield getattr(self.decoder, name)
 353             regname = "_" + name
 354             self.namespace[regname] = regnum
 355             print('reading reg %d' % regnum)
 356             inputs.append(self.gpr(regnum))
 357
 358         # "special" registers
 359         for special in info.special_regs:
 360             if special in special_sprs:
 361                 inputs.append(self.spr[special])
 362             else:
 363                 inputs.append(self.namespace[special])
 364
 365         print(inputs)
 366         results = info.func(self, *inputs)
 367         print(results)
 368
 369         # detect if CA/CA32 already in outputs (sra*, basically)
 370         already_done = 0
 371         if info.write_regs:
 372             output_names = create_args(info.write_regs)
 373             for name in output_names:
 374                 if name == 'CA':
 375                     already_done |= 1
 376                 if name == 'CA32':
 377                     already_done |= 2
 378
 379         print ("carry already done?", bin(already_done))
 380         carry_en = yield self.dec2.e.output_carry
 381         if carry_en:
 382             yield from self.handle_carry_(inputs, results, already_done)
 383         ov_en = yield self.dec2.e.oe
 384         if ov_en:
 385             yield from self.handle_overflow(inputs, results)
 386         rc_en = yield self.dec2.e.rc.data
 387         if rc_en:
 388             self.handle_comparison(results)
 389
 390         # any modified return results?
 391         if info.write_regs:
 392             for name, output in zip(output_names, results):
 393                 if isinstance(output, int):
 394                     output = SelectableInt(output, 256)
 395                 if name in ['CA', 'CA32']:
 396                     if carry_en:
 397                         print ("writing %s to XER" % name, output)
 398                         self.spr['XER'][XER_bits[name]] = output.value
 399                     else:
 400                         print ("NOT writing %s to XER" % name, output)
 401                 elif name in info.special_regs:
 402                     print('writing special %s' % name, output, special_sprs)
 403                     if name in special_sprs:
 404                         self.spr[name] = output
 405                     else:
 406                         self.namespace[name].eq(output)
 407                 else:
 408                     regnum = yield getattr(self.decoder, name)
 409                     print('writing reg %d %s' % (regnum, str(output)))
 410                     if output.bits > 64:
 411                         output = SelectableInt(output.value, 64)
 412                     self.gpr[regnum] = output
 413
 414         # update program counter
 415         self.pc.update(self.namespace)
 416
 417
 418 def inject():
 419     """Decorator factory.
 420
 421     this decorator will "inject" variables into the function's namespace,
 422     from the *dictionary* in self.namespace.  it therefore becomes possible
 423     to make it look like a whole stack of variables which would otherwise
 424     need "self." inserted in front of them (*and* for those variables to be
 425     added to the instance) "appear" in the function.
 426
 427     "self.namespace['SI']" for example becomes accessible as just "SI" but
 428     *only* inside the function, when decorated.
 429     """
 430     def variable_injector(func):
 431         @wraps(func)
 432         def decorator(*args, **kwargs):
 433             try:
 434                 func_globals = func.__globals__  # Python 2.6+
 435             except AttributeError:
 436                 func_globals = func.func_globals  # Earlier versions.
 437
 438             context = args[0].namespace # variables to be injected
 439             saved_values = func_globals.copy()  # Shallow copy of dict.
 440             func_globals.update(context)
 441             result = func(*args, **kwargs)
 442             args[0].namespace = func_globals
 443             #exec (func.__code__, func_globals)
 444
 445             #finally:
 446             #    func_globals = saved_values  # Undo changes.
 447
 448             return result
 449
 450         return decorator
 451
 452     return variable_injector
 453