nsz Git - libfirm/blob - include/libfirm/irarch.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief  Some machine dependent optimizations.
  23  * @date   1.10.2004
  24  * @author Sebastian Hack
  25  * @version $Id$
  26  */
  27 #ifndef FIRM_IR_IRARCH_H
  28 #define FIRM_IR_IRARCH_H
  29
  30 #include "firm_types.h"
  31 #include "begin.h"
  32
  33 /**
  34  * The Multiplication replacement can consist of the following instructions.
  35  */
  36 typedef enum instr {
  37         LEA,   /**< the LEA instruction */
  38         SHIFT, /**< the SHIFT instruction */
  39         SUB,   /**< the SUB instruction */
  40         ADD,   /**< the ADD instruction */
  41         ZERO,  /**< creates a ZERO constant */
  42         MUL,   /**< the original MUL instruction */
  43         ROOT   /**< the ROOT value that is multiplied */
  44 } insn_kind;
  45
  46 /**
  47  * A Callback for evaluating the costs of an instruction.
  48  *
  49  * @param kind   the instruction
  50  * @param tv     for MUL instruction, the multiplication constant
  51  *
  52  * @return the costs of this instruction
  53  */
  54 typedef int (*evaluate_costs_func)(insn_kind kind, tarval *tv);
  55
  56 /**
  57  * A parameter structure that drives the machine dependent Firm
  58  * optimizations.
  59  */
  60 struct ir_settings_arch_dep_t {
  61         /* Mul optimization */
  62         unsigned also_use_subs : 1;    /**< Use also Subs when resolving Muls to shifts */
  63         unsigned maximum_shifts;            /**< The maximum number of shifts that shall be inserted for a mul. */
  64         unsigned highest_shift_amount; /**< The highest shift amount you want to
  65                                             tolerate. Muls which would require a higher
  66                                             shift constant are left. */
  67         evaluate_costs_func evaluate;  /**< Evaluate the costs of a generated instruction. */
  68
  69         /* Div/Mod optimization */
  70         unsigned allow_mulhs   : 1;    /**< Use the Mulhs operation for division by constant */
  71         unsigned allow_mulhu   : 1;    /**< Use the Mulhu operation for division by constant */
  72         unsigned max_bits_for_mulh;         /**< Maximum number of bits the Mulh operation can take.
  73                                             Modes with higher amount of bits will use Mulh */
  74 };
  75
  76 /**
  77  * A factory function, that provides architecture parameters for
  78  * machine dependent optimizations.
  79  */
  80 typedef const ir_settings_arch_dep_t *(*arch_dep_params_factory_t)(void);
  81
  82 /**
  83  * A default parameter factory for testing purposes.
  84  */
  85 FIRM_API const ir_settings_arch_dep_t *arch_dep_default_factory(void);
  86
  87 /**
  88  * Optimization flags.
  89  */
  90 typedef enum {
  91         arch_dep_none         = 0,
  92         arch_dep_mul_to_shift = 1,  /**< optimize Mul into Shift/Add/Sub */
  93         arch_dep_div_by_const = 2,  /**< optimize Div into Shift/Add/Mulh */
  94         arch_dep_mod_by_const = 4   /**< optimize Mod into Shift/Add/Mulh */
  95 } arch_dep_opts_t;
  96
  97 /**
  98  * Initialize the machine dependent optimizations.
  99  * @param factory   A factory that delivers parameters for these
 100  *                  optimizations. If NULL is passed, or this method
 101  *                  is not called, the machine dependent optimizations
 102  *                  are not enabled at all.
 103  */
 104 FIRM_API void arch_dep_init(arch_dep_params_factory_t factory);
 105
 106 /**
 107  * Set the optimizations that shall be applied.
 108  * @param opts An optimization bit mask.
 109  */
 110 FIRM_API void arch_dep_set_opts(arch_dep_opts_t opts);
 111
 112 /**
 113  * Replace Muls with Lea/Shifts/Add/Subs if these
 114  * have smaller costs than the original multiplication.
 115  *
 116  * @param irn       The Firm node to inspect.
 117  * @return          A replacement expression for irn.
 118  */
 119 FIRM_API ir_node *arch_dep_replace_mul_with_shifts(ir_node *irn);
 120
 121 /**
 122  * Replace Divs with Shifts and Add/Subs and Mulh.
 123  * This function is driven by the 3 parameters:
 124  * - allow_mulhu
 125  * - allow_mulhs
 126  * - max_bits_for_mulh
 127  *
 128  * If irn is a Div with a Const, the constant is inspected if it meets the
 129  * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
 130  * sequence can be generated that meets these requirements, this expression
 131  * is returned. In each other case irn is returned unmodified.
 132  *
 133  * @param irn       The Firm node to inspect.
 134  * @return          A replacement expression for irn.
 135  */
 136 FIRM_API ir_node *arch_dep_replace_div_by_const(ir_node *irn);
 137
 138 /**
 139  * Replace Mods with Shifts and Add/Subs and Mulh.
 140  * This function is driven by the 3 parameters:
 141  * - allow_mulhu
 142  * - allow_mulhs
 143  * - max_bits_for_mulh
 144  *
 145  * If irn is a Mod with a Const, the constant is inspected if it meets the
 146  * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
 147  * sequence can be generated that meets these requirements, this expression
 148  * is returned. In each other case irn is returned unmodified.
 149  *
 150  * @param irn       The Firm node to inspect.
 151  * @return          A replacement expression for irn.
 152  */
 153 FIRM_API ir_node *arch_dep_replace_mod_by_const(ir_node *irn);
 154
 155 /**
 156  * Replace DivMods with Shifts and Add/Subs and Mulh.
 157  * This function is driven by the 3 parameters:
 158  * - allow_mulhu
 159  * - allow_mulhs
 160  * - max_bits_for_mulh
 161  *
 162  * If irn is a DivMod with a Const, the constant is inspected if it meets the
 163  * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
 164  * sequence can be generated that meets these requirements, this expression
 165  * is returned. In each other case irn is returned unmodified.
 166  *
 167  * @param div       After call contains the Firm node div result or NULL.
 168  * @param mod       After call contains the Firm node mod result or NULL.
 169  * @param irn       The Firm node to inspect.
 170  */
 171 FIRM_API void arch_dep_replace_divmod_by_const(ir_node **div, ir_node **mod,
 172                                                ir_node *irn);
 173
 174 #include "end.h"
 175
 176 #endif