Introduce flip-flopping normalisations
[libfirm] / include / libfirm / lowering.h
index bc91300..149a6c7 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * 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.
  *
 #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.
  */
@@ -142,58 +147,107 @@ typedef struct {
  * If params->find_pointer_type is NULL, new pointer types
  * are always created automatically.
  */
-void lower_calls_with_compounds(const lower_params_t *params);
+FIRM_API void lower_calls_with_compounds(const lower_params_t *params);
 
 /**
- * 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
+ * Lower CopyB nodes of size smaller that max_size into Loads/Stores
  */
-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_CopyB(ir_graph *irg, unsigned max_size,
+                          unsigned native_mode_bytes);
 
 /**
- * The lowering parameter description.
+ * 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 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 _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_switch(ir_graph *irg, unsigned spare_size,
+                           int allow_out_of_bounds);
 
 /**
- * Lower all double word operations.
+ * 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.
+ *
+ * @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.
  */
-void lower_dw_ops(const lwrdw_param_t *param);
+FIRM_API void lower_highlevel_graph(ir_graph *irg, int lower_bitfields);
 
 /**
- * Default implementation. Context is unused.
+ * 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
  */
-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 ir_graph_pass_t *lower_highlevel_graph_pass(const char *name,
+                                                     int lower_bitfields);
 
 /**
  * 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 graphs.
  *
- * @Note: There is NO lowering ob objects oriented types. This is highly compiler
- *        and ABI specific and should be placed directly in the compiler.
+ * @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);
+
+/**
+ * does the same as lower_highlevel for all nodes on the const code irg
+ */
+FIRM_API void lower_const_code(void);
+
+/**
+ * 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
+ */
+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.
  */
-void lower_highlevel(void);
+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
@@ -202,11 +256,43 @@ void lower_highlevel(void);
  *
  * Example: Psi(a < 0, 1, 0) => a >> 31
  *
- * @param irg               the firm graph to lower
- * @param mode              the mode of the lowered operations
- * @param lower_direct_cmp  if set to 1, psi nodes with only have cmp/=0 as input
+ * @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
+ * 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.
+ */
+typedef int lower_mux_callback(ir_node* mux);
+
+/**
+ * Lowers all mux nodes in the given graph. A callback function may be
+ * given, to select the mux nodes to lower.
+ *
+ * @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.
+ */
+FIRM_API void lower_mux(ir_graph *irg, lower_mux_callback *cb_func);
+
+/**
+ * Creates an ir_graph pass for lower_mux().
+ *
+ * @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.
+ *
+ * @return  the newly created ir_graph pass
  */
-void ir_lower_mode_b(ir_graph *irg, ir_mode *mode, int lower_direct_cmp);
+FIRM_API ir_graph_pass_t *lower_mux_pass(const char *name,
+                                         lower_mux_callback *cb_func);
 
 /**
  * An intrinsic mapper function.
@@ -226,7 +312,7 @@ enum ikind {
 /**
  * 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 */
@@ -237,7 +323,7 @@ typedef struct _i_call_record {
 /**
  * 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 */
@@ -248,7 +334,7 @@ typedef struct _i_instr_record {
 /**
  * An intrinsic record.
  */
-typedef union _i_record {
+typedef union i_record {
        i_call_record  i_call;
        i_instr_record i_instr;
 } i_record;
@@ -267,15 +353,202 @@ typedef union _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);
 
 /**
- * A mapper for the integer absolute value: inttype abs(inttype v).
+ * 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/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);
+
+#define i_mapper_exp2   i_mapper_exp
+#define i_mapper_exp10  i_mapper_exp
+
+/**
+ * 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_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 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)
@@ -283,12 +556,12 @@ int i_mapper_Abs(ir_node *call, void *ctx);
  *
  * @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. */
@@ -358,6 +631,8 @@ typedef struct _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