2 * Copyright (C) 1995-2008 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
29 #include "firm_types.h"
34 * A type telling where to add hidden parameters.
36 typedef enum add_hidden_params {
37 ADD_HIDDEN_ALWAYS_IN_FRONT = 0, /**< always add hidden parameters in front (default). */
38 ADD_HIDDEN_ALWAYS_LAST = 1, /**< always add hidden parameters last, did not work for variadic functions. */
39 ADD_HIDDEN_SMART = 2 /**< add hidden parameters last for non-variadic and first for variadic functions. */
43 * Additional flags for the lowering.
46 LF_NONE = 0, /**< no additional flags */
47 LF_COMPOUND_PARAM = 1, /**< lower calls with compound parameters */
48 LF_COMPOUND_RETURN = 2, /**< lower calls with compound returns */
49 LF_RETURN_HIDDEN = 4, /**< return the hidden address instead of void */
50 LF_SMALL_CMP_IN_REGS = 8 /**< return small compound values in registers */
53 /** Maximum number of registers that can be used to return compound values. */
54 #define MAX_REGISTER_RET_VAL 2
57 * A struct containing all control parameters for
58 * lower_compound_ret_calls().
61 int def_ptr_alignment; /**< Default alignment for data pointer. */
62 unsigned flags; /**< A bitmask of enum lowering_flags. */
63 add_hidden hidden_params; /**< Where to add hidden parameters. */
66 * A function returning a pointer type for a given type.
67 * If this pointer is NULL, a new pointer type is always created.
69 ir_type *(*find_pointer_type)(ir_type *e_type, ir_mode *mode, int alignment);
72 * If the LF_SMALL_CMP_IN_REGS flag is set, this function will be called
73 * to decide, whether a compound value should be returned in registers.
74 * This function must return the number of used registers and fill in the modes
75 * of the registers to use. Up to MAX_REGISTER_RET_VAL registers can be used.
77 int (*ret_compound_in_regs)(ir_type *compound_tp, ir_mode **modes);
81 * Lower calls with compound parameter and return types.
82 * This function does the following transformations:
84 * If LF_COMPOUND_PARAM is set:
86 * - Copy compound parameters to a new location on the callers
87 * stack and transmit the address of this new location
89 * If LF_COMPOUND_RETURN is set:
91 * - Adds a new (hidden) pointer parameter for
92 * any return compound type. The return type is replaced by void
93 * or if LOWERING_FLAGS_RETURN_HIDDEN is set by the address.
95 * - Use of the hidden parameters in the function code.
97 * - Change all calls to functions with compound return
98 * by providing space for the hidden parameter on the callers
101 * - Replace a possible block copy after the function call.
105 * - Changes the types of methods and calls to the lowered ones
107 * - lower all method types of existing entities
109 * In pseudo-code, the following transformation is done:
112 struct x ret = func(a, b);
121 * If the function returns only one possible result, the copy-on-return
122 * optimization is done, ie.
131 * is transformed into
134 void func(struct x *ret, a) {
139 * @param params A structure containing the control parameter for this
142 * During the transformation, pointer types must be created or reused.
143 * The caller can provide params->find_pointer_type for this task to
144 * reduce the number of created pointer types.
145 * If params->find_pointer_type is NULL, new pointer types
146 * are always created automatically.
148 FIRM_API void lower_calls_with_compounds(const lower_params_t *params);
151 * Lower CopyB nodes of size smaller that max_size into Loads/Stores
153 FIRM_API void lower_CopyB(ir_graph *irg, unsigned max_size,
154 unsigned native_mode_bytes);
157 * Lowers all Switches (Cond nodes with non-boolean mode) depending on spare_size.
158 * They will either remain the same or be converted into if-cascades.
160 * @param irg The ir graph to be lowered.
161 * @param spare_size Allowed spare size for table switches in machine words.
162 * (Default in edgfe: 128)
163 * @param allow_out_of_bounds backend can handle out-of-bounds values
164 * (values bigger than minimum and maximum proj
167 FIRM_API void lower_switch(ir_graph *irg, unsigned spare_size,
168 int allow_out_of_bounds);
171 * A callback type for creating an intrinsic entity for a given opcode.
173 * @param method the method type of the emulation function entity
174 * @param op the emulated ir_op
175 * @param imode the input mode of the emulated opcode
176 * @param omode the output mode of the emulated opcode
177 * @param context the context parameter
179 typedef ir_entity *(create_intrinsic_fkt)(ir_type *method, const ir_op *op,
180 const ir_mode *imode,
181 const ir_mode *omode, void *context);
184 * The lowering parameter description.
186 typedef struct lwrdw_param_t {
187 unsigned little_endian : 1; /**< if true should be lowered for little endian, else big endian */
188 unsigned doubleword_size; /**< bitsize of the doubleword mode */
189 create_intrinsic_fkt *create_intrinsic; /**< callback that creates the intrinsic entity */
190 void *ctx; /**< context parameter for the creator function */
194 * Lower all double word operations.
196 * @param param parameter for lowering
198 FIRM_API void lower_dw_ops(const lwrdw_param_t *param);
201 * Default implementation. Context is unused.
203 FIRM_API ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
204 const ir_mode *imode,
205 const ir_mode *omode,
209 * Replaces SymConsts by a real constant if possible.
210 * Replace Sel nodes by address computation. Also resolves array access.
211 * Handle bit fields by added And/Or calculations.
213 * @param irg the graph to lower
214 * @param lower_bitfields the graph contains old-style bitfield
217 * @note: There is NO lowering ob objects oriented types. This is highly compiler
218 * and ABI specific and should be placed directly in the compiler.
220 FIRM_API void lower_highlevel_graph(ir_graph *irg, int lower_bitfields);
223 * Creates an ir_graph pass for lower_highlevel_graph().
225 * @param name the name of this pass or NULL
226 * @param lower_bitfields the graph contains old-style bitfield
229 * @return the newly created ir_graph pass
231 FIRM_API ir_graph_pass_t *lower_highlevel_graph_pass(const char *name,
232 int lower_bitfields);
235 * Replaces SymConsts by a real constant if possible.
236 * Replace Sel nodes by address computation. Also resolves array access.
237 * Handle bit fields by added And/Or calculations.
240 * @note There is NO lowering of objects oriented types. This is highly compiler
241 * and ABI specific and should be placed directly in the compiler.
243 FIRM_API void lower_highlevel(int lower_bitfields);
246 * does the same as lower_highlevel for all nodes on the const code irg
248 FIRM_API void lower_const_code(void);
251 * Creates an ir_prog pass for lower_const_code().
253 * @param name the name of this pass or NULL
255 * @return the newly created ir_prog pass
257 FIRM_API ir_prog_pass_t *lower_const_code_pass(const char *name);
260 * Function which creates a "set" instraction. A "set" instruction takes a
261 * condition value (a value with mode_b) as input and produces a value in a
262 * general purpose integer mode.
263 * Most architectures have special intrinsics for this. But if all else fails
264 * you can just produces the an if-like construct.
266 typedef ir_node* (*create_set_func)(ir_node *cond);
269 * implementation of create_set_func which produces a Mux node with 0/1 input
271 ir_node *ir_create_mux_set(ir_node *cond, ir_mode *dest_mode);
274 * implementation of create_set_func which produces a cond with control
277 ir_node *ir_create_cond_set(ir_node *cond, ir_mode *dest_mode);
279 typedef struct lower_mode_b_config_t {
280 /* mode that is used to transport 0/1 values */
281 ir_mode *lowered_mode;
282 /* callback for creating set-like instructions */
283 create_set_func create_set;
284 /* whether direct Cond(Cmp) should also be lowered */
285 int lower_direct_cmp;
286 } lower_mode_b_config_t;
289 * Lowers mode_b operations to integer arithmetic. After the lowering the only
290 * operations with mode_b are the Projs of Cmps; the only nodes with mode_b
291 * inputs are Cond and Psi nodes.
293 * Example: Psi(a < 0, 1, 0) => a >> 31
295 * @param irg the firm graph to lower
296 * @param config configuration for mode_b lowerer
298 FIRM_API void ir_lower_mode_b(ir_graph *irg,
299 const lower_mode_b_config_t *config);
302 * Used as callback, whenever a lowerable mux is found. The return value
303 * indicates, whether the mux should be lowered. This may be used, to lower
304 * floating point muxes, while keeping mux nodes for integers, for example.
306 * @param mux The mux node that may be lowered.
307 * @return A non-zero value indicates that the mux should be lowered.
309 typedef int lower_mux_callback(ir_node* mux);
312 * Lowers all mux nodes in the given graph. A callback function may be
313 * given, to select the mux nodes to lower.
315 * @param irg The graph to lower mux nodes in.
316 * @param cb_func The callback function for mux selection. Can be NULL,
317 * to lower all mux nodes.
319 FIRM_API void lower_mux(ir_graph *irg, lower_mux_callback *cb_func);
322 * Creates an ir_graph pass for lower_mux().
324 * @param name the name of this pass or NULL
325 * @param cb_func The callback function for mux selection. Can be NULL,
326 * to lower all mux nodes.
328 * @return the newly created ir_graph pass
330 FIRM_API ir_graph_pass_t *lower_mux_pass(const char *name,
331 lower_mux_callback *cb_func);
334 * An intrinsic mapper function.
336 * @param node the IR-node that will be mapped
337 * @param ctx a context
339 * @return non-zero if the call was mapped
341 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
344 INTRINSIC_CALL = 0, /**< the record represents an intrinsic call */
345 INTRINSIC_INSTR /**< the record represents an intrinsic instruction */
349 * An intrinsic call record.
351 typedef struct i_call_record {
352 enum ikind kind; /**< must be INTRINSIC_CALL */
353 ir_entity *i_ent; /**< the entity representing an intrinsic call */
354 i_mapper_func i_mapper; /**< the mapper function to call */
355 void *ctx; /**< mapper context */
356 void *link; /**< used in the construction algorithm, must be NULL */
360 * An intrinsic instruction record.
362 typedef struct i_instr_record {
363 enum ikind kind; /**< must be INTRINSIC_INSTR */
364 ir_op *op; /**< the opcode that must be mapped. */
365 i_mapper_func i_mapper; /**< the mapper function to call */
366 void *ctx; /**< mapper context */
367 void *link; /**< used in the construction algorithm, must be NULL */
371 * An intrinsic record.
373 typedef union i_record {
374 i_call_record i_call;
375 i_instr_record i_instr;
379 * Go through all graphs and map calls to intrinsic functions and instructions.
381 * Every call or instruction is reported to its mapper function,
382 * which is responsible for rebuilding the graph.
384 * current_ir_graph is always set.
386 * @param list an array of intrinsic map records
387 * @param length the length of the array
388 * @param part_block_used set to true if part_block() must be using during lowering
390 * @return number of found intrinsics.
392 FIRM_API unsigned lower_intrinsics(i_record *list, int length,
393 int part_block_used);
396 * Creates an irprog pass for lower_intrinsics.
398 * @param name the name of this pass or NULL
399 * @param list an array of intrinsic map records
400 * @param length the length of the array
401 * @param part_block_used set to true if part_block() must be using during lowering
403 FIRM_API ir_prog_pass_t *lower_intrinsics_pass(const char *name, i_record *list,
404 int length, int part_block_used);
407 * A mapper for the integer/float absolute value: type abs(type v).
408 * Replaces the call by a Abs node.
412 FIRM_API int i_mapper_abs(ir_node *call, void *ctx);
415 * A mapper for the integer byte swap value: type bswap(type v).
416 * Replaces the call by a builtin[ir_bk_bswap] node.
420 FIRM_API int i_mapper_bswap(ir_node *call, void *ctx);
423 * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
425 * @return 1 if the sqrt call was removed, 0 else.
427 FIRM_API int i_mapper_sqrt(ir_node *call, void *ctx);
430 * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
432 * @return 1 if the cbrt call was removed, 0 else.
434 FIRM_API int i_mapper_cbrt(ir_node *call, void *ctx);
437 * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
439 * @return 1 if the pow call was removed, 0 else.
441 FIRM_API int i_mapper_pow(ir_node *call, void *ctx);
444 * A mapper for the floating point exp(a): floattype exp(floattype a);
446 * @return 1 if the exp call was removed, 0 else.
448 FIRM_API int i_mapper_exp(ir_node *call, void *ctx);
450 #define i_mapper_exp2 i_mapper_exp
451 #define i_mapper_exp10 i_mapper_exp
454 * A mapper for the floating point log(a): floattype log(floattype a);
456 * @return 1 if the log call was removed, 0 else.
458 FIRM_API int i_mapper_log(ir_node *call, void *ctx);
460 #define i_mapper_log2 i_mapper_log
461 #define i_mapper_log10 i_mapper_log
464 * A mapper for the floating point sin(a): floattype sin(floattype a);
466 * @return 1 if the sin call was removed, 0 else.
468 FIRM_API int i_mapper_sin(ir_node *call, void *ctx);
471 * A mapper for the floating point sin(a): floattype cos(floattype a);
473 * @return 1 if the cos call was removed, 0 else.
475 FIRM_API int i_mapper_cos(ir_node *call, void *ctx);
478 * A mapper for the floating point tan(a): floattype tan(floattype a);
480 * @return 1 if the tan call was removed, 0 else.
482 FIRM_API int i_mapper_tan(ir_node *call, void *ctx);
485 * A mapper for the floating point asin(a): floattype asin(floattype a);
487 * @return 1 if the asin call was removed, 0 else.
489 FIRM_API int i_mapper_asin(ir_node *call, void *ctx);
492 * A mapper for the floating point acos(a): floattype acos(floattype a);
494 * @return 1 if the tan call was removed, 0 else.
496 FIRM_API int i_mapper_acos(ir_node *call, void *ctx);
499 * A mapper for the floating point atan(a): floattype atan(floattype a);
501 * @return 1 if the atan call was removed, 0 else.
503 FIRM_API int i_mapper_atan(ir_node *call, void *ctx);
506 * A mapper for the floating point sinh(a): floattype sinh(floattype a);
508 * @return 1 if the sinh call was removed, 0 else.
510 FIRM_API int i_mapper_sinh(ir_node *call, void *ctx);
513 * A mapper for the floating point cosh(a): floattype cosh(floattype a);
515 * @return 1 if the cosh call was removed, 0 else.
517 FIRM_API int i_mapper_cosh(ir_node *call, void *ctx);
520 * A mapper for the floating point tanh(a): floattype tanh(floattype a);
522 * @return 1 if the tanh call was removed, 0 else.
524 FIRM_API int i_mapper_tanh(ir_node *call, void *ctx);
527 * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
529 * @return 1 if the strcmp call was removed, 0 else.
531 FIRM_API int i_mapper_strcmp(ir_node *call, void *ctx);
534 * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
536 * @return 1 if the strncmp call was removed, 0 else.
538 FIRM_API int i_mapper_strncmp(ir_node *call, void *ctx);
541 * A mapper for the strcpy-Function: char pointer strcpy(char pointer a, char pointer b);
543 * @return 1 if the strcpy call was removed, 0 else.
545 FIRM_API int i_mapper_strcpy(ir_node *call, void *ctx);
548 * A mapper for the strlen-Function: inttype strlen(char pointer a);
550 * @return 1 if the strlen call was removed, 0 else.
552 FIRM_API int i_mapper_strlen(ir_node *call, void *ctx);
555 * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
557 * @return 1 if the memcpy call was removed, 0 else.
559 FIRM_API int i_mapper_memcpy(ir_node *call, void *ctx);
562 * A mapper for the mempcpy-Function: void pointer mempcpy(void pointer d, void pointer s, inttype c);
564 * @return 1 if the mempcpy call was removed, 0 else.
566 FIRM_API int i_mapper_mempcpy(ir_node *call, void *ctx);
569 * A mapper for the memmove-Function: void pointer memmove(void pointer d, void pointer s, inttype c);
571 * @return 1 if the memmove call was removed, 0 else.
573 FIRM_API int i_mapper_memmove(ir_node *call, void *ctx);
576 * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
578 * @return 1 if the memset call was removed, 0 else.
580 FIRM_API int i_mapper_memset(ir_node *call, void *ctx);
583 * A mapper for the strncmp-Function: inttype memcmp(void pointer a, void pointer b, inttype len);
585 * @return 1 if the strncmp call was removed, 0 else.
587 FIRM_API int i_mapper_memcmp(ir_node *call, void *ctx);
590 * A mapper for the alloca() function: pointer alloca(inttype size)
591 * Replaces the call by a Alloca(stack_alloc) node.
595 FIRM_API int i_mapper_alloca(ir_node *call, void *ctx);
598 * A runtime routine description.
600 typedef struct runtime_rt {
601 ir_entity *ent; /**< The entity representing the runtime routine. */
602 ir_mode *mode; /**< The operation mode of the mapped instruction. */
603 ir_mode *res_mode; /**< The result mode of the mapped instruction or NULL. */
604 long mem_proj_nr; /**< if >= 0, create a memory ProjM() */
605 long regular_proj_nr; /**< if >= 0, create a regular ProjX() */
606 long exc_proj_nr; /**< if >= 0, create a exception ProjX() */
607 long exc_mem_proj_nr; /**< if >= 0, create a exception memory ProjM() */
608 long res_proj_nr; /**< if >= 0, first result projection number */
612 * A mapper for mapping unsupported instructions to runtime calls.
613 * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
614 * rt(arg_0, ..., arg_n).
616 * The mapping is only done, if the modes of all arguments matches the
617 * modes of rt's argument.
618 * Further, if op has a memory input, the generated Call uses it, else
620 * The pinned state of the Call will be set to the pinned state of op.
622 * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
624 * @return 1 if an op was mapped, 0 else
628 * - Maps signed Div nodes to calls to rt_Div():
630 runtime_rt rt_Div = {
631 ent("int rt_Div(int, int)"),
640 i_instr_record map_Div = {
643 i_mapper_RuntimeCall,
649 * - Maps ConvD(F) to calls to rt_Float2Div():
651 runtime_rt rt_Float2Double = {
652 ent("double rt_Float2Div(float)"),
653 get_type_mode("double"),
661 i_instr_record map_Float2Double = {
664 i_mapper_RuntimeCall,
670 FIRM_API int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);