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 * Used as callback, whenever a lowerable mux is found. The return value
118 * indicates, whether the mux should be lowered. This may be used, to lower
119 * floating point muxes, while keeping mux nodes for integers, for example.
121 * @param mux The mux node that may be lowered.
122 * @return A non-zero value indicates that the mux should be lowered.
124 typedef int lower_mux_callback(ir_node* mux);
127 * Lowers all mux nodes in the given graph. A callback function may be
128 * given, to select the mux nodes to lower.
130 * @param irg The graph to lower mux nodes in.
131 * @param cb_func The callback function for mux selection. Can be NULL,
132 * to lower all mux nodes.
134 FIRM_API void lower_mux(ir_graph *irg, lower_mux_callback *cb_func);
137 * Creates an ir_graph pass for lower_mux().
139 * @param name the name of this pass or NULL
140 * @param cb_func The callback function for mux selection. Can be NULL,
141 * to lower all mux nodes.
143 * @return the newly created ir_graph pass
145 FIRM_API ir_graph_pass_t *lower_mux_pass(const char *name,
146 lower_mux_callback *cb_func);
149 * An intrinsic mapper function.
151 * @param node the IR-node that will be mapped
152 * @param ctx a context
154 * @return non-zero if the call was mapped
156 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
159 INTRINSIC_CALL = 0, /**< the record represents an intrinsic call */
160 INTRINSIC_INSTR /**< the record represents an intrinsic instruction */
164 * An intrinsic call record.
166 typedef struct i_call_record {
167 enum ikind kind; /**< must be INTRINSIC_CALL */
168 ir_entity *i_ent; /**< the entity representing an intrinsic call */
169 i_mapper_func i_mapper; /**< the mapper function to call */
170 void *ctx; /**< mapper context */
171 void *link; /**< used in the construction algorithm, must be NULL */
175 * An intrinsic instruction record.
177 typedef struct i_instr_record {
178 enum ikind kind; /**< must be INTRINSIC_INSTR */
179 ir_op *op; /**< the opcode that must be mapped. */
180 i_mapper_func i_mapper; /**< the mapper function to call */
181 void *ctx; /**< mapper context */
182 void *link; /**< used in the construction algorithm, must be NULL */
186 * An intrinsic record.
188 typedef union i_record {
189 i_call_record i_call;
190 i_instr_record i_instr;
194 * Go through all graphs and map calls to intrinsic functions and instructions.
196 * Every call or instruction is reported to its mapper function,
197 * which is responsible for rebuilding the graph.
199 * current_ir_graph is always set.
201 * @param list an array of intrinsic map records
202 * @param length the length of the array
203 * @param part_block_used set to true if part_block() must be using during lowering
205 * @return number of found intrinsics.
207 FIRM_API size_t lower_intrinsics(i_record *list, size_t length,
208 int part_block_used);
211 * Creates an irprog pass for lower_intrinsics.
213 * @param name the name of this pass or NULL
214 * @param list an array of intrinsic map records
215 * @param length the length of the array
216 * @param part_block_used set to true if part_block() must be using during lowering
218 FIRM_API ir_prog_pass_t *lower_intrinsics_pass(const char *name, i_record *list,
219 size_t length, int part_block_used);
222 * A mapper for the integer/float absolute value: type abs(type v).
223 * Replaces the call by a Abs node.
227 FIRM_API int i_mapper_abs(ir_node *call, void *ctx);
230 * A mapper for the integer byte swap value: type bswap(type v).
231 * Replaces the call by a builtin[ir_bk_bswap] node.
235 FIRM_API int i_mapper_bswap(ir_node *call, void *ctx);
238 * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
240 * @return 1 if the sqrt call was removed, 0 else.
242 FIRM_API int i_mapper_sqrt(ir_node *call, void *ctx);
245 * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
247 * @return 1 if the cbrt call was removed, 0 else.
249 FIRM_API int i_mapper_cbrt(ir_node *call, void *ctx);
252 * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
254 * @return 1 if the pow call was removed, 0 else.
256 FIRM_API int i_mapper_pow(ir_node *call, void *ctx);
259 * A mapper for the floating point exp(a): floattype exp(floattype a);
261 * @return 1 if the exp call was removed, 0 else.
263 FIRM_API int i_mapper_exp(ir_node *call, void *ctx);
265 #define i_mapper_exp2 i_mapper_exp
266 #define i_mapper_exp10 i_mapper_exp
269 * A mapper for the floating point log(a): floattype log(floattype a);
271 * @return 1 if the log call was removed, 0 else.
273 FIRM_API int i_mapper_log(ir_node *call, void *ctx);
275 #define i_mapper_log2 i_mapper_log
276 #define i_mapper_log10 i_mapper_log
279 * A mapper for the floating point sin(a): floattype sin(floattype a);
281 * @return 1 if the sin call was removed, 0 else.
283 FIRM_API int i_mapper_sin(ir_node *call, void *ctx);
286 * A mapper for the floating point sin(a): floattype cos(floattype a);
288 * @return 1 if the cos call was removed, 0 else.
290 FIRM_API int i_mapper_cos(ir_node *call, void *ctx);
293 * A mapper for the floating point tan(a): floattype tan(floattype a);
295 * @return 1 if the tan call was removed, 0 else.
297 FIRM_API int i_mapper_tan(ir_node *call, void *ctx);
300 * A mapper for the floating point asin(a): floattype asin(floattype a);
302 * @return 1 if the asin call was removed, 0 else.
304 FIRM_API int i_mapper_asin(ir_node *call, void *ctx);
307 * A mapper for the floating point acos(a): floattype acos(floattype a);
309 * @return 1 if the tan call was removed, 0 else.
311 FIRM_API int i_mapper_acos(ir_node *call, void *ctx);
314 * A mapper for the floating point atan(a): floattype atan(floattype a);
316 * @return 1 if the atan call was removed, 0 else.
318 FIRM_API int i_mapper_atan(ir_node *call, void *ctx);
321 * A mapper for the floating point sinh(a): floattype sinh(floattype a);
323 * @return 1 if the sinh call was removed, 0 else.
325 FIRM_API int i_mapper_sinh(ir_node *call, void *ctx);
328 * A mapper for the floating point cosh(a): floattype cosh(floattype a);
330 * @return 1 if the cosh call was removed, 0 else.
332 FIRM_API int i_mapper_cosh(ir_node *call, void *ctx);
335 * A mapper for the floating point tanh(a): floattype tanh(floattype a);
337 * @return 1 if the tanh call was removed, 0 else.
339 FIRM_API int i_mapper_tanh(ir_node *call, void *ctx);
342 * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
344 * @return 1 if the strcmp call was removed, 0 else.
346 FIRM_API int i_mapper_strcmp(ir_node *call, void *ctx);
349 * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
351 * @return 1 if the strncmp call was removed, 0 else.
353 FIRM_API int i_mapper_strncmp(ir_node *call, void *ctx);
356 * A mapper for the strcpy-Function: char pointer strcpy(char pointer a, char pointer b);
358 * @return 1 if the strcpy call was removed, 0 else.
360 FIRM_API int i_mapper_strcpy(ir_node *call, void *ctx);
363 * A mapper for the strlen-Function: inttype strlen(char pointer a);
365 * @return 1 if the strlen call was removed, 0 else.
367 FIRM_API int i_mapper_strlen(ir_node *call, void *ctx);
370 * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
372 * @return 1 if the memcpy call was removed, 0 else.
374 FIRM_API int i_mapper_memcpy(ir_node *call, void *ctx);
377 * A mapper for the mempcpy-Function: void pointer mempcpy(void pointer d, void pointer s, inttype c);
379 * @return 1 if the mempcpy call was removed, 0 else.
381 FIRM_API int i_mapper_mempcpy(ir_node *call, void *ctx);
384 * A mapper for the memmove-Function: void pointer memmove(void pointer d, void pointer s, inttype c);
386 * @return 1 if the memmove call was removed, 0 else.
388 FIRM_API int i_mapper_memmove(ir_node *call, void *ctx);
391 * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
393 * @return 1 if the memset call was removed, 0 else.
395 FIRM_API int i_mapper_memset(ir_node *call, void *ctx);
398 * A mapper for the strncmp-Function: inttype memcmp(void pointer a, void pointer b, inttype len);
400 * @return 1 if the strncmp call was removed, 0 else.
402 FIRM_API int i_mapper_memcmp(ir_node *call, void *ctx);
405 * A mapper for the alloca() function: pointer alloca(inttype size)
406 * Replaces the call by a Alloca(stack_alloc) node.
410 FIRM_API int i_mapper_alloca(ir_node *call, void *ctx);
413 * A runtime routine description.
415 typedef struct runtime_rt {
416 ir_entity *ent; /**< The entity representing the runtime routine. */
417 ir_mode *mode; /**< The operation mode of the mapped instruction. */
418 ir_mode *res_mode; /**< The result mode of the mapped instruction or NULL. */
419 long mem_proj_nr; /**< if >= 0, create a memory ProjM() */
420 long regular_proj_nr; /**< if >= 0, create a regular ProjX() */
421 long exc_proj_nr; /**< if >= 0, create a exception ProjX() */
422 long res_proj_nr; /**< if >= 0, first result projection number */
426 * A mapper for mapping unsupported instructions to runtime calls.
427 * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
428 * rt(arg_0, ..., arg_n).
430 * The mapping is only done, if the modes of all arguments matches the
431 * modes of rt's argument.
432 * Further, if op has a memory input, the generated Call uses it, else
434 * The pinned state of the Call will be set to the pinned state of op.
436 * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
438 * @return 1 if an op was mapped, 0 else
442 * - Maps signed Div nodes to calls to rt_Div():
444 runtime_rt rt_Div = {
445 ent("int rt_Div(int, int)"),
454 i_instr_record map_Div = {
457 i_mapper_RuntimeCall,
463 * - Maps ConvD(F) to calls to rt_Float2Div():
465 runtime_rt rt_Float2Double = {
466 ent("double rt_Float2Div(float)"),
467 get_type_mode("double"),
475 i_instr_record map_Float2Double = {
478 i_mapper_RuntimeCall,
484 FIRM_API int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);