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, get_isa_dir
   8 from openpower.decoder.power_pseudo import (convert_to_python,
   9                                             check_in_gitignore)
  10 from openpower.decoder.orderedset import OrderedSet
  11 from openpower.decoder.isa.caller import create_args, create_full_args
  12
  13
  14 def get_isasrc_dir():
  15     fdir = os.path.abspath(os.path.dirname(__file__))
  16     fdir = os.path.split(fdir)[0]
  17     return os.path.join(fdir, "isa")
  18
  19
  20 header = """\
  21 # auto-generated by pywriter.py, do not edit or commit
  22
  23 from openpower.decoder.isa.caller import inject, instruction_info
  24 from openpower.decoder.helpers import (
  25                                  ne, eq, gt, ge, lt, le, ltu, gtu, length,
  26                                  RANGE, copy_assign_rhs,
  27                                  ISACallerHelper,
  28                                 )
  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 from openpower.decoder.isafunctions.all import ISACallerFnHelper
  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
  45 """
  46
  47 iinfo_template = """instruction_info(func=%s,
  48                 read_regs=%s,
  49                 uninit_regs=%s, write_regs=%s,
  50                 special_regs=%s, op_fields=%s,
  51                 form='%s',
  52                 asmregs=%s)"""
  53
  54
  55 OLD_GENERATED_FILES_EXCEPTIONS = {
  56     "example_exception.py",
  57 }
  58
  59 class PyISAWriter(ISA):
  60     def __init__(self):
  61         ISA.__init__(self)
  62         self.pages_written = []
  63
  64     def check_for_old_generated_files(self, pagenames):
  65         isadir = get_isasrc_dir()
  66         found = []
  67         first_fname = None
  68         for pagename in sorted(pagenames):
  69             fbasename = pagename + ".py"
  70             if fbasename in OLD_GENERATED_FILES_EXCEPTIONS:
  71                 continue
  72             old_fname = os.path.join(isadir, fbasename)
  73             if os.path.exists(old_fname):
  74                 if first_fname is None:
  75                     first_fname = os.path.join(isadir, "generated", fbasename)
  76                 found.append(fbasename)
  77         for first_old_fname in found:
  78             found_str = " ".join(f"'{i}'" for i in found)
  79             lines = [
  80                 f"found likely old generated file: {first_old_fname!r}",
  81                 f"new location: {first_fname!r}",
  82                 ("please remove the old generated files to avoid committing "
  83                  "them or add to:"),
  84                 ("openpower.decoder.pseudo.pywriter."
  85                  "OLD_GENERATED_FILES_EXCEPTIONS"),
  86                 "commands to remove all likely old generated files:",
  87                 f"(cd {isadir}; rm -v {found_str})",
  88             ]
  89             raise ValueError(
  90                 "\n".join(lines)
  91             )
  92
  93     def write_pysource(self, pagename):
  94         self.pages_written.append(pagename)
  95         instrs = self.page[pagename]
  96         isadir = get_isasrc_dir()
  97         fname = os.path.join(isadir, "generated", pagename + ".py")
  98         check_in_gitignore(fname)
  99         with open(fname, "w") as f:
 100             iinf = ''
 101             # write headers: FP gets extra imports
 102             f.write(header)  # write out header
 103             if (pagename.startswith("fp") or
 104                 pagename.startswith("svfp")):
 105                 f.write(fpheader)
 106             f.write("class %s:\n" % pagename)
 107
 108             # go through all instructions
 109             for page in instrs:
 110                 d = self.instr[page]
 111                 print("page", pagename, page, fname, d.opcode)
 112                 pcode = '\n'.join(d.pcode) + '\n'
 113                 print(pcode)
 114                 incl_carry = pagename == 'fixedshift'
 115                 filename = os.path.join(get_isa_dir(), pagename + ".mdwn")
 116                 pycode, rused = convert_to_python(pcode, d.form, incl_carry,
 117                                                   filename=filename)
 118                 rused['uninit_regs'] |= d.extra_uninit_regs
 119                 # create list of arguments to call
 120                 args = ', '.join(create_full_args(
 121                     read_regs=rused['read_regs'],
 122                     special_regs=rused['special_regs'],
 123                     uninit_regs=rused['uninit_regs'],
 124                     write_regs=rused['write_regs'], extra='self'))
 125                 # create list of arguments to return
 126                 retargs = ', '.join(create_args(rused['write_regs']))
 127                 # write out function.  pre-pend "op_" because some instrs are
 128                 # also python keywords (cmp).  also replace "." with "_"
 129                 op_fname = "op_%s" % page.replace(".", "_")
 130                 f.write("    @inject()\n")
 131                 f.write("    def %s(%s):\n" % (op_fname, args))
 132                 # blech! this works in combination with ISACaller
 133                 # @inject decorator, which works by injecting
 134                 # global variables into the function namespace.
 135                 for blech in ['NIA', 'end_loop']:
 136                     if blech in pycode:  # HACK - TODO fix
 137                         f.write("        global %s\n" % blech)
 138                 pycode = pycode.split("\n")
 139                 pycode = '\n'.join(map(lambda x: "        %s" % x, pycode))
 140                 pycode = pycode.rstrip()
 141                 f.write(pycode + '\n')
 142                 if retargs:
 143                     f.write("        return (%s,)\n\n" % retargs)
 144                 else:
 145                     f.write("\n")
 146                 # accumulate the instruction info
 147                 ops = repr(rused['op_fields'])
 148                 iinfo = iinfo_template % (op_fname, rused['read_regs'],
 149                                           rused['uninit_regs'],
 150                                           rused['write_regs'],
 151                                           rused['special_regs'],
 152                                           ops, d.form, d.regs)
 153                 iinf += "    %s_instrs['%s'] = %s\n" % (pagename, page, iinfo)
 154             # write out initialisation of info, for ISACaller to use
 155             f.write("    %s_instrs = {}\n" % pagename)
 156             f.write(iinf)
 157
 158     def patch_if_needed(self, source):
 159         isadir = get_isasrc_dir()
 160         fname = os.path.join(isadir, "generated", "%s.py" % source)
 161         patchname = os.path.join(isadir, "%s.patch" % source)
 162
 163         try:
 164             with open(patchname, 'r') as patch:
 165                 newfname = fname + '.orig'
 166                 shutil.copyfile(fname, newfname)
 167                 subprocess.check_call(['patch', fname],
 168                                       stdin=patch)
 169         except:
 170             pass
 171
 172     def write_isa_class(self):
 173         isadir = get_isasrc_dir()
 174         fname = os.path.join(isadir, "all.py")
 175         check_in_gitignore(fname)
 176         with open(fname, "w") as f:
 177             f.write('# auto-generated by pywriter.py: do not edit or commit\n')
 178             f.write('from openpower.decoder.isa.caller import ISACaller\n')
 179             f.write('from openpower.decoder.helpers import ISACallerHelper\n')
 180             f.write('from openpower.decoder.isafunctions.all '
 181                     'import ISACallerFnHelper\n')
 182             for page in self.pages_written:
 183                 f.write('from openpower.decoder.isa.generated.%s '
 184                         'import %s\n' % (page, page))
 185             f.write('\n')
 186
 187             f.write('class ISAPages(%s):\n' % ", ".join(self.pages_written))
 188             f.write('    def __init__(self, *args, **kwargs):\n')
 189             f.write('        super().__init__(*args, **kwargs)\n')
 190             f.write('        self.instrs = {\n')
 191             for page in self.pages_written:
 192                 f.write('            **self.%s_instrs,\n' % page)
 193             f.write('        }\n')
 194             classes = ', '.join(['ISAPages', 'ISACaller', 'ISACallerFnHelper',
 195                                  'ISACallerHelper'])
 196             f.write('class ISA(%s): pass\n' % classes)
 197
 198
 199 def pywriter():
 200     isa = PyISAWriter()
 201     write_isa_class = True
 202     if len(sys.argv) == 1:  # quick way to do it
 203         print(dir(isa))
 204         sources = isa.page.keys()
 205     else:
 206         sources = sys.argv[1:]
 207         if sources[0] == "noall": # don't rewrite all.py
 208             write_isa_class = False
 209             sources.pop(0)
 210     print("sources", write_isa_class, sources)
 211     isa.check_for_old_generated_files(sources)
 212     for source in sources:
 213         isa.write_pysource(source)
 214         isa.patch_if_needed(source)
 215     if write_isa_class:
 216         isa.write_isa_class()
 217
 218 if __name__ == '__main__':
 219     pywriter()