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 * A callback type for creating an intrinsic entity for a given opcode.
150 * @param method the method type of the emulation function entity
151 * @param op the emulated ir_op
152 * @param imode the input mode of the emulated opcode
153 * @param omode the output mode of the emulated opcode
154 * @param context the context parameter
156 typedef ir_entity *(create_intrinsic_fkt)(ir_type *method, const ir_op *op,
157 const ir_mode *imode, const ir_mode *omode,
161 * The lowering parameter description.
163 typedef struct _lwrdw_param_t {
164 int enable; /**< if true lowering is enabled */
165 int little_endian; /**< if true should be lowered for little endian, else big endian */
166 ir_mode *high_signed; /**< the double word signed mode to be lowered, typically Ls */
167 ir_mode *high_unsigned; /**< the double word unsigned mode to be lowered, typically Lu */
168 ir_mode *low_signed; /**< the word signed mode to be used, typically Is */
169 ir_mode *low_unsigned; /**< the word unsigned mode to be used, typically Iu */
171 /** callback that creates the intrinsic entity */
172 create_intrinsic_fkt *create_intrinsic;
173 void *ctx; /**< context parameter for the creator function */
177 * Lower all double word operations.
179 void lower_dw_ops(const lwrdw_param_t *param);
182 * Default implementation. Context is unused.
184 ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
185 const ir_mode *imode, const ir_mode *omode,
189 * Replaces SymConsts by a real constant if possible.
190 * Replace Sel nodes by address computation. Also resolves array access.
191 * Handle bit fields by added And/Or calculations.
193 * @param irg the graph to lower
195 * @note: There is NO lowering ob objects oriented types. This is highly compiler
196 * and ABI specific and should be placed directly in the compiler.
198 void lower_highlevel_graph(ir_graph *irg, int lower_bitfields);
201 * Replaces SymConsts by a real constant if possible.
202 * Replace Sel nodes by address computation. Also resolves array access.
203 * Handle bit fields by added And/Or calculations.
206 * @Note: There is NO lowering ob objects oriented types. This is highly compiler
207 * and ABI specific and should be placed directly in the compiler.
209 void lower_highlevel(int lower_bitfields);
212 * does the same as lower_highlevel for all nodes on the const code irg
214 void lower_const_code(void);
216 typedef struct lower_mode_b_config_t {
217 /* mode that is used to transport 0/1 values */
218 ir_mode *lowered_mode;
219 /* preferred mode for the "set" operations (a psi that produces a 0 or 1) */
220 ir_mode *lowered_set_mode;
221 /* wether direct Cond -> Cmps should also be lowered */
222 int lower_direct_cmp;
223 } lower_mode_b_config_t;
226 * Lowers mode_b operations to integer arithmetic. After the lowering the only
227 * operations with mode_b are the Projs of Cmps; the only nodes with mode_b
228 * inputs are Cond and Psi nodes.
230 * Example: Psi(a < 0, 1, 0) => a >> 31
232 * @param irg the firm graph to lower
233 * @param config configuration for mode_b lowerer
235 void ir_lower_mode_b(ir_graph *irg, const lower_mode_b_config_t *config);
238 * An intrinsic mapper function.
240 * @param node the IR-node that will be mapped
241 * @param ctx a context
243 * @return non-zero if the call was mapped
245 typedef int (*i_mapper_func)(ir_node *node, void *ctx);
248 INTRINSIC_CALL = 0, /**< the record represents an intrinsic call */
249 INTRINSIC_INSTR /**< the record represents an intrinsic instruction */
253 * An intrinsic call record.
255 typedef struct _i_call_record {
256 enum ikind kind; /**< must be INTRINSIC_CALL */
257 ir_entity *i_ent; /**< the entity representing an intrinsic call */
258 i_mapper_func i_mapper; /**< the mapper function to call */
259 void *ctx; /**< mapper context */
260 void *link; /**< used in the construction algorithm, must be NULL */
264 * An intrinsic instruction record.
266 typedef struct _i_instr_record {
267 enum ikind kind; /**< must be INTRINSIC_INSTR */
268 ir_op *op; /**< the opcode that must be mapped. */
269 i_mapper_func i_mapper; /**< the mapper function to call */
270 void *ctx; /**< mapper context */
271 void *link; /**< used in the construction algorithm, must be NULL */
275 * An intrinsic record.
277 typedef union _i_record {
278 i_call_record i_call;
279 i_instr_record i_instr;
283 * Go through all graphs and map calls to intrinsic functions and instructions.
285 * Every call or instruction is reported to its mapper function,
286 * which is responsible for rebuilding the graph.
288 * current_ir_graph is always set.
290 * @param list an array of intrinsic map records
291 * @param length the length of the array
292 * @param part_block_used set to true if part_block() must be using during lowering
294 * @return number of found intrinsics.
296 unsigned lower_intrinsics(i_record *list, int length, int part_block_used);
299 * A mapper for the integer/float absolute value: type abs(type v).
300 * Replaces the call by a Abs node.
304 int i_mapper_abs(ir_node *call, void *ctx);
307 * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
309 * @return 0 if the sqrt call was removed, 0 else.
311 int i_mapper_sqrt(ir_node *call, void *ctx);
314 * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
316 * @return 0 if the cbrt call was removed, 0 else.
318 int i_mapper_cbrt(ir_node *call, void *ctx);
321 * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
323 * @return 0 if the pow call was removed, 0 else.
325 int i_mapper_pow(ir_node *call, void *ctx);
328 * A mapper for the floating point exp(a): floattype exp(floattype a);
330 * @return 0 if the exp call was removed, 0 else.
332 int i_mapper_exp(ir_node *call, void *ctx);
334 #define i_mapper_exp2 i_mapper_exp
335 #define i_mapper_exp10 i_mapper_exp
338 * A mapper for the floating point log(a): floattype log(floattype a);
340 * @return 0 if the log call was removed, 0 else.
342 int i_mapper_log(ir_node *call, void *ctx);
344 #define i_mapper_log2 i_mapper_log
345 #define i_mapper_log10 i_mapper_log
348 * A mapper for the floating point sin(a): floattype sin(floattype a);
350 * @return 0 if the sin call was removed, 0 else.
352 int i_mapper_sin(ir_node *call, void *ctx);
355 * A mapper for the floating point sin(a): floattype cos(floattype a);
357 * @return 0 if the cos call was removed, 0 else.
359 int i_mapper_cos(ir_node *call, void *ctx);
362 * A mapper for the floating point tan(a): floattype tan(floattype a);
364 * @return 0 if the tan call was removed, 0 else.
366 int i_mapper_tan(ir_node *call, void *ctx);
369 * A mapper for the floating point asin(a): floattype asin(floattype a);
371 * @return 0 if the asin call was removed, 0 else.
373 int i_mapper_asin(ir_node *call, void *ctx);
376 * A mapper for the floating point acos(a): floattype acos(floattype a);
378 * @return 0 if the tan call was removed, 0 else.
380 int i_mapper_acos(ir_node *call, void *ctx);
383 * A mapper for the floating point atan(a): floattype atan(floattype a);
385 * @return 0 if the atan call was removed, 0 else.
387 int i_mapper_atan(ir_node *call, void *ctx);
390 * A mapper for the floating point sinh(a): floattype sinh(floattype a);
392 * @return 0 if the sinh call was removed, 0 else.
394 int i_mapper_sinh(ir_node *call, void *ctx);
397 * A mapper for the floating point cosh(a): floattype cosh(floattype a);
399 * @return 0 if the cosh call was removed, 0 else.
401 int i_mapper_cosh(ir_node *call, void *ctx);
404 * A mapper for the floating point tanh(a): floattype tanh(floattype a);
406 * @return 0 if the tanh call was removed, 0 else.
408 int i_mapper_tanh(ir_node *call, void *ctx);
411 * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
413 * @return 0 if the strcmp call was removed, 0 else.
415 int i_mapper_strcmp(ir_node *call, void *ctx);
418 * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
420 * @return 0 if the strncmp call was removed, 0 else.
422 int i_mapper_strncmp(ir_node *call, void *ctx);
425 * A mapper for the strlen-Function: inttype strlen(char pointer a);
427 * @return 0 if the strlen call was removed, 0 else.
429 int i_mapper_strlen(ir_node *call, void *ctx);
432 * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
434 * @return 0 if the memcpy call was removed, 0 else.
436 int i_mapper_memcpy(ir_node *call, void *ctx);
439 * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
441 * @return 0 if the memset call was removed, 0 else.
443 int i_mapper_memset(ir_node *call, void *ctx);
446 * A mapper for the alloca() function: pointer alloca(inttype size)
447 * Replaces the call by a Alloca(stack_alloc) node.
451 int i_mapper_alloca(ir_node *call, void *ctx);
454 * A runtime routine description.
456 typedef struct _runtime_rt {
457 ir_entity *ent; /**< The entity representing the runtime routine. */
458 ir_mode *mode; /**< The operation mode of the mapped instruction. */
459 ir_mode *res_mode; /**< The result mode of the mapped instruction or NULL. */
460 long mem_proj_nr; /**< if >= 0, create a memory ProjM() */
461 long regular_proj_nr; /**< if >= 0, create a regular ProjX() */
462 long exc_proj_nr; /**< if >= 0, create a exception ProjX() */
463 long exc_mem_proj_nr; /**< if >= 0, create a exception memory ProjM() */
464 long res_proj_nr; /**< if >= 0, first result projection number */
468 * A mapper for mapping unsupported instructions to runtime calls.
469 * Maps a op(arg_0, ..., arg_n) into a call to a runtime function
470 * rt(arg_0, ..., arg_n).
472 * The mapping is only done, if the modes of all arguments matches the
473 * modes of rt's argument.
474 * Further, if op has a memory input, the generated Call uses it, else
476 * The pinned state of the Call will be set to the pinned state of op.
478 * Note that i_mapper_RuntimeCall() must be used with a i_instr_record.
480 * @return 1 if an op was mapped, 0 else
484 * - Maps signed Div nodes to calls to rt_Div():
486 runtime_rt rt_Div = {
487 ent("int rt_Div(int, int)"),
496 i_instr_record map_Div = {
499 i_mapper_RuntimeCall,
505 * - Maps ConvD(F) to calls to rt_Float2Div():
507 runtime_rt rt_Float2Double = {
508 ent("double rt_Float2Div(float)"),
509 get_type_mode("double"),
517 i_instr_record map_Float2Double = {
520 i_mapper_RuntimeCall,
526 int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);
528 #endif /* FIRM_LOWERING_H */