src/soc/decoder/pseudo/pywriter.py

   1 # python code-writer for OpenPOWER ISA pseudo-code parsing
   2
   3 import os
   4 import sys
   5 import shutil
   6 import subprocess
   7 from soc.decoder.pseudo.pagereader import ISA
   8 from soc.decoder.power_pseudo import convert_to_python
   9 from soc.decoder.orderedset import OrderedSet
  10 from soc.decoder.isa.caller import create_args
  11
  12 def get_isasrc_dir():
  13     fdir = os.path.abspath(os.path.dirname(__file__))
  14     fdir = os.path.split(fdir)[0]
  15     return os.path.join(fdir, "isa")
  16
  17
  18 header = """\
  19 # auto-generated by pywriter.py, do not edit or commit
  20
  21 from soc.decoder.isa.caller import inject, instruction_info
  22 from soc.decoder.helpers import (EXTS, EXTS64, EXTZ64, ROTL64, ROTL32, MASK,
  23                                  ne, eq, gt, ge, lt, le, length,
  24                                  trunc_div, trunc_rem)
  25 from soc.decoder.selectable_int import SelectableInt
  26 from soc.decoder.selectable_int import selectconcat as concat
  27 from soc.decoder.orderedset import OrderedSet
  28
  29 class %s:
  30
  31 """
  32
  33 iinfo_template = """instruction_info(func=%s,
  34                 read_regs=%s,
  35                 uninit_regs=%s, write_regs=%s,
  36                 special_regs=%s, op_fields=%s,
  37                 form='%s',
  38                 asmregs=%s)"""
  39
  40 class PyISAWriter(ISA):
  41     def __init__(self):
  42         ISA.__init__(self)
  43         self.pages_written = []
  44
  45     def write_pysource(self, pagename):
  46         self.pages_written.append(pagename)
  47         instrs = isa.page[pagename]
  48         isadir = get_isasrc_dir()
  49         fname = os.path.join(isadir, "%s.py" % pagename)
  50         with open(fname, "w") as f:
  51             iinf = ''
  52             f.write(header % pagename) # write out header
  53             # go through all instructions
  54             for page in instrs:
  55                 d = self.instr[page]
  56                 print ("page", pagename, page, fname, d.opcode)
  57                 pcode = '\n'.join(d.pcode) + '\n'
  58                 print (pcode)
  59                 incl_carry = pagename == 'fixedshift'
  60                 pycode, rused = convert_to_python(pcode, d.form, incl_carry)
  61                 # create list of arguments to call
  62                 regs = list(rused['read_regs']) + list(rused['uninit_regs'])
  63                 regs += list(rused['special_regs'])
  64                 args = ', '.join(create_args(regs, 'self'))
  65                 # create list of arguments to return
  66                 retargs = ', '.join(create_args(rused['write_regs']))
  67                 # write out function.  pre-pend "op_" because some instrs are
  68                 # also python keywords (cmp).  also replace "." with "_"
  69                 op_fname ="op_%s" % page.replace(".", "_")
  70                 f.write("    @inject()\n")
  71                 f.write("    def %s(%s):\n" % (op_fname, args))
  72                 if 'NIA' in pycode:  # HACK - TODO fix
  73                     f.write("        global NIA\n")
  74                 pycode = pycode.split("\n")
  75                 pycode = '\n'.join(map(lambda x: "        %s" % x, pycode))
  76                 pycode = pycode.rstrip()
  77                 f.write(pycode + '\n')
  78                 if retargs:
  79                     f.write("        return (%s,)\n\n" % retargs)
  80                 else:
  81                     f.write("\n")
  82                 # accumulate the instruction info
  83                 ops = repr(rused['op_fields'])
  84                 iinfo = iinfo_template % (op_fname, rused['read_regs'],
  85                                           rused['uninit_regs'],
  86                                           rused['write_regs'],
  87                                           rused['special_regs'],
  88                                           ops, d.form, d.regs)
  89                 iinf += "    %s_instrs['%s'] = %s\n" % (pagename, page, iinfo)
  90             # write out initialisation of info, for ISACaller to use
  91             f.write("    %s_instrs = {}\n" % pagename)
  92             f.write(iinf)
  93
  94     def patch_if_needed(self, source):
  95         isadir = get_isasrc_dir()
  96         fname = os.path.join(isadir, "%s.py" % source)
  97         patchname = os.path.join(isadir, "%s.patch" % source)
  98
  99         try:
 100             with open(patchname, 'r') as patch:
 101                 newfname = fname + '.orig'
 102                 shutil.copyfile(fname, newfname)
 103                 subprocess.check_call(['patch', fname],
 104                                       stdin=patch)
 105         except:
 106             pass
 107
 108
 109     def write_isa_class(self):
 110         isadir = get_isasrc_dir()
 111         fname = os.path.join(isadir, "all.py")
 112
 113         with open(fname, "w") as f:
 114             f.write('# auto-generated by pywriter.py: do not edit or commit\n')
 115             f.write('from soc.decoder.isa.caller import ISACaller\n')
 116             for page in self.pages_written:
 117                 f.write('from soc.decoder.isa.%s import %s\n' % (page, page))
 118             f.write('\n')
 119
 120             classes = ', '.join(['ISACaller'] + self.pages_written)
 121             f.write('class ISA(%s):\n' % classes)
 122             f.write('    def __init__(self, *args, **kwargs):\n')
 123             f.write('        super().__init__(*args, **kwargs)\n')
 124             f.write('        self.instrs = {\n')
 125             for page in self.pages_written:
 126                 f.write('            **self.%s_instrs,\n' % page)
 127             f.write('        }\n')
 128
 129
 130 if __name__ == '__main__':
 131     isa = PyISAWriter()
 132     if len(sys.argv) == 1: # quick way to do it
 133         print (dir(isa))
 134         sources = isa.page.keys()
 135     else:
 136         sources = sys.argv[1:]
 137     for source in sources:
 138         isa.write_pysource(source)
 139         isa.patch_if_needed(source)
 140     isa.write_isa_class()