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