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
  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 class PyISAWriter(ISA):
  56     def __init__(self):
  57         ISA.__init__(self)
  58         self.pages_written = []
  59
  60     def write_pysource(self, pagename):
  61         self.pages_written.append(pagename)
  62         instrs = self.page[pagename]
  63         isadir = get_isasrc_dir()
  64         fname = os.path.join(isadir, "%s.py" % pagename)
  65         check_in_gitignore(fname)
  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") or
  71                 pagename.startswith("svfp")):
  72                 f.write(fpheader)
  73             f.write("class %s:\n" % pagename)
  74
  75             # go through all instructions
  76             for page in instrs:
  77                 d = self.instr[page]
  78                 print("page", pagename, page, fname, d.opcode)
  79                 pcode = '\n'.join(d.pcode) + '\n'
  80                 print(pcode)
  81                 incl_carry = pagename == 'fixedshift'
  82                 filename = os.path.join(get_isa_dir(), pagename + ".mdwn")
  83                 pycode, rused = convert_to_python(pcode, d.form, incl_carry,
  84                                                   filename=filename)
  85                 # create list of arguments to call
  86                 regs = list(rused['read_regs']) + list(rused['uninit_regs'])
  87                 regs += list(rused['special_regs'])
  88                 args = ', '.join(create_args(regs, 'self'))
  89                 # create list of arguments to return
  90                 retargs = ', '.join(create_args(rused['write_regs']))
  91                 # write out function.  pre-pend "op_" because some instrs are
  92                 # also python keywords (cmp).  also replace "." with "_"
  93                 op_fname = "op_%s" % page.replace(".", "_")
  94                 f.write("    @inject()\n")
  95                 f.write("    def %s(%s):\n" % (op_fname, args))
  96                 # blech! this works in combination with ISACaller
  97                 # @inject decorator, which works by injecting
  98                 # global variables into the function namespace.
  99                 for blech in ['NIA', 'end_loop']:
 100                     if blech in pycode:  # HACK - TODO fix
 101                         f.write("        global %s\n" % blech)
 102                 pycode = pycode.split("\n")
 103                 pycode = '\n'.join(map(lambda x: "        %s" % x, pycode))
 104                 pycode = pycode.rstrip()
 105                 f.write(pycode + '\n')
 106                 if retargs:
 107                     f.write("        return (%s,)\n\n" % retargs)
 108                 else:
 109                     f.write("\n")
 110                 # accumulate the instruction info
 111                 ops = repr(rused['op_fields'])
 112                 iinfo = iinfo_template % (op_fname, rused['read_regs'],
 113                                           rused['uninit_regs'],
 114                                           rused['write_regs'],
 115                                           rused['special_regs'],
 116                                           ops, d.form, d.regs)
 117                 iinf += "    %s_instrs['%s'] = %s\n" % (pagename, page, iinfo)
 118             # write out initialisation of info, for ISACaller to use
 119             f.write("    %s_instrs = {}\n" % pagename)
 120             f.write(iinf)
 121
 122     def patch_if_needed(self, source):
 123         isadir = get_isasrc_dir()
 124         fname = os.path.join(isadir, "%s.py" % source)
 125         patchname = os.path.join(isadir, "%s.patch" % source)
 126
 127         try:
 128             with open(patchname, 'r') as patch:
 129                 newfname = fname + '.orig'
 130                 shutil.copyfile(fname, newfname)
 131                 subprocess.check_call(['patch', fname],
 132                                       stdin=patch)
 133         except:
 134             pass
 135
 136     def write_isa_class(self):
 137         isadir = get_isasrc_dir()
 138         fname = os.path.join(isadir, "all.py")
 139         check_in_gitignore(fname)
 140         with open(fname, "w") as f:
 141             f.write('# auto-generated by pywriter.py: do not edit or commit\n')
 142             f.write('from openpower.decoder.isa.caller import ISACaller\n')
 143             f.write('from openpower.decoder.helpers import ISACallerHelper\n')
 144             f.write('from openpower.decoder.isafunctions.all '
 145                     'import ISACallerFnHelper\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             f.write('class ISAPages(%s):\n' % ", ".join(self.pages_written))
 152             f.write('    def __init__(self, *args, **kwargs):\n')
 153             f.write('        super().__init__(*args, **kwargs)\n')
 154             f.write('        self.instrs = {\n')
 155             for page in self.pages_written:
 156                 f.write('            **self.%s_instrs,\n' % page)
 157             f.write('        }\n')
 158             classes = ', '.join(['ISAPages', 'ISACaller', 'ISACallerFnHelper',
 159                                  'ISACallerHelper'])
 160             f.write('class ISA(%s): pass\n' % classes)
 161
 162
 163 def pywriter():
 164     isa = PyISAWriter()
 165     write_isa_class = True
 166     if len(sys.argv) == 1:  # quick way to do it
 167         print(dir(isa))
 168         sources = isa.page.keys()
 169     else:
 170         sources = sys.argv[1:]
 171         if sources[0] == "noall": # don't rewrite all.py
 172             write_isa_class = False
 173             sources.pop(0)
 174     print ("sources", write_isa_class, sources)
 175     for source in sources:
 176         isa.write_pysource(source)
 177         isa.patch_if_needed(source)
 178     if write_isa_class:
 179         isa.write_isa_class()
 180
 181 if __name__ == '__main__':
 182     pywriter()