2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Some machine dependent optimizations.
24 * @author Sebastian Hack
27 #ifndef FIRM_IR_IRARCH_H
28 #define FIRM_IR_IRARCH_H
30 #include "firm_types.h"
34 * The Multiplication replacement can consist of the following instructions.
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 */
47 * A Callback for evaluating the costs of an instruction.
49 * @param kind the instruction
50 * @param tv for MUL instruction, the multiplication constant
52 * @return the costs of this instruction
54 typedef int (*evaluate_costs_func)(insn_kind kind, tarval *tv);
57 * A parameter structure that drives the machine dependent Firm
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. */
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 */
77 * A factory function, that provides architecture parameters for
78 * machine dependent optimizations.
80 typedef const ir_settings_arch_dep_t *(*arch_dep_params_factory_t)(void);
87 arch_dep_mul_to_shift = 1, /**< optimize Mul into Shift/Add/Sub */
88 arch_dep_div_by_const = 2, /**< optimize Div into Shift/Add/Mulh */
89 arch_dep_mod_by_const = 4 /**< optimize Mod into Shift/Add/Mulh */
93 * Set the optimizations that shall be applied.
94 * @param opts An optimization bit mask.
96 FIRM_API void arch_dep_set_opts(arch_dep_opts_t opts);
99 * Replace Muls with Lea/Shifts/Add/Subs if these
100 * have smaller costs than the original multiplication.
102 * @param irn The Firm node to inspect.
103 * @return A replacement expression for irn.
105 FIRM_API ir_node *arch_dep_replace_mul_with_shifts(ir_node *irn);
108 * Replace Divs with Shifts and Add/Subs and Mulh.
109 * This function is driven by the 3 parameters:
112 * - max_bits_for_mulh
114 * If irn is a Div with a Const, the constant is inspected if it meets the
115 * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
116 * sequence can be generated that meets these requirements, this expression
117 * is returned. In each other case irn is returned unmodified.
119 * @param irn The Firm node to inspect.
120 * @return A replacement expression for irn.
122 FIRM_API ir_node *arch_dep_replace_div_by_const(ir_node *irn);
125 * Replace Mods with Shifts and Add/Subs and Mulh.
126 * This function is driven by the 3 parameters:
129 * - max_bits_for_mulh
131 * If irn is a Mod with a Const, the constant is inspected if it meets the
132 * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
133 * sequence can be generated that meets these requirements, this expression
134 * is returned. In each other case irn is returned unmodified.
136 * @param irn The Firm node to inspect.
137 * @return A replacement expression for irn.
139 FIRM_API ir_node *arch_dep_replace_mod_by_const(ir_node *irn);
142 * Replace DivMods with Shifts and Add/Subs and Mulh.
143 * This function is driven by the 3 parameters:
146 * - max_bits_for_mulh
148 * If irn is a DivMod with a Const, the constant is inspected if it meets the
149 * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
150 * sequence can be generated that meets these requirements, this expression
151 * is returned. In each other case irn is returned unmodified.
153 * @param div After call contains the Firm node div result or NULL.
154 * @param mod After call contains the Firm node mod result or NULL.
155 * @param irn The Firm node to inspect.
157 FIRM_API void arch_dep_replace_divmod_by_const(ir_node **div, ir_node **mod,