gcc/config/aarch64/aarch64-sve-builtins-shapes.h

   1 /* ACLE support for AArch64 SVE (function shapes)
   2    Copyright (C) 2018-2024 Free Software Foundation, Inc.
   3
   4    This file is part of GCC.
   5
   6    GCC is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3, or (at your option)
   9    any later version.
  10
  11    GCC is distributed in the hope that it will be useful, but
  12    WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with GCC; see the file COPYING3.  If not see
  18    <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GCC_AARCH64_SVE_BUILTINS_SHAPES_H
  21 #define GCC_AARCH64_SVE_BUILTINS_SHAPES_H
  22
  23 namespace aarch64_sve
  24 {
  25   /* The naming convention is:
  26
  27      - to use the name of the function if the rules are very specific to
  28        a particular function (e.g. svext, for which the range of the
  29        final immediate value is in no way generic).
  30
  31      - to use names like "unary" etc. if the rules are somewhat generic,
  32        especially if there are no ranges involved.
  33
  34      When using generic names, the handling of the final vector argument
  35      can be modified as follows:
  36
  37      - an "_n" suffix changes the argument from a vector to a scalar.
  38
  39      - an "_opt_n" suffix says that there are two forms of each function:
  40        one in which the argument is the usual vector, and one in which it
  41        is replaced by a scalar.
  42
  43      - an "_opt_single" suffix similarly says that the function can take
  44        a vector or tuple argument, with the former having a "_single" suffix.
  45
  46      - "_int" and "_uint" replace the argument's element type with a
  47        signed or unsigned integer of the same width.  The suffixes above
  48        then indicate whether this final argument is or might be a scalar.
  49
  50      - "_int64" and "_uint64" similarly replace the argument's element type
  51        with int64_t or uint64_t.
  52
  53      - "_wide" replaces the argument's element type with a 64-bit integer
  54        of the same signedness.  This only makes sense for integer elements.
  55
  56      - "_lane" indicates that the argument is indexed by a constant lane
  57        number, provided as an immediately-following argument of type uint64_t.
  58
  59      Also:
  60
  61      - "inherent" means that the function takes no arguments.
  62
  63      - "_rotate" means that the final argument is a rotation amount
  64        (0, 90, 180 or 270).
  65
  66      - "_scalar" indicates that all data arguments are scalars rather
  67        than vectors.
  68
  69      - in gather/scatter addresses, "sv" stands for "scalar base,
  70        vector displacement" while "vs" stands for "vector base,
  71        scalar displacement".
  72
  73      - "_pred" indicates that the function takes an svbool_t argument
  74        that does not act as a governing predicate..  */
  75   namespace shapes
  76   {
  77     extern const function_shape *const adr_index;
  78     extern const function_shape *const adr_offset;
  79     extern const function_shape *const binary;
  80     extern const function_shape *const binary_int_opt_n;
  81     extern const function_shape *const binary_int_opt_single_n;
  82     extern const function_shape *const binary_lane;
  83     extern const function_shape *const binary_long_lane;
  84     extern const function_shape *const binary_long_opt_n;
  85     extern const function_shape *const binary_n;
  86     extern const function_shape *const binary_narrowb_opt_n;
  87     extern const function_shape *const binary_narrowt_opt_n;
  88     extern const function_shape *const binary_opt_n;
  89     extern const function_shape *const binary_opt_single_n;
  90     extern const function_shape *const binary_pred;
  91     extern const function_shape *const binary_rotate;
  92     extern const function_shape *const binary_scalar;
  93     extern const function_shape *const binary_single;
  94     extern const function_shape *const binary_to_uint;
  95     extern const function_shape *const binary_uint;
  96     extern const function_shape *const binary_uint_n;
  97     extern const function_shape *const binary_uint_opt_n;
  98     extern const function_shape *const binary_uint64_n;
  99     extern const function_shape *const binary_uint64_opt_n;
 100     extern const function_shape *const binary_wide;
 101     extern const function_shape *const binary_wide_opt_n;
 102     extern const function_shape *const binary_za_int_m;
 103     extern const function_shape *const binary_za_m;
 104     extern const function_shape *const binary_za_slice_lane;
 105     extern const function_shape *const binary_za_slice_int_opt_single;
 106     extern const function_shape *const binary_za_slice_opt_single;
 107     extern const function_shape *const binary_za_slice_uint_opt_single;
 108     extern const function_shape *const binary_za_uint_m;
 109     extern const function_shape *const binaryxn;
 110     extern const function_shape *const bool_inherent;
 111     extern const function_shape *const clamp;
 112     extern const function_shape *const clast;
 113     extern const function_shape *const compare;
 114     extern const function_shape *const compare_opt_n;
 115     extern const function_shape *const compare_ptr;
 116     extern const function_shape *const compare_scalar;
 117     extern const function_shape *const compare_scalar_count;
 118     extern const function_shape *const compare_wide_opt_n;
 119     extern const function_shape *const count_inherent;
 120     extern const function_shape *const count_pat;
 121     extern const function_shape *const count_pred;
 122     extern const function_shape *const count_pred_c;
 123     extern const function_shape *const count_vector;
 124     extern const function_shape *const create;
 125     extern const function_shape *const dot_za_slice_int_lane;
 126     extern const function_shape *const dot_za_slice_lane;
 127     extern const function_shape *const dot_za_slice_uint_lane;
 128     extern const function_shape *const dupq;
 129     extern const function_shape *const dup_neonq;
 130     extern const function_shape *const ext;
 131     extern const function_shape *const extract_pred;
 132     extern const function_shape *const fold_left;
 133     extern const function_shape *const get;
 134     extern const function_shape *const get_neonq;
 135     extern const function_shape *const inc_dec;
 136     extern const function_shape *const inc_dec_pat;
 137     extern const function_shape *const inc_dec_pred;
 138     extern const function_shape *const inc_dec_pred_scalar;
 139     extern const function_shape *const inherent;
 140     extern const function_shape *const inherent_b;
 141     extern const function_shape *const inherent_za;
 142     extern const function_shape *const inherent_zt;
 143     extern const function_shape *const inherent_mask_za;
 144     extern const function_shape *const ldr_zt;
 145     extern const function_shape *const ldr_za;
 146     extern const function_shape *const load;
 147     extern const function_shape *const load_ext;
 148     extern const function_shape *const load_ext_gather_index;
 149     extern const function_shape *const load_ext_gather_index_restricted;
 150     extern const function_shape *const load_ext_gather_offset;
 151     extern const function_shape *const load_ext_gather_offset_restricted;
 152     extern const function_shape *const load_gather_sv;
 153     extern const function_shape *const load_gather_sv_restricted;
 154     extern const function_shape *const load_gather_vs;
 155     extern const function_shape *const load_replicate;
 156     extern const function_shape *const load_za;
 157     extern const function_shape *const luti2_lane_zt;
 158     extern const function_shape *const luti4_lane_zt;
 159     extern const function_shape *const mmla;
 160     extern const function_shape *const pattern_pred;
 161     extern const function_shape *const prefetch;
 162     extern const function_shape *const prefetch_gather_index;
 163     extern const function_shape *const prefetch_gather_offset;
 164     extern const function_shape *const ptest;
 165     extern const function_shape *const rdffr;
 166     extern const function_shape *const read_za;
 167     extern const function_shape *const read_za_m;
 168     extern const function_shape *const read_za_slice;
 169     extern const function_shape *const reduction;
 170     extern const function_shape *const reduction_wide;
 171     extern const function_shape *const reinterpret;
 172     extern const function_shape *const select_pred;
 173     extern const function_shape *const set;
 174     extern const function_shape *const setffr;
 175     extern const function_shape *const set_neonq;
 176     extern const function_shape *const shift_left_imm_long;
 177     extern const function_shape *const shift_left_imm_to_uint;
 178     extern const function_shape *const shift_right_imm;
 179     extern const function_shape *const shift_right_imm_narrowb;
 180     extern const function_shape *const shift_right_imm_narrowt;
 181     extern const function_shape *const shift_right_imm_narrowxn;
 182     extern const function_shape *const shift_right_imm_narrowb_to_uint;
 183     extern const function_shape *const shift_right_imm_narrowt_to_uint;
 184     extern const function_shape *const store;
 185     extern const function_shape *const store_scatter_index;
 186     extern const function_shape *const store_scatter_index_restricted;
 187     extern const function_shape *const store_scatter_offset;
 188     extern const function_shape *const store_scatter_offset_restricted;
 189     extern const function_shape *const store_za;
 190     extern const function_shape *const storexn;
 191     extern const function_shape *const str_za;
 192     extern const function_shape *const str_zt;
 193     extern const function_shape *const tbl_tuple;
 194     extern const function_shape *const ternary_bfloat;
 195     extern const function_shape *const ternary_bfloat_lane;
 196     extern const function_shape *const ternary_bfloat_lanex2;
 197     extern const function_shape *const ternary_bfloat_opt_n;
 198     extern const function_shape *const ternary_intq_uintq_lane;
 199     extern const function_shape *const ternary_intq_uintq_opt_n;
 200     extern const function_shape *const ternary_lane;
 201     extern const function_shape *const ternary_lane_rotate;
 202     extern const function_shape *const ternary_long_lane;
 203     extern const function_shape *const ternary_long_opt_n;
 204     extern const function_shape *const ternary_opt_n;
 205     extern const function_shape *const ternary_qq_or_011_lane;
 206     extern const function_shape *const ternary_qq_lane_rotate;
 207     extern const function_shape *const ternary_qq_opt_n_or_011;
 208     extern const function_shape *const ternary_qq_rotate;
 209     extern const function_shape *const ternary_rotate;
 210     extern const function_shape *const ternary_shift_left_imm;
 211     extern const function_shape *const ternary_shift_right_imm;
 212     extern const function_shape *const ternary_uint;
 213     extern const function_shape *const ternary_uintq_intq;
 214     extern const function_shape *const ternary_uintq_intq_lane;
 215     extern const function_shape *const ternary_uintq_intq_opt_n;
 216     extern const function_shape *const tmad;
 217     extern const function_shape *const unary;
 218     extern const function_shape *const unary_convert;
 219     extern const function_shape *const unary_convert_narrowt;
 220     extern const function_shape *const unary_convertxn;
 221     extern const function_shape *const unary_long;
 222     extern const function_shape *const unary_n;
 223     extern const function_shape *const unary_narrowb;
 224     extern const function_shape *const unary_narrowt;
 225     extern const function_shape *const unary_narrowb_to_uint;
 226     extern const function_shape *const unary_narrowt_to_uint;
 227     extern const function_shape *const unary_pred;
 228     extern const function_shape *const unary_to_int;
 229     extern const function_shape *const unary_to_uint;
 230     extern const function_shape *const unary_uint;
 231     extern const function_shape *const unary_widen;
 232     extern const function_shape *const unary_za_m;
 233     extern const function_shape *const unary_za_slice;
 234     extern const function_shape *const unaryxn;
 235     extern const function_shape *const write_za;
 236     extern const function_shape *const write_za_m;
 237     extern const function_shape *const write_za_slice;
 238   }
 239 }
 240
 241 #endif