Add a wrapper macro for pmap_get(), which has the return type as additional parameter.
[libfirm] / include / libfirm / irarch.h
index 79071db..c847106 100644 (file)
  * @brief  Some machine dependent optimizations.
  * @date   1.10.2004
  * @author Sebastian Hack
- * @version $Id$
  */
 #ifndef FIRM_IR_IRARCH_H
 #define FIRM_IR_IRARCH_H
 
 #include "firm_types.h"
+#include "begin.h"
 
 /**
  * The Multiplication replacement can consist of the following instructions.
@@ -46,20 +46,21 @@ typedef enum instr {
  * A Callback for evaluating the costs of an instruction.
  *
  * @param kind   the instruction
+ * @param mode   the mode of the instruction
  * @param tv     for MUL instruction, the multiplication constant
  *
  * @return the costs of this instruction
  */
-typedef int (*evaluate_costs_func)(insn_kind kind, tarval *tv);
+typedef int (*evaluate_costs_func)(insn_kind kind, const ir_mode *mode, ir_tarval *tv);
 
 /**
  * A parameter structure that drives the machine dependent Firm
  * optimizations.
  */
-struct ir_settings_arch_dep_t {
+typedef struct ir_settings_arch_dep_t {
        /* Mul optimization */
        unsigned also_use_subs : 1;    /**< Use also Subs when resolving Muls to shifts */
-       unsigned maximum_shifts;            /**< The maximum number of shifts that shall be inserted for a mul. */
+       unsigned maximum_shifts;       /**< The maximum number of shifts that shall be inserted for a mul. */
        unsigned highest_shift_amount; /**< The highest shift amount you want to
                                            tolerate. Muls which would require a higher
                                            shift constant are left. */
@@ -68,9 +69,9 @@ struct ir_settings_arch_dep_t {
        /* Div/Mod optimization */
        unsigned allow_mulhs   : 1;    /**< Use the Mulhs operation for division by constant */
        unsigned allow_mulhu   : 1;    /**< Use the Mulhu operation for division by constant */
-       unsigned max_bits_for_mulh;         /**< Maximum number of bits the Mulh operation can take.
+       unsigned max_bits_for_mulh;    /**< Maximum number of bits the Mulh operation can take.
                                            Modes with higher amount of bits will use Mulh */
-};
+} ir_settings_arch_dep_t;
 
 /**
  * A factory function, that provides architecture parameters for
@@ -78,11 +79,6 @@ struct ir_settings_arch_dep_t {
  */
 typedef const ir_settings_arch_dep_t *(*arch_dep_params_factory_t)(void);
 
-/**
- * A default parameter factory for testing purposes.
- */
-const ir_settings_arch_dep_t *arch_dep_default_factory(void);
-
 /**
  * Optimization flags.
  */
@@ -92,41 +88,25 @@ typedef enum {
        arch_dep_div_by_const = 2,  /**< optimize Div into Shift/Add/Mulh */
        arch_dep_mod_by_const = 4   /**< optimize Mod into Shift/Add/Mulh */
 } arch_dep_opts_t;
+ENUM_BITSET(arch_dep_opts_t)
 
 /**
- * Initialize the machine dependent optimizations.
- * @param factory   A factory that delivers parameters for these
- *                  optimizations. If NULL is passed, or this method
- *                  is not called, the machine dependent optimizations
- *                  are not enabled at all.
- */
-void arch_dep_init(arch_dep_params_factory_t factory);
-
-/**
- * Set the optimizations that shall be applied.
+ * Sets the optimizations that shall be applied.
  * @param opts An optimization bit mask.
  */
-void arch_dep_set_opts(arch_dep_opts_t opts);
+FIRM_API void arch_dep_set_opts(arch_dep_opts_t opts);
 
 /**
- * Replace Muls with Shifts and Add/Subs.
- * This function is driven by the 3 parameters:
- * - also_use_subs
- * - maximum_shifts
- * - highest_shift_amount
- *
- * If irn is a Mul with a Const, the constant is inspected if it meets the
- * requirements of the three variables stated above. If a Shl/Add/Sub
- * sequence can be generated that meets these requirements, this expression
- * is returned. In each other case irn is returned unmodified.
+ * Replaces Muls with Lea/Shifts/Add/Subs if these
+ * have smaller costs than the original multiplication.
  *
  * @param irn       The Firm node to inspect.
  * @return          A replacement expression for irn.
  */
-ir_node *arch_dep_replace_mul_with_shifts(ir_node *irn);
+FIRM_API ir_node *arch_dep_replace_mul_with_shifts(ir_node *irn);
 
 /**
- * Replace Divs with Shifts and Add/Subs and Mulh.
+ * Replaces Divs with Shifts and Add/Subs and Mulh.
  * This function is driven by the 3 parameters:
  * - allow_mulhu
  * - allow_mulhs
@@ -140,10 +120,10 @@ ir_node *arch_dep_replace_mul_with_shifts(ir_node *irn);
  * @param irn       The Firm node to inspect.
  * @return          A replacement expression for irn.
  */
-ir_node *arch_dep_replace_div_by_const(ir_node *irn);
+FIRM_API ir_node *arch_dep_replace_div_by_const(ir_node *irn);
 
 /**
- * Replace Mods with Shifts and Add/Subs and Mulh.
+ * Replaces Mods with Shifts and Add/Subs and Mulh.
  * This function is driven by the 3 parameters:
  * - allow_mulhu
  * - allow_mulhs
@@ -157,24 +137,8 @@ ir_node *arch_dep_replace_div_by_const(ir_node *irn);
  * @param irn       The Firm node to inspect.
  * @return          A replacement expression for irn.
  */
-ir_node *arch_dep_replace_mod_by_const(ir_node *irn);
+FIRM_API ir_node *arch_dep_replace_mod_by_const(ir_node *irn);
 
-/**
- * Replace DivMods with Shifts and Add/Subs and Mulh.
- * This function is driven by the 3 parameters:
- * - allow_mulhu
- * - allow_mulhs
- * - max_bits_for_mulh
- *
- * If irn is a DivMod with a Const, the constant is inspected if it meets the
- * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
- * sequence can be generated that meets these requirements, this expression
- * is returned. In each other case irn is returned unmodified.
- *
- * @param div       After call contains the Firm node div result or NULL.
- * @param mod       After call contains the Firm node mod result or NULL.
- * @param irn       The Firm node to inspect.
- */
-void arch_dep_replace_divmod_by_const(ir_node **div, ir_node **mod, ir_node *irn);
+#include "end.h"
 
 #endif