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