amd64: Added Load and FrameAddr transformation. And fixed some corruption bugs w...
[libfirm] / include / libfirm / irarch.h
index c71183f..a4fdf08 100644 (file)
@@ -28,6 +28,7 @@
 #define FIRM_IR_IRARCH_H
 
 #include "firm_types.h"
+#include "begin.h"
 
 /**
  * The Multiplication replacement can consist of the following instructions.
@@ -39,7 +40,7 @@ typedef enum instr {
        ADD,   /**< the ADD instruction */
        ZERO,  /**< creates a ZERO constant */
        MUL,   /**< the original MUL instruction */
-       ROOT,  /**< the ROOT value that is multiplied */
+       ROOT   /**< the ROOT value that is multiplied */
 } insn_kind;
 
 /**
@@ -59,7 +60,7 @@ typedef int (*evaluate_costs_func)(insn_kind kind, tarval *tv);
 struct ir_settings_arch_dep_t {
        /* Mul optimization */
        unsigned also_use_subs : 1;    /**< Use also Subs when resolving Muls to shifts */
-       int 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,7 +69,7 @@ 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 */
-       int 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 */
 };
 
@@ -81,7 +82,7 @@ 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);
+FIRM_API const ir_settings_arch_dep_t *arch_dep_default_factory(void);
 
 /**
  * Optimization flags.
@@ -100,30 +101,22 @@ typedef enum {
  *                  is not called, the machine dependent optimizations
  *                  are not enabled at all.
  */
-void arch_dep_init(arch_dep_params_factory_t factory);
+FIRM_API void arch_dep_init(arch_dep_params_factory_t factory);
 
 /**
  * Set 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.
+ * Replace 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.
@@ -140,7 +133,7 @@ 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.
@@ -157,7 +150,7 @@ 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.
@@ -175,6 +168,9 @@ ir_node *arch_dep_replace_mod_by_const(ir_node *irn);
  * @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);
+FIRM_API void arch_dep_replace_divmod_by_const(ir_node **div, ir_node **mod,
+                                               ir_node *irn);
+
+#include "end.h"
 
 #endif