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,
189 const ir_mode *omode, void *context);
192 * The lowering parameter description.
194 typedef struct lwrdw_param_t {
195 unsigned little_endian : 1; /**< if true should be lowered for little endian, else big endian */
196 unsigned doubleword_size; /**< bitsize of the doubleword mode */
197 create_intrinsic_fkt *create_intrinsic; /**< callback that creates the intrinsic entity */
198 void *ctx; /**< context parameter for the creator function */
202 * Lower all double word operations.
204 * @param param parameter for lowering
206 FIRM_API void lower_dw_ops(const lwrdw_param_t *param);
209 * Default implementation. Context is unused.
211 FIRM_API ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
212 const ir_mode *imode,
213 const ir_mode *omode,
217 * Replaces SymConsts by a real constant if possible.
218 * Replace Sel nodes by address computation. Also resolves array access.
219 * Handle bit fields by added And/Or calculations.
221 * @param irg the graph to lower
222 * @param lower_bitfields the graph contains old-style bitfield
225 * @note: There is NO lowering ob objects oriented types. This is highly compiler
226 * and ABI specific and should be placed directly in the compiler.
228 FIRM_API void lower_highlevel_graph(ir_graph *irg, int lower_bitfields);
231 * Creates an ir_graph pass for lower_highlevel_graph().
233 * @param name the name of this pass or NULL
234 * @param lower_bitfields the graph contains old-style bitfield
237 * @return the newly created ir_graph pass
239 FIRM_API ir_graph_pass_t *lower_highlevel_graph_pass(const char *name,
240 int lower_bitfields);
243 * Replaces SymConsts by a real constant if possible.
244 * Replace Sel nodes by address computation. Also resolves array access.
245 * Handle bit fields by added And/Or calculations.
248 * @note There is NO lowering of objects oriented types. This is highly compiler
249 * and ABI specific and should be placed directly in the compiler.
251 FIRM_API void lower_highlevel(int lower_bitfields);
254 * does the same as lower_highlevel for all nodes on the const code irg
256 FIRM_API void lower_const_code(void);
259 * Creates an ir_prog pass for lower_const_code().
261 * @param name the name of this pass or NULL
263 * @return the newly created ir_prog pass
265 FIRM_API ir_prog_pass_t *lower_const_code_pass(const char *name);
267 typedef struct lower_mode_b_config_t {
268 /* mode that is used to transport 0/1 values */
269 ir_mode *lowered_mode;
270 /* preferred mode for the "set" operations (a psi that produces a 0 or 1) */
271 ir_mode *lowered_set_mode;
272 /* whether direct Cond -> Cmps should also be lowered */
273 int lower_direct_cmp;
274 } lower_mode_b_config_t;
277 * Lowers mode_b operations to integer arithmetic. After the lowering the only
278 * operations with mode_b are the Projs of Cmps; the only nodes with mode_b
279 * inputs are Cond and Psi nodes.
281 * Example: Psi(a < 0, 1, 0) => a >> 31
283 * @param irg the firm graph to lower
284 * @param config configuration for mode_b lowerer
286 FIRM_API void ir_lower_mode_b(ir_graph *irg,
287 const lower_mode_b_config_t *config);
290 * Creates an ir_graph pass for ir_lower_mode_b().
292 * @param name the name of this pass or NULL
293 * @param config configuration for mode_b lowerer
295 * @return the newly created ir_graph pass
297 FIRM_API ir_graph_pass_t *ir_lower_mode_b_pass(const char *name,
298 const lower_mode_b_config_t *config);
301 * Used as callback, whenever a lowerable mux is found. The return value
302 * indicates, whether the mux should be lowered. This may be used, to lower
303 * floating point muxes, while keeping mux nodes for integers, for example.
305 * @param mux The mux node that may be lowered.
306 * @return A non-zero value indicates that the mux should be lowered.
308 typedef int lower_mux_callback(ir_node* mux);
311 * Lowers all mux nodes in the given graph. A callback function may be
312 * given, to select the mux nodes to lower.
314 * @param irg The graph to lower mux nodes in.
315 * @param cb_func The callback function for mux selection. Can be NULL,
316 * to lower all mux nodes.
318 FIRM_API void lower_mux(ir_graph *irg, lower_mux_callback *cb_func);
321 * Creates an ir_graph pass for lower_mux().
323 * @param name the name of this pass or NULL
324 * @param cb_func The callback function for mux selection. Can be NULL,
325 * to lower all mux nodes.
327 * @return the newly created ir_graph pass
329 FIRM_API ir_graph_pass_t *lower_mux_pass(const char *name,
330 lower_mux_callback *cb_func);
333 * An intrinsic mapper function.
335 * @param node the IR-node that will be mapped
336 * @param ctx a context
338 * @return non-zero if the call was mapped
340 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
343 INTRINSIC_CALL = 0, /**< the record represents an intrinsic call */
344 INTRINSIC_INSTR /**< the record represents an intrinsic instruction */
348 * An intrinsic call record.
350 typedef struct i_call_record {
351 enum ikind kind; /**< must be INTRINSIC_CALL */
352 ir_entity *i_ent; /**< the entity representing an intrinsic call */
353 i_mapper_func i_mapper; /**< the mapper function to call */
354 void *ctx; /**< mapper context */
355 void *link; /**< used in the construction algorithm, must be NULL */
359 * An intrinsic instruction record.
361 typedef struct i_instr_record {
362 enum ikind kind; /**< must be INTRINSIC_INSTR */
363 ir_op *op; /**< the opcode that must be mapped. */
364 i_mapper_func i_mapper; /**< the mapper function to call */
365 void *ctx; /**< mapper context */
366 void *link; /**< used in the construction algorithm, must be NULL */
370 * An intrinsic record.
372 typedef union i_record {
373 i_call_record i_call;
374 i_instr_record i_instr;
378 * Go through all graphs and map calls to intrinsic functions and instructions.
380 * Every call or instruction is reported to its mapper function,
381 * which is responsible for rebuilding the graph.
383 * current_ir_graph is always set.
385 * @param list an array of intrinsic map records
386 * @param length the length of the array
387 * @param part_block_used set to true if part_block() must be using during lowering
389 * @return number of found intrinsics.
391 FIRM_API unsigned lower_intrinsics(i_record *list, int length,
392 int part_block_used);
395 * Creates an irprog pass for lower_intrinsics.
397 * @param name the name of this pass or NULL
398 * @param list an array of intrinsic map records
399 * @param length the length of the array
400 * @param part_block_used set to true if part_block() must be using during lowering
402 FIRM_API ir_prog_pass_t *lower_intrinsics_pass(const char *name, i_record *list,
403 int length, int part_block_used);
406 * A mapper for the integer/float absolute value: type abs(type v).
407 * Replaces the call by a Abs node.
411 FIRM_API int i_mapper_abs(ir_node *call, void *ctx);
414 * A mapper for the integer byte swap value: type bswap(type v).
415 * Replaces the call by a builtin[ir_bk_bswap] node.
419 FIRM_API int i_mapper_bswap(ir_node *call, void *ctx);
422 * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
424 * @return 1 if the sqrt call was removed, 0 else.
426 FIRM_API int i_mapper_sqrt(ir_node *call, void *ctx);
429 * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
431 * @return 1 if the cbrt call was removed, 0 else.
433 FIRM_API int i_mapper_cbrt(ir_node *call, void *ctx);
436 * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
438 * @return 1 if the pow call was removed, 0 else.
440 FIRM_API int i_mapper_pow(ir_node *call, void *ctx);
443 * A mapper for the floating point exp(a): floattype exp(floattype a);
445 * @return 1 if the exp call was removed, 0 else.
447 FIRM_API int i_mapper_exp(ir_node *call, void *ctx);
449 #define i_mapper_exp2 i_mapper_exp
450 #define i_mapper_exp10 i_mapper_exp
453 * A mapper for the floating point log(a): floattype log(floattype a);
455 * @return 1 if the log call was removed, 0 else.
457 FIRM_API int i_mapper_log(ir_node *call, void *ctx);
459 #define i_mapper_log2 i_mapper_log
460 #define i_mapper_log10 i_mapper_log
463 * A mapper for the floating point sin(a): floattype sin(floattype a);
465 * @return 1 if the sin call was removed, 0 else.
467 FIRM_API int i_mapper_sin(ir_node *call, void *ctx);
470 * A mapper for the floating point sin(a): floattype cos(floattype a);
472 * @return 1 if the cos call was removed, 0 else.
474 FIRM_API int i_mapper_cos(ir_node *call, void *ctx);
477 * A mapper for the floating point tan(a): floattype tan(floattype a);
479 * @return 1 if the tan call was removed, 0 else.
481 FIRM_API int i_mapper_tan(ir_node *call, void *ctx);
484 * A mapper for the floating point asin(a): floattype asin(floattype a);
486 * @return 1 if the asin call was removed, 0 else.
488 FIRM_API int i_mapper_asin(ir_node *call, void *ctx);
491 * A mapper for the floating point acos(a): floattype acos(floattype a);
493 * @return 1 if the tan call was removed, 0 else.
495 FIRM_API int i_mapper_acos(ir_node *call, void *ctx);
498 * A mapper for the floating point atan(a): floattype atan(floattype a);
500 * @return 1 if the atan call was removed, 0 else.
502 FIRM_API int i_mapper_atan(ir_node *call, void *ctx);
505 * A mapper for the floating point sinh(a): floattype sinh(floattype a);
507 * @return 1 if the sinh call was removed, 0 else.
509 FIRM_API int i_mapper_sinh(ir_node *call, void *ctx);
512 * A mapper for the floating point cosh(a): floattype cosh(floattype a);
514 * @return 1 if the cosh call was removed, 0 else.
516 FIRM_API int i_mapper_cosh(ir_node *call, void *ctx);
519 * A mapper for the floating point tanh(a): floattype tanh(floattype a);
521 * @return 1 if the tanh call was removed, 0 else.
523 FIRM_API int i_mapper_tanh(ir_node *call, void *ctx);
526 * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
528 * @return 1 if the strcmp call was removed, 0 else.
530 FIRM_API int i_mapper_strcmp(ir_node *call, void *ctx);
533 * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
535 * @return 1 if the strncmp call was removed, 0 else.
537 FIRM_API int i_mapper_strncmp(ir_node *call, void *ctx);
540 * A mapper for the strcpy-Function: char pointer strcpy(char pointer a, char pointer b);
542 * @return 1 if the strcpy call was removed, 0 else.
544 FIRM_API int i_mapper_strcpy(ir_node *call, void *ctx);
547 * A mapper for the strlen-Function: inttype strlen(char pointer a);
549 * @return 1 if the strlen call was removed, 0 else.
551 FIRM_API int i_mapper_strlen(ir_node *call, void *ctx);
554 * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
556 * @return 1 if the memcpy call was removed, 0 else.
558 FIRM_API int i_mapper_memcpy(ir_node *call, void *ctx);
561 * A mapper for the mempcpy-Function: void pointer mempcpy(void pointer d, void pointer s, inttype c);
563 * @return 1 if the mempcpy call was removed, 0 else.
565 FIRM_API int i_mapper_mempcpy(ir_node *call, void *ctx);
568 * A mapper for the memmove-Function: void pointer memmove(void pointer d, void pointer s, inttype c);
570 * @return 1 if the memmove call was removed, 0 else.
572 FIRM_API int i_mapper_memmove(ir_node *call, void *ctx);
575 * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
577 * @return 1 if the memset call was removed, 0 else.
579 FIRM_API int i_mapper_memset(ir_node *call, void *ctx);
582 * A mapper for the strncmp-Function: inttype memcmp(void pointer a, void pointer b, inttype len);
584 * @return 1 if the strncmp call was removed, 0 else.
586 FIRM_API int i_mapper_memcmp(ir_node *call, void *ctx);
589 * A mapper for the alloca() function: pointer alloca(inttype size)
590 * Replaces the call by a Alloca(stack_alloc) node.
594 FIRM_API int i_mapper_alloca(ir_node *call, void *ctx);
597 * A runtime routine description.
599 typedef struct runtime_rt {
600 ir_entity *ent; /**< The entity representing the runtime routine. */
601 ir_mode *mode; /**< The operation mode of the mapped instruction. */
602 ir_mode *res_mode; /**< The result mode of the mapped instruction or NULL. */
603 long mem_proj_nr; /**< if >= 0, create a memory ProjM() */
604 long regular_proj_nr; /**< if >= 0, create a regular ProjX() */
605 long exc_proj_nr; /**< if >= 0, create a exception ProjX() */
606 long exc_mem_proj_nr; /**< if >= 0, create a exception memory ProjM() */
607 long res_proj_nr; /**< if >= 0, first result projection number */
611 * A mapper for mapping unsupported instructions to runtime calls.
612 * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
613 * rt(arg_0, ..., arg_n).
615 * The mapping is only done, if the modes of all arguments matches the
616 * modes of rt's argument.
617 * Further, if op has a memory input, the generated Call uses it, else
619 * The pinned state of the Call will be set to the pinned state of op.
621 * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
623 * @return 1 if an op was mapped, 0 else
627 * - Maps signed Div nodes to calls to rt_Div():
629 runtime_rt rt_Div = {
630 ent("int rt_Div(int, int)"),
639 i_instr_record map_Div = {
642 i_mapper_RuntimeCall,
648 * - Maps ConvD(F) to calls to rt_Float2Div():
650 runtime_rt rt_Float2Double = {
651 ent("double rt_Float2Div(float)"),
652 get_type_mode("double"),
660 i_instr_record map_Float2Double = {
663 i_mapper_RuntimeCall,
669 FIRM_API int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);