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
  52    - mask_store: currently just maskstore
  53    - store_lanes: currently just vec_store_lanes
  54    - mask_store_lanes: currently just vec_mask_store_lanes
  55
  56    DEF_INTERNAL_SIGNED_OPTAB_FN defines an internal function that
  57    maps to one of two optabs, depending on the signedness of an input.
  58    SIGNED_OPTAB and UNSIGNED_OPTAB are the optabs for signed and
  59    unsigned inputs respectively, both without the trailing "_optab".
  60    SELECTOR says which type in the tree_pair determines the signedness.
  61
  62    DEF_INTERNAL_FLT_FN is like DEF_INTERNAL_OPTAB_FN, but in addition,
  63    the function implements the computational part of a built-in math
  64    function BUILT_IN_<NAME>{F,,L}.  Unlike some built-in functions,
  65    these internal functions never set errno.
  66
  67    DEF_INTERNAL_INT_FN is like DEF_INTERNAL_OPTAB_FN, but in addition
  68    says that the function extends the C-level BUILT_IN_<NAME>{,L,LL,IMAX}
  69    group of functions to any integral mode (including vector modes).
  70
  71    Each entry must have a corresponding expander of the form:
  72
  73      void expand_NAME (gimple_call stmt)
  74
  75    where STMT is the statement that performs the call.  These are generated
  76    automatically for optab functions and call out to a function or macro
  77    called expand_<TYPE>_optab_fn.  */
  78
  79 #ifndef DEF_INTERNAL_FN
  80 #define DEF_INTERNAL_FN(CODE, FLAGS, FNSPEC)
  81 #endif
  82
  83 #ifndef DEF_INTERNAL_OPTAB_FN
  84 #define DEF_INTERNAL_OPTAB_FN(NAME, FLAGS, OPTAB, TYPE) \
  85   DEF_INTERNAL_FN (NAME, FLAGS | ECF_LEAF, NULL)
  86 #endif
  87
  88 #ifndef DEF_INTERNAL_SIGNED_OPTAB_FN
  89 #define DEF_INTERNAL_SIGNED_OPTAB_FN(NAME, FLAGS, SELECTOR, SIGNED_OPTAB, \
  90                                      UNSIGNED_OPTAB, TYPE) \
  91   DEF_INTERNAL_FN (NAME, FLAGS | ECF_LEAF, NULL)
  92 #endif
  93
  94 #ifndef DEF_INTERNAL_FLT_FN
  95 #define DEF_INTERNAL_FLT_FN(NAME, FLAGS, OPTAB, TYPE) \
  96   DEF_INTERNAL_OPTAB_FN (NAME, FLAGS, OPTAB, TYPE)
  97 #endif
  98
  99 #ifndef DEF_INTERNAL_FLT_FLOATN_FN
 100 #define DEF_INTERNAL_FLT_FLOATN_FN(NAME, FLAGS, OPTAB, TYPE) \
 101   DEF_INTERNAL_FLT_FN (NAME, FLAGS, OPTAB, TYPE)
 102 #endif
 103
 104 #ifndef DEF_INTERNAL_INT_FN
 105 #define DEF_INTERNAL_INT_FN(NAME, FLAGS, OPTAB, TYPE) \
 106   DEF_INTERNAL_OPTAB_FN (NAME, FLAGS, OPTAB, TYPE)
 107 #endif
 108
 109 DEF_INTERNAL_OPTAB_FN (MASK_LOAD, ECF_PURE, maskload, mask_load)
 110 DEF_INTERNAL_OPTAB_FN (LOAD_LANES, ECF_CONST, vec_load_lanes, load_lanes)
 111 DEF_INTERNAL_OPTAB_FN (MASK_LOAD_LANES, ECF_PURE,
 112                        vec_mask_load_lanes, mask_load_lanes)
 113
 114 DEF_INTERNAL_OPTAB_FN (MASK_STORE, 0, maskstore, mask_store)
 115 DEF_INTERNAL_OPTAB_FN (STORE_LANES, ECF_CONST, vec_store_lanes, store_lanes)
 116 DEF_INTERNAL_OPTAB_FN (MASK_STORE_LANES, 0,
 117                        vec_mask_store_lanes, mask_store_lanes)
 118
 119 DEF_INTERNAL_OPTAB_FN (WHILE_ULT, ECF_CONST | ECF_NOTHROW, while_ult, while)
 120
 121 DEF_INTERNAL_OPTAB_FN (VEC_SHL_INSERT, ECF_CONST | ECF_NOTHROW,
 122                        vec_shl_insert, binary)
 123
 124 DEF_INTERNAL_OPTAB_FN (RSQRT, ECF_CONST, rsqrt, unary)
 125
 126 DEF_INTERNAL_OPTAB_FN (REDUC_PLUS, ECF_CONST | ECF_NOTHROW,
 127                        reduc_plus_scal, unary)
 128 DEF_INTERNAL_SIGNED_OPTAB_FN (REDUC_MAX, ECF_CONST | ECF_NOTHROW, first,
 129                               reduc_smax_scal, reduc_umax_scal, unary)
 130 DEF_INTERNAL_SIGNED_OPTAB_FN (REDUC_MIN, ECF_CONST | ECF_NOTHROW, first,
 131                               reduc_smin_scal, reduc_umin_scal, unary)
 132 DEF_INTERNAL_OPTAB_FN (REDUC_AND, ECF_CONST | ECF_NOTHROW,
 133                        reduc_and_scal, unary)
 134 DEF_INTERNAL_OPTAB_FN (REDUC_IOR, ECF_CONST | ECF_NOTHROW,
 135                        reduc_ior_scal, unary)
 136 DEF_INTERNAL_OPTAB_FN (REDUC_XOR, ECF_CONST | ECF_NOTHROW,
 137                        reduc_xor_scal, unary)
 138
 139 /* Unary math functions.  */
 140 DEF_INTERNAL_FLT_FN (ACOS, ECF_CONST, acos, unary)
 141 DEF_INTERNAL_FLT_FN (ASIN, ECF_CONST, asin, unary)
 142 DEF_INTERNAL_FLT_FN (ATAN, ECF_CONST, atan, unary)
 143 DEF_INTERNAL_FLT_FN (COS, ECF_CONST, cos, unary)
 144 DEF_INTERNAL_FLT_FN (EXP, ECF_CONST, exp, unary)
 145 DEF_INTERNAL_FLT_FN (EXP10, ECF_CONST, exp10, unary)
 146 DEF_INTERNAL_FLT_FN (EXP2, ECF_CONST, exp2, unary)
 147 DEF_INTERNAL_FLT_FN (EXPM1, ECF_CONST, expm1, unary)
 148 DEF_INTERNAL_FLT_FN (LOG, ECF_CONST, log, unary)
 149 DEF_INTERNAL_FLT_FN (LOG10, ECF_CONST, log10, unary)
 150 DEF_INTERNAL_FLT_FN (LOG1P, ECF_CONST, log1p, unary)
 151 DEF_INTERNAL_FLT_FN (LOG2, ECF_CONST, log2, unary)
 152 DEF_INTERNAL_FLT_FN (LOGB, ECF_CONST, logb, unary)
 153 DEF_INTERNAL_FLT_FN (SIGNIFICAND, ECF_CONST, significand, unary)
 154 DEF_INTERNAL_FLT_FN (SIN, ECF_CONST, sin, unary)
 155 DEF_INTERNAL_FLT_FLOATN_FN (SQRT, ECF_CONST, sqrt, unary)
 156 DEF_INTERNAL_FLT_FN (TAN, ECF_CONST, tan, unary)
 157
 158 /* FP rounding.  */
 159 DEF_INTERNAL_FLT_FLOATN_FN (CEIL, ECF_CONST, ceil, unary)
 160 DEF_INTERNAL_FLT_FLOATN_FN (FLOOR, ECF_CONST, floor, unary)
 161 DEF_INTERNAL_FLT_FLOATN_FN (NEARBYINT, ECF_CONST, nearbyint, unary)
 162 DEF_INTERNAL_FLT_FLOATN_FN (RINT, ECF_CONST, rint, unary)
 163 DEF_INTERNAL_FLT_FLOATN_FN (ROUND, ECF_CONST, round, unary)
 164 DEF_INTERNAL_FLT_FLOATN_FN (TRUNC, ECF_CONST, btrunc, unary)
 165
 166 /* Binary math functions.  */
 167 DEF_INTERNAL_FLT_FN (ATAN2, ECF_CONST, atan2, binary)
 168 DEF_INTERNAL_FLT_FLOATN_FN (COPYSIGN, ECF_CONST, copysign, binary)
 169 DEF_INTERNAL_FLT_FN (FMOD, ECF_CONST, fmod, binary)
 170 DEF_INTERNAL_FLT_FN (POW, ECF_CONST, pow, binary)
 171 DEF_INTERNAL_FLT_FN (REMAINDER, ECF_CONST, remainder, binary)
 172 DEF_INTERNAL_FLT_FN (SCALB, ECF_CONST, scalb, binary)
 173 DEF_INTERNAL_FLT_FLOATN_FN (FMIN, ECF_CONST, fmin, binary)
 174 DEF_INTERNAL_FLT_FLOATN_FN (FMAX, ECF_CONST, fmax, binary)
 175 DEF_INTERNAL_OPTAB_FN (XORSIGN, ECF_CONST, xorsign, binary)
 176
 177 /* FP scales.  */
 178 DEF_INTERNAL_FLT_FN (LDEXP, ECF_CONST, ldexp, binary)
 179
 180 /* Unary integer ops.  */
 181 DEF_INTERNAL_INT_FN (CLRSB, ECF_CONST | ECF_NOTHROW, clrsb, unary)
 182 DEF_INTERNAL_INT_FN (CLZ, ECF_CONST | ECF_NOTHROW, clz, unary)
 183 DEF_INTERNAL_INT_FN (CTZ, ECF_CONST | ECF_NOTHROW, ctz, unary)
 184 DEF_INTERNAL_INT_FN (FFS, ECF_CONST | ECF_NOTHROW, ffs, unary)
 185 DEF_INTERNAL_INT_FN (PARITY, ECF_CONST | ECF_NOTHROW, parity, unary)
 186 DEF_INTERNAL_INT_FN (POPCOUNT, ECF_CONST | ECF_NOTHROW, popcount, unary)
 187
 188 DEF_INTERNAL_FN (GOMP_USE_SIMT, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 189 DEF_INTERNAL_FN (GOMP_SIMT_ENTER, ECF_LEAF | ECF_NOTHROW, NULL)
 190 DEF_INTERNAL_FN (GOMP_SIMT_ENTER_ALLOC, ECF_LEAF | ECF_NOTHROW, NULL)
 191 DEF_INTERNAL_FN (GOMP_SIMT_EXIT, ECF_LEAF | ECF_NOTHROW, NULL)
 192 DEF_INTERNAL_FN (GOMP_SIMT_LANE, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 193 DEF_INTERNAL_FN (GOMP_SIMT_VF, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 194 DEF_INTERNAL_FN (GOMP_SIMT_LAST_LANE, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 195 DEF_INTERNAL_FN (GOMP_SIMT_ORDERED_PRED, ECF_LEAF | ECF_NOTHROW, NULL)
 196 DEF_INTERNAL_FN (GOMP_SIMT_VOTE_ANY, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 197 DEF_INTERNAL_FN (GOMP_SIMT_XCHG_BFLY, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 198 DEF_INTERNAL_FN (GOMP_SIMT_XCHG_IDX, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 199 DEF_INTERNAL_FN (GOMP_SIMD_LANE, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 200 DEF_INTERNAL_FN (GOMP_SIMD_VF, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 201 DEF_INTERNAL_FN (GOMP_SIMD_LAST_LANE, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 202 DEF_INTERNAL_FN (GOMP_SIMD_ORDERED_START, ECF_LEAF | ECF_NOTHROW, NULL)
 203 DEF_INTERNAL_FN (GOMP_SIMD_ORDERED_END, ECF_LEAF | ECF_NOTHROW, NULL)
 204 DEF_INTERNAL_FN (LOOP_VECTORIZED, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 205 DEF_INTERNAL_FN (LOOP_DIST_ALIAS, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 206 DEF_INTERNAL_FN (ANNOTATE,  ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 207 DEF_INTERNAL_FN (UBSAN_NULL, ECF_LEAF | ECF_NOTHROW, ".R.")
 208 DEF_INTERNAL_FN (UBSAN_BOUNDS, ECF_LEAF | ECF_NOTHROW, NULL)
 209 DEF_INTERNAL_FN (UBSAN_VPTR, ECF_LEAF | ECF_NOTHROW, ".RR..")
 210 DEF_INTERNAL_FN (UBSAN_CHECK_ADD, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 211 DEF_INTERNAL_FN (UBSAN_CHECK_SUB, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 212 DEF_INTERNAL_FN (UBSAN_CHECK_MUL, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 213 DEF_INTERNAL_FN (UBSAN_PTR, ECF_LEAF | ECF_NOTHROW, ".R.")
 214 DEF_INTERNAL_FN (UBSAN_OBJECT_SIZE, ECF_LEAF | ECF_NOTHROW, NULL)
 215 DEF_INTERNAL_FN (ABNORMAL_DISPATCHER, ECF_NORETURN, NULL)
 216 DEF_INTERNAL_FN (BUILTIN_EXPECT, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 217 DEF_INTERNAL_FN (ASAN_CHECK, ECF_TM_PURE | ECF_LEAF | ECF_NOTHROW, ".R...")
 218 DEF_INTERNAL_FN (ASAN_MARK, ECF_LEAF | ECF_NOTHROW, ".R..")
 219 DEF_INTERNAL_FN (ASAN_POISON, ECF_LEAF | ECF_NOTHROW | ECF_NOVOPS, NULL)
 220 DEF_INTERNAL_FN (ASAN_POISON_USE, ECF_LEAF | ECF_NOTHROW | ECF_NOVOPS, NULL)
 221 DEF_INTERNAL_FN (ADD_OVERFLOW, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 222 DEF_INTERNAL_FN (SUB_OVERFLOW, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 223 DEF_INTERNAL_FN (MUL_OVERFLOW, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 224 DEF_INTERNAL_FN (TSAN_FUNC_EXIT, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
 225 DEF_INTERNAL_FN (VA_ARG, ECF_NOTHROW | ECF_LEAF, NULL)
 226
 227 /* An unduplicable, uncombinable function.  Generally used to preserve
 228    a CFG property in the face of jump threading, tail merging or
 229    other such optimizations.  The first argument distinguishes
 230    between uses.  See internal-fn.h for usage.  */
 231 DEF_INTERNAL_FN (UNIQUE, ECF_NOTHROW, NULL)
 232 DEF_INTERNAL_FN (PHI, 0, NULL)
 233
 234 /* DIM_SIZE and DIM_POS return the size of a particular compute
 235    dimension and the executing thread's position within that
 236    dimension.  DIM_POS is pure (and not const) so that it isn't
 237    thought to clobber memory and can be gcse'd within a single
 238    parallel region, but not across FORK/JOIN boundaries.  They take a
 239    single INTEGER_CST argument.  This might be overly conservative.  */
 240 DEF_INTERNAL_FN (GOACC_DIM_SIZE, ECF_CONST | ECF_NOTHROW | ECF_LEAF, ".")
 241 DEF_INTERNAL_FN (GOACC_DIM_POS, ECF_PURE | ECF_NOTHROW | ECF_LEAF, ".")
 242
 243 /* OpenACC looping abstraction.  See internal-fn.h for usage.  */
 244 DEF_INTERNAL_FN (GOACC_LOOP, ECF_PURE | ECF_NOTHROW, NULL)
 245
 246 /* OpenACC reduction abstraction.  See internal-fn.h  for usage.  */
 247 DEF_INTERNAL_FN (GOACC_REDUCTION, ECF_NOTHROW | ECF_LEAF, NULL)
 248
 249 /* Openacc tile abstraction. Describes the spans of the element loop.
 250    GOACC_TILE (num-loops, loop-no, tile-arg, tile-mask, element-mask).  */
 251 DEF_INTERNAL_FN (GOACC_TILE, ECF_NOTHROW | ECF_LEAF, NULL)
 252
 253 /* Set errno to EDOM, if GCC knows how to do that directly for the
 254    current target.  */
 255 DEF_INTERNAL_FN (SET_EDOM, ECF_LEAF | ECF_NOTHROW, NULL)
 256
 257 /* Atomic functions.  These don't have ECF_NOTHROW because for
 258    -fnon-call-exceptions they can throw, otherwise we set
 259    gimple_call_nothrow_p on it.  */
 260 DEF_INTERNAL_FN (ATOMIC_BIT_TEST_AND_SET, ECF_LEAF, NULL)
 261 DEF_INTERNAL_FN (ATOMIC_BIT_TEST_AND_COMPLEMENT, ECF_LEAF, NULL)
 262 DEF_INTERNAL_FN (ATOMIC_BIT_TEST_AND_RESET, ECF_LEAF, NULL)
 263 DEF_INTERNAL_FN (ATOMIC_COMPARE_EXCHANGE, ECF_LEAF, NULL)
 264
 265 /* To implement [[fallthrough]].  */
 266 DEF_INTERNAL_FN (FALLTHROUGH, ECF_LEAF | ECF_NOTHROW, NULL)
 267
 268 /* To implement __builtin_launder.  */
 269 DEF_INTERNAL_FN (LAUNDER, ECF_LEAF | ECF_NOTHROW | ECF_NOVOPS, NULL)
 270
 271 /* Divmod function.  */
 272 DEF_INTERNAL_FN (DIVMOD, ECF_CONST | ECF_LEAF, NULL)
 273
 274 /* A NOP function with arbitrary arguments and return value.  */
 275 DEF_INTERNAL_FN (NOP, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
 276
 277 #undef DEF_INTERNAL_INT_FN
 278 #undef DEF_INTERNAL_FLT_FN
 279 #undef DEF_INTERNAL_FLT_FLOATN_FN
 280 #undef DEF_INTERNAL_SIGNED_OPTAB_FN
 281 #undef DEF_INTERNAL_OPTAB_FN
 282 #undef DEF_INTERNAL_FN