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 mode   the mode of the instruction
  51  * @param tv     for MUL instruction, the multiplication constant
  52  *
  53  * @return the costs of this instruction
  54  */
  55 typedef int (*evaluate_costs_func)(insn_kind kind, const ir_mode *mode, ir_tarval *tv);
  56
  57 /**
  58  * A parameter structure that drives the machine dependent Firm
  59  * optimizations.
  60  */
  61 struct ir_settings_arch_dep_t {
  62         /* Mul optimization */
  63         unsigned also_use_subs : 1;    /**< Use also Subs when resolving Muls to shifts */
  64         unsigned maximum_shifts;       /**< The maximum number of shifts that shall be inserted for a mul. */
  65         unsigned highest_shift_amount; /**< The highest shift amount you want to
  66                                             tolerate. Muls which would require a higher
  67                                             shift constant are left. */
  68         evaluate_costs_func evaluate;  /**< Evaluate the costs of a generated instruction. */
  69
  70         /* Div/Mod optimization */
  71         unsigned allow_mulhs   : 1;    /**< Use the Mulhs operation for division by constant */
  72         unsigned allow_mulhu   : 1;    /**< Use the Mulhu operation for division by constant */
  73         unsigned max_bits_for_mulh;    /**< Maximum number of bits the Mulh operation can take.
  74                                             Modes with higher amount of bits will use Mulh */
  75 };
  76
  77 /**
  78  * A factory function, that provides architecture parameters for
  79  * machine dependent optimizations.
  80  */
  81 typedef const ir_settings_arch_dep_t *(*arch_dep_params_factory_t)(void);
  82
  83 /**
  84  * Optimization flags.
  85  */
  86 typedef enum {
  87         arch_dep_none         = 0,
  88         arch_dep_mul_to_shift = 1,  /**< optimize Mul into Shift/Add/Sub */
  89         arch_dep_div_by_const = 2,  /**< optimize Div into Shift/Add/Mulh */
  90         arch_dep_mod_by_const = 4   /**< optimize Mod into Shift/Add/Mulh */
  91 } arch_dep_opts_t;
  92
  93 /**
  94  * Set the optimizations that shall be applied.
  95  * @param opts An optimization bit mask.
  96  */
  97 FIRM_API void arch_dep_set_opts(arch_dep_opts_t opts);
  98
  99 /**
 100  * Replace Muls with Lea/Shifts/Add/Subs if these
 101  * have smaller costs than the original multiplication.
 102  *
 103  * @param irn       The Firm node to inspect.
 104  * @return          A replacement expression for irn.
 105  */
 106 FIRM_API ir_node *arch_dep_replace_mul_with_shifts(ir_node *irn);
 107
 108 /**
 109  * Replace Divs with Shifts and Add/Subs and Mulh.
 110  * This function is driven by the 3 parameters:
 111  * - allow_mulhu
 112  * - allow_mulhs
 113  * - max_bits_for_mulh
 114  *
 115  * If irn is a Div with a Const, the constant is inspected if it meets the
 116  * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
 117  * sequence can be generated that meets these requirements, this expression
 118  * is returned. In each other case irn is returned unmodified.
 119  *
 120  * @param irn       The Firm node to inspect.
 121  * @return          A replacement expression for irn.
 122  */
 123 FIRM_API ir_node *arch_dep_replace_div_by_const(ir_node *irn);
 124
 125 /**
 126  * Replace Mods with Shifts and Add/Subs and Mulh.
 127  * This function is driven by the 3 parameters:
 128  * - allow_mulhu
 129  * - allow_mulhs
 130  * - max_bits_for_mulh
 131  *
 132  * If irn is a Mod with a Const, the constant is inspected if it meets the
 133  * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
 134  * sequence can be generated that meets these requirements, this expression
 135  * is returned. In each other case irn is returned unmodified.
 136  *
 137  * @param irn       The Firm node to inspect.
 138  * @return          A replacement expression for irn.
 139  */
 140 FIRM_API ir_node *arch_dep_replace_mod_by_const(ir_node *irn);
 141
 142 /**
 143  * Replace DivMods with Shifts and Add/Subs and Mulh.
 144  * This function is driven by the 3 parameters:
 145  * - allow_mulhu
 146  * - allow_mulhs
 147  * - max_bits_for_mulh
 148  *
 149  * If irn is a DivMod with a Const, the constant is inspected if it meets the
 150  * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
 151  * sequence can be generated that meets these requirements, this expression
 152  * is returned. In each other case irn is returned unmodified.
 153  *
 154  * @param div       After call contains the Firm node div result or NULL.
 155  * @param mod       After call contains the Firm node mod result or NULL.
 156  * @param irn       The Firm node to inspect.
 157  */
 158 FIRM_API void arch_dep_replace_divmod_by_const(ir_node **div, ir_node **mod,
 159                                                ir_node *irn);
 160
 161 #include "end.h"
 162
 163 #endif