rename lower_Switch to lower_switch to be consistent with the rest
[libfirm] / include / libfirm / lowering.h
index 2c8742a..3c3111f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
 #ifndef FIRM_LOWERING_H
 #define FIRM_LOWERING_H
 
+#include "firm_types.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_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 */
+       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. */
@@ -54,23 +55,23 @@ enum lowering_flags {
  * 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);
+       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;
 
 /**
@@ -143,6 +144,21 @@ typedef struct {
  */
 void lower_calls_with_compounds(const lower_params_t *params);
 
+/**
+ *  * Lower CopyB nodes of size smaller that max_size into Loads/Stores
+ */
+void lower_CopyB(ir_graph *irg, unsigned max_size, unsigned native_mode_bytes);
+
+/**
+ * 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)
+ */
+void lower_switch(ir_graph *irg, unsigned spare_size);
+
 /**
  * A callback type for creating an intrinsic entity for a given opcode.
  *
@@ -187,12 +203,51 @@ ir_entity *def_create_intrinsic_fkt(ir_type *method, const ir_op *op,
 /**
  * Replaces SymConsts by a real constant if possible.
  * Replace Sel nodes by address computation.  Also resolves array access.
- * Handle Bitfields by added And/Or calculations.
+ * Handle bit fields by added And/Or calculations.
+ *
+ * @param irg  the graph 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.
+ */
+void lower_highlevel_graph(ir_graph *irg, 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.
  */
-void lower_highlevel(void);
+void lower_highlevel(int lower_bitfields);
+
+/**
+ * does the same as lower_highlevel for all nodes on the const code irg
+ */
+void lower_const_code(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;
+
+/**
+ * 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
+ */
+void ir_lower_mode_b(ir_graph *irg, const lower_mode_b_config_t *config);
 
 /**
  * An intrinsic mapper function.
@@ -247,20 +302,160 @@ typedef union _i_record {
  *
  * current_ir_graph is always set.
  *
- * @param list    an array of intrinsic map records
- * @param length  the length of the array
+ * @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
  *
  * @return number of found intrinsics.
  */
-unsigned lower_intrinsics(i_record *list, int length);
+unsigned lower_intrinsics(i_record *list, int 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);
+int i_mapper_abs(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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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 0 if the log call was removed, 0 else.
+ */
+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 0 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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+int i_mapper_strncmp(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.
+ */
+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.
+ */
+int i_mapper_memcpy(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.
+ */
+int i_mapper_memset(ir_node *call, void *ctx);
 
 /**
  * A mapper for the alloca() function: pointer alloca(inttype size)
@@ -268,7 +463,7 @@ int i_mapper_Abs(ir_node *call, void *ctx);
  *
  * @return always 1
  */
-int i_mapper_Alloca(ir_node *call, void *ctx);
+int i_mapper_alloca(ir_node *call, void *ctx);
 
 /**
  * A runtime routine description.