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