irarch.h 6.15 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

20
/**
Matthias Braun's avatar
Matthias Braun committed
21
22
23
 * @file
 * @brief  Some machine dependent optimizations.
 * @date   1.10.2004
24
 * @author Sebastian Hack
Matthias Braun's avatar
Matthias Braun committed
25
 * @version $Id$
26
 */
Matthias Braun's avatar
Matthias Braun committed
27
28
#ifndef FIRM_IR_IRARCH_H
#define FIRM_IR_IRARCH_H
29

30
#include "firm_types.h"
31

32
33
34
35
36
37
38
39
/**
 * The Multiplication replacement can consist of the following instructions.
 */
typedef enum instr {
	LEA,   /**< the LEA instruction */
	SHIFT, /**< the SHIFT instruction */
	SUB,   /**< the SUB instruction */
	ADD,   /**< the ADD instruction */
Michael Beck's avatar
Michael Beck committed
40
	ZERO,  /**< creates a ZERO constant */
41
42
43
44
45
46
47
48
49
50
51
52
53
54
	MUL,   /**< the original MUL instruction */
	ROOT,  /**< the ROOT value that is multiplied */
} insn_kind;

/**
 * A Callback for evaluating the costs of an instruction.
 *
 * @param kind   the instruction
 * @param tv     for MUL instruction, the multiplication constant
 *
 * @return the costs of this instruction
 */
typedef int (*evaluate_costs_func)(insn_kind kind, tarval *tv);

55
56
57
58
/**
 * A parameter structure that drives the machine dependent Firm
 * optimizations.
 */
59
60
61
62
63
64
65
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 highest_shift_amount; /**< The highest shift amount you want to
	                                    tolerate. Muls which would require a higher
	                                    shift constant are left. */
66
	evaluate_costs_func evaluate;  /**< Evaluate the costs of a generated instruction. */
67

68
69
70
71
72
73
	/* 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.
	                                    Modes with higher amount of bits will use Mulh */
};
74
75
76
77
78

/**
 * A factory function, that provides architecture parameters for
 * machine dependent optimizations.
 */
79
typedef const ir_settings_arch_dep_t *(*arch_dep_params_factory_t)(void);
80
81
82
83

/**
 * A default parameter factory for testing purposes.
 */
84
const ir_settings_arch_dep_t *arch_dep_default_factory(void);
85
86
87
88
89

/**
 * Optimization flags.
 */
typedef enum {
90
91
92
93
	arch_dep_none         = 0,
	arch_dep_mul_to_shift = 1,  /**< optimize Mul into Shift/Add/Sub */
	arch_dep_div_by_const = 2,  /**< optimize Div into Shift/Add/Mulh */
	arch_dep_mod_by_const = 4   /**< optimize Mod into Shift/Add/Mulh */
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
} arch_dep_opts_t;

/**
 * Initialize the machine dependent optimizations.
 * @param factory   A factory that delivers parameters for these
 *                  optimizations. If NULL is passed, or this method
 *                  is not called, the machine dependent optimizations
 *                  are not enabled at all.
 */
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);

/**
 * Replace Muls with Shifts and Add/Subs.
 * This function is driven by the 3 parameters:
 * - also_use_subs
 * - maximum_shifts
 * - highest_shift_amount
 *
118
 * If irn is a Mul with a Const, the constant is inspected if it meets the
119
 * requirements of the three variables stated above. If a Shl/Add/Sub
120
121
 * sequence can be generated that meets these requirements, this expression
 * is returned. In each other case irn is returned unmodified.
122
123
124
125
126
127
 *
 * @param irn       The Firm node to inspect.
 * @return          A replacement expression for irn.
 */
ir_node *arch_dep_replace_mul_with_shifts(ir_node *irn);

Michael Beck's avatar
Michael Beck committed
128
/**
129
 * Replace Divs with Shifts and Add/Subs and Mulh.
Michael Beck's avatar
Michael Beck committed
130
 * This function is driven by the 3 parameters:
131
132
 * - allow_mulhu
 * - allow_mulhs
133
 * - max_bits_for_mulh
Michael Beck's avatar
Michael Beck committed
134
 *
135
 * If irn is a Div with a Const, the constant is inspected if it meets the
136
 * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
137
138
 * sequence can be generated that meets these requirements, this expression
 * is returned. In each other case irn is returned unmodified.
Michael Beck's avatar
Michael Beck committed
139
140
141
142
 *
 * @param irn       The Firm node to inspect.
 * @return          A replacement expression for irn.
 */
143
ir_node *arch_dep_replace_div_by_const(ir_node *irn);
Michael Beck's avatar
Michael Beck committed
144

Michael Beck's avatar
Michael Beck committed
145
/**
146
 * Replace Mods with Shifts and Add/Subs and Mulh.
Michael Beck's avatar
Michael Beck committed
147
 * This function is driven by the 3 parameters:
148
149
 * - allow_mulhu
 * - allow_mulhs
150
 * - max_bits_for_mulh
Michael Beck's avatar
Michael Beck committed
151
 *
152
 * If irn is a Mod with a Const, the constant is inspected if it meets the
153
 * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
154
155
 * sequence can be generated that meets these requirements, this expression
 * is returned. In each other case irn is returned unmodified.
Michael Beck's avatar
Michael Beck committed
156
157
158
159
 *
 * @param irn       The Firm node to inspect.
 * @return          A replacement expression for irn.
 */
160
ir_node *arch_dep_replace_mod_by_const(ir_node *irn);
Michael Beck's avatar
Michael Beck committed
161
162

/**
163
 * Replace DivMods with Shifts and Add/Subs and Mulh.
Michael Beck's avatar
Michael Beck committed
164
 * This function is driven by the 3 parameters:
165
166
 * - allow_mulhu
 * - allow_mulhs
167
 * - max_bits_for_mulh
Michael Beck's avatar
Michael Beck committed
168
 *
169
 * If irn is a DivMod with a Const, the constant is inspected if it meets the
170
 * requirements of the variables stated above. If a Shl/Add/Sub/Mulh
171
172
 * sequence can be generated that meets these requirements, this expression
 * is returned. In each other case irn is returned unmodified.
Michael Beck's avatar
Michael Beck committed
173
174
175
176
177
 *
 * @param div       After call contains the Firm node div result or NULL.
 * @param mod       After call contains the Firm node mod result or NULL.
 * @param irn       The Firm node to inspect.
 */
178
void arch_dep_replace_divmod_by_const(ir_node **div, ir_node **mod, ir_node *irn);
Michael Beck's avatar
Michael Beck committed
179

Matthias Braun's avatar
Matthias Braun committed
180
#endif