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)
164 FIRM_API void lower_switch(ir_graph *irg, unsigned spare_size);
167 * Creates an ir_graph pass for lower_switch().
169 * @param name the name of this pass or NULL
170 * @param spare_size Allowed spare size for table switches in machine words.
171 * (Default in edgfe: 128)
173 * @return the newly created ir_graph pass
175 FIRM_API ir_graph_pass_t *lower_switch_pass(const char *name,
176 unsigned spare_size);
179 * A callback type for creating an intrinsic entity for a given opcode.
181 * @param method the method type of the emulation function entity
182 * @param op the emulated ir_op
183 * @param imode the input mode of the emulated opcode
184 * @param omode the output mode of the emulated opcode
185 * @param context the context parameter
187 typedef ir_entity *(create_intrinsic_fkt)(ir_type *method, const ir_op *op,
188 const ir_mode *imode, const ir_mode *omode,
192 * The lowering parameter description.
194 typedef struct _lwrdw_param_t {
195 int enable; /**< if true lowering is enabled */
196 int little_endian; /**< if true should be lowered for little endian, else big endian */
197 ir_mode *high_signed; /**< the double word signed mode to be lowered, typically Ls */
198 ir_mode *high_unsigned; /**< the double word unsigned mode to be lowered, typically Lu */
199 ir_mode *low_signed; /**< the word signed mode to be used, typically Is */
200 ir_mode *low_unsigned; /**< the word unsigned mode to be used, typically Iu */
202 /** callback that creates the intrinsic entity */
203 create_intrinsic_fkt *create_intrinsic;
204 void *ctx; /**< context parameter for the creator function */
208 * Lower all double word operations.
210 * @param param parameter for lowering
212 FIRM_API void lower_dw_ops(const lwrdw_param_t *param);
215 * Creates an ir_prog pass for lower_dw_ops().
217 * @param name the name of this pass or NULL
218 * @param param parameter for lowering
220 * @return the newly created ir_prog pass
222 FIRM_API ir_prog_pass_t *lower_dw_ops_pass(const char *name,
223 const lwrdw_param_t *param);
226 * Default implementation. Context is unused.
228 FIRM_API ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
229 const ir_mode *imode,
230 const ir_mode *omode,
234 * Replaces SymConsts by a real constant if possible.
235 * Replace Sel nodes by address computation. Also resolves array access.
236 * Handle bit fields by added And/Or calculations.
238 * @param irg the graph to lower
239 * @param lower_bitfields the graph contains old-style bitfield
242 * @note: There is NO lowering ob objects oriented types. This is highly compiler
243 * and ABI specific and should be placed directly in the compiler.
245 FIRM_API void lower_highlevel_graph(ir_graph *irg, int lower_bitfields);
248 * Creates an ir_graph pass for lower_highlevel_graph().
250 * @param name the name of this pass or NULL
251 * @param lower_bitfields the graph contains old-style bitfield
254 * @return the newly created ir_graph pass
256 FIRM_API ir_graph_pass_t *lower_highlevel_graph_pass(const char *name,
257 int lower_bitfields);
260 * Replaces SymConsts by a real constant if possible.
261 * Replace Sel nodes by address computation. Also resolves array access.
262 * Handle bit fields by added And/Or calculations.
265 * @note There is NO lowering of objects oriented types. This is highly compiler
266 * and ABI specific and should be placed directly in the compiler.
268 FIRM_API void lower_highlevel(int lower_bitfields);
271 * does the same as lower_highlevel for all nodes on the const code irg
273 FIRM_API void lower_const_code(void);
276 * Creates an ir_prog pass for lower_const_code().
278 * @param name the name of this pass or NULL
280 * @return the newly created ir_prog pass
282 FIRM_API ir_prog_pass_t *lower_const_code_pass(const char *name);
284 typedef struct lower_mode_b_config_t {
285 /* mode that is used to transport 0/1 values */
286 ir_mode *lowered_mode;
287 /* preferred mode for the "set" operations (a psi that produces a 0 or 1) */
288 ir_mode *lowered_set_mode;
289 /* whether direct Cond -> Cmps should also be lowered */
290 int lower_direct_cmp;
291 } lower_mode_b_config_t;
294 * Lowers mode_b operations to integer arithmetic. After the lowering the only
295 * operations with mode_b are the Projs of Cmps; the only nodes with mode_b
296 * inputs are Cond and Psi nodes.
298 * Example: Psi(a < 0, 1, 0) => a >> 31
300 * @param irg the firm graph to lower
301 * @param config configuration for mode_b lowerer
303 FIRM_API void ir_lower_mode_b(ir_graph *irg,
304 const lower_mode_b_config_t *config);
307 * Creates an ir_graph pass for ir_lower_mode_b().
309 * @param name the name of this pass or NULL
310 * @param config configuration for mode_b lowerer
312 * @return the newly created ir_graph pass
314 FIRM_API ir_graph_pass_t *ir_lower_mode_b_pass(const char *name,
315 const lower_mode_b_config_t *config);
318 * Used as callback, whenever a lowerable mux is found. The return value
319 * indicates, whether the mux should be lowered. This may be used, to lower
320 * floating point muxes, while keeping mux nodes for integers, for example.
322 * @param mux The mux node that may be lowered.
323 * @return A non-zero value indicates that the mux should be lowered.
325 typedef int lower_mux_callback(ir_node* mux);
328 * Lowers all mux nodes in the given graph. A callback function may be
329 * given, to select the mux nodes to lower.
331 * @param irg The graph to lower mux nodes in.
332 * @param cb_func The callback function for mux selection. Can be NULL,
333 * to lower all mux nodes.
335 FIRM_API void lower_mux(ir_graph *irg, lower_mux_callback *cb_func);
338 * Creates an ir_graph pass for lower_mux().
340 * @param name the name of this pass or NULL
341 * @param cb_func The callback function for mux selection. Can be NULL,
342 * to lower all mux nodes.
344 * @return the newly created ir_graph pass
346 FIRM_API ir_graph_pass_t *lower_mux_pass(const char *name,
347 lower_mux_callback *cb_func);
350 * An intrinsic mapper function.
352 * @param node the IR-node that will be mapped
353 * @param ctx a context
355 * @return non-zero if the call was mapped
357 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
360 INTRINSIC_CALL = 0, /**< the record represents an intrinsic call */
361 INTRINSIC_INSTR /**< the record represents an intrinsic instruction */
365 * An intrinsic call record.
367 typedef struct _i_call_record {
368 enum ikind kind; /**< must be INTRINSIC_CALL */
369 ir_entity *i_ent; /**< the entity representing an intrinsic call */
370 i_mapper_func i_mapper; /**< the mapper function to call */
371 void *ctx; /**< mapper context */
372 void *link; /**< used in the construction algorithm, must be NULL */
376 * An intrinsic instruction record.
378 typedef struct _i_instr_record {
379 enum ikind kind; /**< must be INTRINSIC_INSTR */
380 ir_op *op; /**< the opcode that must be mapped. */
381 i_mapper_func i_mapper; /**< the mapper function to call */
382 void *ctx; /**< mapper context */
383 void *link; /**< used in the construction algorithm, must be NULL */
387 * An intrinsic record.
389 typedef union _i_record {
390 i_call_record i_call;
391 i_instr_record i_instr;
395 * Go through all graphs and map calls to intrinsic functions and instructions.
397 * Every call or instruction is reported to its mapper function,
398 * which is responsible for rebuilding the graph.
400 * current_ir_graph is always set.
402 * @param list an array of intrinsic map records
403 * @param length the length of the array
404 * @param part_block_used set to true if part_block() must be using during lowering
406 * @return number of found intrinsics.
408 FIRM_API unsigned lower_intrinsics(i_record *list, int length,
409 int part_block_used);
412 * Creates an irprog pass for lower_intrinsics.
414 * @param name the name of this pass or NULL
415 * @param list an array of intrinsic map records
416 * @param length the length of the array
417 * @param part_block_used set to true if part_block() must be using during lowering
419 FIRM_API ir_prog_pass_t *lower_intrinsics_pass(const char *name, i_record *list,
420 int length, int part_block_used);
423 * A mapper for the integer/float absolute value: type abs(type v).
424 * Replaces the call by a Abs node.
428 FIRM_API int i_mapper_abs(ir_node *call, void *ctx);
431 * A mapper for the integer byte swap value: type bswap(type v).
432 * Replaces the call by a builtin[ir_bk_bswap] node.
436 FIRM_API int i_mapper_bswap(ir_node *call, void *ctx);
439 * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
441 * @return 1 if the sqrt call was removed, 0 else.
443 FIRM_API int i_mapper_sqrt(ir_node *call, void *ctx);
446 * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
448 * @return 1 if the cbrt call was removed, 0 else.
450 FIRM_API int i_mapper_cbrt(ir_node *call, void *ctx);
453 * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
455 * @return 1 if the pow call was removed, 0 else.
457 FIRM_API int i_mapper_pow(ir_node *call, void *ctx);
460 * A mapper for the floating point exp(a): floattype exp(floattype a);
462 * @return 1 if the exp call was removed, 0 else.
464 FIRM_API int i_mapper_exp(ir_node *call, void *ctx);
466 #define i_mapper_exp2 i_mapper_exp
467 #define i_mapper_exp10 i_mapper_exp
470 * A mapper for the floating point log(a): floattype log(floattype a);
472 * @return 1 if the log call was removed, 0 else.
474 FIRM_API int i_mapper_log(ir_node *call, void *ctx);
476 #define i_mapper_log2 i_mapper_log
477 #define i_mapper_log10 i_mapper_log
480 * A mapper for the floating point sin(a): floattype sin(floattype a);
482 * @return 1 if the sin call was removed, 0 else.
484 FIRM_API int i_mapper_sin(ir_node *call, void *ctx);
487 * A mapper for the floating point sin(a): floattype cos(floattype a);
489 * @return 1 if the cos call was removed, 0 else.
491 FIRM_API int i_mapper_cos(ir_node *call, void *ctx);
494 * A mapper for the floating point tan(a): floattype tan(floattype a);
496 * @return 1 if the tan call was removed, 0 else.
498 FIRM_API int i_mapper_tan(ir_node *call, void *ctx);
501 * A mapper for the floating point asin(a): floattype asin(floattype a);
503 * @return 1 if the asin call was removed, 0 else.
505 FIRM_API int i_mapper_asin(ir_node *call, void *ctx);
508 * A mapper for the floating point acos(a): floattype acos(floattype a);
510 * @return 1 if the tan call was removed, 0 else.
512 FIRM_API int i_mapper_acos(ir_node *call, void *ctx);
515 * A mapper for the floating point atan(a): floattype atan(floattype a);
517 * @return 1 if the atan call was removed, 0 else.
519 FIRM_API int i_mapper_atan(ir_node *call, void *ctx);
522 * A mapper for the floating point sinh(a): floattype sinh(floattype a);
524 * @return 1 if the sinh call was removed, 0 else.
526 FIRM_API int i_mapper_sinh(ir_node *call, void *ctx);
529 * A mapper for the floating point cosh(a): floattype cosh(floattype a);
531 * @return 1 if the cosh call was removed, 0 else.
533 FIRM_API int i_mapper_cosh(ir_node *call, void *ctx);
536 * A mapper for the floating point tanh(a): floattype tanh(floattype a);
538 * @return 1 if the tanh call was removed, 0 else.
540 FIRM_API int i_mapper_tanh(ir_node *call, void *ctx);
543 * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
545 * @return 1 if the strcmp call was removed, 0 else.
547 FIRM_API int i_mapper_strcmp(ir_node *call, void *ctx);
550 * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
552 * @return 1 if the strncmp call was removed, 0 else.
554 FIRM_API int i_mapper_strncmp(ir_node *call, void *ctx);
557 * A mapper for the strcpy-Function: char pointer strcpy(char pointer a, char pointer b);
559 * @return 1 if the strcpy call was removed, 0 else.
561 FIRM_API int i_mapper_strcpy(ir_node *call, void *ctx);
564 * A mapper for the strlen-Function: inttype strlen(char pointer a);
566 * @return 1 if the strlen call was removed, 0 else.
568 FIRM_API int i_mapper_strlen(ir_node *call, void *ctx);
571 * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
573 * @return 1 if the memcpy call was removed, 0 else.
575 FIRM_API int i_mapper_memcpy(ir_node *call, void *ctx);
578 * A mapper for the mempcpy-Function: void pointer mempcpy(void pointer d, void pointer s, inttype c);
580 * @return 1 if the mempcpy call was removed, 0 else.
582 FIRM_API int i_mapper_mempcpy(ir_node *call, void *ctx);
585 * A mapper for the memmove-Function: void pointer memmove(void pointer d, void pointer s, inttype c);
587 * @return 1 if the memmove call was removed, 0 else.
589 FIRM_API int i_mapper_memmove(ir_node *call, void *ctx);
592 * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
594 * @return 1 if the memset call was removed, 0 else.
596 FIRM_API int i_mapper_memset(ir_node *call, void *ctx);
599 * A mapper for the strncmp-Function: inttype memcmp(void pointer a, void pointer b, inttype len);
601 * @return 1 if the strncmp call was removed, 0 else.
603 FIRM_API int i_mapper_memcmp(ir_node *call, void *ctx);
606 * A mapper for the alloca() function: pointer alloca(inttype size)
607 * Replaces the call by a Alloca(stack_alloc) node.
611 FIRM_API int i_mapper_alloca(ir_node *call, void *ctx);
614 * A runtime routine description.
616 typedef struct _runtime_rt {
617 ir_entity *ent; /**< The entity representing the runtime routine. */
618 ir_mode *mode; /**< The operation mode of the mapped instruction. */
619 ir_mode *res_mode; /**< The result mode of the mapped instruction or NULL. */
620 long mem_proj_nr; /**< if >= 0, create a memory ProjM() */
621 long regular_proj_nr; /**< if >= 0, create a regular ProjX() */
622 long exc_proj_nr; /**< if >= 0, create a exception ProjX() */
623 long exc_mem_proj_nr; /**< if >= 0, create a exception memory ProjM() */
624 long res_proj_nr; /**< if >= 0, first result projection number */
628 * A mapper for mapping unsupported instructions to runtime calls.
629 * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
630 * rt(arg_0, ..., arg_n).
632 * The mapping is only done, if the modes of all arguments matches the
633 * modes of rt's argument.
634 * Further, if op has a memory input, the generated Call uses it, else
636 * The pinned state of the Call will be set to the pinned state of op.
638 * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
640 * @return 1 if an op was mapped, 0 else
644 * - Maps signed Div nodes to calls to rt_Div():
646 runtime_rt rt_Div = {
647 ent("int rt_Div(int, int)"),
656 i_instr_record map_Div = {
659 i_mapper_RuntimeCall,
665 * - Maps ConvD(F) to calls to rt_Float2Div():
667 runtime_rt rt_Float2Double = {
668 ent("double rt_Float2Div(float)"),
669 get_type_mode("double"),
677 i_instr_record map_Float2Double = {
680 i_mapper_RuntimeCall,
686 FIRM_API int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);