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"
31 * A type telling where to add hidden parameters.
33 typedef enum add_hidden_params {
34 ADD_HIDDEN_ALWAYS_IN_FRONT = 0, /**< always add hidden parameters in front (default). */
35 ADD_HIDDEN_ALWAYS_LAST = 1, /**< always add hidden parameters last, did not work for variadic functions. */
36 ADD_HIDDEN_SMART = 2 /**< add hidden parameters last for non-variadic and first for variadic functions. */
40 * Additional flags for the lowering.
43 LF_NONE = 0, /**< no additional flags */
44 LF_COMPOUND_PARAM = 1, /**< lower calls with compound parameters */
45 LF_COMPOUND_RETURN = 2, /**< lower calls with compound returns */
46 LF_RETURN_HIDDEN = 4, /**< return the hidden address instead of void */
47 LF_SMALL_CMP_IN_REGS = 8 /**< return small compound values in registers */
50 /** Maximum number of registers that can be used to return compound values. */
51 #define MAX_REGISTER_RET_VAL 2
54 * A struct containing all control parameters for
55 * lower_compound_ret_calls().
58 int def_ptr_alignment; /**< Default alignment for data pointer. */
59 unsigned flags; /**< A bitmask of enum lowering_flags. */
60 add_hidden hidden_params; /**< Where to add hidden parameters. */
63 * A function returning a pointer type for a given type.
64 * If this pointer is NULL, a new pointer type is always created.
66 ir_type *(*find_pointer_type)(ir_type *e_type, ir_mode *mode, int alignment);
69 * If the LF_SMALL_CMP_IN_REGS flag is set, this function will be called
70 * to decide, whether a compound value should be returned in registers.
71 * This function must return the number of used registers and fill in the modes
72 * of the registers to use. Up to MAX_REGISTER_RET_VAL registers can be used.
74 int (*ret_compound_in_regs)(ir_type *compound_tp, ir_mode **modes);
78 * Lower calls with compound parameter and return types.
79 * This function does the following transformations:
81 * If LF_COMPOUND_PARAM is set:
83 * - Copy compound parameters to a new location on the callers
84 * stack and transmit the address of this new location
86 * If LF_COMPOUND_RETURN is set:
88 * - Adds a new (hidden) pointer parameter for
89 * any return compound type. The return type is replaced by void
90 * or if LOWERING_FLAGS_RETURN_HIDDEN is set by the address.
92 * - Use of the hidden parameters in the function code.
94 * - Change all calls to functions with compound return
95 * by providing space for the hidden parameter on the callers
98 * - Replace a possible block copy after the function call.
102 * - Changes the types of methods and calls to the lowered ones
104 * - lower all method types of existing entities
106 * In pseudo-code, the following transformation is done:
109 struct x ret = func(a, b);
118 * If the function returns only one possible result, the copy-on-return
119 * optimization is done, ie.
128 * is transformed into
131 void func(struct x *ret, a) {
136 * @param params A structure containing the control parameter for this
139 * During the transformation, pointer types must be created or reused.
140 * The caller can provide params->find_pointer_type for this task to
141 * reduce the number of created pointer types.
142 * If params->find_pointer_type is NULL, new pointer types
143 * are always created automatically.
145 void lower_calls_with_compounds(const lower_params_t *params);
148 * * Lower CopyB nodes of size smaller that max_size into Loads/Stores
150 void lower_CopyB(ir_graph *irg, unsigned max_size, unsigned native_mode_bytes);
153 * Lowers all Switches (Cond nodes with non-boolean mode) depending on spare_size.
154 * They will either remain the same or be converted into if-cascades.
156 * @param irg The ir graph to be lowered.
157 * @param spare_size Allowed spare size for table switches in machine words.
158 * (Default in edgfe: 128)
160 void lower_switch(ir_graph *irg, unsigned spare_size);
163 * Creates an ir_graph pass for lower_switch().
165 * @param name the name of this pass or NULL
166 * @param spare_size Allowed spare size for table switches in machine words.
167 * (Default in edgfe: 128)
169 * @return the newly created ir_graph pass
171 ir_graph_pass_t *lower_switch_pass(const char *name, unsigned spare_size);
174 * A callback type for creating an intrinsic entity for a given opcode.
176 * @param method the method type of the emulation function entity
177 * @param op the emulated ir_op
178 * @param imode the input mode of the emulated opcode
179 * @param omode the output mode of the emulated opcode
180 * @param context the context parameter
182 typedef ir_entity *(create_intrinsic_fkt)(ir_type *method, const ir_op *op,
183 const ir_mode *imode, const ir_mode *omode,
187 * The lowering parameter description.
189 typedef struct _lwrdw_param_t {
190 int enable; /**< if true lowering is enabled */
191 int little_endian; /**< if true should be lowered for little endian, else big endian */
192 ir_mode *high_signed; /**< the double word signed mode to be lowered, typically Ls */
193 ir_mode *high_unsigned; /**< the double word unsigned mode to be lowered, typically Lu */
194 ir_mode *low_signed; /**< the word signed mode to be used, typically Is */
195 ir_mode *low_unsigned; /**< the word unsigned mode to be used, typically Iu */
197 /** callback that creates the intrinsic entity */
198 create_intrinsic_fkt *create_intrinsic;
199 void *ctx; /**< context parameter for the creator function */
203 * Lower all double word operations.
205 * @param param parameter for lowering
207 void lower_dw_ops(const lwrdw_param_t *param);
210 * Creates an ir_prog pass for lower_dw_ops().
212 * @param name the name of this pass or NULL
213 * @param param parameter for lowering
215 * @return the newly created ir_prog pass
217 ir_prog_pass_t *lower_dw_ops_pass(const char *name, const lwrdw_param_t *param);
220 * Default implementation. Context is unused.
222 ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
223 const ir_mode *imode, const ir_mode *omode,
227 * Replaces SymConsts by a real constant if possible.
228 * Replace Sel nodes by address computation. Also resolves array access.
229 * Handle bit fields by added And/Or calculations.
231 * @param irg the graph to lower
232 * @param lower_bitfields the graph contains old-style bitfield
235 * @note: There is NO lowering ob objects oriented types. This is highly compiler
236 * and ABI specific and should be placed directly in the compiler.
238 void lower_highlevel_graph(ir_graph *irg, int lower_bitfields);
241 * Creates an ir_graph pass for lower_highlevel_graph().
243 * @param name the name of this pass or NULL
244 * @param lower_bitfields the graph contains old-style bitfield
247 * @return the newly created ir_graph pass
249 ir_graph_pass_t *lower_highlevel_graph_pass(const char *name, int lower_bitfields);
252 * Replaces SymConsts by a real constant if possible.
253 * Replace Sel nodes by address computation. Also resolves array access.
254 * Handle bit fields by added And/Or calculations.
257 * @note There is NO lowering of objects oriented types. This is highly compiler
258 * and ABI specific and should be placed directly in the compiler.
260 void lower_highlevel(int lower_bitfields);
263 * does the same as lower_highlevel for all nodes on the const code irg
265 void lower_const_code(void);
268 * Creates an ir_prog pass for lower_const_code().
270 * @param name the name of this pass or NULL
272 * @return the newly created ir_prog pass
274 ir_prog_pass_t *lower_const_code_pass(const char *name);
276 typedef struct lower_mode_b_config_t {
277 /* mode that is used to transport 0/1 values */
278 ir_mode *lowered_mode;
279 /* preferred mode for the "set" operations (a psi that produces a 0 or 1) */
280 ir_mode *lowered_set_mode;
281 /* whether direct Cond -> Cmps should also be lowered */
282 int lower_direct_cmp;
283 } lower_mode_b_config_t;
286 * Lowers mode_b operations to integer arithmetic. After the lowering the only
287 * operations with mode_b are the Projs of Cmps; the only nodes with mode_b
288 * inputs are Cond and Psi nodes.
290 * Example: Psi(a < 0, 1, 0) => a >> 31
292 * @param irg the firm graph to lower
293 * @param config configuration for mode_b lowerer
295 void ir_lower_mode_b(ir_graph *irg, const lower_mode_b_config_t *config);
298 * Creates an ir_graph pass for ir_lower_mode_b().
300 * @param name the name of this pass or NULL
301 * @param config configuration for mode_b lowerer
303 * @return the newly created ir_graph pass
305 ir_graph_pass_t *ir_lower_mode_b_pass(
306 const char *name, const lower_mode_b_config_t *config);
309 * Used as callback, whenever a lowerable mux is found. The return value
310 * indicates, whether the mux should be lowered. This may be used, to lower
311 * floating point muxes, while keeping mux nodes for integers, for example.
313 * @param mux The mux node that may be lowered.
314 * @return A non-zero value indicates that the mux should be lowered.
316 typedef int lower_mux_callback(ir_node* mux);
319 * Lowers all mux nodes in the given graph. A callback function may be
320 * given, to select the mux nodes to lower.
322 * @param irg The graph to lower mux nodes in.
323 * @param cb_func The callback function for mux selection. Can be NULL,
324 * to lower all mux nodes.
326 void lower_mux(ir_graph *irg, lower_mux_callback *cb_func);
329 * Creates an ir_graph pass for lower_mux().
331 * @param name the name of this pass or NULL
332 * @param cb_func The callback function for mux selection. Can be NULL,
333 * to lower all mux nodes.
335 * @return the newly created ir_graph pass
337 ir_graph_pass_t *lower_mux_pass(const char *name, lower_mux_callback *cb_func);
340 * An intrinsic mapper function.
342 * @param node the IR-node that will be mapped
343 * @param ctx a context
345 * @return non-zero if the call was mapped
347 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
350 INTRINSIC_CALL = 0, /**< the record represents an intrinsic call */
351 INTRINSIC_INSTR /**< the record represents an intrinsic instruction */
355 * An intrinsic call record.
357 typedef struct _i_call_record {
358 enum ikind kind; /**< must be INTRINSIC_CALL */
359 ir_entity *i_ent; /**< the entity representing an intrinsic call */
360 i_mapper_func i_mapper; /**< the mapper function to call */
361 void *ctx; /**< mapper context */
362 void *link; /**< used in the construction algorithm, must be NULL */
366 * An intrinsic instruction record.
368 typedef struct _i_instr_record {
369 enum ikind kind; /**< must be INTRINSIC_INSTR */
370 ir_op *op; /**< the opcode that must be mapped. */
371 i_mapper_func i_mapper; /**< the mapper function to call */
372 void *ctx; /**< mapper context */
373 void *link; /**< used in the construction algorithm, must be NULL */
377 * An intrinsic record.
379 typedef union _i_record {
380 i_call_record i_call;
381 i_instr_record i_instr;
385 * Go through all graphs and map calls to intrinsic functions and instructions.
387 * Every call or instruction is reported to its mapper function,
388 * which is responsible for rebuilding the graph.
390 * current_ir_graph is always set.
392 * @param list an array of intrinsic map records
393 * @param length the length of the array
394 * @param part_block_used set to true if part_block() must be using during lowering
396 * @return number of found intrinsics.
398 unsigned lower_intrinsics(i_record *list, int length, int part_block_used);
401 * Creates an irprog pass for lower_intrinsics.
403 * @param name the name of this pass or NULL
404 * @param list an array of intrinsic map records
405 * @param length the length of the array
406 * @param part_block_used set to true if part_block() must be using during lowering
408 ir_prog_pass_t *lower_intrinsics_pass(
410 i_record *list, int length, int part_block_used);
413 * A mapper for the integer/float absolute value: type abs(type v).
414 * Replaces the call by a Abs node.
418 int i_mapper_abs(ir_node *call, void *ctx);
421 * A mapper for the integer byte swap value: type bswap(type v).
422 * Replaces the call by a builtin[ir_bk_bswap] node.
426 int i_mapper_bswap(ir_node *call, void *ctx);
429 * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
431 * @return 1 if the sqrt call was removed, 0 else.
433 int i_mapper_sqrt(ir_node *call, void *ctx);
436 * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
438 * @return 1 if the cbrt call was removed, 0 else.
440 int i_mapper_cbrt(ir_node *call, void *ctx);
443 * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
445 * @return 1 if the pow call was removed, 0 else.
447 int i_mapper_pow(ir_node *call, void *ctx);
450 * A mapper for the floating point exp(a): floattype exp(floattype a);
452 * @return 1 if the exp call was removed, 0 else.
454 int i_mapper_exp(ir_node *call, void *ctx);
456 #define i_mapper_exp2 i_mapper_exp
457 #define i_mapper_exp10 i_mapper_exp
460 * A mapper for the floating point log(a): floattype log(floattype a);
462 * @return 1 if the log call was removed, 0 else.
464 int i_mapper_log(ir_node *call, void *ctx);
466 #define i_mapper_log2 i_mapper_log
467 #define i_mapper_log10 i_mapper_log
470 * A mapper for the floating point sin(a): floattype sin(floattype a);
472 * @return 1 if the sin call was removed, 0 else.
474 int i_mapper_sin(ir_node *call, void *ctx);
477 * A mapper for the floating point sin(a): floattype cos(floattype a);
479 * @return 1 if the cos call was removed, 0 else.
481 int i_mapper_cos(ir_node *call, void *ctx);
484 * A mapper for the floating point tan(a): floattype tan(floattype a);
486 * @return 1 if the tan call was removed, 0 else.
488 int i_mapper_tan(ir_node *call, void *ctx);
491 * A mapper for the floating point asin(a): floattype asin(floattype a);
493 * @return 1 if the asin call was removed, 0 else.
495 int i_mapper_asin(ir_node *call, void *ctx);
498 * A mapper for the floating point acos(a): floattype acos(floattype a);
500 * @return 1 if the tan call was removed, 0 else.
502 int i_mapper_acos(ir_node *call, void *ctx);
505 * A mapper for the floating point atan(a): floattype atan(floattype a);
507 * @return 1 if the atan call was removed, 0 else.
509 int i_mapper_atan(ir_node *call, void *ctx);
512 * A mapper for the floating point sinh(a): floattype sinh(floattype a);
514 * @return 1 if the sinh call was removed, 0 else.
516 int i_mapper_sinh(ir_node *call, void *ctx);
519 * A mapper for the floating point cosh(a): floattype cosh(floattype a);
521 * @return 1 if the cosh call was removed, 0 else.
523 int i_mapper_cosh(ir_node *call, void *ctx);
526 * A mapper for the floating point tanh(a): floattype tanh(floattype a);
528 * @return 1 if the tanh call was removed, 0 else.
530 int i_mapper_tanh(ir_node *call, void *ctx);
533 * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
535 * @return 1 if the strcmp call was removed, 0 else.
537 int i_mapper_strcmp(ir_node *call, void *ctx);
540 * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
542 * @return 1 if the strncmp call was removed, 0 else.
544 int i_mapper_strncmp(ir_node *call, void *ctx);
547 * A mapper for the strcpy-Function: char pointer strcpy(char pointer a, char pointer b);
549 * @return 1 if the strcpy call was removed, 0 else.
551 int i_mapper_strcpy(ir_node *call, void *ctx);
554 * A mapper for the strlen-Function: inttype strlen(char pointer a);
556 * @return 1 if the strlen call was removed, 0 else.
558 int i_mapper_strlen(ir_node *call, void *ctx);
561 * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
563 * @return 1 if the memcpy call was removed, 0 else.
565 int i_mapper_memcpy(ir_node *call, void *ctx);
568 * A mapper for the mempcpy-Function: void pointer mempcpy(void pointer d, void pointer s, inttype c);
570 * @return 1 if the mempcpy call was removed, 0 else.
572 int i_mapper_mempcpy(ir_node *call, void *ctx);
575 * A mapper for the memmove-Function: void pointer memmove(void pointer d, void pointer s, inttype c);
577 * @return 1 if the memmove call was removed, 0 else.
579 int i_mapper_memmove(ir_node *call, void *ctx);
582 * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
584 * @return 1 if the memset call was removed, 0 else.
586 int i_mapper_memset(ir_node *call, void *ctx);
589 * A mapper for the strncmp-Function: inttype memcmp(void pointer a, void pointer b, inttype len);
591 * @return 1 if the strncmp call was removed, 0 else.
593 int i_mapper_memcmp(ir_node *call, void *ctx);
596 * A mapper for the alloca() function: pointer alloca(inttype size)
597 * Replaces the call by a Alloca(stack_alloc) node.
601 int i_mapper_alloca(ir_node *call, void *ctx);
604 * A runtime routine description.
606 typedef struct _runtime_rt {
607 ir_entity *ent; /**< The entity representing the runtime routine. */
608 ir_mode *mode; /**< The operation mode of the mapped instruction. */
609 ir_mode *res_mode; /**< The result mode of the mapped instruction or NULL. */
610 long mem_proj_nr; /**< if >= 0, create a memory ProjM() */
611 long regular_proj_nr; /**< if >= 0, create a regular ProjX() */
612 long exc_proj_nr; /**< if >= 0, create a exception ProjX() */
613 long exc_mem_proj_nr; /**< if >= 0, create a exception memory ProjM() */
614 long res_proj_nr; /**< if >= 0, first result projection number */
618 * A mapper for mapping unsupported instructions to runtime calls.
619 * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
620 * rt(arg_0, ..., arg_n).
622 * The mapping is only done, if the modes of all arguments matches the
623 * modes of rt's argument.
624 * Further, if op has a memory input, the generated Call uses it, else
626 * The pinned state of the Call will be set to the pinned state of op.
628 * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
630 * @return 1 if an op was mapped, 0 else
634 * - Maps signed Div nodes to calls to rt_Div():
636 runtime_rt rt_Div = {
637 ent("int rt_Div(int, int)"),
646 i_instr_record map_Div = {
649 i_mapper_RuntimeCall,
655 * - Maps ConvD(F) to calls to rt_Float2Div():
657 runtime_rt rt_Float2Double = {
658 ent("double rt_Float2Div(float)"),
659 get_type_mode("double"),
667 i_instr_record map_Float2Double = {
670 i_mapper_RuntimeCall,
676 int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);
678 #endif /* FIRM_LOWERING_H */