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

   1 /*
   2  * Copyright (C) 1995-2007 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
  32 /**
  33  * The Multiplication replacement can consist of the following instructions.
  34  */
  35 typedef enum instr {
  36         LEA,   /**< the LEA instruction */
  37         SHIFT, /**< the SHIFT instruction */
  38         SUB,   /**< the SUB instruction */
  39         ADD,   /**< the ADD instruction */
  40         MUL,   /**< the original MUL instruction */
  41         ROOT,  /**< the ROOT value that is multiplied */
  42 } insn_kind;
  43
  44 /**
  45  * A Callback for evaluating the costs of an instruction.
  46  *
  47  * @param kind   the instruction
  48  * @param tv     for MUL instruction, the multiplication constant
  49  *
  50  * @return the costs of this instruction
  51  */
  52 typedef int (*evaluate_costs_func)(insn_kind kind, tarval *tv);
  53
  54 /**
  55  * A parameter structure that drives the machine dependent Firm
  56  * optimizations.
  57  */
  58 struct ir_settings_arch_dep_t {
  59         /* Mul optimization */
  60         unsigned also_use_subs : 1;    /**< Use also Subs when resolving Muls to shifts */
  61         int maximum_shifts;            /**< The maximum number of shifts that shall be inserted for a mul. */
  62         unsigned highest_shift_amount; /**< The highest shift amount you want to
  63                                             tolerate. Muls which would require a higher
  64                                             shift constant are left. */
  65         evaluate_costs_func evaluate;  /**< Evaluate the costs of a generated instruction. */
  66
  67         /* Div/Mod optimization */
  68         unsigned allow_mulhs   : 1;    /**< Use the Mulhs operation for division by constant */
  69         unsigned allow_mulhu   : 1;    /**< Use the Mulhu operation for division by constant */
  70         int max_bits_for_mulh;         /**< Maximum number of bits the Mulh operation can take.
  71                                             Modes with higher amount of bits will use Mulh */
  72 };
  73
  74 /**
  75  * A factory function, that provides architecture parameters for
  76  * machine dependent optimizations.
  77  */
  78 typedef const ir_settings_arch_dep_t *(*arch_dep_params_factory_t)(void);
  79
  80 /**
  81  * A default parameter factory for testing purposes.
  82  */
  83 const ir_settings_arch_dep_t *arch_dep_default_factory(void);
  84
  85 /**
  86  * Optimization flags.
  87  */
  88 typedef enum {
  89         arch_dep_none         = 0,
  90         arch_dep_mul_to_shift = 1,  /**< optimize Mul into Shift/Add/Sub */
  91         arch_dep_div_by_const = 2,  /**< optimize Div into Shift/Add/Mulh */
  92         arch_dep_mod_by_const = 4   /**< optimize Mod into Shift/Add/Mulh */
  93 } arch_dep_opts_t;
  94
  95 /**
  96  * Initialize the machine dependent optimizations.
  97  * @param factory   A factory that delivers parameters for these
  98  *                  optimizations. If NULL is passed, or this method
  99  *                  is not called, the machine dependent optimizations
 100  *                  are not enabled at all.
 101  */
 102 void arch_dep_init(arch_dep_params_factory_t factory);
 103
 104 /**
 105  * Set the optimizations that shall be applied.
 106  * @param opts An optimization bit mask.
 107  */
 108 void arch_dep_set_opts(arch_dep_opts_t opts);
 109
 110 /**
 111  * Replace Muls with Shifts and Add/Subs.
 112  * This function is driven by the 3 parameters:
 113  * - also_use_subs
 114  * - maximum_shifts
 115  * - highest_shift_amount
 116  *
 117  * If irn is a Mul with a Const, the constant is inspected if it meets the
 118  * requirements of the three variables stated above. If a Shl/Add/Sub
 119  * sequence can be generated that meets these requirements, this expression
 120  * is returned. In each other case irn is returned unmodified.
 121  *
 122  * @param irn       The Firm node to inspect.
 123  * @return          A replacement expression for irn.
 124  */
 125 ir_node *arch_dep_replace_mul_with_shifts(ir_node *irn);
 126
 127 /**
 128  * Replace Divs with Shifts and Add/Subs and Mulh.
 129  * This function is driven by the 3 parameters:
 130  * - allow_mulhu
 131  * - allow_mulhs
 132  * - max_bits_for_mulh
 133  *
 134  * If irn is a Div with a Const, the constant is inspected if it meets the
 135  * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
 136  * sequence can be generated that meets these requirements, this expression
 137  * is returned. In each other case irn is returned unmodified.
 138  *
 139  * @param irn       The Firm node to inspect.
 140  * @return          A replacement expression for irn.
 141  */
 142 ir_node *arch_dep_replace_div_by_const(ir_node *irn);
 143
 144 /**
 145  * Replace Mods with Shifts and Add/Subs and Mulh.
 146  * This function is driven by the 3 parameters:
 147  * - allow_mulhu
 148  * - allow_mulhs
 149  * - max_bits_for_mulh
 150  *
 151  * If irn is a Mod with a Const, the constant is inspected if it meets the
 152  * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
 153  * sequence can be generated that meets these requirements, this expression
 154  * is returned. In each other case irn is returned unmodified.
 155  *
 156  * @param irn       The Firm node to inspect.
 157  * @return          A replacement expression for irn.
 158  */
 159 ir_node *arch_dep_replace_mod_by_const(ir_node *irn);
 160
 161 /**
 162  * Replace DivMods with Shifts and Add/Subs and Mulh.
 163  * This function is driven by the 3 parameters:
 164  * - allow_mulhu
 165  * - allow_mulhs
 166  * - max_bits_for_mulh
 167  *
 168  * If irn is a DivMod with a Const, the constant is inspected if it meets the
 169  * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
 170  * sequence can be generated that meets these requirements, this expression
 171  * is returned. In each other case irn is returned unmodified.
 172  *
 173  * @param div       After call contains the Firm node div result or NULL.
 174  * @param mod       After call contains the Firm node mod result or NULL.
 175  * @param irn       The Firm node to inspect.
 176  */
 177 void arch_dep_replace_divmod_by_const(ir_node **div, ir_node **mod, ir_node *irn);
 178
 179 #endif