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