Implement P0258R2 - helper for C++17
[official-gcc.git] / gcc / expr.h
bloba77f6e53cd345b11d825f4ee832c683f37ce87c1
1 /* Definitions for code generation pass of GNU compiler.
2 Copyright (C) 1987-2016 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 #ifndef GCC_EXPR_H
21 #define GCC_EXPR_H
23 /* This is the 4th arg to `expand_expr'.
24 EXPAND_STACK_PARM means we are possibly expanding a call param onto
25 the stack.
26 EXPAND_SUM means it is ok to return a PLUS rtx or MULT rtx.
27 EXPAND_INITIALIZER is similar but also record any labels on forced_labels.
28 EXPAND_CONST_ADDRESS means it is ok to return a MEM whose address
29 is a constant that is not a legitimate address.
30 EXPAND_WRITE means we are only going to write to the resulting rtx.
31 EXPAND_MEMORY means we are interested in a memory result, even if
32 the memory is constant and we could have propagated a constant value,
33 or the memory is unaligned on a STRICT_ALIGNMENT target. */
34 enum expand_modifier {EXPAND_NORMAL = 0, EXPAND_STACK_PARM, EXPAND_SUM,
35 EXPAND_CONST_ADDRESS, EXPAND_INITIALIZER, EXPAND_WRITE,
36 EXPAND_MEMORY};
38 /* Prevent the compiler from deferring stack pops. See
39 inhibit_defer_pop for more information. */
40 #define NO_DEFER_POP (inhibit_defer_pop += 1)
42 /* Allow the compiler to defer stack pops. See inhibit_defer_pop for
43 more information. */
44 #define OK_DEFER_POP (inhibit_defer_pop -= 1)
46 /* This structure is used to pass around information about exploded
47 unary, binary and trinary expressions between expand_expr_real_1 and
48 friends. */
49 typedef struct separate_ops
51 enum tree_code code;
52 location_t location;
53 tree type;
54 tree op0, op1, op2;
55 } *sepops;
57 /* This is run during target initialization to set up which modes can be
58 used directly in memory and to initialize the block move optab. */
59 extern void init_expr_target (void);
61 /* This is run at the start of compiling a function. */
62 extern void init_expr (void);
64 /* Emit some rtl insns to move data between rtx's, converting machine modes.
65 Both modes must be floating or both fixed. */
66 extern void convert_move (rtx, rtx, int);
68 /* Convert an rtx to specified machine mode and return the result. */
69 extern rtx convert_to_mode (machine_mode, rtx, int);
71 /* Convert an rtx to MODE from OLDMODE and return the result. */
72 extern rtx convert_modes (machine_mode, machine_mode, rtx, int);
74 /* Expand a call to memcpy or memmove or memcmp, and return the result. */
75 extern rtx emit_block_op_via_libcall (enum built_in_function, rtx, rtx, rtx,
76 bool);
78 static inline rtx
79 emit_block_copy_via_libcall (rtx dst, rtx src, rtx size, bool tailcall = false)
81 return emit_block_op_via_libcall (BUILT_IN_MEMCPY, dst, src, size, tailcall);
84 static inline rtx
85 emit_block_move_via_libcall (rtx dst, rtx src, rtx size, bool tailcall = false)
87 return emit_block_op_via_libcall (BUILT_IN_MEMMOVE, dst, src, size, tailcall);
90 static inline rtx
91 emit_block_comp_via_libcall (rtx dst, rtx src, rtx size, bool tailcall = false)
93 return emit_block_op_via_libcall (BUILT_IN_MEMCMP, dst, src, size, tailcall);
96 /* Emit code to move a block Y to a block X. */
97 enum block_op_methods
99 BLOCK_OP_NORMAL,
100 BLOCK_OP_NO_LIBCALL,
101 BLOCK_OP_CALL_PARM,
102 /* Like BLOCK_OP_NORMAL, but the libcall can be tail call optimized. */
103 BLOCK_OP_TAILCALL
106 typedef rtx (*by_pieces_constfn) (void *, HOST_WIDE_INT, machine_mode);
108 extern rtx emit_block_move (rtx, rtx, rtx, enum block_op_methods);
109 extern rtx emit_block_move_hints (rtx, rtx, rtx, enum block_op_methods,
110 unsigned int, HOST_WIDE_INT,
111 unsigned HOST_WIDE_INT,
112 unsigned HOST_WIDE_INT,
113 unsigned HOST_WIDE_INT);
114 extern rtx emit_block_cmp_hints (rtx, rtx, rtx, tree, rtx, bool,
115 by_pieces_constfn, void *);
116 extern bool emit_storent_insn (rtx to, rtx from);
118 /* Copy all or part of a value X into registers starting at REGNO.
119 The number of registers to be filled is NREGS. */
120 extern void move_block_to_reg (int, rtx, int, machine_mode);
122 /* Copy all or part of a BLKmode value X out of registers starting at REGNO.
123 The number of registers to be filled is NREGS. */
124 extern void move_block_from_reg (int, rtx, int);
126 /* Generate a non-consecutive group of registers represented by a PARALLEL. */
127 extern rtx gen_group_rtx (rtx);
129 /* Load a BLKmode value into non-consecutive registers represented by a
130 PARALLEL. */
131 extern void emit_group_load (rtx, rtx, tree, int);
133 /* Similarly, but load into new temporaries. */
134 extern rtx emit_group_load_into_temps (rtx, rtx, tree, int);
136 /* Move a non-consecutive group of registers represented by a PARALLEL into
137 a non-consecutive group of registers represented by a PARALLEL. */
138 extern void emit_group_move (rtx, rtx);
140 /* Move a group of registers represented by a PARALLEL into pseudos. */
141 extern rtx emit_group_move_into_temps (rtx);
143 /* Store a BLKmode value from non-consecutive registers represented by a
144 PARALLEL. */
145 extern void emit_group_store (rtx, rtx, tree, int);
147 extern rtx maybe_emit_group_store (rtx, tree);
149 /* Copy BLKmode object from a set of registers. */
150 extern void copy_blkmode_from_reg (rtx, rtx, tree);
152 /* Mark REG as holding a parameter for the next CALL_INSN.
153 Mode is TYPE_MODE of the non-promoted parameter, or VOIDmode. */
154 extern void use_reg_mode (rtx *, rtx, machine_mode);
155 extern void clobber_reg_mode (rtx *, rtx, machine_mode);
157 extern rtx copy_blkmode_to_reg (machine_mode, tree);
159 /* Mark REG as holding a parameter for the next CALL_INSN. */
160 static inline void
161 use_reg (rtx *fusage, rtx reg)
163 use_reg_mode (fusage, reg, VOIDmode);
166 /* Mark REG as clobbered by the call with FUSAGE as CALL_INSN_FUNCTION_USAGE. */
167 static inline void
168 clobber_reg (rtx *fusage, rtx reg)
170 clobber_reg_mode (fusage, reg, VOIDmode);
173 /* Mark NREGS consecutive regs, starting at REGNO, as holding parameters
174 for the next CALL_INSN. */
175 extern void use_regs (rtx *, int, int);
177 /* Mark a PARALLEL as holding a parameter for the next CALL_INSN. */
178 extern void use_group_regs (rtx *, rtx);
180 #ifdef GCC_INSN_CODES_H
181 extern rtx expand_cmpstrn_or_cmpmem (insn_code, rtx, rtx, rtx, tree, rtx,
182 HOST_WIDE_INT);
183 #endif
185 /* Write zeros through the storage of OBJECT.
186 If OBJECT has BLKmode, SIZE is its length in bytes. */
187 extern rtx clear_storage (rtx, rtx, enum block_op_methods);
188 extern rtx clear_storage_hints (rtx, rtx, enum block_op_methods,
189 unsigned int, HOST_WIDE_INT,
190 unsigned HOST_WIDE_INT,
191 unsigned HOST_WIDE_INT,
192 unsigned HOST_WIDE_INT);
193 /* The same, but always output an library call. */
194 extern rtx set_storage_via_libcall (rtx, rtx, rtx, bool = false);
196 /* Expand a setmem pattern; return true if successful. */
197 extern bool set_storage_via_setmem (rtx, rtx, rtx, unsigned int,
198 unsigned int, HOST_WIDE_INT,
199 unsigned HOST_WIDE_INT,
200 unsigned HOST_WIDE_INT,
201 unsigned HOST_WIDE_INT);
203 /* Return nonzero if it is desirable to store LEN bytes generated by
204 CONSTFUN with several move instructions by store_by_pieces
205 function. CONSTFUNDATA is a pointer which will be passed as argument
206 in every CONSTFUN call.
207 ALIGN is maximum alignment we can assume.
208 MEMSETP is true if this is a real memset/bzero, not a copy
209 of a const string. */
210 extern int can_store_by_pieces (unsigned HOST_WIDE_INT,
211 by_pieces_constfn,
212 void *, unsigned int, bool);
214 /* Generate several move instructions to store LEN bytes generated by
215 CONSTFUN to block TO. (A MEM rtx with BLKmode). CONSTFUNDATA is a
216 pointer which will be passed as argument in every CONSTFUN call.
217 ALIGN is maximum alignment we can assume.
218 MEMSETP is true if this is a real memset/bzero, not a copy.
219 Returns TO + LEN. */
220 extern rtx store_by_pieces (rtx, unsigned HOST_WIDE_INT, by_pieces_constfn,
221 void *, unsigned int, bool, int);
223 /* Emit insns to set X from Y. */
224 extern rtx_insn *emit_move_insn (rtx, rtx);
225 extern rtx_insn *gen_move_insn (rtx, rtx);
227 /* Emit insns to set X from Y, with no frills. */
228 extern rtx_insn *emit_move_insn_1 (rtx, rtx);
230 extern rtx_insn *emit_move_complex_push (machine_mode, rtx, rtx);
231 extern rtx_insn *emit_move_complex_parts (rtx, rtx);
232 extern rtx read_complex_part (rtx, bool);
233 extern void write_complex_part (rtx, rtx, bool);
234 extern rtx read_complex_part (rtx, bool);
235 extern rtx emit_move_resolve_push (machine_mode, rtx);
237 /* Push a block of length SIZE (perhaps variable)
238 and return an rtx to address the beginning of the block. */
239 extern rtx push_block (rtx, int, int);
241 /* Generate code to push something onto the stack, given its mode and type. */
242 extern bool emit_push_insn (rtx, machine_mode, tree, rtx, unsigned int,
243 int, rtx, int, rtx, rtx, int, rtx, bool);
245 /* Extract the accessible bit-range from a COMPONENT_REF. */
246 extern void get_bit_range (unsigned HOST_WIDE_INT *, unsigned HOST_WIDE_INT *,
247 tree, HOST_WIDE_INT *, tree *);
249 /* Expand an assignment that stores the value of FROM into TO. */
250 extern void expand_assignment (tree, tree, bool);
252 /* Generate code for computing expression EXP,
253 and storing the value into TARGET.
254 If SUGGEST_REG is nonzero, copy the value through a register
255 and return that register, if that is possible. */
256 extern rtx store_expr_with_bounds (tree, rtx, int, bool, bool, tree);
257 extern rtx store_expr (tree, rtx, int, bool, bool);
259 /* Given an rtx that may include add and multiply operations,
260 generate them as insns and return a pseudo-reg containing the value.
261 Useful after calling expand_expr with 1 as sum_ok. */
262 extern rtx force_operand (rtx, rtx);
264 /* Work horses for expand_expr. */
265 extern rtx expand_expr_real (tree, rtx, machine_mode,
266 enum expand_modifier, rtx *, bool);
267 extern rtx expand_expr_real_1 (tree, rtx, machine_mode,
268 enum expand_modifier, rtx *, bool);
269 extern rtx expand_expr_real_2 (sepops, rtx, machine_mode,
270 enum expand_modifier);
272 /* Generate code for computing expression EXP.
273 An rtx for the computed value is returned. The value is never null.
274 In the case of a void EXP, const0_rtx is returned. */
275 static inline rtx
276 expand_expr (tree exp, rtx target, machine_mode mode,
277 enum expand_modifier modifier)
279 return expand_expr_real (exp, target, mode, modifier, NULL, false);
282 static inline rtx
283 expand_normal (tree exp)
285 return expand_expr_real (exp, NULL_RTX, VOIDmode, EXPAND_NORMAL, NULL, false);
289 /* Return the tree node and offset if a given argument corresponds to
290 a string constant. */
291 extern tree string_constant (tree, tree *);
293 /* Two different ways of generating switch statements. */
294 extern int try_casesi (tree, tree, tree, tree, rtx, rtx, rtx, int);
295 extern int try_tablejump (tree, tree, tree, tree, rtx, rtx, int);
297 extern int safe_from_p (const_rtx, tree, int);
299 /* Get the personality libfunc for a function decl. */
300 rtx get_personality_function (tree);
302 /* Determine whether the LEN bytes can be moved by using several move
303 instructions. Return nonzero if a call to move_by_pieces should
304 succeed. */
305 extern bool can_move_by_pieces (unsigned HOST_WIDE_INT, unsigned int);
307 extern unsigned HOST_WIDE_INT highest_pow2_factor (const_tree);
309 extern bool categorize_ctor_elements (const_tree, HOST_WIDE_INT *,
310 HOST_WIDE_INT *, bool *);
312 extern void expand_operands (tree, tree, rtx, rtx*, rtx*,
313 enum expand_modifier);
315 /* rtl.h and tree.h were included. */
316 /* Return an rtx for the size in bytes of the value of an expr. */
317 extern rtx expr_size (tree);
319 #endif /* GCC_EXPR_H */