gcc/internal-fn.def

   1 /* Internal functions.
   2    Copyright (C) 2011-2018 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 under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 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 /* This file specifies a list of internal "functions".  These functions
  21    differ from built-in functions in that they have no linkage and cannot
  22    be called directly by the user.  They represent operations that are only
  23    synthesised by GCC itself.
  24
  25    Internal functions are used instead of tree codes if the operation
  26    and its operands are more naturally represented as a GIMPLE_CALL
  27    than a GIMPLE_ASSIGN.
  28
  29    Each entry in this file has one of the forms:
  30
  31      DEF_INTERNAL_FN (NAME, FLAGS, FNSPEC)
  32      DEF_INTERNAL_OPTAB_FN (NAME, FLAGS, OPTAB, TYPE)
  33      DEF_INTERNAL_SIGNED_OPTAB_FN (NAME, FLAGS, SELECTOR, SIGNED_OPTAB,
  34                                    UNSIGNED_OPTAB, TYPE)
  35      DEF_INTERNAL_FLT_FN (NAME, FLAGS, OPTAB, TYPE)
  36      DEF_INTERNAL_INT_FN (NAME, FLAGS, OPTAB, TYPE)
  37
  38    where NAME is the name of the function, FLAGS is a set of
  39    ECF_* flags and FNSPEC is a string describing functions fnspec.
  40
  41    DEF_INTERNAL_OPTAB_FN defines an internal function that maps to a
  42    direct optab.  The function should only be called with a given
  43    set of types if the associated optab is available for the modes
  44    of those types.  OPTAB says what optab to use (without the trailing
  45    "_optab") and TYPE categorizes the optab based on its inputs and
  46    outputs.  The possible types of optab are:
  47
  48    - mask_load: currently just maskload
  49    - load_lanes: currently just vec_load_lanes
  50    - mask_load_lanes: currently just vec_mask_load_lanes
  51    - gather_load: used for {mask_,}gather_load
  52
  53    - mask_store: currently just maskstore
  54    - store_lanes: currently just vec_store_lanes
  55    - mask_store_lanes: currently just vec_mask_store_lanes
  56
  57    - unary: a normal unary optab, such as vec_reverse_<mode>
  58    - binary: a normal binary optab, such as vec_interleave_lo_<mode>
  59
  60    - cond_binary: a conditional binary optab, such as add<mode>cc
  61
  62    - fold_left: for scalar = FN (scalar, vector), keyed off the vector mode
  63
  64    DEF_INTERNAL_SIGNED_OPTAB_FN defines an internal function that
  65    maps to one of two optabs, depending on the signedness of an input.
  66    SIGNED_OPTAB and UNSIGNED_OPTAB are the optabs for signed and
  67    unsigned inputs respectively, both without the trailing "_optab".
  68    SELECTOR says which type in the tree_pair determines the signedness.
  69
  70    DEF_INTERNAL_FLT_FN is like DEF_INTERNAL_OPTAB_FN, but in addition,
  71    the function implements the computational part of a built-in math
  72    function BUILT_IN_<NAME>{F,,L}.  Unlike some built-in functions,
  73    these internal functions never set errno.
  74
  75    DEF_INTERNAL_INT_FN is like DEF_INTERNAL_OPTAB_FN, but in addition
  76    says that the function extends the C-level BUILT_IN_<NAME>{,L,LL,IMAX}
  77    group of functions to any integral mode (including vector modes).
  78
  79    Each entry must have a corresponding expander of the form:
  80
  81      void expand_NAME (gimple_call stmt)
  82
  83    where STMT is the statement that performs the call.  These are generated
  84    automatically for optab functions and call out to a function or macro
  85    called expand_<TYPE>_optab_fn.  */
  86
  87 #ifndef DEF_INTERNAL_FN
  88 #define DEF_INTERNAL_FN(CODE, FLAGS, FNSPEC)
  89 #endif
  90
  91 #ifndef DEF_INTERNAL_OPTAB_FN
  92 #define DEF_INTERNAL_OPTAB_FN(NAME, FLAGS, OPTAB, TYPE) \
  93   DEF_INTERNAL_FN (NAME, FLAGS | ECF_LEAF, NULL)
  94 #endif
  95
  96 #ifndef DEF_INTERNAL_SIGNED_OPTAB_FN
  97 #define DEF_INTERNAL_SIGNED_OPTAB_FN(NAME, FLAGS, SELECTOR, SIGNED_OPTAB, \
  98                                      UNSIGNED_OPTAB, TYPE) \
  99   DEF_INTERNAL_FN (NAME, FLAGS | ECF_LEAF, NULL)
 100 #endif
 101
 102 #ifndef DEF_INTERNAL_FLT_FN
 103 #define DEF_INTERNAL_FLT_FN(NAME, FLAGS, OPTAB, TYPE) \
 104   DEF_INTERNAL_OPTAB_FN (NAME, FLAGS, OPTAB, TYPE)
 105 #endif
 106
 107 #ifndef DEF_INTERNAL_FLT_FLOATN_FN
 108 #define DEF_INTERNAL_FLT_FLOATN_FN(NAME, FLAGS, OPTAB, TYPE) \
 109   DEF_INTERNAL_FLT_FN (NAME, FLAGS, OPTAB, TYPE)
 110 #endif
 111
 112 #ifndef DEF_INTERNAL_INT_FN
 113 #define DEF_INTERNAL_INT_FN(NAME, FLAGS, OPTAB, TYPE) \
 114   DEF_INTERNAL_OPTAB_FN (NAME, FLAGS, OPTAB, TYPE)
 115 #endif
 116
 117 DEF_INTERNAL_OPTAB_FN (MASK_LOAD, ECF_PURE, maskload, mask_load)
 118 DEF_INTERNAL_OPTAB_FN (LOAD_LANES, ECF_CONST, vec_load_lanes, load_lanes)
 119 DEF_INTERNAL_OPTAB_FN (MASK_LOAD_LANES, ECF_PURE,
 120                        vec_mask_load_lanes, mask_load_lanes)
 121
 122 DEF_INTERNAL_OPTAB_FN (GATHER_LOAD, ECF_PURE, gather_load, gather_load)
 123 DEF_INTERNAL_OPTAB_FN (MASK_GATHER_LOAD, ECF_PURE,
 124                        mask_gather_load, gather_load)
 125
 126 DEF_INTERNAL_OPTAB_FN (MASK_STORE, 0, maskstore, mask_store)
 127 DEF_INTERNAL_OPTAB_FN (STORE_LANES, ECF_CONST, vec_store_lanes, store_lanes)
 128 DEF_INTERNAL_OPTAB_FN (MASK_STORE_LANES, 0,
 129                        vec_mask_store_lanes, mask_store_lanes)
 130
 131 DEF_INTERNAL_OPTAB_FN (WHILE_ULT, ECF_CONST | ECF_NOTHROW, while_ult, while)
 132
 133 DEF_INTERNAL_OPTAB_FN (VEC_SHL_INSERT, ECF_CONST | ECF_NOTHROW,
 134                        vec_shl_insert, binary)
 135
 136 DEF_INTERNAL_OPTAB_FN (COND_ADD, ECF_CONST, cond_add, cond_binary)
 137 DEF_INTERNAL_OPTAB_FN (COND_SUB, ECF_CONST, cond_sub, cond_binary)
 138 DEF_INTERNAL_SIGNED_OPTAB_FN (COND_MIN, ECF_CONST, first,
 139                               cond_smin, cond_umin, cond_binary)
 140 DEF_INTERNAL_SIGNED_OPTAB_FN (COND_MAX, ECF_CONST, first,
 141                               cond_smax, cond_umax, cond_binary)
 142 DEF_INTERNAL_OPTAB_FN (COND_AND, ECF_CONST | ECF_NOTHROW,
 143                        cond_and, cond_binary)
 144 DEF_INTERNAL_OPTAB_FN (COND_IOR, ECF_CONST | ECF_NOTHROW,
 145                        cond_ior, cond_binary)
 146 DEF_INTERNAL_OPTAB_FN (COND_XOR, ECF_CONST | ECF_NOTHROW,
 147                        cond_xor, cond_binary)
 148
 149 DEF_INTERNAL_OPTAB_FN (RSQRT, ECF_CONST, rsqrt, unary)
 150
 151 DEF_INTERNAL_OPTAB_FN (REDUC_PLUS, ECF_CONST | ECF_NOTHROW,
 152                        reduc_plus_scal, unary)
 153 DEF_INTERNAL_SIGNED_OPTAB_FN (REDUC_MAX, ECF_CONST | ECF_NOTHROW, first,
 154                               reduc_smax_scal, reduc_umax_scal, unary)
 155 DEF_INTERNAL_SIGNED_OPTAB_FN (REDUC_MIN, ECF_CONST | ECF_NOTHROW, first,
 156                               reduc_smin_scal, reduc_umin_scal, unary)
 157 DEF_INTERNAL_OPTAB_FN (REDUC_AND, ECF_CONST | ECF_NOTHROW,
 158                        reduc_and_scal, unary)
 159 DEF_INTERNAL_OPTAB_FN (REDUC_IOR, ECF_CONST | ECF_NOTHROW,
 160                        reduc_ior_scal, unary)
 161 DEF_INTERNAL_OPTAB_FN (REDUC_XOR, ECF_CONST | ECF_NOTHROW,
 162                        reduc_xor_scal, unary)
 163
 164 /* Extract the last active element from a vector.  */
 165 DEF_INTERNAL_OPTAB_FN (EXTRACT_LAST, ECF_CONST | ECF_NOTHROW,
 166                        extract_last, cond_unary)
 167
 168 /* Same, but return the first argument if no elements are active.  */
 169 DEF_INTERNAL_OPTAB_FN (FOLD_EXTRACT_LAST, ECF_CONST | ECF_NOTHROW,
 170                        fold_extract_last, fold_extract)
 171
 172 DEF_INTERNAL_OPTAB_FN (FOLD_LEFT_PLUS, ECF_CONST | ECF_NOTHROW,
 173                        fold_left_plus, fold_left)
 174
 175 /* Unary math functions.  */
 176 DEF_INTERNAL_FLT_FN (ACOS, ECF_CONST, acos, unary)
 177 DEF_INTERNAL_FLT_FN (ASIN, ECF_CONST, asin, unary)
 178 DEF_INTERNAL_FLT_FN (ATAN, ECF_CONST, atan, unary)
 179 DEF_INTERNAL_FLT_FN (COS, ECF_CONST, cos, unary)
 180 DEF_INTERNAL_FLT_FN (EXP, ECF_CONST, exp, unary)
 181 DEF_INTERNAL_FLT_FN (EXP10, ECF_CONST, exp10, unary)
 182 DEF_INTERNAL_FLT_FN (EXP2, ECF_CONST, exp2, unary)
 183 DEF_INTERNAL_FLT_FN (EXPM1, ECF_CONST, expm1, unary)
 184 DEF_INTERNAL_FLT_FN (LOG, ECF_CONST, log, unary)
 185 DEF_INTERNAL_FLT_FN (LOG10, ECF_CONST, log10, unary)
 186 DEF_INTERNAL_FLT_FN (LOG1P, ECF_CONST, log1p, unary)
 187 DEF_INTERNAL_FLT_FN (LOG2, ECF_CONST, log2, unary)
 188 DEF_INTERNAL_FLT_FN (LOGB, ECF_CONST, logb, unary)
 189 DEF_INTERNAL_FLT_FN (SIGNIFICAND, ECF_CONST, significand, unary)
 190 DEF_INTERNAL_FLT_FN (SIN, ECF_CONST, sin, unary)
 191 DEF_INTERNAL_FLT_FLOATN_FN (SQRT, ECF_CONST, sqrt, unary)
 192 DEF_INTERNAL_FLT_FN (TAN, ECF_CONST, tan, unary)
 193
 194 /* FP rounding.  */
 195 DEF_INTERNAL_FLT_FLOATN_FN (CEIL, ECF_CONST, ceil, unary)
 196 DEF_INTERNAL_FLT_FLOATN_FN (FLOOR, ECF_CONST, floor, unary)
 197 DEF_INTERNAL_FLT_FLOATN_FN (NEARBYINT, ECF_CONST, nearbyint, unary)
 198 DEF_INTERNAL_FLT_FLOATN_FN (RINT, ECF_CONST, rint, unary)
 199 DEF_INTERNAL_FLT_FLOATN_FN (ROUND, ECF_CONST, round, unary)
 200 DEF_INTERNAL_FLT_FLOATN_FN (TRUNC, ECF_CONST, btrunc, unary)
 201
 202 /* Binary math functions.  */
 203 DEF_INTERNAL_FLT_FN (ATAN2, ECF_CONST, atan2, binary)
 204 DEF_INTERNAL_FLT_FLOATN_FN (COPYSIGN, ECF_CONST, copysign, binary)
 205 DEF_INTERNAL_FLT_FN (FMOD, ECF_CONST, fmod, binary)
 206 DEF_INTERNAL_FLT_FN (POW, ECF_CONST, pow, binary)
 207 DEF_INTERNAL_FLT_FN (REMAINDER, ECF_CONST, remainder, binary)
 208 DEF_INTERNAL_FLT_FN (SCALB, ECF_CONST, scalb, binary)
 209 DEF_INTERNAL_FLT_FLOATN_FN (FMIN, ECF_CONST, fmin, binary)
 210 DEF_INTERNAL_FLT_FLOATN_FN (FMAX, ECF_CONST, fmax, binary)
 211 DEF_INTERNAL_OPTAB_FN (XORSIGN, ECF_CONST, xorsign, binary)
 212
 213 /* FP scales.  */
 214 DEF_INTERNAL_FLT_FN (LDEXP, ECF_CONST, ldexp, binary)
 215
 216 /* Unary integer ops.  */
 217 DEF_INTERNAL_INT_FN (CLRSB, ECF_CONST | ECF_NOTHROW, clrsb, unary)
 218 DEF_INTERNAL_INT_FN (CLZ, ECF_CONST | ECF_NOTHROW, clz, unary)
 219 DEF_INTERNAL_INT_FN (CTZ, ECF_CONST | ECF_NOTHROW, ctz, unary)
 220 DEF_INTERNAL_INT_FN (FFS, ECF_CONST | ECF_NOTHROW, ffs, unary)
 221 DEF_INTERNAL_INT_FN (PARITY, ECF_CONST | ECF_NOTHROW, parity, unary)
 222 DEF_INTERNAL_INT_FN (POPCOUNT, ECF_CONST | ECF_NOTHROW, popcount, unary)
 223
 224 DEF_INTERNAL_FN (GOMP_USE_SIMT, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 225 DEF_INTERNAL_FN (GOMP_SIMT_ENTER, ECF_LEAF | ECF_NOTHROW, NULL)
 226 DEF_INTERNAL_FN (GOMP_SIMT_ENTER_ALLOC, ECF_LEAF | ECF_NOTHROW, NULL)
 227 DEF_INTERNAL_FN (GOMP_SIMT_EXIT, ECF_LEAF | ECF_NOTHROW, NULL)
 228 DEF_INTERNAL_FN (GOMP_SIMT_LANE, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 229 DEF_INTERNAL_FN (GOMP_SIMT_VF, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 230 DEF_INTERNAL_FN (GOMP_SIMT_LAST_LANE, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 231 DEF_INTERNAL_FN (GOMP_SIMT_ORDERED_PRED, ECF_LEAF | ECF_NOTHROW, NULL)
 232 DEF_INTERNAL_FN (GOMP_SIMT_VOTE_ANY, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 233 DEF_INTERNAL_FN (GOMP_SIMT_XCHG_BFLY, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 234 DEF_INTERNAL_FN (GOMP_SIMT_XCHG_IDX, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 235 DEF_INTERNAL_FN (GOMP_SIMD_LANE, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 236 DEF_INTERNAL_FN (GOMP_SIMD_VF, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 237 DEF_INTERNAL_FN (GOMP_SIMD_LAST_LANE, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 238 DEF_INTERNAL_FN (GOMP_SIMD_ORDERED_START, ECF_LEAF | ECF_NOTHROW, NULL)
 239 DEF_INTERNAL_FN (GOMP_SIMD_ORDERED_END, ECF_LEAF | ECF_NOTHROW, NULL)
 240 DEF_INTERNAL_FN (LOOP_VECTORIZED, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 241 DEF_INTERNAL_FN (LOOP_DIST_ALIAS, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 242 DEF_INTERNAL_FN (ANNOTATE,  ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 243 DEF_INTERNAL_FN (UBSAN_NULL, ECF_LEAF | ECF_NOTHROW, ".R.")
 244 DEF_INTERNAL_FN (UBSAN_BOUNDS, ECF_LEAF | ECF_NOTHROW, NULL)
 245 DEF_INTERNAL_FN (UBSAN_VPTR, ECF_LEAF | ECF_NOTHROW, ".RR..")
 246 DEF_INTERNAL_FN (UBSAN_CHECK_ADD, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 247 DEF_INTERNAL_FN (UBSAN_CHECK_SUB, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 248 DEF_INTERNAL_FN (UBSAN_CHECK_MUL, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 249 DEF_INTERNAL_FN (UBSAN_PTR, ECF_LEAF | ECF_NOTHROW, ".R.")
 250 DEF_INTERNAL_FN (UBSAN_OBJECT_SIZE, ECF_LEAF | ECF_NOTHROW, NULL)
 251 DEF_INTERNAL_FN (ABNORMAL_DISPATCHER, ECF_NORETURN, NULL)
 252 DEF_INTERNAL_FN (BUILTIN_EXPECT, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 253 DEF_INTERNAL_FN (ASAN_CHECK, ECF_TM_PURE | ECF_LEAF | ECF_NOTHROW, ".R...")
 254 DEF_INTERNAL_FN (ASAN_MARK, ECF_LEAF | ECF_NOTHROW, ".R..")
 255 DEF_INTERNAL_FN (ASAN_POISON, ECF_LEAF | ECF_NOTHROW | ECF_NOVOPS, NULL)
 256 DEF_INTERNAL_FN (ASAN_POISON_USE, ECF_LEAF | ECF_NOTHROW | ECF_NOVOPS, NULL)
 257 DEF_INTERNAL_FN (ADD_OVERFLOW, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 258 DEF_INTERNAL_FN (SUB_OVERFLOW, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 259 DEF_INTERNAL_FN (MUL_OVERFLOW, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 260 DEF_INTERNAL_FN (TSAN_FUNC_EXIT, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 261 DEF_INTERNAL_FN (VA_ARG, ECF_NOTHROW | ECF_LEAF, NULL)
 262
 263 /* An unduplicable, uncombinable function.  Generally used to preserve
 264    a CFG property in the face of jump threading, tail merging or
 265    other such optimizations.  The first argument distinguishes
 266    between uses.  See internal-fn.h for usage.  */
 267 DEF_INTERNAL_FN (UNIQUE, ECF_NOTHROW, NULL)
 268 DEF_INTERNAL_FN (PHI, 0, NULL)
 269
 270 /* DIM_SIZE and DIM_POS return the size of a particular compute
 271    dimension and the executing thread's position within that
 272    dimension.  DIM_POS is pure (and not const) so that it isn't
 273    thought to clobber memory and can be gcse'd within a single
 274    parallel region, but not across FORK/JOIN boundaries.  They take a
 275    single INTEGER_CST argument.  This might be overly conservative.  */
 276 DEF_INTERNAL_FN (GOACC_DIM_SIZE, ECF_CONST | ECF_NOTHROW | ECF_LEAF, ".")
 277 DEF_INTERNAL_FN (GOACC_DIM_POS, ECF_PURE | ECF_NOTHROW | ECF_LEAF, ".")
 278
 279 /* OpenACC looping abstraction.  See internal-fn.h for usage.  */
 280 DEF_INTERNAL_FN (GOACC_LOOP, ECF_PURE | ECF_NOTHROW, NULL)
 281
 282 /* OpenACC reduction abstraction.  See internal-fn.h  for usage.  */
 283 DEF_INTERNAL_FN (GOACC_REDUCTION, ECF_NOTHROW | ECF_LEAF, NULL)
 284
 285 /* Openacc tile abstraction. Describes the spans of the element loop.
 286    GOACC_TILE (num-loops, loop-no, tile-arg, tile-mask, element-mask).  */
 287 DEF_INTERNAL_FN (GOACC_TILE, ECF_NOTHROW | ECF_LEAF, NULL)
 288
 289 /* Set errno to EDOM, if GCC knows how to do that directly for the
 290    current target.  */
 291 DEF_INTERNAL_FN (SET_EDOM, ECF_LEAF | ECF_NOTHROW, NULL)
 292
 293 /* Atomic functions.  These don't have ECF_NOTHROW because for
 294    -fnon-call-exceptions they can throw, otherwise we set
 295    gimple_call_nothrow_p on it.  */
 296 DEF_INTERNAL_FN (ATOMIC_BIT_TEST_AND_SET, ECF_LEAF, NULL)
 297 DEF_INTERNAL_FN (ATOMIC_BIT_TEST_AND_COMPLEMENT, ECF_LEAF, NULL)
 298 DEF_INTERNAL_FN (ATOMIC_BIT_TEST_AND_RESET, ECF_LEAF, NULL)
 299 DEF_INTERNAL_FN (ATOMIC_COMPARE_EXCHANGE, ECF_LEAF, NULL)
 300
 301 /* To implement [[fallthrough]].  */
 302 DEF_INTERNAL_FN (FALLTHROUGH, ECF_LEAF | ECF_NOTHROW, NULL)
 303
 304 /* To implement __builtin_launder.  */
 305 DEF_INTERNAL_FN (LAUNDER, ECF_LEAF | ECF_NOTHROW | ECF_NOVOPS, NULL)
 306
 307 /* Divmod function.  */
 308 DEF_INTERNAL_FN (DIVMOD, ECF_CONST | ECF_LEAF, NULL)
 309
 310 /* A NOP function with arbitrary arguments and return value.  */
 311 DEF_INTERNAL_FN (NOP, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 312
 313 #undef DEF_INTERNAL_INT_FN
 314 #undef DEF_INTERNAL_FLT_FN
 315 #undef DEF_INTERNAL_FLT_FLOATN_FN
 316 #undef DEF_INTERNAL_SIGNED_OPTAB_FN
 317 #undef DEF_INTERNAL_OPTAB_FN
 318 #undef DEF_INTERNAL_FN