1/* Definitions for code generation pass of GNU compiler.
2 Copyright (C) 2001-2023 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
8the Free Software Foundation; either version 3, or (at your option)
9any later version.
10
11GCC is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for 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_OPTABS_H
21#define GCC_OPTABS_H
22
23#include "optabs-query.h"
24#include "optabs-libfuncs.h"
25#include "vec-perm-indices.h"
26
27/* Generate code for a widening multiply. */
28extern rtx expand_widening_mult (machine_mode, rtx, rtx, rtx, int, optab);
29
30/* Describes the type of an expand_operand. Each value is associated
31 with a create_*_operand function; see the comments above those
32 functions for details. */
33enum expand_operand_type {
34 EXPAND_FIXED,
35 EXPAND_OUTPUT,
36 EXPAND_INPUT,
37 EXPAND_CONVERT_TO,
38 EXPAND_CONVERT_FROM,
39 EXPAND_ADDRESS,
40 EXPAND_INTEGER,
41 EXPAND_UNDEFINED_INPUT
42};
43
44/* Information about an operand for instruction expansion. */
45class expand_operand {
46public:
47 /* The type of operand. */
48 ENUM_BITFIELD (expand_operand_type) type : 8;
49
50 /* True if any conversion should treat VALUE as being unsigned
51 rather than signed. Only meaningful for certain types. */
52 unsigned int unsigned_p : 1;
53
54 /* Is the target operand. */
55 unsigned int target : 1;
56
57 /* Unused; available for future use. */
58 unsigned int unused : 6;
59
60 /* The mode passed to the convert_*_operand function. It has a
61 type-dependent meaning. */
62 ENUM_BITFIELD (machine_mode) mode : 16;
63
64 /* The value of the operand. */
65 rtx value;
66
67 /* The value of an EXPAND_INTEGER operand. */
68 poly_int64 int_value;
69};
70
71/* Initialize OP with the given fields. Initialise the other fields
72 to their default values. */
73
74inline void
75create_expand_operand (class expand_operand *op,
76 enum expand_operand_type type,
77 rtx value, machine_mode mode,
78 bool unsigned_p, poly_int64 int_value = 0)
79{
80 op->type = type;
81 op->unsigned_p = unsigned_p;
82 op->target = 0;
83 op->unused = 0;
84 op->mode = mode;
85 op->value = value;
86 op->int_value = int_value;
87}
88
89/* Make OP describe an operand that must use rtx X, even if X is volatile. */
90
91inline void
92create_fixed_operand (class expand_operand *op, rtx x)
93{
94 create_expand_operand (op, type: EXPAND_FIXED, value: x, VOIDmode, unsigned_p: false);
95}
96
97/* Make OP describe an output operand that must have mode MODE.
98 X, if nonnull, is a suggestion for where the output should be stored.
99 It is OK for VALUE to be inconsistent with MODE, although it will just
100 be ignored in that case. */
101
102inline void
103create_output_operand (class expand_operand *op, rtx x,
104 machine_mode mode)
105{
106 create_expand_operand (op, type: EXPAND_OUTPUT, value: x, mode, unsigned_p: false);
107}
108
109/* Make OP describe an input operand that must have mode MODE and
110 value VALUE; MODE cannot be VOIDmode. The backend may request that
111 VALUE be copied into a different kind of rtx before being passed
112 as an operand. */
113
114inline void
115create_input_operand (class expand_operand *op, rtx value,
116 machine_mode mode)
117{
118 create_expand_operand (op, type: EXPAND_INPUT, value, mode, unsigned_p: false);
119}
120
121/* Make OP describe an undefined input operand of mode MODE. MODE cannot
122 be null. */
123
124inline void
125create_undefined_input_operand (class expand_operand *op, machine_mode mode)
126{
127 create_expand_operand (op, type: EXPAND_UNDEFINED_INPUT, gen_rtx_SCRATCH (mode),
128 mode, unsigned_p: false);
129}
130
131/* Like create_input_operand, except that VALUE must first be converted
132 to mode MODE. UNSIGNED_P says whether VALUE is unsigned. */
133
134inline void
135create_convert_operand_to (class expand_operand *op, rtx value,
136 machine_mode mode, bool unsigned_p)
137{
138 create_expand_operand (op, type: EXPAND_CONVERT_TO, value, mode, unsigned_p);
139}
140
141/* Make OP describe an input operand that should have the same value
142 as VALUE, after any mode conversion that the backend might request.
143 If VALUE is a CONST_INT, it should be treated as having mode MODE.
144 UNSIGNED_P says whether VALUE is unsigned.
145
146 The conversion of VALUE can include a combination of numerical
147 conversion (as for convert_modes) and duplicating a scalar to fill
148 a vector (if VALUE is a scalar but the operand is a vector). */
149
150inline void
151create_convert_operand_from (class expand_operand *op, rtx value,
152 machine_mode mode, bool unsigned_p)
153{
154 create_expand_operand (op, type: EXPAND_CONVERT_FROM, value, mode, unsigned_p);
155}
156
157
158/* Make OP describe an input Pmode address operand. VALUE is the value
159 of the address, but it may need to be converted to Pmode first. */
160
161inline void
162create_address_operand (class expand_operand *op, rtx value)
163{
164 create_expand_operand (op, type: EXPAND_ADDRESS, value, Pmode, unsigned_p: false);
165}
166
167extern void create_integer_operand (class expand_operand *, poly_int64);
168
169/* Passed to expand_simple_binop and expand_binop to say which options
170 to try to use if the requested operation can't be open-coded on the
171 requisite mode. Either OPTAB_LIB or OPTAB_LIB_WIDEN says try using
172 a library call. Either OPTAB_WIDEN or OPTAB_LIB_WIDEN says try
173 using a wider mode. OPTAB_MUST_WIDEN says try widening and don't
174 try anything else. */
175
176enum optab_methods
177{
178 OPTAB_DIRECT,
179 OPTAB_LIB,
180 OPTAB_WIDEN,
181 OPTAB_LIB_WIDEN,
182 OPTAB_MUST_WIDEN
183};
184
185extern rtx expand_widen_pattern_expr (struct separate_ops *, rtx , rtx , rtx,
186 rtx, int);
187extern rtx expand_ternary_op (machine_mode mode, optab ternary_optab,
188 rtx op0, rtx op1, rtx op2, rtx target,
189 int unsignedp);
190extern rtx simplify_expand_binop (machine_mode mode, optab binoptab,
191 rtx op0, rtx op1, rtx target, int unsignedp,
192 enum optab_methods methods);
193extern bool force_expand_binop (machine_mode, optab, rtx, rtx, rtx, int,
194 enum optab_methods);
195extern rtx expand_vector_broadcast (machine_mode, rtx);
196
197extern rtx expand_doubleword_divmod (machine_mode, rtx, rtx, rtx *, bool);
198
199/* Generate code for a simple binary or unary operation. "Simple" in
200 this case means "can be unambiguously described by a (mode, code)
201 pair and mapped to a single optab." */
202extern rtx expand_simple_binop (machine_mode, enum rtx_code, rtx,
203 rtx, rtx, int, enum optab_methods);
204
205/* Expand a binary operation given optab and rtx operands. */
206extern rtx expand_binop (machine_mode, optab, rtx, rtx, rtx, int,
207 enum optab_methods);
208
209/* Expand a binary operation with both signed and unsigned forms. */
210extern rtx sign_expand_binop (machine_mode, optab, optab, rtx, rtx,
211 rtx, int, enum optab_methods);
212
213/* Generate code to perform an operation on one operand with two results. */
214extern bool expand_twoval_unop (optab, rtx, rtx, rtx, int);
215
216/* Generate code to perform an operation on two operands with two results. */
217extern bool expand_twoval_binop (optab, rtx, rtx, rtx, rtx, int);
218
219/* Generate code to perform an operation on two operands with two
220 results, using a library function. */
221extern bool expand_twoval_binop_libfunc (optab, rtx, rtx, rtx, rtx,
222 enum rtx_code);
223extern rtx expand_simple_unop (machine_mode, enum rtx_code, rtx, rtx,
224 int);
225
226/* Expand a unary arithmetic operation given optab rtx operand. */
227extern rtx expand_unop (machine_mode, optab, rtx, rtx, int);
228
229/* Expand the absolute value operation. */
230extern rtx expand_abs_nojump (machine_mode, rtx, rtx, int);
231extern rtx expand_abs (machine_mode, rtx, rtx, int, int);
232
233/* Expand the one's complement absolute value operation. */
234extern rtx expand_one_cmpl_abs_nojump (machine_mode, rtx, rtx);
235
236/* Expand the copysign operation. */
237extern rtx expand_copysign (rtx, rtx, rtx);
238/* Generate an instruction with a given INSN_CODE with an output and
239 an input. */
240extern bool maybe_emit_unop_insn (enum insn_code, rtx, rtx, enum rtx_code);
241extern void emit_unop_insn (enum insn_code, rtx, rtx, enum rtx_code);
242
243/* Emit code to make a call to a constant function or a library call. */
244extern void emit_libcall_block (rtx_insn *, rtx, rtx, rtx);
245
246/* The various uses that a comparison can have; used by can_compare_p:
247 jumps, conditional moves, store flag operations. */
248enum can_compare_purpose
249{
250 ccp_jump,
251 ccp_cmov,
252 ccp_store_flag
253};
254
255/* Nonzero if a compare of mode MODE can be done straightforwardly
256 (without splitting it into pieces). */
257extern bool can_compare_p (enum rtx_code, machine_mode,
258 enum can_compare_purpose);
259
260/* Return whether the backend can emit a vector comparison (vec_cmp/vec_cmpu)
261 for code CODE, comparing operands of mode VALUE_MODE and producing a result
262 with MASK_MODE. */
263extern bool can_vec_cmp_compare_p (enum rtx_code, machine_mode, machine_mode);
264
265/* Return whether the backend can emit a vector comparison (vcond/vcondu) for
266 code CODE, comparing operands of mode CMP_OP_MODE and producing a result
267 with VALUE_MODE. */
268extern bool can_vcond_compare_p (enum rtx_code, machine_mode, machine_mode);
269
270/* Return whether the backend can emit vector set instructions for inserting
271 element into vector at variable index position. */
272extern bool can_vec_set_var_idx_p (machine_mode);
273extern bool can_vec_extract_var_idx_p (machine_mode, machine_mode);
274
275extern rtx prepare_operand (enum insn_code, rtx, int, machine_mode,
276 machine_mode, int);
277/* Emit a pair of rtl insns to compare two rtx's and to jump
278 to a label if the comparison is true. */
279extern void emit_cmp_and_jump_insns (rtx, rtx, enum rtx_code, rtx,
280 machine_mode, int, rtx,
281 profile_probability prob
282 = profile_probability::uninitialized ());
283extern void emit_cmp_and_jump_insns (rtx, rtx, enum rtx_code, rtx,
284 machine_mode, int, tree, rtx,
285 profile_probability prob
286 = profile_probability::uninitialized ());
287
288/* Generate code to indirectly jump to a location given in the rtx LOC. */
289extern void emit_indirect_jump (rtx);
290
291#include "insn-config.h"
292
293#ifndef GCC_INSN_CONFIG_H
294#error "insn-config.h must be included before optabs.h"
295#endif
296
297/* Emit a conditional move operation. */
298rtx emit_conditional_move (rtx, rtx_comparison, rtx, rtx, machine_mode, int);
299rtx emit_conditional_move (rtx, rtx, rtx, rtx, rtx, machine_mode);
300
301/* Emit a conditional negate or bitwise complement operation. */
302rtx emit_conditional_neg_or_complement (rtx, rtx_code, machine_mode, rtx,
303 rtx, rtx);
304
305rtx emit_conditional_add (rtx, enum rtx_code, rtx, rtx, machine_mode,
306 rtx, rtx, machine_mode, int);
307
308/* Create but don't emit one rtl instruction to perform certain operations.
309 Modes must match; operands must meet the operation's predicates.
310 Likewise for subtraction and for just copying. */
311extern rtx_insn *gen_add2_insn (rtx, rtx);
312extern rtx_insn *gen_add3_insn (rtx, rtx, rtx);
313extern bool have_add2_insn (rtx, rtx);
314extern rtx_insn *gen_addptr3_insn (rtx, rtx, rtx);
315extern bool have_addptr3_insn (rtx, rtx, rtx);
316extern rtx_insn *gen_sub2_insn (rtx, rtx);
317extern rtx_insn *gen_sub3_insn (rtx, rtx, rtx);
318extern bool have_sub2_insn (rtx, rtx);
319
320/* Generate the body of an insn to extend Y (with mode MFROM)
321 into X (with mode MTO). Do zero-extension if UNSIGNEDP is nonzero. */
322extern rtx_insn *gen_extend_insn (rtx, rtx, machine_mode, machine_mode, int);
323
324/* Generate code for a FLOAT_EXPR. */
325extern void expand_float (rtx, rtx, int);
326
327/* Generate code for a FIX_EXPR. */
328extern void expand_fix (rtx, rtx, int);
329
330/* Generate code for a FIXED_CONVERT_EXPR. */
331extern void expand_fixed_convert (rtx, rtx, int, int);
332
333/* Generate code for float to integral conversion. */
334extern bool expand_sfix_optab (rtx, rtx, convert_optab);
335
336/* Report whether the machine description contains an insn which can
337 perform the operation described by CODE and MODE. */
338extern bool have_insn_for (enum rtx_code, machine_mode);
339
340/* Generate a conditional trap instruction. */
341extern rtx_insn *gen_cond_trap (enum rtx_code, rtx, rtx, rtx);
342
343/* Generate code for VEC_PERM_EXPR. */
344extern rtx expand_vec_perm_var (machine_mode, rtx, rtx, rtx, rtx);
345extern rtx expand_vec_perm_const (machine_mode, rtx, rtx,
346 const vec_perm_builder &, machine_mode, rtx);
347
348/* Generate code for vector comparison. */
349extern rtx expand_vec_cmp_expr (tree, tree, rtx);
350
351/* Generate code for VEC_SERIES_EXPR. */
352extern rtx expand_vec_series_expr (machine_mode, rtx, rtx, rtx);
353
354/* Generate code for MULT_HIGHPART_EXPR. */
355extern rtx expand_mult_highpart (machine_mode, rtx, rtx, rtx, bool);
356
357extern rtx expand_sync_lock_test_and_set (rtx, rtx, rtx);
358extern rtx expand_atomic_test_and_set (rtx, rtx, enum memmodel);
359extern rtx expand_atomic_exchange (rtx, rtx, rtx, enum memmodel);
360extern bool expand_atomic_compare_and_swap (rtx *, rtx *, rtx, rtx, rtx, bool,
361 enum memmodel, enum memmodel);
362/* Generate memory barriers. */
363extern void expand_mem_thread_fence (enum memmodel);
364extern void expand_mem_signal_fence (enum memmodel);
365
366rtx expand_atomic_load (rtx, rtx, enum memmodel);
367rtx expand_atomic_store (rtx, rtx, enum memmodel, bool);
368rtx expand_atomic_fetch_op (rtx, rtx, rtx, enum rtx_code, enum memmodel,
369 bool);
370
371extern void expand_asm_reg_clobber_mem_blockage (HARD_REG_SET);
372
373extern bool insn_operand_matches (enum insn_code icode, unsigned int opno,
374 rtx operand);
375extern bool valid_multiword_target_p (rtx);
376extern void create_convert_operand_from_type (class expand_operand *op,
377 rtx value, tree type);
378extern bool maybe_legitimize_operands (enum insn_code icode,
379 unsigned int opno, unsigned int nops,
380 class expand_operand *ops);
381extern rtx_insn *maybe_gen_insn (enum insn_code icode, unsigned int nops,
382 class expand_operand *ops);
383extern bool maybe_expand_insn (enum insn_code icode, unsigned int nops,
384 class expand_operand *ops);
385extern bool maybe_expand_jump_insn (enum insn_code icode, unsigned int nops,
386 class expand_operand *ops);
387extern void expand_insn (enum insn_code icode, unsigned int nops,
388 class expand_operand *ops);
389extern void expand_jump_insn (enum insn_code icode, unsigned int nops,
390 class expand_operand *ops);
391
392extern enum rtx_code get_rtx_code_1 (enum tree_code tcode, bool unsignedp);
393extern enum rtx_code get_rtx_code (enum tree_code tcode, bool unsignedp);
394extern rtx vector_compare_rtx (machine_mode cmp_mode, enum tree_code tcode,
395 tree t_op0, tree t_op1, bool unsignedp,
396 enum insn_code icode, unsigned int opno);
397
398
399#endif /* GCC_OPTABS_H */
400

source code of gcc/optabs.h