GCC Middle and Back End API Reference
internal-fn.h
Go to the documentation of this file.
1/* Internal functions.
2 Copyright (C) 2011-2024 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
19
20#ifndef GCC_INTERNAL_FN_H
21#define GCC_INTERNAL_FN_H
22
23#include "insn-codes.h"
24#include "insn-opinit.h"
25
26
27/* INTEGER_CST values for IFN_UNIQUE function arg-0.
28
29 UNSPEC: Undifferentiated UNIQUE.
30
31 FORK and JOIN mark the points at which OpenACC partitioned
32 execution is entered or exited.
33 DEP_VAR = UNIQUE ({FORK,JOIN}, DEP_VAR, AXIS)
34
35 HEAD_MARK and TAIL_MARK are used to demark the sequence entering
36 or leaving partitioned execution.
37 DEP_VAR = UNIQUE ({HEAD,TAIL}_MARK, REMAINING_MARKS, ...PRIMARY_FLAGS)
38
39 The PRIMARY_FLAGS only occur on the first HEAD_MARK of a sequence.
40
41 PRIVATE captures variables to be made private at the surrounding parallelism
42 level. */
43#define IFN_UNIQUE_CODES \
44 DEF(UNSPEC), \
45 DEF(OACC_FORK), DEF(OACC_JOIN), \
46 DEF(OACC_HEAD_MARK), DEF(OACC_TAIL_MARK), \
47 DEF(OACC_PRIVATE)
48
50#define DEF(X) IFN_UNIQUE_##X
52#undef DEF
53};
54
55/* INTEGER_CST values for IFN_GOACC_LOOP arg-0. Allows the precise
56 stepping of the compute geometry over the loop iterations to be
57 deferred until it is known which compiler is generating the code.
58 The action is encoded in a constant first argument.
59
60 CHUNK_MAX = LOOP (CODE_CHUNKS, DIR, RANGE, STEP, CHUNK_SIZE, MASK)
61 STEP = LOOP (CODE_STEP, DIR, RANGE, STEP, CHUNK_SIZE, MASK)
62 OFFSET = LOOP (CODE_OFFSET, DIR, RANGE, STEP, CHUNK_SIZE, MASK, CHUNK_NO)
63 BOUND = LOOP (CODE_BOUND, DIR, RANGE, STEP, CHUNK_SIZE, MASK, OFFSET)
64
65 DIR - +1 for up loop, -1 for down loop
66 RANGE - Range of loop (END - BASE)
67 STEP - iteration step size
68 CHUNKING - size of chunking, (constant zero for no chunking)
69 CHUNK_NO - chunk number
70 MASK - partitioning mask. */
71
72#define IFN_GOACC_LOOP_CODES \
73 DEF(CHUNKS), DEF(STEP), DEF(OFFSET), DEF(BOUND)
75#define DEF(X) IFN_GOACC_LOOP_##X
77#undef DEF
78};
79
80/* The GOACC_REDUCTION function defines a generic interface to support
81 gang, worker and vector reductions. All calls are of the following
82 form:
83
84 V = REDUCTION (CODE, REF_TO_RES, LOCAL_VAR, LEVEL, OP, OFFSET)
85
86 REF_TO_RES - is a reference to the original reduction varl, may be NULL
87 LOCAL_VAR is the intermediate reduction variable
88 LEVEL corresponds to the GOMP_DIM of the reduction
89 OP is the tree code of the reduction operation
90 OFFSET may be used as an offset into a reduction array for the
91 reductions occuring at this level.
92 In general the return value is LOCAL_VAR, which creates a data
93 dependency between calls operating on the same reduction. */
94
95#define IFN_GOACC_REDUCTION_CODES \
96 DEF(SETUP), DEF(INIT), DEF(FINI), DEF(TEARDOWN)
98#define DEF(X) IFN_GOACC_REDUCTION_##X
100#undef DEF
102
103/* Initialize internal function tables. */
104
105extern void init_internal_fns ();
106
107/* Return the name of internal function FN. The name is only meaningful
108 for dumps; it has no linkage. */
109
110extern const char *const internal_fn_name_array[];
111
112inline const char *
114{
115 return internal_fn_name_array[(int) fn];
116}
117
118extern internal_fn lookup_internal_fn (const char *);
121 internal_fn *);
123
124/* Return the ECF_* flags for function FN. */
125
126extern const int internal_fn_flags_array[];
127
128inline int
130{
131 return internal_fn_flags_array[(int) fn];
132}
133
134/* Return fnspec for function FN. */
135
137
138inline const_tree
140{
141 return internal_fn_fnspec_array[(int) fn];
142}
143
144/* Describes an internal function that maps directly to an optab. */
146{
147 /* optabs can be parameterized by one or two modes. These fields describe
148 how to select those modes from the types of the return value and
149 arguments. A value of -1 says that the mode is determined by the
150 return type while a value N >= 0 says that the mode is determined by
151 the type of argument N. A value of -2 says that this internal
152 function isn't directly mapped to an optab. */
153 signed int type0 : 8;
154 signed int type1 : 8;
155 /* True if the function is pointwise, so that it can be vectorized by
156 converting the return type and all argument types to vectors of the
157 same number of elements. E.g. we can vectorize an IFN_SQRT on
158 floats as an IFN_SQRT on vectors of N floats.
159
160 This only needs 1 bit, but occupies the full 16 to ensure a nice
161 layout. */
162 unsigned int vectorizable : 16;
163};
164
166
167/* Return true if FN is mapped directly to an optab. */
168
169inline bool
174
175/* Return true if FN is a direct internal function that can be vectorized by
176 converting the return type and all argument types to vectors of the same
177 number of elements. E.g. we can vectorize an IFN_SQRT on floats as an
178 IFN_SQRT on vectors of N floats. */
179
180inline bool
185
186/* Return optab information about internal function FN. Only meaningful
187 if direct_internal_fn_p (FN). */
188
189inline const direct_internal_fn_info &
195
203
204/* Return true if FN is supported for types TYPE0 and TYPE1 when the
205 optimization type is OPT_TYPE. The types are those associated with
206 the "type0" and "type1" fields of FN's direct_internal_fn_info
207 structure. */
208
209inline bool
211 optimization_type opt_type)
212{
213 return direct_internal_fn_supported_p (fn, tree_pair (type0, type1),
214 opt_type);
215}
216
221extern bool widening_fn_p (code_helper);
222
223extern bool set_edom_supported_p (void);
224
232 tree_code *, tree (&)[3],
233 tree *, tree *, tree *);
234
235extern bool internal_load_fn_p (internal_fn);
236extern bool internal_store_fn_p (internal_fn);
243 tree, tree, int);
245 poly_uint64, unsigned int);
246#define VECT_PARTIAL_BIAS_UNSUPPORTED 127
247
248extern signed char internal_len_load_store_bias (internal_fn ifn,
249 machine_mode);
250
251extern void expand_addsub_overflow (location_t, tree_code, tree, tree, tree,
252 bool, bool, bool, bool, tree *);
253extern void expand_internal_call (gcall *);
254extern void expand_internal_call (internal_fn, gcall *);
255extern void expand_PHI (internal_fn, gcall *);
256extern void expand_SHUFFLEVECTOR (internal_fn, gcall *);
257extern void expand_SPACESHIP (internal_fn, gcall *);
259extern void expand_ASSUME (internal_fn, gcall *);
260extern void expand_MASK_CALL (internal_fn, gcall *);
261extern void expand_MULBITINT (internal_fn, gcall *);
262extern void expand_DIVMODBITINT (internal_fn, gcall *);
263extern void expand_FLOATTOBITINT (internal_fn, gcall *);
264extern void expand_BITINTTOFLOAT (internal_fn, gcall *);
265extern void expand_CLRSB (internal_fn, gcall *);
266extern void expand_CLZ (internal_fn, gcall *);
267extern void expand_CTZ (internal_fn, gcall *);
268extern void expand_FFS (internal_fn, gcall *);
269extern void expand_PARITY (internal_fn, gcall *);
270extern void expand_POPCOUNT (internal_fn, gcall *);
271
273
274enum {
282
283#endif
Definition tree.h:81
std::pair< tree, tree > tree_pair
Definition coretypes.h:374
const union tree_node * const_tree
Definition coretypes.h:98
#define GTY(x)
Definition coretypes.h:41
union tree_node * tree
Definition coretypes.h:97
optimization_type
Definition coretypes.h:272
internal_fn
Definition genmatch.cc:360
@ IFN_LAST
Definition genmatch.cc:362
tree_code
Definition genmatch.cc:347
enum optab_tag optab
bool set_edom_supported_p(void)
Definition internal-fn.cc:4363
bool vectorizable_internal_fn_p(internal_fn fn)
Definition internal-fn.h:181
signed char internal_len_load_store_bias(internal_fn ifn, machine_mode)
Definition internal-fn.cc:4953
const direct_internal_fn_info & direct_internal_fn(internal_fn fn)
Definition internal-fn.h:190
bool direct_internal_fn_p(internal_fn fn)
Definition internal-fn.h:170
bool internal_gather_scatter_fn_p(internal_fn)
Definition internal-fn.cc:4710
int internal_fn_mask_index(internal_fn)
Definition internal-fn.cc:4842
#define IFN_GOACC_REDUCTION_CODES
Definition internal-fn.h:95
int first_commutative_argument(internal_fn)
Definition internal-fn.cc:4291
void expand_CLZ(internal_fn, gcall *)
Definition internal-fn.cc:5217
tree_pair direct_internal_fn_types(internal_fn, tree, tree *)
Definition internal-fn.cc:4018
tree_code conditional_internal_fn_code(internal_fn)
Definition internal-fn.cc:4453
bool commutative_binary_fn_p(internal_fn)
Definition internal-fn.cc:4222
const_tree internal_fn_fnspec(enum internal_fn fn)
Definition internal-fn.h:139
internal_fn get_len_internal_fn(internal_fn)
Definition internal-fn.cc:4543
int internal_fn_flags(enum internal_fn fn)
Definition internal-fn.h:129
internal_fn get_unconditional_internal_fn(internal_fn)
Definition internal-fn.cc:4563
const char * internal_fn_name(enum internal_fn fn)
Definition internal-fn.h:113
void expand_addsub_overflow(location_t, tree_code, tree, tree, tree, bool, bool, bool, bool, tree *)
Definition internal-fn.cc:1057
void expand_MULBITINT(internal_fn, gcall *)
Definition internal-fn.cc:5092
bool internal_load_fn_p(internal_fn)
Definition internal-fn.cc:4664
const direct_internal_fn_info direct_internal_fn_array[IFN_LAST+1]
Definition internal-fn.cc:193
void init_internal_fns()
Definition internal-fn.cc:146
internal_fn get_conditional_len_internal_fn(tree_code)
Definition internal-fn.cc:4490
void expand_DIVMODBITINT(internal_fn, gcall *)
Definition internal-fn.cc:5103
#define IFN_GOACC_LOOP_CODES
Definition internal-fn.h:72
const_tree internal_fn_fnspec_array[IFN_LAST+1]
Definition internal-fn.cc:143
bool internal_check_ptrs_fn_supported_p(internal_fn, tree, poly_uint64, unsigned int)
Definition internal-fn.cc:4933
void expand_POPCOUNT(internal_fn, gcall *)
Definition internal-fn.cc:5245
int internal_fn_stored_value_index(internal_fn)
Definition internal-fn.cc:4875
ifn_unique_kind
Definition internal-fn.h:49
void expand_FLOATTOBITINT(internal_fn, gcall *)
Definition internal-fn.cc:5114
void expand_CTZ(internal_fn, gcall *)
Definition internal-fn.cc:5224
const char *const internal_fn_name_array[]
Definition internal-fn.cc:63
bool widening_fn_p(code_helper)
Definition internal-fn.cc:4335
int internal_fn_len_index(internal_fn)
Definition internal-fn.cc:4731
void expand_FFS(internal_fn, gcall *)
Definition internal-fn.cc:5231
void expand_SHUFFLEVECTOR(internal_fn, gcall *)
Definition internal-fn.cc:5044
ifn_goacc_loop_kind
Definition internal-fn.h:74
const int internal_fn_flags_array[]
Definition internal-fn.cc:70
void expand_SPACESHIP(internal_fn, gcall *)
Definition internal-fn.cc:5056
void expand_TRAP(internal_fn, gcall *)
#define IFN_UNIQUE_CODES
Definition internal-fn.h:43
void lookup_hilo_internal_fn(internal_fn, internal_fn *, internal_fn *)
Definition internal-fn.cc:100
bool commutative_ternary_fn_p(internal_fn)
Definition internal-fn.cc:4255
ifn_goacc_reduction_kind
Definition internal-fn.h:97
void expand_PHI(internal_fn, gcall *)
Definition internal-fn.cc:5050
bool can_interpret_as_conditional_op_p(gimple *, tree *, tree_code *, tree(&)[3], tree *, tree *, tree *)
Definition internal-fn.cc:4610
void expand_internal_call(gcall *)
Definition internal-fn.cc:5001
void expand_MASK_CALL(internal_fn, gcall *)
Definition internal-fn.cc:5085
bool associative_binary_fn_p(internal_fn)
Definition internal-fn.cc:4274
int internal_fn_else_index(internal_fn)
Definition internal-fn.cc:4781
internal_fn get_conditional_internal_fn(tree_code)
Definition internal-fn.cc:4437
optab direct_internal_fn_optab(internal_fn, tree_pair)
Definition internal-fn.cc:4120
void lookup_evenodd_internal_fn(internal_fn, internal_fn *, internal_fn *)
Definition internal-fn.cc:122
void expand_CLRSB(internal_fn, gcall *)
Definition internal-fn.cc:5210
bool internal_gather_scatter_fn_supported_p(internal_fn, tree, tree, tree, int)
Definition internal-fn.cc:4908
bool direct_internal_fn_supported_p(internal_fn, tree_pair, optimization_type)
Definition internal-fn.cc:4166
void expand_BITINTTOFLOAT(internal_fn, gcall *)
Definition internal-fn.cc:5151
@ ATOMIC_OP_FETCH_CMP_0_EQ
Definition internal-fn.h:275
@ ATOMIC_OP_FETCH_CMP_0_GT
Definition internal-fn.h:279
@ ATOMIC_OP_FETCH_CMP_0_LE
Definition internal-fn.h:278
@ ATOMIC_OP_FETCH_CMP_0_LT
Definition internal-fn.h:277
@ ATOMIC_OP_FETCH_CMP_0_GE
Definition internal-fn.h:280
@ ATOMIC_OP_FETCH_CMP_0_NE
Definition internal-fn.h:276
void expand_PARITY(internal_fn, gcall *)
Definition internal-fn.cc:5238
bool internal_store_fn_p(internal_fn)
Definition internal-fn.cc:4687
void expand_ASSUME(internal_fn, gcall *)
Definition internal-fn.cc:5080
internal_fn lookup_internal_fn(const char *)
Definition internal-fn.cc:80
bool vectorized_internal_fn_supported_p(internal_fn, tree)
Definition internal-fn.cc:5012
Definition internal-fn.h:146
signed int type1
Definition internal-fn.h:154
signed int type0
Definition internal-fn.h:153
unsigned int vectorizable
Definition internal-fn.h:162
Definition gimple.h:353
Definition gimple.h:225
#define gcc_checking_assert(EXPR)
Definition system.h:828