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
25 #ifndef FIRM_LOWERING_H
26 #define FIRM_LOWERING_H
30 #include "firm_types.h"
35 * @defgroup ir_lowering Lowering
37 * Lowering is the process of transforming a highlevel representation
38 * (a representation closer to the sourcecode) into a lower-level representation
39 * (something closer to the target machine).
45 * Lower small CopyB nodes to Load/Store nodes, preserve medium-sized CopyB
46 * nodes and replace large CopyBs by a call to memcpy, depending on the given
49 * Small CopyB nodes (size <= max_small_size) are turned into a series of
51 * Medium-sized CopyB nodes (max_small_size < size < min_large_size) are
53 * Large CopyB nodes (size >= min_large_size) are turned into a memcpy call.
55 * @param irg The graph to be lowered.
56 * @param max_small_size The maximum number of bytes for a CopyB node so
57 * that it is still considered 'small'.
58 * @param min_large_size The minimum number of bytes for a CopyB node so
59 * that it is regarded as 'large'.
60 * @param allow_misalignments Backend can handle misaligned loads and stores.
62 FIRM_API void lower_CopyB(ir_graph *irg, unsigned max_small_size,
63 unsigned min_large_size, int allow_misalignments);
66 * Lowers all Switches (Cond nodes with non-boolean mode) depending on spare_size.
67 * They will either remain the same or be converted into if-cascades.
69 * @param irg The ir graph to be lowered.
70 * @param small_switch If switch has <= cases then change it to an if-cascade.
71 * @param spare_size Allowed spare size for table switches in machine words.
72 * (Default in edgfe: 128)
73 * @param allow_out_of_bounds backend can handle out-of-bounds values
74 * (values bigger than minimum and maximum proj
77 FIRM_API void lower_switch(ir_graph *irg, unsigned small_switch,
78 unsigned spare_size, int allow_out_of_bounds);
81 * Replaces SymConsts by a real constant if possible.
82 * Replaces Sel nodes by address computation. Also resolves array access.
83 * Handle bit fields by added And/Or calculations.
85 * @param irg the graph to lower
87 * @note: There is NO lowering ob objects oriented types. This is highly compiler
88 * and ABI specific and should be placed directly in the compiler.
90 FIRM_API void lower_highlevel_graph(ir_graph *irg);
93 * Creates an ir_graph pass for lower_highlevel_graph().
95 * @param name the name of this pass or NULL
97 * @return the newly created ir_graph pass
99 FIRM_API ir_graph_pass_t *lower_highlevel_graph_pass(const char *name);
102 * Replaces SymConsts by a real constant if possible.
103 * Replaces Sel nodes by address computation. Also resolves array access.
104 * Handle bit fields by added And/Or calculations.
107 * @note There is NO lowering of objects oriented types. This is highly compiler
108 * and ABI specific and should be placed directly in the compiler.
110 FIRM_API void lower_highlevel(void);
113 * does the same as lower_highlevel for all nodes on the const code irg
115 FIRM_API void lower_const_code(void);
118 * Creates an ir_prog pass for lower_const_code().
120 * @param name the name of this pass or NULL
122 * @return the newly created ir_prog pass
124 FIRM_API ir_prog_pass_t *lower_const_code_pass(const char *name);
127 * Used as callback, whenever a lowerable mux is found. The return value
128 * indicates, whether the mux should be lowered. This may be used, to lower
129 * floating point muxes, while keeping mux nodes for integers, for example.
131 * @param mux The mux node that may be lowered.
132 * @return A non-zero value indicates that the mux should be lowered.
134 typedef int lower_mux_callback(ir_node* mux);
137 * Lowers all mux nodes in the given graph. A callback function may be
138 * given, to select the mux nodes to lower.
140 * @param irg The graph to lower mux nodes in.
141 * @param cb_func The callback function for mux selection. Can be NULL,
142 * to lower all mux nodes.
144 FIRM_API void lower_mux(ir_graph *irg, lower_mux_callback *cb_func);
147 * Creates an ir_graph pass for lower_mux().
149 * @param name the name of this pass or NULL
150 * @param cb_func The callback function for mux selection. Can be NULL,
151 * to lower all mux nodes.
153 * @return the newly created ir_graph pass
155 FIRM_API ir_graph_pass_t *lower_mux_pass(const char *name,
156 lower_mux_callback *cb_func);
159 * An intrinsic mapper function.
161 * @param node the IR-node that will be mapped
162 * @param ctx a context
164 * @return non-zero if the call was mapped
166 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
168 /** kind of an instruction record
171 INTRINSIC_CALL = 0, /**< the record represents an intrinsic call */
172 INTRINSIC_INSTR /**< the record represents an intrinsic instruction */
176 * An intrinsic call record.
178 typedef struct i_call_record {
179 enum ikind kind; /**< must be INTRINSIC_CALL */
180 ir_entity *i_ent; /**< the entity representing an intrinsic call */
181 i_mapper_func i_mapper; /**< the mapper function to call */
182 void *ctx; /**< mapper context */
183 void *link; /**< used in the construction algorithm, must be NULL */
187 * An intrinsic instruction record.
189 typedef struct i_instr_record {
190 enum ikind kind; /**< must be INTRINSIC_INSTR */
191 ir_op *op; /**< the opcode that must be mapped. */
192 i_mapper_func i_mapper; /**< the mapper function to call */
193 void *ctx; /**< mapper context */
194 void *link; /**< used in the construction algorithm, must be NULL */
198 * An intrinsic record.
200 typedef union i_record {
201 enum ikind kind; /**< kind of record */
202 i_call_record i_call; /**< used for call records */
203 i_instr_record i_instr; /**< used for isnstruction records */
207 * Go through all graphs and map calls to intrinsic functions and instructions.
209 * Every call or instruction is reported to its mapper function,
210 * which is responsible for rebuilding the graph.
212 * current_ir_graph is always set.
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 * @return number of found intrinsics.
220 FIRM_API size_t lower_intrinsics(i_record *list, size_t length,
221 int part_block_used);
224 * Creates an irprog pass for lower_intrinsics.
226 * @param name the name of this pass or NULL
227 * @param list an array of intrinsic map records
228 * @param length the length of the array
229 * @param part_block_used set to true if part_block() must be using during lowering
231 FIRM_API ir_prog_pass_t *lower_intrinsics_pass(const char *name, i_record *list,
232 size_t length, int part_block_used);
235 * A mapper for the integer/float absolute value: type abs(type v).
236 * Replaces the call by a Abs node.
240 FIRM_API int i_mapper_abs(ir_node *call, void *ctx);
243 * A mapper for the integer byte swap value: type bswap(type v).
244 * Replaces the call by a builtin[ir_bk_bswap] node.
248 FIRM_API int i_mapper_bswap(ir_node *call, void *ctx);
251 * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
253 * @return 1 if the sqrt call was removed, 0 else.
255 FIRM_API int i_mapper_sqrt(ir_node *call, void *ctx);
258 * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
260 * @return 1 if the cbrt call was removed, 0 else.
262 FIRM_API int i_mapper_cbrt(ir_node *call, void *ctx);
265 * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
267 * @return 1 if the pow call was removed, 0 else.
269 FIRM_API int i_mapper_pow(ir_node *call, void *ctx);
272 * A mapper for the floating point exp(a): floattype exp(floattype a);
274 * @return 1 if the exp call was removed, 0 else.
276 FIRM_API int i_mapper_exp(ir_node *call, void *ctx);
279 * A mapper for the floating point exp2(a): floattype exp2(floattype a);
281 * @return 1 if the exp call was removed, 0 else.
283 FIRM_API int i_mapper_exp2(ir_node *call, void *ctx);
286 * A mapper for the floating point exp10(a): floattype exp10(floattype a);
288 * @return 1 if the exp call was removed, 0 else.
290 FIRM_API int i_mapper_exp10(ir_node *call, void *ctx);
293 * A mapper for the floating point log(a): floattype log(floattype a);
295 * @return 1 if the log call was removed, 0 else.
297 FIRM_API int i_mapper_log(ir_node *call, void *ctx);
300 * A mapper for the floating point log(a): floattype log(floattype a);
302 * @return 1 if the log call was removed, 0 else.
304 FIRM_API int i_mapper_log2(ir_node *call, void *ctx);
307 * A mapper for the floating point log(a): floattype log(floattype a);
309 * @return 1 if the log call was removed, 0 else.
311 FIRM_API int i_mapper_log10(ir_node *call, void *ctx);
314 * A mapper for the floating point sin(a): floattype sin(floattype a);
316 * @return 1 if the sin call was removed, 0 else.
318 FIRM_API int i_mapper_sin(ir_node *call, void *ctx);
321 * A mapper for the floating point sin(a): floattype cos(floattype a);
323 * @return 1 if the cos call was removed, 0 else.
325 FIRM_API int i_mapper_cos(ir_node *call, void *ctx);
328 * A mapper for the floating point tan(a): floattype tan(floattype a);
330 * @return 1 if the tan call was removed, 0 else.
332 FIRM_API int i_mapper_tan(ir_node *call, void *ctx);
335 * A mapper for the floating point asin(a): floattype asin(floattype a);
337 * @return 1 if the asin call was removed, 0 else.
339 FIRM_API int i_mapper_asin(ir_node *call, void *ctx);
342 * A mapper for the floating point acos(a): floattype acos(floattype a);
344 * @return 1 if the tan call was removed, 0 else.
346 FIRM_API int i_mapper_acos(ir_node *call, void *ctx);
349 * A mapper for the floating point atan(a): floattype atan(floattype a);
351 * @return 1 if the atan call was removed, 0 else.
353 FIRM_API int i_mapper_atan(ir_node *call, void *ctx);
356 * A mapper for the floating point sinh(a): floattype sinh(floattype a);
358 * @return 1 if the sinh call was removed, 0 else.
360 FIRM_API int i_mapper_sinh(ir_node *call, void *ctx);
363 * A mapper for the floating point cosh(a): floattype cosh(floattype a);
365 * @return 1 if the cosh call was removed, 0 else.
367 FIRM_API int i_mapper_cosh(ir_node *call, void *ctx);
370 * A mapper for the floating point tanh(a): floattype tanh(floattype a);
372 * @return 1 if the tanh call was removed, 0 else.
374 FIRM_API int i_mapper_tanh(ir_node *call, void *ctx);
377 * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
379 * @return 1 if the strcmp call was removed, 0 else.
381 FIRM_API int i_mapper_strcmp(ir_node *call, void *ctx);
384 * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
386 * @return 1 if the strncmp call was removed, 0 else.
388 FIRM_API int i_mapper_strncmp(ir_node *call, void *ctx);
391 * A mapper for the strcpy-Function: char pointer strcpy(char pointer a, char pointer b);
393 * @return 1 if the strcpy call was removed, 0 else.
395 FIRM_API int i_mapper_strcpy(ir_node *call, void *ctx);
398 * A mapper for the strlen-Function: inttype strlen(char pointer a);
400 * @return 1 if the strlen call was removed, 0 else.
402 FIRM_API int i_mapper_strlen(ir_node *call, void *ctx);
405 * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
407 * @return 1 if the memcpy call was removed, 0 else.
409 FIRM_API int i_mapper_memcpy(ir_node *call, void *ctx);
412 * A mapper for the mempcpy-Function: void pointer mempcpy(void pointer d, void pointer s, inttype c);
414 * @return 1 if the mempcpy call was removed, 0 else.
416 FIRM_API int i_mapper_mempcpy(ir_node *call, void *ctx);
419 * A mapper for the memmove-Function: void pointer memmove(void pointer d, void pointer s, inttype c);
421 * @return 1 if the memmove call was removed, 0 else.
423 FIRM_API int i_mapper_memmove(ir_node *call, void *ctx);
426 * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
428 * @return 1 if the memset call was removed, 0 else.
430 FIRM_API int i_mapper_memset(ir_node *call, void *ctx);
433 * A mapper for the strncmp-Function: inttype memcmp(void pointer a, void pointer b, inttype len);
435 * @return 1 if the strncmp call was removed, 0 else.
437 FIRM_API int i_mapper_memcmp(ir_node *call, void *ctx);
440 * A mapper for the alloca() function: pointer alloca(inttype size)
441 * Replaces the call by a Alloca(stack_alloc) node.
445 FIRM_API int i_mapper_alloca(ir_node *call, void *ctx);
448 * A runtime routine description.
450 typedef struct runtime_rt {
451 ir_entity *ent; /**< The entity representing the runtime routine. */
452 ir_mode *mode; /**< The operation mode of the mapped instruction. */
453 ir_mode *res_mode; /**< The result mode of the mapped instruction or NULL. */
454 long mem_proj_nr; /**< if >= 0, create a memory ProjM() */
455 long regular_proj_nr; /**< if >= 0, create a regular ProjX() */
456 long exc_proj_nr; /**< if >= 0, create a exception ProjX() */
457 long res_proj_nr; /**< if >= 0, first result projection number */
461 * A mapper for mapping unsupported instructions to runtime calls.
462 * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
463 * rt(arg_0, ..., arg_n).
465 * The mapping is only done, if the modes of all arguments matches the
466 * modes of rt's argument.
467 * Further, if op has a memory input, the generated Call uses it, else
469 * The pinned state of the Call will be set to the pinned state of op.
471 * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
473 * @return 1 if an op was mapped, 0 else
477 * - Maps signed Div nodes to calls to rt_Div():
479 runtime_rt rt_Div = {
480 ent("int rt_Div(int, int)"),
489 i_instr_record map_Div = {
492 i_mapper_RuntimeCall,
498 * - Maps ConvD(F) to calls to rt_Float2Div():
500 runtime_rt rt_Float2Double = {
501 ent("double rt_Float2Div(float)"),
502 get_type_mode("double"),
510 i_instr_record map_Float2Double = {
513 i_mapper_RuntimeCall,
519 FIRM_API int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);