remove get_XXX_attr type functions
[libfirm] / include / libfirm / lowering.h
index 3c3111f..f54ce72 100644 (file)
@@ -159,6 +159,17 @@ void lower_CopyB(ir_graph *irg, unsigned max_size, unsigned native_mode_bytes);
  */
 void lower_switch(ir_graph *irg, unsigned spare_size);
 
+/**
+ * Creates an ir_graph pass for lower_switch().
+ *
+ * @param name       the name of this pass or NULL
+ * @param spare_size Allowed spare size for table switches in machine words.
+ *                   (Default in edgfe: 128)
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *lower_switch_pass(const char *name, unsigned spare_size);
+
 /**
  * A callback type for creating an intrinsic entity for a given opcode.
  *
@@ -190,9 +201,21 @@ typedef struct _lwrdw_param_t {
 
 /**
  * Lower all double word operations.
+ *
+ * @param param  parameter for lowering
  */
 void lower_dw_ops(const lwrdw_param_t *param);
 
+/**
+ * Creates an ir_prog pass for lower_dw_ops().
+ *
+ * @param name   the name of this pass or NULL
+ * @param param  parameter for lowering
+ *
+ * @return  the newly created ir_prog pass
+ */
+ir_prog_pass_t *lower_dw_ops_pass(const char *name, const lwrdw_param_t *param);
+
 /**
  * Default implementation. Context is unused.
  */
@@ -205,21 +228,34 @@ ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
  * 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 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_highlevel_graph(ir_graph *irg, int lower_bitfields);
 
+/**
+ * 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_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.
  */
 void lower_highlevel(int lower_bitfields);
 
@@ -228,12 +264,21 @@ void lower_highlevel(int lower_bitfields);
  */
 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
+ */
+ir_prog_pass_t *lower_const_code_pass(const char *name);
+
 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 */
+       /* whether direct Cond -> Cmps should also be lowered */
        int lower_direct_cmp;
 } lower_mode_b_config_t;
 
@@ -244,11 +289,53 @@ typedef struct lower_mode_b_config_t {
  *
  * Example: Psi(a < 0, 1, 0) => a >> 31
  *
- * @param irg            the firm graph to lower
- * @param config         configuration for mode_b lowerer
+ * @param irg      the firm graph to lower
+ * @param config   configuration for mode_b lowerer
  */
 void ir_lower_mode_b(ir_graph *irg, const lower_mode_b_config_t *config);
 
+/**
+ * Creates an ir_graph pass for ir_lower_mode_b().
+ *
+ * @param name     the name of this pass or NULL
+ * @param config   configuration for mode_b lowerer
+ *
+ * @return  the newly created ir_graph pass
+ */
+ir_graph_pass_t *ir_lower_mode_b_pass(
+       const char *name, 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.
+ */
+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
+ */
+ir_graph_pass_t *lower_mux_pass(const char *name, lower_mux_callback *cb_func);
+
 /**
  * An intrinsic mapper function.
  *
@@ -310,6 +397,18 @@ typedef union _i_record {
  */
 unsigned lower_intrinsics(i_record *list, int 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
+ */
+ir_prog_pass_t *lower_intrinsics_pass(
+       const char *name,
+       i_record *list, int length, int part_block_used);
+
 /**
  * A mapper for the integer/float absolute value: type abs(type v).
  * Replaces the call by a Abs node.
@@ -318,31 +417,39 @@ unsigned lower_intrinsics(i_record *list, int length, int part_block_used);
  */
 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
+ */
+int i_mapper_bswap(ir_node *call, void *ctx);
+
 /**
  * A mapper for the floating point sqrt(v): floattype sqrt(floattype v);
  *
- * @return 0 if the sqrt call was removed, 0 else.
+ * @return 1 if the sqrt call was removed, 0 else.
  */
 int i_mapper_sqrt(ir_node *call, void *ctx);
 
 /**
  * A mapper for the floating point cbrt(v): floattype sqrt(floattype v);
  *
- * @return 0 if the cbrt call was removed, 0 else.
+ * @return 1 if the cbrt call was removed, 0 else.
  */
 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 0 if the pow call was removed, 0 else.
+ * @return 1 if the pow call was removed, 0 else.
  */
 int i_mapper_pow(ir_node *call, void *ctx);
 
 /**
  * A mapper for the floating point exp(a): floattype exp(floattype a);
  *
- * @return 0 if the exp call was removed, 0 else.
+ * @return 1 if the exp call was removed, 0 else.
  */
 int i_mapper_exp(ir_node *call, void *ctx);
 
@@ -352,7 +459,7 @@ int i_mapper_exp(ir_node *call, void *ctx);
 /**
  * A mapper for the floating point log(a): floattype log(floattype a);
  *
- * @return 0 if the log call was removed, 0 else.
+ * @return 1 if the log call was removed, 0 else.
  */
 int i_mapper_log(ir_node *call, void *ctx);
 
@@ -362,101 +469,129 @@ int i_mapper_log(ir_node *call, void *ctx);
 /**
  * A mapper for the floating point sin(a): floattype sin(floattype a);
  *
- * @return 0 if the sin call was removed, 0 else.
+ * @return 1 if the sin call was removed, 0 else.
  */
 int i_mapper_sin(ir_node *call, void *ctx);
 
 /**
  * A mapper for the floating point sin(a): floattype cos(floattype a);
  *
- * @return 0 if the cos call was removed, 0 else.
+ * @return 1 if the cos call was removed, 0 else.
  */
 int i_mapper_cos(ir_node *call, void *ctx);
 
 /**
  * A mapper for the floating point tan(a): floattype tan(floattype a);
  *
- * @return 0 if the tan call was removed, 0 else.
+ * @return 1 if the tan call was removed, 0 else.
  */
 int i_mapper_tan(ir_node *call, void *ctx);
 
 /**
  * A mapper for the floating point asin(a): floattype asin(floattype a);
  *
- * @return 0 if the asin call was removed, 0 else.
+ * @return 1 if the asin call was removed, 0 else.
  */
 int i_mapper_asin(ir_node *call, void *ctx);
 
 /**
  * A mapper for the floating point acos(a): floattype acos(floattype a);
  *
- * @return 0 if the tan call was removed, 0 else.
+ * @return 1 if the tan call was removed, 0 else.
  */
 int i_mapper_acos(ir_node *call, void *ctx);
 
 /**
  * A mapper for the floating point atan(a): floattype atan(floattype a);
  *
- * @return 0 if the atan call was removed, 0 else.
+ * @return 1 if the atan call was removed, 0 else.
  */
 int i_mapper_atan(ir_node *call, void *ctx);
 
 /**
  * A mapper for the floating point sinh(a): floattype sinh(floattype a);
  *
- * @return 0 if the sinh call was removed, 0 else.
+ * @return 1 if the sinh call was removed, 0 else.
  */
 int i_mapper_sinh(ir_node *call, void *ctx);
 
 /**
  * A mapper for the floating point cosh(a): floattype cosh(floattype a);
  *
- * @return 0 if the cosh call was removed, 0 else.
+ * @return 1 if the cosh call was removed, 0 else.
  */
 int i_mapper_cosh(ir_node *call, void *ctx);
 
 /**
  * A mapper for the floating point tanh(a): floattype tanh(floattype a);
  *
- * @return 0 if the tanh call was removed, 0 else.
+ * @return 1 if the tanh call was removed, 0 else.
  */
 int i_mapper_tanh(ir_node *call, void *ctx);
 
 /**
  * A mapper for the strcmp-Function: inttype strcmp(char pointer a, char pointer b);
  *
- * @return 0 if the strcmp call was removed, 0 else.
+ * @return 1 if the strcmp call was removed, 0 else.
  */
 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 0 if the strncmp call was removed, 0 else.
+ * @return 1 if the strncmp call was removed, 0 else.
  */
 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.
+ */
+int i_mapper_strcpy(ir_node *call, void *ctx);
+
 /**
  * A mapper for the strlen-Function: inttype strlen(char pointer a);
  *
- * @return 0 if the strlen call was removed, 0 else.
+ * @return 1 if the strlen call was removed, 0 else.
  */
 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 0 if the memcpy call was removed, 0 else.
+ * @return 1 if the memcpy call was removed, 0 else.
  */
 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.
+ */
+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.
+ */
+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 0 if the memset call was removed, 0 else.
+ * @return 1 if the memset call was removed, 0 else.
  */
 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.
+ */
+int i_mapper_memcmp(ir_node *call, void *ctx);
+
 /**
  * A mapper for the alloca() function: pointer alloca(inttype size)
  * Replaces the call by a Alloca(stack_alloc) node.