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