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 * A type telling where to add hidden parameters.
38 typedef enum add_hidden_params {
39 ADD_HIDDEN_ALWAYS_IN_FRONT = 0, /**< always add hidden parameters in front (default). */
40 ADD_HIDDEN_ALWAYS_LAST = 1, /**< always add hidden parameters last, did not work for variadic functions. */
41 ADD_HIDDEN_SMART = 2 /**< add hidden parameters last for non-variadic and first for variadic functions. */
45 * Additional flags for the lowering.
48 LF_NONE = 0, /**< no additional flags */
49 LF_COMPOUND_PARAM = 1, /**< lower calls with compound parameters */
50 LF_COMPOUND_RETURN = 2, /**< lower calls with compound returns */
51 LF_RETURN_HIDDEN = 4, /**< return the hidden address instead of void */
52 LF_SMALL_CMP_IN_REGS = 8 /**< return small compound values in registers */
55 /** Maximum number of registers that can be used to return compound values. */
56 #define MAX_REGISTER_RET_VAL 2
59 * A struct containing all control parameters for
60 * lower_compound_ret_calls().
63 int def_ptr_alignment; /**< Default alignment for data pointer. */
64 unsigned flags; /**< A bitmask of enum lowering_flags. */
65 add_hidden hidden_params; /**< Where to add hidden parameters. */
68 * A function returning a pointer type for a given type.
69 * If this pointer is NULL, a new pointer type is always created.
71 ir_type *(*find_pointer_type)(ir_type *e_type, ir_mode *mode, int alignment);
74 * If the LF_SMALL_CMP_IN_REGS flag is set, this function will be called
75 * to decide, whether a compound value should be returned in registers.
76 * This function must return the number of used registers and fill in the modes
77 * of the registers to use. Up to MAX_REGISTER_RET_VAL registers can be used.
79 int (*ret_compound_in_regs)(ir_type *compound_tp, ir_mode **modes);
83 * Lower calls with compound parameter and return types.
84 * This function does the following transformations:
86 * If LF_COMPOUND_PARAM is set:
88 * - Copy compound parameters to a new location on the callers
89 * stack and transmit the address of this new location
91 * If LF_COMPOUND_RETURN is set:
93 * - Adds a new (hidden) pointer parameter for
94 * any return compound type. The return type is replaced by void
95 * or if LOWERING_FLAGS_RETURN_HIDDEN is set by the address.
97 * - Use of the hidden parameters in the function code.
99 * - Change all calls to functions with compound return
100 * by providing space for the hidden parameter on the callers
103 * - Replace a possible block copy after the function call.
107 * - Changes the types of methods and calls to the lowered ones
109 * - lower all method types of existing entities
111 * In pseudo-code, the following transformation is done:
114 struct x ret = func(a, b);
123 * If the function returns only one possible result, the copy-on-return
124 * optimization is done, ie.
133 * is transformed into
136 void func(struct x *ret, a) {
141 * @param params A structure containing the control parameter for this
144 * During the transformation, pointer types must be created or reused.
145 * The caller can provide params->find_pointer_type for this task to
146 * reduce the number of created pointer types.
147 * If params->find_pointer_type is NULL, new pointer types
148 * are always created automatically.
150 FIRM_API void lower_calls_with_compounds(const lower_params_t *params);
153 * Lower CopyB nodes of size smaller that max_size into Loads/Stores
155 FIRM_API void lower_CopyB(ir_graph *irg, unsigned max_size,
156 unsigned native_mode_bytes);
159 * Lowers all Switches (Cond nodes with non-boolean mode) depending on spare_size.
160 * They will either remain the same or be converted into if-cascades.
162 * @param irg The ir graph to be lowered.
163 * @param spare_size Allowed spare size for table switches in machine words.
164 * (Default in edgfe: 128)
165 * @param allow_out_of_bounds backend can handle out-of-bounds values
166 * (values bigger than minimum and maximum proj
169 FIRM_API void lower_switch(ir_graph *irg, unsigned spare_size,
170 int allow_out_of_bounds);
173 * A callback type for creating an intrinsic entity for a given opcode.
175 * @param method the method type of the emulation function entity
176 * @param op the emulated ir_op
177 * @param imode the input mode of the emulated opcode
178 * @param omode the output mode of the emulated opcode
179 * @param context the context parameter
181 typedef ir_entity *(create_intrinsic_fkt)(ir_type *method, const ir_op *op,
182 const ir_mode *imode,
183 const ir_mode *omode, void *context);
186 * The lowering parameter description.
188 typedef struct lwrdw_param_t {
189 unsigned little_endian : 1; /**< if true should be lowered for little endian, else big endian */
190 unsigned doubleword_size; /**< bitsize of the doubleword mode */
191 create_intrinsic_fkt *create_intrinsic; /**< callback that creates the intrinsic entity */
192 void *ctx; /**< context parameter for the creator function */
196 * Lower all double word operations.
198 * @param param parameter for lowering
200 FIRM_API void lower_dw_ops(const lwrdw_param_t *param);
203 * Default implementation. Context is unused.
205 FIRM_API ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
206 const ir_mode *imode,
207 const ir_mode *omode,
211 * Replaces SymConsts by a real constant if possible.
212 * Replace Sel nodes by address computation. Also resolves array access.
213 * Handle bit fields by added And/Or calculations.
215 * @param irg the graph to lower
216 * @param lower_bitfields the graph contains old-style bitfield
219 * @note: There is NO lowering ob objects oriented types. This is highly compiler
220 * and ABI specific and should be placed directly in the compiler.
222 FIRM_API void lower_highlevel_graph(ir_graph *irg, int lower_bitfields);
225 * Creates an ir_graph pass for lower_highlevel_graph().
227 * @param name the name of this pass or NULL
228 * @param lower_bitfields the graph contains old-style bitfield
231 * @return the newly created ir_graph pass
233 FIRM_API ir_graph_pass_t *lower_highlevel_graph_pass(const char *name,
234 int lower_bitfields);
237 * Replaces SymConsts by a real constant if possible.
238 * Replace Sel nodes by address computation. Also resolves array access.
239 * Handle bit fields by added And/Or calculations.
242 * @note There is NO lowering of 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(int lower_bitfields);
248 * does the same as lower_highlevel for all nodes on the const code irg
250 FIRM_API void lower_const_code(void);
253 * Creates an ir_prog pass for lower_const_code().
255 * @param name the name of this pass or NULL
257 * @return the newly created ir_prog pass
259 FIRM_API ir_prog_pass_t *lower_const_code_pass(const char *name);
262 * Function which creates a "set" instraction. A "set" instruction takes a
263 * condition value (a value with mode_b) as input and produces a value in a
264 * general purpose integer mode.
265 * Most architectures have special intrinsics for this. But if all else fails
266 * you can just produces the an if-like construct.
268 typedef ir_node* (*create_set_func)(ir_node *cond);
271 * implementation of create_set_func which produces a Mux node with 0/1 input
273 ir_node *ir_create_mux_set(ir_node *cond, ir_mode *dest_mode);
276 * implementation of create_set_func which produces a cond with control
279 ir_node *ir_create_cond_set(ir_node *cond, ir_mode *dest_mode);
281 typedef struct lower_mode_b_config_t {
282 /* mode that is used to transport 0/1 values */
283 ir_mode *lowered_mode;
284 /* callback for creating set-like instructions */
285 create_set_func create_set;
286 /* whether direct Cond(Cmp) should also be lowered */
287 int lower_direct_cmp;
288 } lower_mode_b_config_t;
291 * Lowers mode_b operations to integer arithmetic. After the lowering the only
292 * operations with mode_b are the Projs of Cmps; the only nodes with mode_b
293 * inputs are Cond and Psi nodes.
295 * Example: Psi(a < 0, 1, 0) => a >> 31
297 * @param irg the firm graph to lower
298 * @param config configuration for mode_b lowerer
300 FIRM_API void ir_lower_mode_b(ir_graph *irg,
301 const lower_mode_b_config_t *config);
304 * Used as callback, whenever a lowerable mux is found. The return value
305 * indicates, whether the mux should be lowered. This may be used, to lower
306 * floating point muxes, while keeping mux nodes for integers, for example.
308 * @param mux The mux node that may be lowered.
309 * @return A non-zero value indicates that the mux should be lowered.
311 typedef int lower_mux_callback(ir_node* mux);
314 * Lowers all mux nodes in the given graph. A callback function may be
315 * given, to select the mux nodes to lower.
317 * @param irg The graph to lower mux nodes in.
318 * @param cb_func The callback function for mux selection. Can be NULL,
319 * to lower all mux nodes.
321 FIRM_API void lower_mux(ir_graph *irg, lower_mux_callback *cb_func);
324 * Creates an ir_graph pass for lower_mux().
326 * @param name the name of this pass or NULL
327 * @param cb_func The callback function for mux selection. Can be NULL,
328 * to lower all mux nodes.
330 * @return the newly created ir_graph pass
332 FIRM_API ir_graph_pass_t *lower_mux_pass(const char *name,
333 lower_mux_callback *cb_func);
336 * An intrinsic mapper function.
338 * @param node the IR-node that will be mapped
339 * @param ctx a context
341 * @return non-zero if the call was mapped
343 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
346 INTRINSIC_CALL = 0, /**< the record represents an intrinsic call */
347 INTRINSIC_INSTR /**< the record represents an intrinsic instruction */
351 * An intrinsic call record.
353 typedef struct i_call_record {
354 enum ikind kind; /**< must be INTRINSIC_CALL */
355 ir_entity *i_ent; /**< the entity representing an intrinsic call */
356 i_mapper_func i_mapper; /**< the mapper function to call */
357 void *ctx; /**< mapper context */
358 void *link; /**< used in the construction algorithm, must be NULL */
362 * An intrinsic instruction record.
364 typedef struct i_instr_record {
365 enum ikind kind; /**< must be INTRINSIC_INSTR */
366 ir_op *op; /**< the opcode that must be mapped. */
367 i_mapper_func i_mapper; /**< the mapper function to call */
368 void *ctx; /**< mapper context */
369 void *link; /**< used in the construction algorithm, must be NULL */
373 * An intrinsic record.
375 typedef union i_record {
376 i_call_record i_call;
377 i_instr_record i_instr;
381 * Go through all graphs and map calls to intrinsic functions and instructions.
383 * Every call or instruction is reported to its mapper function,
384 * which is responsible for rebuilding the graph.
386 * current_ir_graph is always set.
388 * @param list an array of intrinsic map records
389 * @param length the length of the array
390 * @param part_block_used set to true if part_block() must be using during lowering
392 * @return number of found intrinsics.
394 FIRM_API size_t lower_intrinsics(i_record *list, size_t length,
395 int part_block_used);
398 * Creates an irprog pass for lower_intrinsics.
400 * @param name the name of this pass or NULL
401 * @param list an array of intrinsic map records
402 * @param length the length of the array
403 * @param part_block_used set to true if part_block() must be using during lowering
405 FIRM_API ir_prog_pass_t *lower_intrinsics_pass(const char *name, i_record *list,
406 size_t length, int part_block_used);
409 * A mapper for the integer/float absolute value: type abs(type v).
410 * Replaces the call by a Abs node.
414 FIRM_API int i_mapper_abs(ir_node *call, void *ctx);
417 * A mapper for the integer byte swap value: type bswap(type v).
418 * Replaces the call by a builtin[ir_bk_bswap] node.
422 FIRM_API int i_mapper_bswap(ir_node *call, void *ctx);
425 * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
427 * @return 1 if the sqrt call was removed, 0 else.
429 FIRM_API int i_mapper_sqrt(ir_node *call, void *ctx);
432 * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
434 * @return 1 if the cbrt call was removed, 0 else.
436 FIRM_API int i_mapper_cbrt(ir_node *call, void *ctx);
439 * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
441 * @return 1 if the pow call was removed, 0 else.
443 FIRM_API int i_mapper_pow(ir_node *call, void *ctx);
446 * A mapper for the floating point exp(a): floattype exp(floattype a);
448 * @return 1 if the exp call was removed, 0 else.
450 FIRM_API int i_mapper_exp(ir_node *call, void *ctx);
452 #define i_mapper_exp2 i_mapper_exp
453 #define i_mapper_exp10 i_mapper_exp
456 * A mapper for the floating point log(a): floattype log(floattype a);
458 * @return 1 if the log call was removed, 0 else.
460 FIRM_API int i_mapper_log(ir_node *call, void *ctx);
462 #define i_mapper_log2 i_mapper_log
463 #define i_mapper_log10 i_mapper_log
466 * A mapper for the floating point sin(a): floattype sin(floattype a);
468 * @return 1 if the sin call was removed, 0 else.
470 FIRM_API int i_mapper_sin(ir_node *call, void *ctx);
473 * A mapper for the floating point sin(a): floattype cos(floattype a);
475 * @return 1 if the cos call was removed, 0 else.
477 FIRM_API int i_mapper_cos(ir_node *call, void *ctx);
480 * A mapper for the floating point tan(a): floattype tan(floattype a);
482 * @return 1 if the tan call was removed, 0 else.
484 FIRM_API int i_mapper_tan(ir_node *call, void *ctx);
487 * A mapper for the floating point asin(a): floattype asin(floattype a);
489 * @return 1 if the asin call was removed, 0 else.
491 FIRM_API int i_mapper_asin(ir_node *call, void *ctx);
494 * A mapper for the floating point acos(a): floattype acos(floattype a);
496 * @return 1 if the tan call was removed, 0 else.
498 FIRM_API int i_mapper_acos(ir_node *call, void *ctx);
501 * A mapper for the floating point atan(a): floattype atan(floattype a);
503 * @return 1 if the atan call was removed, 0 else.
505 FIRM_API int i_mapper_atan(ir_node *call, void *ctx);
508 * A mapper for the floating point sinh(a): floattype sinh(floattype a);
510 * @return 1 if the sinh call was removed, 0 else.
512 FIRM_API int i_mapper_sinh(ir_node *call, void *ctx);
515 * A mapper for the floating point cosh(a): floattype cosh(floattype a);
517 * @return 1 if the cosh call was removed, 0 else.
519 FIRM_API int i_mapper_cosh(ir_node *call, void *ctx);
522 * A mapper for the floating point tanh(a): floattype tanh(floattype a);
524 * @return 1 if the tanh call was removed, 0 else.
526 FIRM_API int i_mapper_tanh(ir_node *call, void *ctx);
529 * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
531 * @return 1 if the strcmp call was removed, 0 else.
533 FIRM_API int i_mapper_strcmp(ir_node *call, void *ctx);
536 * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
538 * @return 1 if the strncmp call was removed, 0 else.
540 FIRM_API int i_mapper_strncmp(ir_node *call, void *ctx);
543 * A mapper for the strcpy-Function: char pointer strcpy(char pointer a, char pointer b);
545 * @return 1 if the strcpy call was removed, 0 else.
547 FIRM_API int i_mapper_strcpy(ir_node *call, void *ctx);
550 * A mapper for the strlen-Function: inttype strlen(char pointer a);
552 * @return 1 if the strlen call was removed, 0 else.
554 FIRM_API int i_mapper_strlen(ir_node *call, void *ctx);
557 * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
559 * @return 1 if the memcpy call was removed, 0 else.
561 FIRM_API int i_mapper_memcpy(ir_node *call, void *ctx);
564 * A mapper for the mempcpy-Function: void pointer mempcpy(void pointer d, void pointer s, inttype c);
566 * @return 1 if the mempcpy call was removed, 0 else.
568 FIRM_API int i_mapper_mempcpy(ir_node *call, void *ctx);
571 * A mapper for the memmove-Function: void pointer memmove(void pointer d, void pointer s, inttype c);
573 * @return 1 if the memmove call was removed, 0 else.
575 FIRM_API int i_mapper_memmove(ir_node *call, void *ctx);
578 * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
580 * @return 1 if the memset call was removed, 0 else.
582 FIRM_API int i_mapper_memset(ir_node *call, void *ctx);
585 * A mapper for the strncmp-Function: inttype memcmp(void pointer a, void pointer b, inttype len);
587 * @return 1 if the strncmp call was removed, 0 else.
589 FIRM_API int i_mapper_memcmp(ir_node *call, void *ctx);
592 * A mapper for the alloca() function: pointer alloca(inttype size)
593 * Replaces the call by a Alloca(stack_alloc) node.
597 FIRM_API int i_mapper_alloca(ir_node *call, void *ctx);
600 * A runtime routine description.
602 typedef struct runtime_rt {
603 ir_entity *ent; /**< The entity representing the runtime routine. */
604 ir_mode *mode; /**< The operation mode of the mapped instruction. */
605 ir_mode *res_mode; /**< The result mode of the mapped instruction or NULL. */
606 long mem_proj_nr; /**< if >= 0, create a memory ProjM() */
607 long regular_proj_nr; /**< if >= 0, create a regular ProjX() */
608 long exc_proj_nr; /**< if >= 0, create a exception ProjX() */
609 long exc_mem_proj_nr; /**< if >= 0, create a exception memory ProjM() */
610 long res_proj_nr; /**< if >= 0, first result projection number */
614 * A mapper for mapping unsupported instructions to runtime calls.
615 * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
616 * rt(arg_0, ..., arg_n).
618 * The mapping is only done, if the modes of all arguments matches the
619 * modes of rt's argument.
620 * Further, if op has a memory input, the generated Call uses it, else
622 * The pinned state of the Call will be set to the pinned state of op.
624 * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
626 * @return 1 if an op was mapped, 0 else
630 * - Maps signed Div nodes to calls to rt_Div():
632 runtime_rt rt_Div = {
633 ent("int rt_Div(int, int)"),
642 i_instr_record map_Div = {
645 i_mapper_RuntimeCall,
651 * - Maps ConvD(F) to calls to rt_Float2Div():
653 runtime_rt rt_Float2Double = {
654 ent("double rt_Float2Div(float)"),
655 get_type_mode("double"),
663 i_instr_record map_Float2Double = {
666 i_mapper_RuntimeCall,
672 FIRM_API int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);