src/soc/decoder/isa/caller.py

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