Reassoiation optimization added
[libfirm] / ir / opt / reassoc.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/opt/reassoc.c
4  * Purpose:     Reassociation
5  * Author:      Michael Beck
6  * Created:
7  * CVS-ID:      $Id$
8  * Copyright:   (c) 1998-2004 Universität Karlsruhe
9  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
10  */
11
12 #ifdef HAVE_CONFIG_H
13 # include <config.h>
14 #endif
15
16 # include "irnode_t.h"
17 # include "irgraph_t.h"
18 # include "irmode_t.h"
19 # include "iropt_t.h"
20 # include "ircons_t.h"
21 # include "irgmod.h"
22 # include "dbginfo.h"
23 # include "iropt_dbg.h"
24 # include "irflag_t.h"
25 # include "irgwalk.h"
26 # include "reassoc_t.h"
27 # include "firmstat.h"
28
29 typedef struct _walker_t {
30   int changes;          /* set, if a reassociation take place */
31 } walker_t;
32
33 typedef enum {
34   NO_CONSTANT   = 0,    /**< node is not constant */
35   REAL_CONSTANT = 1,    /**< node is a constnt that is suitable for constant folding */
36   CONST_EXPR    = 4     /**< node is not constnt expression in the current context,
37                              use 4 here to simplify implementation of get_comm_Binop_ops() */
38 } const_class_t;
39
40 /**
41  * returns wheater a node is constant, ie is a constant or
42  * is loop invariant
43  */
44 static const_class_t get_const_class(ir_node *n)
45 {
46   ir_op *op = get_irn_op(n);
47
48   if (op == op_Const)
49     return REAL_CONSTANT;
50   if (op == op_SymConst)
51     return CONST_EXPR;
52
53   return NO_CONSTANT;
54 }
55
56 /**
57  * returns the operands of a commutative bin-op, if one operand is
58  * a constant in the current context, it is returned as the second one.
59  *
60  * Beware: Real constrants must be returned with higher priority than
61  * constnt expression, because they might be folded.
62  */
63 static void get_comm_Binop_ops(ir_node *binop, ir_node **a, ir_node **c)
64 {
65   ir_node *op_a = get_binop_left(binop);
66   ir_node *op_b = get_binop_right(binop);
67   int class_a = get_const_class(op_a);
68   int class_b = get_const_class(op_b);
69
70   assert(is_op_commutative(get_irn_op(binop)));
71
72   switch (class_a + 2*class_b) {
73     case REAL_CONSTANT + 2*NO_CONSTANT:
74     case REAL_CONSTANT + 2*REAL_CONSTANT:
75     case REAL_CONSTANT + 2*CONST_EXPR:
76     case CONST_EXPR    + 2*NO_CONSTANT:
77       *a = op_b;
78       *c = op_a;
79       break;
80     default:
81       *a = op_a;
82       *c = op_b;
83       break;
84   }
85 }
86
87 /**
88  * reassociate a Sub: x - c = (-c) + x
89  */
90 static int reassoc_Sub(ir_node *n)
91 {
92   ir_node *right = get_Sub_right(n);
93
94   /* handles rule R6:
95    * convert x - c => (-c) + x
96    *
97    * As there is NO real Minus in Firm it makes no sense to do this
98    * for non-real constants yet.
99    * */
100   if (get_const_class(right) == REAL_CONSTANT) {
101     ir_node *block = get_nodes_block(right);
102     ir_mode *mode  = get_irn_mode(right);
103     dbg_info *dbg  = get_irn_dbg_info(right);
104     ir_node *irn, *c;
105
106     c   = new_r_Const(current_ir_graph, block, mode, get_mode_null(mode));
107     irn = new_rd_Sub(dbg, current_ir_graph, block, c, right, mode);
108
109     irn = new_rd_Add(dbg, current_ir_graph, block, irn, get_Sub_left(n), get_irn_mode(n));
110
111     printf("Applied: %s - %s => (-%s) + %s\n",
112         get_irn_opname(get_Sub_left(n)), get_irn_opname(c),
113         get_irn_opname(c), get_irn_opname(get_Sub_left(n)) );
114
115     exchange(n, irn);
116
117     return 1;
118   }
119   return 0;
120 }
121
122 /** Retrieve a mode form the operands. We need this, because
123  * Add and Sub are allowed to operate on (P, Is)
124  */
125 static ir_mode *get_mode_from_ops(ir_node *op1, ir_node *op2)
126 {
127   ir_mode *m1, *m2;
128
129   m1 = get_irn_mode(op1);
130   if (mode_is_reference(m1))
131     return m1;
132
133   m2 = get_irn_mode(op2);
134   if (mode_is_reference(m2))
135     return m2;
136
137   assert(m1 == m2);
138
139   return m1;
140 }
141
142 /**
143  * reassociate a commutative Binop
144  *
145  * BEWARE: this rule leads to a potential loop, if
146  * all two operands are are constant expressions and the third is a
147  * constant, so avoid this situation.
148  */
149 static int reassoc_commutative(ir_node *n)
150 {
151   ir_op *op      = get_irn_op(n);
152   ir_node *block = get_nodes_block(n);
153   ir_node *t1, *c1;
154
155   get_comm_Binop_ops(n, &t1, &c1);
156
157   if (get_irn_op(t1) == op) {
158     ir_node *t2, *c2;
159     const_class_t c_c1, c_c2, c_t2;
160
161     get_comm_Binop_ops(t1, &t2, &c2);
162
163     c_c1 = get_const_class(c1);
164     c_c2 = get_const_class(c2);
165     c_t2 = get_const_class(t2);
166
167     if ( ((c_c1 > NO_CONSTANT) & (c_t2 > NO_CONSTANT)) &&
168          ((((c_c1 ^ c_c2 ^ c_t2) & CONST_EXPR) == 0) || ((c_c1 & c_c2 & c_t2) == CONST_EXPR)) ) {
169       /* all three are constant and either all are constant expressions or two of them are:
170        * then, applying this rule would lead into a cycle
171        *
172        * Note that if t2 is a onstant so is c2, so we save one test.
173        */
174       return 0;
175     }
176
177     if ((c_c1 != NO_CONSTANT) & (c_c2 != NO_CONSTANT)) {
178       /* handles rules R7, R8, R9, R10:
179        * convert c1 .OP. (c2 .OP. x) => (c1 .OP. c2) .OP. x
180        */
181       ir_node *irn, *in[2];
182       ir_mode *mode;
183
184       in[0] = c1;
185       in[1] = c2;
186
187       mode = get_mode_from_ops(in[0], in[1]);
188       in[0] = optimize_node(new_ir_node(NULL, current_ir_graph, block, op, mode, 2, in));
189       in[1] = t2;
190
191       mode = get_mode_from_ops(in[0], in[1]);
192       irn   = optimize_node(new_ir_node(NULL, current_ir_graph, block, op, mode, 2, in));
193
194       printf("Applied: %s .%s. (%s .%s. %s) => (%s .%s. %s) .%s. %s\n",
195           get_irn_opname(c1), get_irn_opname(n), get_irn_opname(c2), get_irn_opname(n), get_irn_opname(t2),
196           get_irn_opname(c1), get_irn_opname(n), get_irn_opname(c2), get_irn_opname(n), get_irn_opname(t2));
197
198       exchange(n, irn);
199
200       return 1;
201     }
202   }
203   return 0;
204 }
205
206 #define reassoc_Add  reassoc_commutative
207
208 /**
209  * reassociate using distibutive law for Mul and Add/Sub
210  */
211 static int reassoc_Mul(ir_node *n)
212 {
213   ir_node *add_sub, *c;
214   ir_op *op;
215
216   if (reassoc_commutative(n))
217     return 1;
218
219   get_comm_Binop_ops(n, &add_sub, &c);
220   op = get_irn_op(add_sub);
221
222   /* handles rules R11, R12, R13, R14, R15, R16, R17, R18, R19, R20 */
223   if (op == op_Add || op == op_Sub) {
224     ir_mode *mode = get_irn_mode(n);
225     ir_node *irn, *block, *t1, *t2, *in[2];
226
227     block = get_nodes_block(n);
228     t1 = get_binop_left(add_sub);
229     t2 = get_binop_right(add_sub);
230
231     in[0] = new_rd_Mul(NULL, current_ir_graph, block, c, t1, mode);
232     in[1] = new_rd_Mul(NULL, current_ir_graph, block, c, t2, mode);
233
234     mode  = get_mode_from_ops(in[0], in[1]);
235     irn   = optimize_node(new_ir_node(NULL, current_ir_graph, block, op, mode, 2, in));
236
237     printf("Applied: (%s .%s. %s) %s %s => (%s %s %s) .%s. (%s %s %s)\n",
238         get_irn_opname(t1), get_op_name(op), get_irn_opname(t2), get_irn_opname(n), get_irn_opname(c),
239         get_irn_opname(t1), get_irn_opname(n), get_irn_opname(c),
240         get_op_name(op),
241         get_irn_opname(t2), get_irn_opname(n), get_irn_opname(c));
242
243     exchange(n, irn);
244
245     return 1;
246   }
247   return 0;
248 }
249
250 /**
251  * The walker for the reassociation
252  */
253 static void do_reassociation(ir_node *n, void *env)
254 {
255   walker_t *wenv = env;
256   int res;
257
258   /* reassociation must run until fixpoint */
259   do {
260     ir_op   *op    = get_irn_op(n);
261     ir_mode *mode  = get_irn_mode(n);
262
263     res = 0;
264
265     /* reassociation works only for integer or reference modes */
266     if (op->reassociate && (mode_is_int(mode) || mode_is_reference(mode))) {
267       res = op->reassociate(n);
268       if (res) {
269         wenv->changes = 1;
270
271         /* we need a skip here, or we will see an Id in the next iteration */
272         n = skip_Id(n);
273       }
274     }
275   } while (res == 1);
276 }
277
278 /*
279  * do the reassociation
280  */
281 void optimize_reassociation(ir_graph *irg)
282 {
283   walker_t env;
284
285   assert(get_irg_phase_state(irg) != phase_building);
286
287   /* reassociation needs constant folding */
288   if (!get_opt_reassociation() || !get_opt_constant_folding())
289     return;
290
291   env.changes = 0;
292
293   irg_walk_graph(irg, NULL, do_reassociation, &env);
294
295   /* now we have collected enough information, optimize */
296   irg_walk_graph(irg, NULL, do_reassociation, &env);
297
298   /* Handle graph state */
299   if (env.changes) {
300     if (get_irg_outs_state(current_ir_graph) == outs_consistent)
301       set_irg_outs_inconsistent(current_ir_graph);
302   }
303 }
304
305 /* initialise the reassociation by adding operations to some opcodes */
306 void firm_init_reassociation(void)
307 {
308 #define INIT(a) op_##a->reassociate  = reassoc_##a;
309   INIT(Mul);
310   INIT(Add);
311   INIT(Sub);
312 #undef CASE
313 }