/*
- * Copyright (C) 1995-2008 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.
- */
-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.
- */
-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
-
-/**
- * A struct containing all control parameters for
- * lower_compound_ret_calls().
- */
-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;
-
-/**
- * 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:
+ * @defgroup ir_lowering Lowering
*
- * - Changes the types of methods and calls to the lowered ones
+ * 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).
*
- * - 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
- *
- * is transformed into
- *
- @code
- void func(struct x *ret, a) {
- ret->a = a;
- }
- @endcode
- *
- * @param params A structure containing the control parameter for this
- * transformation.
- *
- * 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.
+ * @{
*/
-FIRM_API void lower_calls_with_compounds(const lower_params_t *params);
/**
- * Lower CopyB nodes of size smaller that max_size into Loads/Stores
+ * 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.
*/
-FIRM_API void lower_CopyB(ir_graph *irg, unsigned max_size,
- unsigned native_mode_bytes);
+FIRM_API void lower_CopyB(ir_graph *irg, unsigned max_small_size,
+ unsigned min_large_size, int allow_misalignments);
/**
* 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)
*/
-FIRM_API void lower_switch(ir_graph *irg, unsigned spare_size,
- int allow_out_of_bounds);
-
-/**
- * A callback type for creating an intrinsic entity for a given opcode.
- *
- * @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
- */
-typedef ir_entity *(create_intrinsic_fkt)(ir_type *method, const ir_op *op,
- const ir_mode *imode,
- const ir_mode *omode, void *context);
-
-/**
- * The lowering parameter description.
- */
-typedef struct lwrdw_param_t {
- unsigned little_endian : 1; /**< if true should be lowered for little endian, else big endian */
- unsigned doubleword_size; /**< bitsize of the doubleword mode */
- create_intrinsic_fkt *create_intrinsic; /**< callback that creates the intrinsic entity */
- void *ctx; /**< context parameter for the creator function */
-} lwrdw_param_t;
-
-/**
- * Lower all double word operations.
- *
- * @param param parameter for lowering
- */
-FIRM_API void lower_dw_ops(const lwrdw_param_t *param);
-
-/**
- * Default implementation. Context is unused.
- */
-FIRM_API ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
- const ir_mode *imode,
- const ir_mode *omode,
- void *context);
+FIRM_API void lower_switch(ir_graph *irg, unsigned small_switch,
+ unsigned spare_size, int allow_out_of_bounds);
/**
* Replaces SymConsts by a real constant if possible.
* Handle bit fields by added And/Or calculations.
*
* @param irg the graph to lower
- * @param lower_bitfields the graph contains old-style bitfield
- * constructs
*
* @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, int lower_bitfields);
+FIRM_API void lower_highlevel_graph(ir_graph *irg);
/**
* Creates an ir_graph pass for lower_highlevel_graph().
*
* @param name the name of this pass or NULL
- * @param lower_bitfields the graph contains old-style bitfield
- * constructs
*
* @return the newly created ir_graph pass
*/
-FIRM_API ir_graph_pass_t *lower_highlevel_graph_pass(const char *name,
- int lower_bitfields);
+FIRM_API ir_graph_pass_t *lower_highlevel_graph_pass(const char *name);
/**
* Replaces SymConsts by a real constant if possible.
* @note There is NO lowering of objects oriented types. This is highly compiler
* and ABI specific and should be placed directly in the compiler.
*/
-FIRM_API void lower_highlevel(int lower_bitfields);
+FIRM_API void lower_highlevel(void);
/**
* does the same as lower_highlevel for all nodes on the const code irg
*/
FIRM_API ir_prog_pass_t *lower_const_code_pass(const char *name);
-/**
- * Function which creates a "set" instraction. A "set" instruction takes a
- * condition value (a value with mode_b) as input and produces a value in a
- * general purpose integer mode.
- * Most architectures have special intrinsics for this. But if all else fails
- * you can just produces the an if-like construct.
- */
-typedef ir_node* (*create_set_func)(ir_node *cond);
-
-/**
- * implementation of create_set_func which produces a Mux node with 0/1 input
- */
-ir_node *ir_create_mux_set(ir_node *cond, ir_mode *dest_mode);
-
-/**
- * implementation of create_set_func which produces a cond with control
- * flow
- */
-ir_node *ir_create_cond_set(ir_node *cond, ir_mode *dest_mode);
-
-typedef struct lower_mode_b_config_t {
- /* mode that is used to transport 0/1 values */
- ir_mode *lowered_mode;
- /* callback for creating set-like instructions */
- create_set_func create_set;
- /* whether direct Cond(Cmp) should also be lowered */
- int lower_direct_cmp;
-} lower_mode_b_config_t;
-
-/**
- * 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.
- *
- * Example: Psi(a < 0, 1, 0) => a >> 31
- *
- * @param irg the firm graph to lower
- * @param config configuration for mode_b lowerer
- */
-FIRM_API void ir_lower_mode_b(ir_graph *irg,
- const lower_mode_b_config_t *config);
-
/**
* 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
*
* @return number of found intrinsics.
*/
-FIRM_API unsigned lower_intrinsics(i_record *list, int length,
+FIRM_API size_t lower_intrinsics(i_record *list, size_t length,
int part_block_used);
/**
* @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,
- int length, int part_block_used);
+ size_t length, int part_block_used);
/**
* A mapper for the integer/float absolute value: type abs(type v).
*/
FIRM_API int i_mapper_exp(ir_node *call, void *ctx);
-#define i_mapper_exp2 i_mapper_exp
-#define i_mapper_exp10 i_mapper_exp
+/**
+ * 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 log(a): floattype log(floattype a);
*/
FIRM_API int i_mapper_log(ir_node *call, void *ctx);
-#define i_mapper_log2 i_mapper_log
-#define i_mapper_log10 i_mapper_log
+/**
+ * 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_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);
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;
*/
FIRM_API int i_mapper_RuntimeCall(ir_node *node, runtime_rt *rt);
+/** @} */
+
#include "end.h"
#endif