src/openpower/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 openpower.decoder.pseudo.pagereader import ISA
   8 from openpower.decoder.power_pseudo import convert_to_python
   9 from openpower.decoder.orderedset import OrderedSet
  10 from openpower.decoder.isa.caller import create_args
  11
  12
  13 def get_isasrc_dir():
  14     fdir = os.path.abspath(os.path.dirname(__file__))
  15     fdir = os.path.split(fdir)[0]
  16     return os.path.join(fdir, "isa")
  17
  18
  19 header = """\
  20 # auto-generated by pywriter.py, do not edit or commit
  21
  22 from openpower.decoder.isa.caller import inject, instruction_info
  23 from openpower.decoder.helpers import (EXTS, EXTS64, EXTZ64, ROTL64, ROTL32,
  24                                  MASK, MASK32,
  25                                  ne, eq, gt, ge, lt, le, ltu, gtu, length,
  26                                  trunc_divs, trunc_rems, MULS, DIVS, MODS,
  27                                  EXTS128, undefined,
  28                                  bitrev, SHL64,
  29                                 )
  30 from openpower.decoder.selectable_int import SelectableInt
  31 from openpower.decoder.selectable_int import selectconcat as concat
  32 from openpower.decoder.orderedset import OrderedSet
  33
  34 """
  35
  36 fpheader = """
  37 from openpower.decoder.helpers import (
  38                                  SINGLE,
  39                                  FPADD32, FPSUB32, FPMUL32, FPDIV32,
  40                                  FPADD64, FPSUB64, FPMUL64, FPDIV64,
  41                                  FPMULADD32,
  42                                  FPSIN32, FPCOS32,
  43                                 )
  44 from openpower.decoder.isafunctions.fpfromint import INT2FP
  45 from openpower.decoder.isafunctions.double2single import DOUBLE
  46 from openpower.decoder.isafunctions.bcd import BCD_TO_DPD, DPD_TO_BCD
  47
  48
  49 """
  50
  51 iinfo_template = """instruction_info(func=%s,
  52                 read_regs=%s,
  53                 uninit_regs=%s, write_regs=%s,
  54                 special_regs=%s, op_fields=%s,
  55                 form='%s',
  56                 asmregs=%s)"""
  57
  58
  59 class PyISAWriter(ISA):
  60     def __init__(self):
  61         ISA.__init__(self)
  62         self.pages_written = []
  63
  64     def write_pysource(self, pagename):
  65         self.pages_written.append(pagename)
  66         instrs = self.page[pagename]
  67         isadir = get_isasrc_dir()
  68         fname = os.path.join(isadir, "%s.py" % pagename)
  69         with open(fname, "w") as f:
  70             iinf = ''
  71             # write headers: FP gets extra imports
  72             f.write(header)  # write out header
  73             if (pagename.startswith("fp") or
  74                 pagename.startswith("svfp")):
  75                 f.write(fpheader)
  76             f.write("class %s:\n" % pagename)
  77
  78             # go through all instructions
  79             for page in instrs:
  80                 d = self.instr[page]
  81                 print("page", pagename, page, fname, d.opcode)
  82                 pcode = '\n'.join(d.pcode) + '\n'
  83                 print(pcode)
  84                 incl_carry = pagename == 'fixedshift'
  85                 pycode, rused = convert_to_python(pcode, d.form, incl_carry)
  86                 # create list of arguments to call
  87                 regs = list(rused['read_regs']) + list(rused['uninit_regs'])
  88                 regs += list(rused['special_regs'])
  89                 args = ', '.join(create_args(regs, 'self'))
  90                 # create list of arguments to return
  91                 retargs = ', '.join(create_args(rused['write_regs']))
  92                 # write out function.  pre-pend "op_" because some instrs are
  93                 # also python keywords (cmp).  also replace "." with "_"
  94                 op_fname = "op_%s" % page.replace(".", "_")
  95                 f.write("    @inject()\n")
  96                 f.write("    def %s(%s):\n" % (op_fname, args))
  97                 if 'NIA' in pycode:  # HACK - TODO fix
  98                     f.write("        global NIA\n")
  99                 pycode = pycode.split("\n")
 100                 pycode = '\n'.join(map(lambda x: "        %s" % x, pycode))
 101                 pycode = pycode.rstrip()
 102                 f.write(pycode + '\n')
 103                 if retargs:
 104                     f.write("        return (%s,)\n\n" % retargs)
 105                 else:
 106                     f.write("\n")
 107                 # accumulate the instruction info
 108                 ops = repr(rused['op_fields'])
 109                 iinfo = iinfo_template % (op_fname, rused['read_regs'],
 110                                           rused['uninit_regs'],
 111                                           rused['write_regs'],
 112                                           rused['special_regs'],
 113                                           ops, d.form, d.regs)
 114                 iinf += "    %s_instrs['%s'] = %s\n" % (pagename, page, iinfo)
 115             # write out initialisation of info, for ISACaller to use
 116             f.write("    %s_instrs = {}\n" % pagename)
 117             f.write(iinf)
 118
 119     def patch_if_needed(self, source):
 120         isadir = get_isasrc_dir()
 121         fname = os.path.join(isadir, "%s.py" % source)
 122         patchname = os.path.join(isadir, "%s.patch" % source)
 123
 124         try:
 125             with open(patchname, 'r') as patch:
 126                 newfname = fname + '.orig'
 127                 shutil.copyfile(fname, newfname)
 128                 subprocess.check_call(['patch', fname],
 129                                       stdin=patch)
 130         except:
 131             pass
 132
 133     def write_isa_class(self):
 134         isadir = get_isasrc_dir()
 135         fname = os.path.join(isadir, "all.py")
 136
 137         with open(fname, "w") as f:
 138             f.write('# auto-generated by pywriter.py: do not edit or commit\n')
 139             f.write('from openpower.decoder.isa.caller import ISACaller\n')
 140             for page in self.pages_written:
 141                 f.write('from openpower.decoder.isa.%s ' \
 142                         'import %s\n' % (page, page))
 143             f.write('\n')
 144
 145             classes = ', '.join(['ISACaller'] + self.pages_written)
 146             f.write('class ISA(%s):\n' % classes)
 147             f.write('    def __init__(self, *args, **kwargs):\n')
 148             f.write('        super().__init__(*args, **kwargs)\n')
 149             f.write('        self.instrs = {\n')
 150             for page in self.pages_written:
 151                 f.write('            **self.%s_instrs,\n' % page)
 152             f.write('        }\n')
 153
 154
 155 def pywriter():
 156     isa = PyISAWriter()
 157     write_isa_class = True
 158     if len(sys.argv) == 1:  # quick way to do it
 159         print(dir(isa))
 160         sources = isa.page.keys()
 161     else:
 162         sources = sys.argv[1:]
 163         if sources[0] == "noall": # don't rewrite all.py
 164             write_isa_class = False
 165             sources.pop(0)
 166     print ("sources", write_isa_class, sources)
 167     for source in sources:
 168         isa.write_pysource(source)
 169         isa.patch_if_needed(source)
 170     if write_isa_class:
 171         isa.write_isa_class()
 172
 173 if __name__ == '__main__':
 174     pywriter()