target/hexagon/gen_helper_protos.py

   1 #!/usr/bin/env python3
   2
   3 ##
   4 ##  Copyright(c) 2019-2023 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
  20 import sys
  21 import re
  22 import string
  23 import hex_common
  24
  25 ##
  26 ## Helpers for gen_helper_prototype
  27 ##
  28 def_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
  39 def_helper_types_pair = {
  40     'R' : 's64',
  41     'C' : 's64',
  42     'S' : 's64',
  43     'G' : 's64',
  44     'V' : 'ptr',
  45     'Q' : 'ptr'
  46 }
  47
  48 def 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 ##
  62 def 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             if hex_common.need_PC(tag): def_helper_size += 1
  89             if hex_common.helper_needs_next_PC(tag): def_helper_size += 1
  90             if hex_common.need_condexec_reg(tag, regs): def_helper_size += 1
  91             f.write('DEF_HELPER_%s(%s' % (def_helper_size, tag))
  92             ## The return type is void
  93             f.write(', void' )
  94         else:
  95             def_helper_size = len(regs)+len(imms)+numscalarreadwrite
  96             if hex_common.need_pkt_has_multi_cof(tag): def_helper_size += 1
  97             if hex_common.need_part1(tag): def_helper_size += 1
  98             if hex_common.need_slot(tag): def_helper_size += 1
  99             if hex_common.need_PC(tag): def_helper_size += 1
 100             if hex_common.need_condexec_reg(tag, regs): def_helper_size += 1
 101             if hex_common.helper_needs_next_PC(tag): def_helper_size += 1
 102             f.write('DEF_HELPER_%s(%s' % (def_helper_size, tag))
 103
 104         ## Generate the qemu DEF_HELPER type for each result
 105         ## Iterate over this list twice
 106         ## - Emit the scalar result
 107         ## - Emit the vector result
 108         i=0
 109         for regtype,regid,toss,numregs in regs:
 110             if (hex_common.is_written(regid)):
 111                 if (not hex_common.is_hvx_reg(regtype)):
 112                     gen_def_helper_opn(f, tag, regtype, regid, toss, numregs, i)
 113                 i += 1
 114
 115         ## Put the env between the outputs and inputs
 116         f.write(', env' )
 117         i += 1
 118
 119         # Second pass
 120         for regtype,regid,toss,numregs in regs:
 121             if (hex_common.is_written(regid)):
 122                 if (hex_common.is_hvx_reg(regtype)):
 123                     gen_def_helper_opn(f, tag, regtype, regid, toss, numregs, i)
 124                     i += 1
 125
 126         ## For conditional instructions, we pass in the destination register
 127         if 'A_CONDEXEC' in hex_common.attribdict[tag]:
 128             for regtype, regid, toss, numregs in regs:
 129                 if (hex_common.is_writeonly(regid) and
 130                     not hex_common.is_hvx_reg(regtype)):
 131                     gen_def_helper_opn(f, tag, regtype, regid, toss, numregs, i)
 132                     i += 1
 133
 134         ## Generate the qemu type for each input operand (regs and immediates)
 135         for regtype,regid,toss,numregs in regs:
 136             if (hex_common.is_read(regid)):
 137                 if (hex_common.is_hvx_reg(regtype) and
 138                     hex_common.is_readwrite(regid)):
 139                     continue
 140                 gen_def_helper_opn(f, tag, regtype, regid, toss, numregs, i)
 141                 i += 1
 142         for immlett,bits,immshift in imms:
 143             f.write(", s32")
 144
 145         ## Add the arguments for the instruction pkt_has_multi_cof, slot and
 146         ## part1 (if needed)
 147         if hex_common.need_pkt_has_multi_cof(tag): f.write(', i32')
 148         if hex_common.need_PC(tag): f.write(', i32')
 149         if hex_common.helper_needs_next_PC(tag): f.write(', i32')
 150         if hex_common.need_slot(tag): f.write(', i32' )
 151         if hex_common.need_part1(tag): f.write(' , i32' )
 152         f.write(')\n')
 153
 154 def main():
 155     hex_common.read_semantics_file(sys.argv[1])
 156     hex_common.read_attribs_file(sys.argv[2])
 157     hex_common.read_overrides_file(sys.argv[3])
 158     hex_common.read_overrides_file(sys.argv[4])
 159     ## Whether or not idef-parser is enabled is
 160     ## determined by the number of arguments to
 161     ## this script:
 162     ##
 163     ##   5 args. -> not enabled,
 164     ##   6 args. -> idef-parser enabled.
 165     ##
 166     ## The 6:th arg. then holds a list of the successfully
 167     ## parsed instructions.
 168     is_idef_parser_enabled = len(sys.argv) > 6
 169     if is_idef_parser_enabled:
 170         hex_common.read_idef_parser_enabled_file(sys.argv[5])
 171     hex_common.calculate_attribs()
 172     tagregs = hex_common.get_tagregs()
 173     tagimms = hex_common.get_tagimms()
 174
 175     output_file = sys.argv[-1]
 176     with open(output_file, 'w') as f:
 177         for tag in hex_common.tags:
 178             ## Skip the priv instructions
 179             if ( "A_PRIV" in hex_common.attribdict[tag] ) :
 180                 continue
 181             ## Skip the guest instructions
 182             if ( "A_GUEST" in hex_common.attribdict[tag] ) :
 183                 continue
 184             ## Skip the diag instructions
 185             if ( tag == "Y6_diag" ) :
 186                 continue
 187             if ( tag == "Y6_diag0" ) :
 188                 continue
 189             if ( tag == "Y6_diag1" ) :
 190                 continue
 191
 192             if ( hex_common.skip_qemu_helper(tag) ):
 193                 continue
 194             if ( hex_common.is_idef_parser_enabled(tag) ):
 195                 continue
 196
 197             gen_helper_prototype(f, tag, tagregs, tagimms)
 198
 199 if __name__ == "__main__":
 200     main()