#!/usr/bin/env python3 ## ## Copyright(c) 2019-2023 Qualcomm Innovation Center, Inc. All Rights Reserved. ## ## This program is free software; you can redistribute it and/or modify ## it under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 2 of the License, or ## (at your option) any later version. ## ## This program is distributed in the hope that it will be useful, ## but WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with this program; if not, see . ## import sys import re import string import hex_common ## ## Helpers for gen_helper_function ## def gen_decl_ea(f): f.write(" uint32_t EA;\n") def gen_helper_return_type(f, regtype, regid, regno): if regno > 1: f.write(", ") f.write("int32_t") def gen_helper_return_type_pair(f, regtype, regid, regno): if regno > 1: f.write(", ") f.write("int64_t") def gen_helper_arg(f, regtype, regid, regno): if regno > 0: f.write(", ") f.write(f"int32_t {regtype}{regid}V") def gen_helper_arg_new(f, regtype, regid, regno): if regno >= 0: f.write(", ") f.write(f"int32_t {regtype}{regid}N") def gen_helper_arg_pair(f, regtype, regid, regno): if regno >= 0: f.write(", ") f.write(f"int64_t {regtype}{regid}V") def gen_helper_arg_ext(f, regtype, regid, regno): if regno > 0: f.write(", ") f.write(f"void *{regtype}{regid}V_void") def gen_helper_arg_ext_pair(f, regtype, regid, regno): if regno > 0: f.write(", ") f.write(f"void *{regtype}{regid}V_void") def gen_helper_arg_opn(f, regtype, regid, i, tag): if hex_common.is_pair(regid): if hex_common.is_hvx_reg(regtype): gen_helper_arg_ext_pair(f, regtype, regid, i) else: gen_helper_arg_pair(f, regtype, regid, i) elif hex_common.is_single(regid): if hex_common.is_old_val(regtype, regid, tag): if hex_common.is_hvx_reg(regtype): gen_helper_arg_ext(f, regtype, regid, i) else: gen_helper_arg(f, regtype, regid, i) elif hex_common.is_new_val(regtype, regid, tag): gen_helper_arg_new(f, regtype, regid, i) else: hex_common.bad_register(regtype, regid, toss, numregs) else: hex_common.bad_register(regtype, regid, toss, numregs) def gen_helper_arg_imm(f, immlett): f.write(f", int32_t {hex_common.imm_name(immlett)}") def gen_helper_dest_decl(f, regtype, regid, regno, subfield=""): f.write(f" int32_t {regtype}{regid}V{subfield} = 0;\n") def gen_helper_dest_decl_pair(f, regtype, regid, regno, subfield=""): f.write(f" int64_t {regtype}{regid}V{subfield} = 0;\n") def gen_helper_dest_decl_ext(f, regtype, regid): if regtype == "Q": f.write( f" /* {regtype}{regid}V is *(MMQReg *)" f"({regtype}{regid}V_void) */\n" ) else: f.write( f" /* {regtype}{regid}V is *(MMVector *)" f"({regtype}{regid}V_void) */\n" ) def gen_helper_dest_decl_ext_pair(f, regtype, regid, regno): f.write( f" /* {regtype}{regid}V is *(MMVectorPair *))" f"{regtype}{regid}V_void) */\n" ) def gen_helper_dest_decl_opn(f, regtype, regid, i): if hex_common.is_pair(regid): if hex_common.is_hvx_reg(regtype): gen_helper_dest_decl_ext_pair(f, regtype, regid, i) else: gen_helper_dest_decl_pair(f, regtype, regid, i) elif hex_common.is_single(regid): if hex_common.is_hvx_reg(regtype): gen_helper_dest_decl_ext(f, regtype, regid) else: gen_helper_dest_decl(f, regtype, regid, i) else: hex_common.bad_register(regtype, regid, toss, numregs) def gen_helper_src_var_ext(f, regtype, regid): if regtype == "Q": f.write( f" /* {regtype}{regid}V is *(MMQReg *)" f"({regtype}{regid}V_void) */\n" ) else: f.write( f" /* {regtype}{regid}V is *(MMVector *)" f"({regtype}{regid}V_void) */\n" ) def gen_helper_src_var_ext_pair(f, regtype, regid, regno): f.write( f" /* {regtype}{regid}V{regno} is *(MMVectorPair *)" f"({regtype}{regid}V{regno}_void) */\n" ) def gen_helper_return(f, regtype, regid, regno): f.write(f" return {regtype}{regid}V;\n") def gen_helper_return_pair(f, regtype, regid, regno): f.write(f" return {regtype}{regid}V;\n") def gen_helper_dst_write_ext(f, regtype, regid): return def gen_helper_dst_write_ext_pair(f, regtype, regid): return def gen_helper_return_opn(f, regtype, regid, i): if hex_common.is_pair(regid): if hex_common.is_hvx_reg(regtype): gen_helper_dst_write_ext_pair(f, regtype, regid) else: gen_helper_return_pair(f, regtype, regid, i) elif hex_common.is_single(regid): if hex_common.is_hvx_reg(regtype): gen_helper_dst_write_ext(f, regtype, regid) else: gen_helper_return(f, regtype, regid, i) else: hex_common.bad_register(regtype, regid, toss, numregs) ## ## Generate the TCG code to call the helper ## For A2_add: Rd32=add(Rs32,Rt32), { RdV=RsV+RtV;} ## We produce: ## int32_t HELPER(A2_add)(CPUHexagonState *env, int32_t RsV, int32_t RtV) ## { ## uint32_t slot __attribute__(unused)) = 4; ## int32_t RdV = 0; ## { RdV=RsV+RtV;} ## COUNT_HELPER(A2_add); ## return RdV; ## } ## def gen_helper_function(f, tag, tagregs, tagimms): regs = tagregs[tag] imms = tagimms[tag] numresults = 0 numscalarresults = 0 numscalarreadwrite = 0 for regtype, regid, toss, numregs in regs: if hex_common.is_written(regid): numresults += 1 if hex_common.is_scalar_reg(regtype): numscalarresults += 1 if hex_common.is_readwrite(regid): if hex_common.is_scalar_reg(regtype): numscalarreadwrite += 1 if numscalarresults > 1: ## The helper is bogus when there is more than one result f.write( f"void HELPER({tag})(CPUHexagonState *env) " f"{{ BOGUS_HELPER({tag}); }}\n" ) else: ## The return type of the function is the type of the destination ## register (if scalar) i = 0 for regtype, regid, toss, numregs in regs: if hex_common.is_written(regid): if hex_common.is_pair(regid): if hex_common.is_hvx_reg(regtype): continue else: gen_helper_return_type_pair(f, regtype, regid, i) elif hex_common.is_single(regid): if hex_common.is_hvx_reg(regtype): continue else: gen_helper_return_type(f, regtype, regid, i) else: hex_common.bad_register(regtype, regid, toss, numregs) i += 1 if numscalarresults == 0: f.write("void") f.write(f" HELPER({tag})(CPUHexagonState *env") ## Arguments include the vector destination operands i = 1 for regtype, regid, toss, numregs in regs: if hex_common.is_written(regid): if hex_common.is_pair(regid): if hex_common.is_hvx_reg(regtype): gen_helper_arg_ext_pair(f, regtype, regid, i) else: continue elif hex_common.is_single(regid): if hex_common.is_hvx_reg(regtype): gen_helper_arg_ext(f, regtype, regid, i) else: # This is the return value of the function continue else: hex_common.bad_register(regtype, regid, toss, numregs) i += 1 ## For conditional instructions, we pass in the destination register if "A_CONDEXEC" in hex_common.attribdict[tag]: for regtype, regid, toss, numregs in regs: if hex_common.is_writeonly(regid) and not hex_common.is_hvx_reg( regtype ): gen_helper_arg_opn(f, regtype, regid, i, tag) i += 1 ## Arguments to the helper function are the source regs and immediates for regtype, regid, toss, numregs in regs: if hex_common.is_read(regid): if hex_common.is_hvx_reg(regtype) and hex_common.is_readwrite(regid): continue gen_helper_arg_opn(f, regtype, regid, i, tag) i += 1 for immlett, bits, immshift in imms: gen_helper_arg_imm(f, immlett) i += 1 if hex_common.need_pkt_has_multi_cof(tag): f.write(", uint32_t pkt_has_multi_cof") if (hex_common.need_pkt_need_commit(tag)): f.write(", uint32_t pkt_need_commit") if hex_common.need_PC(tag): if i > 0: f.write(", ") f.write("target_ulong PC") i += 1 if hex_common.helper_needs_next_PC(tag): if i > 0: f.write(", ") f.write("target_ulong next_PC") i += 1 if hex_common.need_slot(tag): if i > 0: f.write(", ") f.write("uint32_t slotval") i += 1 if hex_common.need_part1(tag): if i > 0: f.write(", ") f.write("uint32_t part1") f.write(")\n{\n") if hex_common.need_ea(tag): gen_decl_ea(f) ## Declare the return variable i = 0 if "A_CONDEXEC" not in hex_common.attribdict[tag]: for regtype, regid, toss, numregs in regs: if hex_common.is_writeonly(regid): gen_helper_dest_decl_opn(f, regtype, regid, i) i += 1 for regtype, regid, toss, numregs in regs: if hex_common.is_read(regid): if hex_common.is_pair(regid): if hex_common.is_hvx_reg(regtype): gen_helper_src_var_ext_pair(f, regtype, regid, i) elif hex_common.is_single(regid): if hex_common.is_hvx_reg(regtype): gen_helper_src_var_ext(f, regtype, regid) else: hex_common.bad_register(regtype, regid, toss, numregs) if hex_common.need_slot(tag): if "A_LOAD" in hex_common.attribdict[tag]: f.write(" bool pkt_has_store_s1 = slotval & 0x1;\n") f.write(" uint32_t slot = slotval >> 1;\n") if "A_FPOP" in hex_common.attribdict[tag]: f.write(" arch_fpop_start(env);\n") f.write(f" {hex_common.semdict[tag]}\n") if "A_FPOP" in hex_common.attribdict[tag]: f.write(" arch_fpop_end(env);\n") ## Save/return the return variable for regtype, regid, toss, numregs in regs: if hex_common.is_written(regid): gen_helper_return_opn(f, regtype, regid, i) f.write("}\n\n") ## End of the helper definition def main(): hex_common.read_semantics_file(sys.argv[1]) hex_common.read_attribs_file(sys.argv[2]) hex_common.read_overrides_file(sys.argv[3]) hex_common.read_overrides_file(sys.argv[4]) ## Whether or not idef-parser is enabled is ## determined by the number of arguments to ## this script: ## ## 5 args. -> not enabled, ## 6 args. -> idef-parser enabled. ## ## The 6:th arg. then holds a list of the successfully ## parsed instructions. is_idef_parser_enabled = len(sys.argv) > 6 if is_idef_parser_enabled: hex_common.read_idef_parser_enabled_file(sys.argv[5]) hex_common.calculate_attribs() tagregs = hex_common.get_tagregs() tagimms = hex_common.get_tagimms() output_file = sys.argv[-1] with open(output_file, "w") as f: for tag in hex_common.tags: ## Skip the priv instructions if "A_PRIV" in hex_common.attribdict[tag]: continue ## Skip the guest instructions if "A_GUEST" in hex_common.attribdict[tag]: continue ## Skip the diag instructions if tag == "Y6_diag": continue if tag == "Y6_diag0": continue if tag == "Y6_diag1": continue if hex_common.skip_qemu_helper(tag): continue if hex_common.is_idef_parser_enabled(tag): continue gen_helper_function(f, tag, tagregs, tagimms) if __name__ == "__main__": main()