2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Lowering of high level constructs.
23 * @author Michael Beck
26 #ifndef FIRM_LOWERING_H
27 #define FIRM_LOWERING_H
31 #include "firm_types.h"
36 * Lower small CopyB nodes to Load/Store nodes, preserve medium-sized CopyB
37 * nodes and replace large CopyBs by a call to memcpy, depending on the given
40 * Small CopyB nodes (size <= max_small_size) are turned into a series of
42 * Medium-sized CopyB nodes (max_small_size < size < min_large_size) are
44 * Large CopyB nodes (size >= min_large_size) are turned into a memcpy call.
46 * @param irg The graph to be lowered.
47 * @param max_small_size The maximum number of bytes for a CopyB node so
48 * that it is still considered 'small'.
49 * @param min_large_size The minimum number of bytes for a CopyB node so
50 * that it is regarded as 'large'.
52 FIRM_API void lower_CopyB(ir_graph *irg, unsigned max_small_size,
53 unsigned min_large_size);
56 * Lowers all Switches (Cond nodes with non-boolean mode) depending on spare_size.
57 * They will either remain the same or be converted into if-cascades.
59 * @param irg The ir graph to be lowered.
60 * @param small_switch If switch has <= cases then change it to an if-cascade.
61 * @param spare_size Allowed spare size for table switches in machine words.
62 * (Default in edgfe: 128)
63 * @param allow_out_of_bounds backend can handle out-of-bounds values
64 * (values bigger than minimum and maximum proj
67 FIRM_API void lower_switch(ir_graph *irg, unsigned small_switch,
68 unsigned spare_size, int allow_out_of_bounds);
71 * Replaces SymConsts by a real constant if possible.
72 * Replace Sel nodes by address computation. Also resolves array access.
73 * Handle bit fields by added And/Or calculations.
75 * @param irg the graph to lower
77 * @note: There is NO lowering ob objects oriented types. This is highly compiler
78 * and ABI specific and should be placed directly in the compiler.
80 FIRM_API void lower_highlevel_graph(ir_graph *irg);
83 * Creates an ir_graph pass for lower_highlevel_graph().
85 * @param name the name of this pass or NULL
87 * @return the newly created ir_graph pass
89 FIRM_API ir_graph_pass_t *lower_highlevel_graph_pass(const char *name);
92 * Replaces SymConsts by a real constant if possible.
93 * Replace Sel nodes by address computation. Also resolves array access.
94 * Handle bit fields by added And/Or calculations.
97 * @note There is NO lowering of objects oriented types. This is highly compiler
98 * and ABI specific and should be placed directly in the compiler.
100 FIRM_API void lower_highlevel(void);
103 * does the same as lower_highlevel for all nodes on the const code irg
105 FIRM_API void lower_const_code(void);
108 * Creates an ir_prog pass for lower_const_code().
110 * @param name the name of this pass or NULL
112 * @return the newly created ir_prog pass
114 FIRM_API ir_prog_pass_t *lower_const_code_pass(const char *name);
117 * Function which creates a "set" instraction. A "set" instruction takes a
118 * condition value (a value with mode_b) as input and produces a value in a
119 * general purpose integer mode.
120 * Most architectures have special intrinsics for this. But if all else fails
121 * you can just produces the an if-like construct.
123 typedef ir_node* (*create_set_func)(ir_node *cond);
126 * implementation of create_set_func which produces a Mux node with 0/1 input
128 FIRM_API ir_node *ir_create_mux_set(ir_node *cond, ir_mode *dest_mode);
131 * implementation of create_set_func which produces a cond with control
134 FIRM_API ir_node *ir_create_cond_set(ir_node *cond, ir_mode *dest_mode);
136 typedef struct lower_mode_b_config_t {
137 /* mode that is used to transport 0/1 values */
138 ir_mode *lowered_mode;
139 /* callback for creating set-like instructions */
140 create_set_func create_set;
141 /* whether direct Cond(Cmp) should also be lowered */
142 int lower_direct_cmp;
143 } lower_mode_b_config_t;
146 * Lowers mode_b operations to integer arithmetic. After the lowering the only
147 * operations with mode_b are the Projs of Cmps; the only nodes with mode_b
148 * inputs are Cond and Psi nodes.
150 * Example: Psi(a < 0, 1, 0) => a >> 31
152 * @param irg the firm graph to lower
153 * @param config configuration for mode_b lowerer
155 FIRM_API void ir_lower_mode_b(ir_graph *irg,
156 const lower_mode_b_config_t *config);
159 * Used as callback, whenever a lowerable mux is found. The return value
160 * indicates, whether the mux should be lowered. This may be used, to lower
161 * floating point muxes, while keeping mux nodes for integers, for example.
163 * @param mux The mux node that may be lowered.
164 * @return A non-zero value indicates that the mux should be lowered.
166 typedef int lower_mux_callback(ir_node* mux);
169 * Lowers all mux nodes in the given graph. A callback function may be
170 * given, to select the mux nodes to lower.
172 * @param irg The graph to lower mux nodes in.
173 * @param cb_func The callback function for mux selection. Can be NULL,
174 * to lower all mux nodes.
176 FIRM_API void lower_mux(ir_graph *irg, lower_mux_callback *cb_func);
179 * Creates an ir_graph pass for lower_mux().
181 * @param name the name of this pass or NULL
182 * @param cb_func The callback function for mux selection. Can be NULL,
183 * to lower all mux nodes.
185 * @return the newly created ir_graph pass
187 FIRM_API ir_graph_pass_t *lower_mux_pass(const char *name,
188 lower_mux_callback *cb_func);
191 * An intrinsic mapper function.
193 * @param node the IR-node that will be mapped
194 * @param ctx a context
196 * @return non-zero if the call was mapped
198 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
201 INTRINSIC_CALL = 0, /**< the record represents an intrinsic call */
202 INTRINSIC_INSTR /**< the record represents an intrinsic instruction */
206 * An intrinsic call record.
208 typedef struct i_call_record {
209 enum ikind kind; /**< must be INTRINSIC_CALL */
210 ir_entity *i_ent; /**< the entity representing an intrinsic call */
211 i_mapper_func i_mapper; /**< the mapper function to call */
212 void *ctx; /**< mapper context */
213 void *link; /**< used in the construction algorithm, must be NULL */
217 * An intrinsic instruction record.
219 typedef struct i_instr_record {
220 enum ikind kind; /**< must be INTRINSIC_INSTR */
221 ir_op *op; /**< the opcode that must be mapped. */
222 i_mapper_func i_mapper; /**< the mapper function to call */
223 void *ctx; /**< mapper context */
224 void *link; /**< used in the construction algorithm, must be NULL */
228 * An intrinsic record.
230 typedef union i_record {
231 i_call_record i_call;
232 i_instr_record i_instr;
236 * Go through all graphs and map calls to intrinsic functions and instructions.
238 * Every call or instruction is reported to its mapper function,
239 * which is responsible for rebuilding the graph.
241 * current_ir_graph is always set.
243 * @param list an array of intrinsic map records
244 * @param length the length of the array
245 * @param part_block_used set to true if part_block() must be using during lowering
247 * @return number of found intrinsics.
249 FIRM_API size_t lower_intrinsics(i_record *list, size_t length,
250 int part_block_used);
253 * Creates an irprog pass for lower_intrinsics.
255 * @param name the name of this pass or NULL
256 * @param list an array of intrinsic map records
257 * @param length the length of the array
258 * @param part_block_used set to true if part_block() must be using during lowering
260 FIRM_API ir_prog_pass_t *lower_intrinsics_pass(const char *name, i_record *list,
261 size_t length, int part_block_used);
264 * A mapper for the integer/float absolute value: type abs(type v).
265 * Replaces the call by a Abs node.
269 FIRM_API int i_mapper_abs(ir_node *call, void *ctx);
272 * A mapper for the integer byte swap value: type bswap(type v).
273 * Replaces the call by a builtin[ir_bk_bswap] node.
277 FIRM_API int i_mapper_bswap(ir_node *call, void *ctx);
280 * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
282 * @return 1 if the sqrt call was removed, 0 else.
284 FIRM_API int i_mapper_sqrt(ir_node *call, void *ctx);
287 * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
289 * @return 1 if the cbrt call was removed, 0 else.
291 FIRM_API int i_mapper_cbrt(ir_node *call, void *ctx);
294 * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
296 * @return 1 if the pow call was removed, 0 else.
298 FIRM_API int i_mapper_pow(ir_node *call, void *ctx);
301 * A mapper for the floating point exp(a): floattype exp(floattype a);
303 * @return 1 if the exp call was removed, 0 else.
305 FIRM_API int i_mapper_exp(ir_node *call, void *ctx);
307 #define i_mapper_exp2 i_mapper_exp
308 #define i_mapper_exp10 i_mapper_exp
311 * A mapper for the floating point log(a): floattype log(floattype a);
313 * @return 1 if the log call was removed, 0 else.
315 FIRM_API int i_mapper_log(ir_node *call, void *ctx);
317 #define i_mapper_log2 i_mapper_log
318 #define i_mapper_log10 i_mapper_log
321 * A mapper for the floating point sin(a): floattype sin(floattype a);
323 * @return 1 if the sin call was removed, 0 else.
325 FIRM_API int i_mapper_sin(ir_node *call, void *ctx);
328 * A mapper for the floating point sin(a): floattype cos(floattype a);
330 * @return 1 if the cos call was removed, 0 else.
332 FIRM_API int i_mapper_cos(ir_node *call, void *ctx);
335 * A mapper for the floating point tan(a): floattype tan(floattype a);
337 * @return 1 if the tan call was removed, 0 else.
339 FIRM_API int i_mapper_tan(ir_node *call, void *ctx);
342 * A mapper for the floating point asin(a): floattype asin(floattype a);
344 * @return 1 if the asin call was removed, 0 else.
346 FIRM_API int i_mapper_asin(ir_node *call, void *ctx);
349 * A mapper for the floating point acos(a): floattype acos(floattype a);
351 * @return 1 if the tan call was removed, 0 else.
353 FIRM_API int i_mapper_acos(ir_node *call, void *ctx);
356 * A mapper for the floating point atan(a): floattype atan(floattype a);
358 * @return 1 if the atan call was removed, 0 else.
360 FIRM_API int i_mapper_atan(ir_node *call, void *ctx);
363 * A mapper for the floating point sinh(a): floattype sinh(floattype a);
365 * @return 1 if the sinh call was removed, 0 else.
367 FIRM_API int i_mapper_sinh(ir_node *call, void *ctx);
370 * A mapper for the floating point cosh(a): floattype cosh(floattype a);
372 * @return 1 if the cosh call was removed, 0 else.
374 FIRM_API int i_mapper_cosh(ir_node *call, void *ctx);
377 * A mapper for the floating point tanh(a): floattype tanh(floattype a);
379 * @return 1 if the tanh call was removed, 0 else.
381 FIRM_API int i_mapper_tanh(ir_node *call, void *ctx);
384 * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
386 * @return 1 if the strcmp call was removed, 0 else.
388 FIRM_API int i_mapper_strcmp(ir_node *call, void *ctx);
391 * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
393 * @return 1 if the strncmp call was removed, 0 else.
395 FIRM_API int i_mapper_strncmp(ir_node *call, void *ctx);
398 * A mapper for the strcpy-Function: char pointer strcpy(char pointer a, char pointer b);
400 * @return 1 if the strcpy call was removed, 0 else.
402 FIRM_API int i_mapper_strcpy(ir_node *call, void *ctx);
405 * A mapper for the strlen-Function: inttype strlen(char pointer a);
407 * @return 1 if the strlen call was removed, 0 else.
409 FIRM_API int i_mapper_strlen(ir_node *call, void *ctx);
412 * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
414 * @return 1 if the memcpy call was removed, 0 else.
416 FIRM_API int i_mapper_memcpy(ir_node *call, void *ctx);
419 * A mapper for the mempcpy-Function: void pointer mempcpy(void pointer d, void pointer s, inttype c);
421 * @return 1 if the mempcpy call was removed, 0 else.
423 FIRM_API int i_mapper_mempcpy(ir_node *call, void *ctx);
426 * A mapper for the memmove-Function: void pointer memmove(void pointer d, void pointer s, inttype c);
428 * @return 1 if the memmove call was removed, 0 else.
430 FIRM_API int i_mapper_memmove(ir_node *call, void *ctx);
433 * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
435 * @return 1 if the memset call was removed, 0 else.
437 FIRM_API int i_mapper_memset(ir_node *call, void *ctx);
440 * A mapper for the strncmp-Function: inttype memcmp(void pointer a, void pointer b, inttype len);
442 * @return 1 if the strncmp call was removed, 0 else.
444 FIRM_API int i_mapper_memcmp(ir_node *call, void *ctx);
447 * A mapper for the alloca() function: pointer alloca(inttype size)
448 * Replaces the call by a Alloca(stack_alloc) node.
452 FIRM_API int i_mapper_alloca(ir_node *call, void *ctx);
455 * A runtime routine description.
457 typedef struct runtime_rt {
458 ir_entity *ent; /**< The entity representing the runtime routine. */
459 ir_mode *mode; /**< The operation mode of the mapped instruction. */
460 ir_mode *res_mode; /**< The result mode of the mapped instruction or NULL. */
461 long mem_proj_nr; /**< if >= 0, create a memory ProjM() */
462 long regular_proj_nr; /**< if >= 0, create a regular ProjX() */
463 long exc_proj_nr; /**< if >= 0, create a exception ProjX() */
464 long res_proj_nr; /**< if >= 0, first result projection number */
468 * A mapper for mapping unsupported instructions to runtime calls.
469 * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
470 * rt(arg_0, ..., arg_n).
472 * The mapping is only done, if the modes of all arguments matches the
473 * modes of rt's argument.
474 * Further, if op has a memory input, the generated Call uses it, else
476 * The pinned state of the Call will be set to the pinned state of op.
478 * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
480 * @return 1 if an op was mapped, 0 else
484 * - Maps signed Div nodes to calls to rt_Div():
486 runtime_rt rt_Div = {
487 ent("int rt_Div(int, int)"),
496 i_instr_record map_Div = {
499 i_mapper_RuntimeCall,
505 * - Maps ConvD(F) to calls to rt_Float2Div():
507 runtime_rt rt_Float2Double = {
508 ent("double rt_Float2Div(float)"),
509 get_type_mode("double"),
517 i_instr_record map_Float2Double = {
520 i_mapper_RuntimeCall,
526 FIRM_API int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);