xref: /qemu/target/hexagon/gen_helper_protos.py (revision fb67c2bf24f4399bb0347580324740409e1bb2d7)
1#!/usr/bin/env python3
2
3##
4##  Copyright(c) 2019-2022 Qualcomm Innovation Center, Inc. All Rights Reserved.
5##
6##  This program is free software; you can redistribute it and/or modify
7##  it under the terms of the GNU General Public License as published by
8##  the Free Software Foundation; either version 2 of the License, or
9##  (at your option) any later version.
10##
11##  This program is distributed in the hope that it will be useful,
12##  but WITHOUT ANY WARRANTY; without even the implied warranty of
13##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14##  GNU General Public License for more details.
15##
16##  You should have received a copy of the GNU General Public License
17##  along with this program; if not, see <http://www.gnu.org/licenses/>.
18##
19
20import sys
21import re
22import string
23import hex_common
24
25##
26## Helpers for gen_helper_prototype
27##
28def_helper_types = {
29    'N' : 's32',
30    'O' : 's32',
31    'P' : 's32',
32    'M' : 's32',
33    'C' : 's32',
34    'R' : 's32',
35    'V' : 'ptr',
36    'Q' : 'ptr'
37}
38
39def_helper_types_pair = {
40    'R' : 's64',
41    'C' : 's64',
42    'S' : 's64',
43    'G' : 's64',
44    'V' : 'ptr',
45    'Q' : 'ptr'
46}
47
48def gen_def_helper_opn(f, tag, regtype, regid, toss, numregs, i):
49    if (hex_common.is_pair(regid)):
50        f.write(", %s" % (def_helper_types_pair[regtype]))
51    elif (hex_common.is_single(regid)):
52        f.write(", %s" % (def_helper_types[regtype]))
53    else:
54        print("Bad register parse: ",regtype,regid,toss,numregs)
55
56##
57## Generate the DEF_HELPER prototype for an instruction
58##     For A2_add: Rd32=add(Rs32,Rt32)
59##     We produce:
60##         DEF_HELPER_3(A2_add, s32, env, s32, s32)
61##
62def gen_helper_prototype(f, tag, tagregs, tagimms):
63    regs = tagregs[tag]
64    imms = tagimms[tag]
65
66    numresults = 0
67    numscalarresults = 0
68    numscalarreadwrite = 0
69    for regtype,regid,toss,numregs in regs:
70        if (hex_common.is_written(regid)):
71            numresults += 1
72            if (hex_common.is_scalar_reg(regtype)):
73                numscalarresults += 1
74        if (hex_common.is_readwrite(regid)):
75            if (hex_common.is_scalar_reg(regtype)):
76                numscalarreadwrite += 1
77
78    if (numscalarresults > 1):
79        ## The helper is bogus when there is more than one result
80        f.write('DEF_HELPER_1(%s, void, env)\n' % tag)
81    else:
82        ## Figure out how many arguments the helper will take
83        if (numscalarresults == 0):
84            def_helper_size = len(regs)+len(imms)+numscalarreadwrite+1
85            if hex_common.need_pkt_has_multi_cof(tag): def_helper_size += 1
86            if hex_common.need_part1(tag): def_helper_size += 1
87            if hex_common.need_slot(tag): def_helper_size += 1
88            f.write('DEF_HELPER_%s(%s' % (def_helper_size, tag))
89            ## The return type is void
90            f.write(', void' )
91        else:
92            def_helper_size = len(regs)+len(imms)+numscalarreadwrite
93            if hex_common.need_pkt_has_multi_cof(tag): def_helper_size += 1
94            if hex_common.need_part1(tag): def_helper_size += 1
95            if hex_common.need_slot(tag): def_helper_size += 1
96            f.write('DEF_HELPER_%s(%s' % (def_helper_size, tag))
97
98        ## Generate the qemu DEF_HELPER type for each result
99        ## Iterate over this list twice
100        ## - Emit the scalar result
101        ## - Emit the vector result
102        i=0
103        for regtype,regid,toss,numregs in regs:
104            if (hex_common.is_written(regid)):
105                if (not hex_common.is_hvx_reg(regtype)):
106                    gen_def_helper_opn(f, tag, regtype, regid, toss, numregs, i)
107                i += 1
108
109        ## Put the env between the outputs and inputs
110        f.write(', env' )
111        i += 1
112
113        # Second pass
114        for regtype,regid,toss,numregs in regs:
115            if (hex_common.is_written(regid)):
116                if (hex_common.is_hvx_reg(regtype)):
117                    gen_def_helper_opn(f, tag, regtype, regid, toss, numregs, i)
118                    i += 1
119
120        ## Generate the qemu type for each input operand (regs and immediates)
121        for regtype,regid,toss,numregs in regs:
122            if (hex_common.is_read(regid)):
123                if (hex_common.is_hvx_reg(regtype) and
124                    hex_common.is_readwrite(regid)):
125                    continue
126                gen_def_helper_opn(f, tag, regtype, regid, toss, numregs, i)
127                i += 1
128        for immlett,bits,immshift in imms:
129            f.write(", s32")
130
131        ## Add the arguments for the instruction pkt_has_multi_cof, slot and
132        ## part1 (if needed)
133        if hex_common.need_pkt_has_multi_cof(tag): f.write(', i32')
134        if hex_common.need_slot(tag): f.write(', i32' )
135        if hex_common.need_part1(tag): f.write(' , i32' )
136        f.write(')\n')
137
138def main():
139    hex_common.read_semantics_file(sys.argv[1])
140    hex_common.read_attribs_file(sys.argv[2])
141    hex_common.read_overrides_file(sys.argv[3])
142    hex_common.read_overrides_file(sys.argv[4])
143    hex_common.calculate_attribs()
144    tagregs = hex_common.get_tagregs()
145    tagimms = hex_common.get_tagimms()
146
147    with open(sys.argv[5], 'w') as f:
148        for tag in hex_common.tags:
149            ## Skip the priv instructions
150            if ( "A_PRIV" in hex_common.attribdict[tag] ) :
151                continue
152            ## Skip the guest instructions
153            if ( "A_GUEST" in hex_common.attribdict[tag] ) :
154                continue
155            ## Skip the diag instructions
156            if ( tag == "Y6_diag" ) :
157                continue
158            if ( tag == "Y6_diag0" ) :
159                continue
160            if ( tag == "Y6_diag1" ) :
161                continue
162
163            if ( hex_common.skip_qemu_helper(tag) ):
164                continue
165
166            gen_helper_prototype(f, tag, tagregs, tagimms)
167
168if __name__ == "__main__":
169    main()
170