/*
- * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
*
* This file is part of libFirm.
*
* @file
* @brief Lowering of high level constructs.
* @author Michael Beck
- * @version $Id$
*/
#ifndef FIRM_LOWERING_H
#define FIRM_LOWERING_H
+#include <stddef.h>
+
#include "firm_types.h"
+
+#include "begin.h"
+
/**
- * A type telling where to add hidden parameters.
+ * @defgroup ir_lowering Lowering
+ *
+ * Lowering is the process of transforming a highlevel representation
+ * (a representation closer to the sourcecode) into a lower-level representation
+ * (something closer to the target machine).
+ *
+ * @{
*/
-typedef enum add_hidden_params {
- ADD_HIDDEN_ALWAYS_IN_FRONT = 0, /**< always add hidden parameters in front (default). */
- ADD_HIDDEN_ALWAYS_LAST = 1, /**< always add hidden parameters last, did not work for variadic functions. */
- ADD_HIDDEN_SMART = 2 /**< add hidden parameters last for non-variadic and first for variadic functions. */
-} add_hidden;
/**
- * Additional flags for the lowering.
+ * Lower small CopyB nodes to Load/Store nodes, preserve medium-sized CopyB
+ * nodes and replace large CopyBs by a call to memcpy, depending on the given
+ * parameters.
+ *
+ * Small CopyB nodes (size <= max_small_size) are turned into a series of
+ * loads and stores.
+ * Medium-sized CopyB nodes (max_small_size < size < min_large_size) are
+ * left untouched.
+ * Large CopyB nodes (size >= min_large_size) are turned into a memcpy call.
+ *
+ * @param irg The graph to be lowered.
+ * @param max_small_size The maximum number of bytes for a CopyB node so
+ * that it is still considered 'small'.
+ * @param min_large_size The minimum number of bytes for a CopyB node so
+ * that it is regarded as 'large'.
+ * @param allow_misalignments Backend can handle misaligned loads and stores.
*/
-enum lowering_flags {
- LF_NONE = 0, /**< no additional flags */
- LF_COMPOUND_PARAM = 1, /**< lower calls with compound parameters */
- LF_COMPOUND_RETURN = 2, /**< lower calls with compound returns */
- LF_RETURN_HIDDEN = 4, /**< return the hidden address instead of void */
- LF_SMALL_CMP_IN_REGS = 8 /**< return small compound values in registers */
-};
-
-/** Maximum number of registers that can be used to return compound values. */
-#define MAX_REGISTER_RET_VAL 2
+FIRM_API void lower_CopyB(ir_graph *irg, unsigned max_small_size,
+ unsigned min_large_size, int allow_misalignments);
/**
- * A struct containing all control parameters for
- * lower_compound_ret_calls().
+ * Lowers all Switches (Cond nodes with non-boolean mode) depending on spare_size.
+ * They will either remain the same or be converted into if-cascades.
+ *
+ * @param irg The ir graph to be lowered.
+ * @param small_switch If switch has <= cases then change it to an if-cascade.
+ * @param spare_size Allowed spare size for table switches in machine words.
+ * (Default in edgfe: 128)
+ * @param allow_out_of_bounds backend can handle out-of-bounds values
+ * (values bigger than minimum and maximum proj
+ * number)
*/
-typedef struct {
- int def_ptr_alignment; /**< Default alignment for data pointer. */
- unsigned flags; /**< A bitmask of enum lowering_flags. */
- add_hidden hidden_params; /**< Where to add hidden parameters. */
-
- /**
- * A function returning a pointer type for a given type.
- * If this pointer is NULL, a new pointer type is always created.
- */
- ir_type *(*find_pointer_type)(ir_type *e_type, ir_mode *mode, int alignment);
-
- /**
- * If the LF_SMALL_CMP_IN_REGS flag is set, this function will be called
- * to decide, whether a compound value should be returned in registers.
- * This function must return the number of used registers and fill in the modes
- * of the registers to use. Up to MAX_REGISTER_RET_VAL registers can be used.
- */
- int (*ret_compound_in_regs)(ir_type *compound_tp, ir_mode **modes);
-} lower_params_t;
+FIRM_API void lower_switch(ir_graph *irg, unsigned small_switch,
+ unsigned spare_size, int allow_out_of_bounds);
/**
- * Lower calls with compound parameter and return types.
- * This function does the following transformations:
- *
- * If LF_COMPOUND_PARAM is set:
- *
- * - Copy compound parameters to a new location on the callers
- * stack and transmit the address of this new location
- *
- * If LF_COMPOUND_RETURN is set:
- *
- * - Adds a new (hidden) pointer parameter for
- * any return compound type. The return type is replaced by void
- * or if LOWERING_FLAGS_RETURN_HIDDEN is set by the address.
- *
- * - Use of the hidden parameters in the function code.
- *
- * - Change all calls to functions with compound return
- * by providing space for the hidden parameter on the callers
- * stack.
- *
- * - Replace a possible block copy after the function call.
- *
- * General:
- *
- * - Changes the types of methods and calls to the lowered ones
- *
- * - lower all method types of existing entities
- *
- * In pseudo-code, the following transformation is done:
- *
- @code
- struct x ret = func(a, b);
- @endcode
- *
- * is translated into
- @code
- struct x ret;
- func(&ret, a, b);
- @endcode
- *
- * If the function returns only one possible result, the copy-on-return
- * optimization is done, ie.
- @code
- struct x func(a) {
- struct x ret;
- ret.a = a;
- return ret;
- }
- @endcode
+ * Replaces SymConsts by a real constant if possible.
+ * Replaces Sel nodes by address computation. Also resolves array access.
+ * Handle bit fields by added And/Or calculations.
*
- * is transformed into
+ * @param irg the graph to lower
*
- @code
- void func(struct x *ret, a) {
- ret->a = a;
- }
- @endcode
+ * @note: There is NO lowering ob objects oriented types. This is highly compiler
+ * and ABI specific and should be placed directly in the compiler.
+ */
+FIRM_API void lower_highlevel_graph(ir_graph *irg);
+
+/**
+ * Creates an ir_graph pass for lower_highlevel_graph().
*
- * @param params A structure containing the control parameter for this
- * transformation.
+ * @param name the name of this pass or NULL
*
- * During the transformation, pointer types must be created or reused.
- * The caller can provide params->find_pointer_type for this task to
- * reduce the number of created pointer types.
- * If params->find_pointer_type is NULL, new pointer types
- * are always created automatically.
+ * @return the newly created ir_graph pass
*/
-void lower_calls_with_compounds(const lower_params_t *params);
+FIRM_API ir_graph_pass_t *lower_highlevel_graph_pass(const char *name);
/**
- * A callback type for creating an intrinsic entity for a given opcode.
+ * Replaces SymConsts by a real constant if possible.
+ * Replaces Sel nodes by address computation. Also resolves array access.
+ * Handle bit fields by added And/Or calculations.
+ * Lowers all graphs.
*
- * @param method the method type of the emulation function entity
- * @param op the emulated ir_op
- * @param imode the input mode of the emulated opcode
- * @param omode the output mode of the emulated opcode
- * @param context the context parameter
+ * @note There is NO lowering of objects oriented types. This is highly compiler
+ * and ABI specific and should be placed directly in the compiler.
*/
-typedef ir_entity *(create_intrinsic_fkt)(ir_type *method, const ir_op *op,
- const ir_mode *imode, const ir_mode *omode,
- void *context);
+FIRM_API void lower_highlevel(void);
/**
- * The lowering parameter description.
+ * does the same as lower_highlevel for all nodes on the const code irg
*/
-typedef struct _lwrdw_param_t {
- int enable; /**< if true lowering is enabled */
- int little_endian; /**< if true should be lowered for little endian, else big endian */
- ir_mode *high_signed; /**< the double word signed mode to be lowered, typically Ls */
- ir_mode *high_unsigned; /**< the double word unsigned mode to be lowered, typically Lu */
- ir_mode *low_signed; /**< the word signed mode to be used, typically Is */
- ir_mode *low_unsigned; /**< the word unsigned mode to be used, typically Iu */
-
- /** callback that creates the intrinsic entity */
- create_intrinsic_fkt *create_intrinsic;
- void *ctx; /**< context parameter for the creator function */
-} lwrdw_param_t;
+FIRM_API void lower_const_code(void);
/**
- * Lower all double word operations.
+ * Creates an ir_prog pass for lower_const_code().
+ *
+ * @param name the name of this pass or NULL
+ *
+ * @return the newly created ir_prog pass
*/
-void lower_dw_ops(const lwrdw_param_t *param);
+FIRM_API ir_prog_pass_t *lower_const_code_pass(const char *name);
/**
- * Default implementation. Context is unused.
+ * Used as callback, whenever a lowerable mux is found. The return value
+ * indicates, whether the mux should be lowered. This may be used, to lower
+ * floating point muxes, while keeping mux nodes for integers, for example.
+ *
+ * @param mux The mux node that may be lowered.
+ * @return A non-zero value indicates that the mux should be lowered.
*/
-ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
- const ir_mode *imode, const ir_mode *omode,
- void *context);
+typedef int lower_mux_callback(ir_node* mux);
/**
- * Replaces SymConsts by a real constant if possible.
- * Replace Sel nodes by address computation. Also resolves array access.
- * Handle bit fields by added And/Or calculations.
+ * Lowers all mux nodes in the given graph. A callback function may be
+ * given, to select the mux nodes to lower.
*
- * @Note: There is NO lowering ob objects oriented types. This is highly compiler
- * and ABI specific and should be placed directly in the compiler.
+ * @param irg The graph to lower mux nodes in.
+ * @param cb_func The callback function for mux selection. Can be NULL,
+ * to lower all mux nodes.
*/
-void lower_highlevel(void);
-
-typedef struct lower_mode_b_config_t {
- /* mode that is used to transport 0/1 values */
- ir_mode *lowered_mode;
- /* preferred mode for the "set" operations (a psi that produces a 0 or 1) */
- ir_mode *lowered_set_mode;
- /* wether direct Cond -> Cmps should also be lowered */
- int lower_direct_cmp;
-} lower_mode_b_config_t;
+FIRM_API void lower_mux(ir_graph *irg, lower_mux_callback *cb_func);
/**
- * Lowers mode_b operations to integer arithmetic. After the lowering the only
- * operations with mode_b are the Projs of Cmps; the only nodes with mode_b
- * inputs are Cond and Psi nodes.
+ * Creates an ir_graph pass for lower_mux().
*
- * Example: Psi(a < 0, 1, 0) => a >> 31
+ * @param name the name of this pass or NULL
+ * @param cb_func The callback function for mux selection. Can be NULL,
+ * to lower all mux nodes.
*
- * @param irg the firm graph to lower
- * @param config configuration for mode_b lowerer
+ * @return the newly created ir_graph pass
*/
-void ir_lower_mode_b(ir_graph *irg, const lower_mode_b_config_t *config);
+FIRM_API ir_graph_pass_t *lower_mux_pass(const char *name,
+ lower_mux_callback *cb_func);
/**
* An intrinsic mapper function.
*/
typedef int (*i_mapper_func)(ir_node *node, void *ctx);
+/** kind of an instruction record
+ * @see #i_record */
enum ikind {
INTRINSIC_CALL = 0, /**< the record represents an intrinsic call */
INTRINSIC_INSTR /**< the record represents an intrinsic instruction */
/**
* An intrinsic call record.
*/
-typedef struct _i_call_record {
+typedef struct i_call_record {
enum ikind kind; /**< must be INTRINSIC_CALL */
ir_entity *i_ent; /**< the entity representing an intrinsic call */
i_mapper_func i_mapper; /**< the mapper function to call */
/**
* An intrinsic instruction record.
*/
-typedef struct _i_instr_record {
+typedef struct i_instr_record {
enum ikind kind; /**< must be INTRINSIC_INSTR */
ir_op *op; /**< the opcode that must be mapped. */
i_mapper_func i_mapper; /**< the mapper function to call */
/**
* An intrinsic record.
*/
-typedef union _i_record {
- i_call_record i_call;
- i_instr_record i_instr;
+typedef union i_record {
+ enum ikind kind; /**< kind of record */
+ i_call_record i_call; /**< used for call records */
+ i_instr_record i_instr; /**< used for isnstruction records */
} i_record;
/**
*
* @return number of found intrinsics.
*/
-unsigned lower_intrinsics(i_record *list, int length, int part_block_used);
+FIRM_API size_t lower_intrinsics(i_record *list, size_t length,
+ int part_block_used);
+
+/**
+ * Creates an irprog pass for lower_intrinsics.
+ *
+ * @param name the name of this pass or NULL
+ * @param list an array of intrinsic map records
+ * @param length the length of the array
+ * @param part_block_used set to true if part_block() must be using during lowering
+ */
+FIRM_API ir_prog_pass_t *lower_intrinsics_pass(const char *name, i_record *list,
+ size_t length, int part_block_used);
/**
- * A mapper for the integer absolute value: inttype abs(inttype v).
+ * A mapper for the integer/float absolute value: type abs(type v).
* Replaces the call by a Abs node.
*
* @return always 1
*/
-int i_mapper_Abs(ir_node *call, void *ctx);
+FIRM_API int i_mapper_abs(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the integer byte swap value: type bswap(type v).
+ * Replaces the call by a builtin[ir_bk_bswap] node.
+ *
+ * @return always 1
+ */
+FIRM_API int i_mapper_bswap(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
+ *
+ * @return 1 if the sqrt call was removed, 0 else.
+ */
+FIRM_API int i_mapper_sqrt(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
+ *
+ * @return 1 if the cbrt call was removed, 0 else.
+ */
+FIRM_API int i_mapper_cbrt(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
+ *
+ * @return 1 if the pow call was removed, 0 else.
+ */
+FIRM_API int i_mapper_pow(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point exp(a): floattype exp(floattype a);
+ *
+ * @return 1 if the exp call was removed, 0 else.
+ */
+FIRM_API int i_mapper_exp(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point exp2(a): floattype exp2(floattype a);
+ *
+ * @return 1 if the exp call was removed, 0 else.
+ */
+FIRM_API int i_mapper_exp2(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point exp10(a): floattype exp10(floattype a);
+ *
+ * @return 1 if the exp call was removed, 0 else.
+ */
+FIRM_API int i_mapper_exp10(ir_node *call, void *ctx);
/**
- * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
+ * A mapper for the floating point log(a): floattype log(floattype a);
*
- * @return 0 if the sqrt call was removed, 0 else.
+ * @return 1 if the log call was removed, 0 else.
*/
-int i_mapper_Sqrt(ir_node *call, void *ctx);
+FIRM_API int i_mapper_log(ir_node *call, void *ctx);
/**
- * A mapper for the floating point pow(a, b): floattype pow(floattype a, floattype b);
+ * A mapper for the floating point log(a): floattype log(floattype a);
*
- * @return 0 if the pow call was removed, 0 else.
+ * @return 1 if the log call was removed, 0 else.
*/
-int i_mapper_Pow(ir_node *call, void *ctx);
+FIRM_API int i_mapper_log2(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point log(a): floattype log(floattype a);
+ *
+ * @return 1 if the log call was removed, 0 else.
+ */
+FIRM_API int i_mapper_log10(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point sin(a): floattype sin(floattype a);
+ *
+ * @return 1 if the sin call was removed, 0 else.
+ */
+FIRM_API int i_mapper_sin(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point sin(a): floattype cos(floattype a);
+ *
+ * @return 1 if the cos call was removed, 0 else.
+ */
+FIRM_API int i_mapper_cos(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point tan(a): floattype tan(floattype a);
+ *
+ * @return 1 if the tan call was removed, 0 else.
+ */
+FIRM_API int i_mapper_tan(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point asin(a): floattype asin(floattype a);
+ *
+ * @return 1 if the asin call was removed, 0 else.
+ */
+FIRM_API int i_mapper_asin(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point acos(a): floattype acos(floattype a);
+ *
+ * @return 1 if the tan call was removed, 0 else.
+ */
+FIRM_API int i_mapper_acos(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point atan(a): floattype atan(floattype a);
+ *
+ * @return 1 if the atan call was removed, 0 else.
+ */
+FIRM_API int i_mapper_atan(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point sinh(a): floattype sinh(floattype a);
+ *
+ * @return 1 if the sinh call was removed, 0 else.
+ */
+FIRM_API int i_mapper_sinh(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point cosh(a): floattype cosh(floattype a);
+ *
+ * @return 1 if the cosh call was removed, 0 else.
+ */
+FIRM_API int i_mapper_cosh(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the floating point tanh(a): floattype tanh(floattype a);
+ *
+ * @return 1 if the tanh call was removed, 0 else.
+ */
+FIRM_API int i_mapper_tanh(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
+ *
+ * @return 1 if the strcmp call was removed, 0 else.
+ */
+FIRM_API int i_mapper_strcmp(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the strncmp-Function: inttype strncmp(char pointer a, char pointer b, inttype len);
+ *
+ * @return 1 if the strncmp call was removed, 0 else.
+ */
+FIRM_API int i_mapper_strncmp(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the strcpy-Function: char pointer strcpy(char pointer a, char pointer b);
+ *
+ * @return 1 if the strcpy call was removed, 0 else.
+ */
+FIRM_API int i_mapper_strcpy(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the strlen-Function: inttype strlen(char pointer a);
+ *
+ * @return 1 if the strlen call was removed, 0 else.
+ */
+FIRM_API int i_mapper_strlen(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the memcpy-Function: void pointer memcpy(void pointer d, void pointer s, inttype c);
+ *
+ * @return 1 if the memcpy call was removed, 0 else.
+ */
+FIRM_API int i_mapper_memcpy(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the mempcpy-Function: void pointer mempcpy(void pointer d, void pointer s, inttype c);
+ *
+ * @return 1 if the mempcpy call was removed, 0 else.
+ */
+FIRM_API int i_mapper_mempcpy(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the memmove-Function: void pointer memmove(void pointer d, void pointer s, inttype c);
+ *
+ * @return 1 if the memmove call was removed, 0 else.
+ */
+FIRM_API int i_mapper_memmove(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the memset-Function: void pointer memset(void pointer d, inttype C, inttype len);
+ *
+ * @return 1 if the memset call was removed, 0 else.
+ */
+FIRM_API int i_mapper_memset(ir_node *call, void *ctx);
+
+/**
+ * A mapper for the strncmp-Function: inttype memcmp(void pointer a, void pointer b, inttype len);
+ *
+ * @return 1 if the strncmp call was removed, 0 else.
+ */
+FIRM_API int i_mapper_memcmp(ir_node *call, void *ctx);
/**
* A mapper for the alloca() function: pointer alloca(inttype size)
*
* @return always 1
*/
-int i_mapper_Alloca(ir_node *call, void *ctx);
+FIRM_API int i_mapper_alloca(ir_node *call, void *ctx);
/**
* A runtime routine description.
*/
-typedef struct _runtime_rt {
+typedef struct runtime_rt {
ir_entity *ent; /**< The entity representing the runtime routine. */
ir_mode *mode; /**< The operation mode of the mapped instruction. */
ir_mode *res_mode; /**< The result mode of the mapped instruction or NULL. */
long mem_proj_nr; /**< if >= 0, create a memory ProjM() */
long regular_proj_nr; /**< if >= 0, create a regular ProjX() */
long exc_proj_nr; /**< if >= 0, create a exception ProjX() */
- long exc_mem_proj_nr; /**< if >= 0, create a exception memory ProjM() */
long res_proj_nr; /**< if >= 0, first result projection number */
} runtime_rt;
};
@endcode
*/
-int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);
+FIRM_API int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);
+
+/** @} */
+
+#include "end.h"
-#endif /* FIRM_LOWERING_H */
+#endif
projects / libfirm / blobdiff