CWG 616, 1213 - value category of subobject references.
[official-gcc.git] / gcc / internal-fn.def
bloba5f8504849054cfd0d6d0d2467ae4f3c05441f59
1 /* Internal functions.
2 Copyright (C) 2011-2018 Free Software Foundation, Inc.
4 This file is part of GCC.
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.
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.
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/>. */
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.
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.
29 Each entry in this file has one of the forms:
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)
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.
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:
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
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 - scatter_store: used for {mask_,}scatter_store
58 - unary: a normal unary optab, such as vec_reverse_<mode>
59 - binary: a normal binary optab, such as vec_interleave_lo_<mode>
60 - ternary: a normal ternary optab, such as fma<mode>4
62 - cond_binary: a conditional binary optab, such as add<mode>cc
64 - fold_left: for scalar = FN (scalar, vector), keyed off the vector mode
66 DEF_INTERNAL_SIGNED_OPTAB_FN defines an internal function that
67 maps to one of two optabs, depending on the signedness of an input.
68 SIGNED_OPTAB and UNSIGNED_OPTAB are the optabs for signed and
69 unsigned inputs respectively, both without the trailing "_optab".
70 SELECTOR says which type in the tree_pair determines the signedness.
72 DEF_INTERNAL_FLT_FN is like DEF_INTERNAL_OPTAB_FN, but in addition,
73 the function implements the computational part of a built-in math
74 function BUILT_IN_<NAME>{F,,L}. Unlike some built-in functions,
75 these internal functions never set errno.
77 DEF_INTERNAL_INT_FN is like DEF_INTERNAL_OPTAB_FN, but in addition
78 says that the function extends the C-level BUILT_IN_<NAME>{,L,LL,IMAX}
79 group of functions to any integral mode (including vector modes).
81 Each entry must have a corresponding expander of the form:
83 void expand_NAME (gimple_call stmt)
85 where STMT is the statement that performs the call. These are generated
86 automatically for optab functions and call out to a function or macro
87 called expand_<TYPE>_optab_fn. */
89 #ifndef DEF_INTERNAL_FN
90 #define DEF_INTERNAL_FN(CODE, FLAGS, FNSPEC)
91 #endif
93 #ifndef DEF_INTERNAL_OPTAB_FN
94 #define DEF_INTERNAL_OPTAB_FN(NAME, FLAGS, OPTAB, TYPE) \
95 DEF_INTERNAL_FN (NAME, FLAGS | ECF_LEAF, NULL)
96 #endif
98 #ifndef DEF_INTERNAL_SIGNED_OPTAB_FN
99 #define DEF_INTERNAL_SIGNED_OPTAB_FN(NAME, FLAGS, SELECTOR, SIGNED_OPTAB, \
100 UNSIGNED_OPTAB, TYPE) \
101 DEF_INTERNAL_FN (NAME, FLAGS | ECF_LEAF, NULL)
102 #endif
104 #ifndef DEF_INTERNAL_FLT_FN
105 #define DEF_INTERNAL_FLT_FN(NAME, FLAGS, OPTAB, TYPE) \
106 DEF_INTERNAL_OPTAB_FN (NAME, FLAGS, OPTAB, TYPE)
107 #endif
109 #ifndef DEF_INTERNAL_FLT_FLOATN_FN
110 #define DEF_INTERNAL_FLT_FLOATN_FN(NAME, FLAGS, OPTAB, TYPE) \
111 DEF_INTERNAL_FLT_FN (NAME, FLAGS, OPTAB, TYPE)
112 #endif
114 #ifndef DEF_INTERNAL_INT_FN
115 #define DEF_INTERNAL_INT_FN(NAME, FLAGS, OPTAB, TYPE) \
116 DEF_INTERNAL_OPTAB_FN (NAME, FLAGS, OPTAB, TYPE)
117 #endif
119 DEF_INTERNAL_OPTAB_FN (MASK_LOAD, ECF_PURE, maskload, mask_load)
120 DEF_INTERNAL_OPTAB_FN (LOAD_LANES, ECF_CONST, vec_load_lanes, load_lanes)
121 DEF_INTERNAL_OPTAB_FN (MASK_LOAD_LANES, ECF_PURE,
122 vec_mask_load_lanes, mask_load_lanes)
124 DEF_INTERNAL_OPTAB_FN (GATHER_LOAD, ECF_PURE, gather_load, gather_load)
125 DEF_INTERNAL_OPTAB_FN (MASK_GATHER_LOAD, ECF_PURE,
126 mask_gather_load, gather_load)
128 DEF_INTERNAL_OPTAB_FN (SCATTER_STORE, 0, scatter_store, scatter_store)
129 DEF_INTERNAL_OPTAB_FN (MASK_SCATTER_STORE, 0,
130 mask_scatter_store, scatter_store)
132 DEF_INTERNAL_OPTAB_FN (MASK_STORE, 0, maskstore, mask_store)
133 DEF_INTERNAL_OPTAB_FN (STORE_LANES, ECF_CONST, vec_store_lanes, store_lanes)
134 DEF_INTERNAL_OPTAB_FN (MASK_STORE_LANES, 0,
135 vec_mask_store_lanes, mask_store_lanes)
137 DEF_INTERNAL_OPTAB_FN (WHILE_ULT, ECF_CONST | ECF_NOTHROW, while_ult, while)
139 DEF_INTERNAL_OPTAB_FN (VEC_SHL_INSERT, ECF_CONST | ECF_NOTHROW,
140 vec_shl_insert, binary)
142 DEF_INTERNAL_OPTAB_FN (FMS, ECF_CONST, fms, ternary)
143 DEF_INTERNAL_OPTAB_FN (FNMA, ECF_CONST, fnma, ternary)
144 DEF_INTERNAL_OPTAB_FN (FNMS, ECF_CONST, fnms, ternary)
146 DEF_INTERNAL_OPTAB_FN (COND_ADD, ECF_CONST, cond_add, cond_binary)
147 DEF_INTERNAL_OPTAB_FN (COND_SUB, ECF_CONST, cond_sub, cond_binary)
148 DEF_INTERNAL_SIGNED_OPTAB_FN (COND_MIN, ECF_CONST, first,
149 cond_smin, cond_umin, cond_binary)
150 DEF_INTERNAL_SIGNED_OPTAB_FN (COND_MAX, ECF_CONST, first,
151 cond_smax, cond_umax, cond_binary)
152 DEF_INTERNAL_OPTAB_FN (COND_AND, ECF_CONST | ECF_NOTHROW,
153 cond_and, cond_binary)
154 DEF_INTERNAL_OPTAB_FN (COND_IOR, ECF_CONST | ECF_NOTHROW,
155 cond_ior, cond_binary)
156 DEF_INTERNAL_OPTAB_FN (COND_XOR, ECF_CONST | ECF_NOTHROW,
157 cond_xor, cond_binary)
159 DEF_INTERNAL_OPTAB_FN (RSQRT, ECF_CONST, rsqrt, unary)
161 DEF_INTERNAL_OPTAB_FN (REDUC_PLUS, ECF_CONST | ECF_NOTHROW,
162 reduc_plus_scal, unary)
163 DEF_INTERNAL_SIGNED_OPTAB_FN (REDUC_MAX, ECF_CONST | ECF_NOTHROW, first,
164 reduc_smax_scal, reduc_umax_scal, unary)
165 DEF_INTERNAL_SIGNED_OPTAB_FN (REDUC_MIN, ECF_CONST | ECF_NOTHROW, first,
166 reduc_smin_scal, reduc_umin_scal, unary)
167 DEF_INTERNAL_OPTAB_FN (REDUC_AND, ECF_CONST | ECF_NOTHROW,
168 reduc_and_scal, unary)
169 DEF_INTERNAL_OPTAB_FN (REDUC_IOR, ECF_CONST | ECF_NOTHROW,
170 reduc_ior_scal, unary)
171 DEF_INTERNAL_OPTAB_FN (REDUC_XOR, ECF_CONST | ECF_NOTHROW,
172 reduc_xor_scal, unary)
174 /* Extract the last active element from a vector. */
175 DEF_INTERNAL_OPTAB_FN (EXTRACT_LAST, ECF_CONST | ECF_NOTHROW,
176 extract_last, cond_unary)
178 /* Same, but return the first argument if no elements are active. */
179 DEF_INTERNAL_OPTAB_FN (FOLD_EXTRACT_LAST, ECF_CONST | ECF_NOTHROW,
180 fold_extract_last, fold_extract)
182 DEF_INTERNAL_OPTAB_FN (FOLD_LEFT_PLUS, ECF_CONST | ECF_NOTHROW,
183 fold_left_plus, fold_left)
185 /* Unary math functions. */
186 DEF_INTERNAL_FLT_FN (ACOS, ECF_CONST, acos, unary)
187 DEF_INTERNAL_FLT_FN (ASIN, ECF_CONST, asin, unary)
188 DEF_INTERNAL_FLT_FN (ATAN, ECF_CONST, atan, unary)
189 DEF_INTERNAL_FLT_FN (COS, ECF_CONST, cos, unary)
190 DEF_INTERNAL_FLT_FN (EXP, ECF_CONST, exp, unary)
191 DEF_INTERNAL_FLT_FN (EXP10, ECF_CONST, exp10, unary)
192 DEF_INTERNAL_FLT_FN (EXP2, ECF_CONST, exp2, unary)
193 DEF_INTERNAL_FLT_FN (EXPM1, ECF_CONST, expm1, unary)
194 DEF_INTERNAL_FLT_FN (LOG, ECF_CONST, log, unary)
195 DEF_INTERNAL_FLT_FN (LOG10, ECF_CONST, log10, unary)
196 DEF_INTERNAL_FLT_FN (LOG1P, ECF_CONST, log1p, unary)
197 DEF_INTERNAL_FLT_FN (LOG2, ECF_CONST, log2, unary)
198 DEF_INTERNAL_FLT_FN (LOGB, ECF_CONST, logb, unary)
199 DEF_INTERNAL_FLT_FN (SIGNIFICAND, ECF_CONST, significand, unary)
200 DEF_INTERNAL_FLT_FN (SIN, ECF_CONST, sin, unary)
201 DEF_INTERNAL_FLT_FLOATN_FN (SQRT, ECF_CONST, sqrt, unary)
202 DEF_INTERNAL_FLT_FN (TAN, ECF_CONST, tan, unary)
204 /* FP rounding. */
205 DEF_INTERNAL_FLT_FLOATN_FN (CEIL, ECF_CONST, ceil, unary)
206 DEF_INTERNAL_FLT_FLOATN_FN (FLOOR, ECF_CONST, floor, unary)
207 DEF_INTERNAL_FLT_FLOATN_FN (NEARBYINT, ECF_CONST, nearbyint, unary)
208 DEF_INTERNAL_FLT_FLOATN_FN (RINT, ECF_CONST, rint, unary)
209 DEF_INTERNAL_FLT_FLOATN_FN (ROUND, ECF_CONST, round, unary)
210 DEF_INTERNAL_FLT_FLOATN_FN (TRUNC, ECF_CONST, btrunc, unary)
212 /* Binary math functions. */
213 DEF_INTERNAL_FLT_FN (ATAN2, ECF_CONST, atan2, binary)
214 DEF_INTERNAL_FLT_FLOATN_FN (COPYSIGN, ECF_CONST, copysign, binary)
215 DEF_INTERNAL_FLT_FN (FMOD, ECF_CONST, fmod, binary)
216 DEF_INTERNAL_FLT_FN (POW, ECF_CONST, pow, binary)
217 DEF_INTERNAL_FLT_FN (REMAINDER, ECF_CONST, remainder, binary)
218 DEF_INTERNAL_FLT_FN (SCALB, ECF_CONST, scalb, binary)
219 DEF_INTERNAL_FLT_FLOATN_FN (FMIN, ECF_CONST, fmin, binary)
220 DEF_INTERNAL_FLT_FLOATN_FN (FMAX, ECF_CONST, fmax, binary)
221 DEF_INTERNAL_OPTAB_FN (XORSIGN, ECF_CONST, xorsign, binary)
223 /* FP scales. */
224 DEF_INTERNAL_FLT_FN (LDEXP, ECF_CONST, ldexp, binary)
226 /* Ternary math functions. */
227 DEF_INTERNAL_FLT_FN (FMA, ECF_CONST, fma, ternary)
229 /* Unary integer ops. */
230 DEF_INTERNAL_INT_FN (CLRSB, ECF_CONST | ECF_NOTHROW, clrsb, unary)
231 DEF_INTERNAL_INT_FN (CLZ, ECF_CONST | ECF_NOTHROW, clz, unary)
232 DEF_INTERNAL_INT_FN (CTZ, ECF_CONST | ECF_NOTHROW, ctz, unary)
233 DEF_INTERNAL_INT_FN (FFS, ECF_CONST | ECF_NOTHROW, ffs, unary)
234 DEF_INTERNAL_INT_FN (PARITY, ECF_CONST | ECF_NOTHROW, parity, unary)
235 DEF_INTERNAL_INT_FN (POPCOUNT, ECF_CONST | ECF_NOTHROW, popcount, unary)
237 DEF_INTERNAL_FN (GOMP_USE_SIMT, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
238 DEF_INTERNAL_FN (GOMP_SIMT_ENTER, ECF_LEAF | ECF_NOTHROW, NULL)
239 DEF_INTERNAL_FN (GOMP_SIMT_ENTER_ALLOC, ECF_LEAF | ECF_NOTHROW, NULL)
240 DEF_INTERNAL_FN (GOMP_SIMT_EXIT, ECF_LEAF | ECF_NOTHROW, NULL)
241 DEF_INTERNAL_FN (GOMP_SIMT_LANE, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
242 DEF_INTERNAL_FN (GOMP_SIMT_VF, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
243 DEF_INTERNAL_FN (GOMP_SIMT_LAST_LANE, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
244 DEF_INTERNAL_FN (GOMP_SIMT_ORDERED_PRED, ECF_LEAF | ECF_NOTHROW, NULL)
245 DEF_INTERNAL_FN (GOMP_SIMT_VOTE_ANY, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
246 DEF_INTERNAL_FN (GOMP_SIMT_XCHG_BFLY, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
247 DEF_INTERNAL_FN (GOMP_SIMT_XCHG_IDX, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
248 DEF_INTERNAL_FN (GOMP_SIMD_LANE, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
249 DEF_INTERNAL_FN (GOMP_SIMD_VF, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
250 DEF_INTERNAL_FN (GOMP_SIMD_LAST_LANE, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
251 DEF_INTERNAL_FN (GOMP_SIMD_ORDERED_START, ECF_LEAF | ECF_NOTHROW, NULL)
252 DEF_INTERNAL_FN (GOMP_SIMD_ORDERED_END, ECF_LEAF | ECF_NOTHROW, NULL)
253 DEF_INTERNAL_FN (LOOP_VECTORIZED, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
254 DEF_INTERNAL_FN (LOOP_DIST_ALIAS, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
255 DEF_INTERNAL_FN (ANNOTATE, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
256 DEF_INTERNAL_FN (UBSAN_NULL, ECF_LEAF | ECF_NOTHROW, ".R.")
257 DEF_INTERNAL_FN (UBSAN_BOUNDS, ECF_LEAF | ECF_NOTHROW, NULL)
258 DEF_INTERNAL_FN (UBSAN_VPTR, ECF_LEAF | ECF_NOTHROW, ".RR..")
259 DEF_INTERNAL_FN (UBSAN_CHECK_ADD, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
260 DEF_INTERNAL_FN (UBSAN_CHECK_SUB, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
261 DEF_INTERNAL_FN (UBSAN_CHECK_MUL, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
262 DEF_INTERNAL_FN (UBSAN_PTR, ECF_LEAF | ECF_NOTHROW, ".R.")
263 DEF_INTERNAL_FN (UBSAN_OBJECT_SIZE, ECF_LEAF | ECF_NOTHROW, NULL)
264 DEF_INTERNAL_FN (ABNORMAL_DISPATCHER, ECF_NORETURN, NULL)
265 DEF_INTERNAL_FN (BUILTIN_EXPECT, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
266 DEF_INTERNAL_FN (ASAN_CHECK, ECF_TM_PURE | ECF_LEAF | ECF_NOTHROW, "..R..")
267 DEF_INTERNAL_FN (ASAN_MARK, ECF_LEAF | ECF_NOTHROW, NULL)
268 DEF_INTERNAL_FN (ASAN_POISON, ECF_LEAF | ECF_NOTHROW | ECF_NOVOPS, NULL)
269 DEF_INTERNAL_FN (ASAN_POISON_USE, ECF_LEAF | ECF_NOTHROW | ECF_NOVOPS, NULL)
270 DEF_INTERNAL_FN (ADD_OVERFLOW, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
271 DEF_INTERNAL_FN (SUB_OVERFLOW, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
272 DEF_INTERNAL_FN (MUL_OVERFLOW, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
273 DEF_INTERNAL_FN (TSAN_FUNC_EXIT, ECF_NOVOPS | ECF_LEAF | ECF_NOTHROW, NULL)
274 DEF_INTERNAL_FN (VA_ARG, ECF_NOTHROW | ECF_LEAF, NULL)
276 /* An unduplicable, uncombinable function. Generally used to preserve
277 a CFG property in the face of jump threading, tail merging or
278 other such optimizations. The first argument distinguishes
279 between uses. See internal-fn.h for usage. */
280 DEF_INTERNAL_FN (UNIQUE, ECF_NOTHROW, NULL)
281 DEF_INTERNAL_FN (PHI, 0, NULL)
283 /* DIM_SIZE and DIM_POS return the size of a particular compute
284 dimension and the executing thread's position within that
285 dimension. DIM_POS is pure (and not const) so that it isn't
286 thought to clobber memory and can be gcse'd within a single
287 parallel region, but not across FORK/JOIN boundaries. They take a
288 single INTEGER_CST argument. This might be overly conservative. */
289 DEF_INTERNAL_FN (GOACC_DIM_SIZE, ECF_CONST | ECF_NOTHROW | ECF_LEAF, ".")
290 DEF_INTERNAL_FN (GOACC_DIM_POS, ECF_PURE | ECF_NOTHROW | ECF_LEAF, ".")
292 /* OpenACC looping abstraction. See internal-fn.h for usage. */
293 DEF_INTERNAL_FN (GOACC_LOOP, ECF_PURE | ECF_NOTHROW, NULL)
295 /* OpenACC reduction abstraction. See internal-fn.h for usage. */
296 DEF_INTERNAL_FN (GOACC_REDUCTION, ECF_NOTHROW | ECF_LEAF, NULL)
298 /* Openacc tile abstraction. Describes the spans of the element loop.
299 GOACC_TILE (num-loops, loop-no, tile-arg, tile-mask, element-mask). */
300 DEF_INTERNAL_FN (GOACC_TILE, ECF_NOTHROW | ECF_LEAF, NULL)
302 /* Set errno to EDOM, if GCC knows how to do that directly for the
303 current target. */
304 DEF_INTERNAL_FN (SET_EDOM, ECF_LEAF | ECF_NOTHROW, NULL)
306 /* Atomic functions. These don't have ECF_NOTHROW because for
307 -fnon-call-exceptions they can throw, otherwise we set
308 gimple_call_nothrow_p on it. */
309 DEF_INTERNAL_FN (ATOMIC_BIT_TEST_AND_SET, ECF_LEAF, NULL)
310 DEF_INTERNAL_FN (ATOMIC_BIT_TEST_AND_COMPLEMENT, ECF_LEAF, NULL)
311 DEF_INTERNAL_FN (ATOMIC_BIT_TEST_AND_RESET, ECF_LEAF, NULL)
312 DEF_INTERNAL_FN (ATOMIC_COMPARE_EXCHANGE, ECF_LEAF, NULL)
314 /* To implement [[fallthrough]]. */
315 DEF_INTERNAL_FN (FALLTHROUGH, ECF_LEAF | ECF_NOTHROW, NULL)
317 /* To implement __builtin_launder. */
318 DEF_INTERNAL_FN (LAUNDER, ECF_LEAF | ECF_NOTHROW | ECF_NOVOPS, NULL)
320 /* Divmod function. */
321 DEF_INTERNAL_FN (DIVMOD, ECF_CONST | ECF_LEAF, NULL)
323 /* A NOP function with arbitrary arguments and return value. */
324 DEF_INTERNAL_FN (NOP, ECF_CONST | ECF_LEAF | ECF_NOTHROW, NULL)
326 #undef DEF_INTERNAL_INT_FN
327 #undef DEF_INTERNAL_FLT_FN
328 #undef DEF_INTERNAL_FLT_FLOATN_FN
329 #undef DEF_INTERNAL_SIGNED_OPTAB_FN
330 #undef DEF_INTERNAL_OPTAB_FN
331 #undef DEF_INTERNAL_FN