db538d12cd55acff60da78a01345966feb47fd0e
[libfirm] / ir / opt / reassoc.c
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   Reassociation
23  * @author  Michael Beck
24  * @version $Id$
25  */
26 #include "config.h"
27
28 #include "iroptimize.h"
29 #include "iropt_t.h"
30 #include "irnode_t.h"
31 #include "irgraph_t.h"
32 #include "irmode_t.h"
33 #include "ircons_t.h"
34 #include "irgmod.h"
35 #include "iropt_dbg.h"
36 #include "irflag_t.h"
37 #include "irgwalk.h"
38 #include "irouts.h"
39 #include "reassoc_t.h"
40 #include "opt_init.h"
41 #include "irhooks.h"
42 #include "irloop.h"
43 #include "pdeq.h"
44 #include "debug.h"
45 #include "irpass.h"
46
47 //#define NEW_REASSOC
48
49 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
50
51 typedef struct walker_t {
52         int       changes;   /**< set, if a reassociation take place */
53         ir_graph *irg;
54         waitq    *wq;        /**< a wait queue */
55 } walker_t;
56
57 typedef enum {
58         NO_CONSTANT   = 0,    /**< node is not constant */
59         REAL_CONSTANT = 1,    /**< node is a Const that is suitable for constant folding */
60         REGION_CONST  = 4     /**< node is a constant expression in the current context,
61                                    use 4 here to simplify implementation of get_comm_Binop_ops() */
62 } const_class_t;
63
64 /**
65  * returns whether a node is constant ie is a constant or
66  * is loop invariant (called region constant)
67  *
68  * @param n     the node to be checked for constant
69  * @param block a block that might be in a loop
70  */
71 static const_class_t get_const_class(const ir_node *n, const ir_node *block)
72 {
73         if (is_Const(n))
74                 return REAL_CONSTANT;
75
76         /* constant nodes which can't be folded are region constants */
77         if (is_irn_constlike(n))
78                 return REGION_CONST;
79
80         /*
81          * Beware: Bad nodes are always loop-invariant, but
82          * cannot handled in later code, so filter them here.
83          */
84         if (! is_Bad(n) && is_loop_invariant(n, block))
85                 return REGION_CONST;
86
87         return NO_CONSTANT;
88 }  /* get_const_class */
89
90 /**
91  * returns the operands of a commutative bin-op, if one operand is
92  * a region constant, it is returned as the second one.
93  *
94  * Beware: Real constants must be returned with higher priority than
95  * region constants, because they might be folded.
96  */
97 static void get_comm_Binop_ops(ir_node *binop, ir_node **a, ir_node **c)
98 {
99         ir_node *op_a = get_binop_left(binop);
100         ir_node *op_b = get_binop_right(binop);
101         ir_node *block = get_nodes_block(binop);
102         int class_a = get_const_class(op_a, block);
103         int class_b = get_const_class(op_b, block);
104
105         assert(is_op_commutative(get_irn_op(binop)));
106
107         switch (class_a + 2*class_b) {
108         case REAL_CONSTANT + 2*REAL_CONSTANT:
109                 /* if both are constants, one might be a
110                  * pointer constant like NULL, return the other
111                  */
112                 if (mode_is_reference(get_irn_mode(op_a))) {
113                         *a = op_a;
114                         *c = op_b;
115                 } else {
116                         *a = op_b;
117                         *c = op_a;
118                 }
119                 break;
120         case REAL_CONSTANT + 2*NO_CONSTANT:
121         case REAL_CONSTANT + 2*REGION_CONST:
122         case REGION_CONST  + 2*NO_CONSTANT:
123                 *a = op_b;
124                 *c = op_a;
125                 break;
126         default:
127                 *a = op_a;
128                 *c = op_b;
129                 break;
130         }
131 }  /* get_comm_Binop_ops */
132
133 /**
134  * reassociate a Sub: x - c = x + (-c)
135  */
136 static int reassoc_Sub(ir_node **in)
137 {
138         ir_node *n = *in;
139         ir_node *right = get_Sub_right(n);
140         ir_mode *rmode = get_irn_mode(right);
141         ir_node *block;
142
143         /* cannot handle SubIs(P, P) */
144         if (mode_is_reference(rmode))
145                 return 0;
146
147         block = get_nodes_block(n);
148
149         /* handles rule R6:
150          * convert x - c => x + (-c)
151          */
152         if (get_const_class(right, block) == REAL_CONSTANT) {
153                 ir_node *left  = get_Sub_left(n);
154                 ir_mode *mode;
155                 dbg_info *dbi;
156                 ir_node *irn;
157
158                 switch (get_const_class(left, block)) {
159                 case REAL_CONSTANT:
160                         irn = optimize_in_place(n);
161                         if (irn != n) {
162                                 exchange(n, irn);
163                                 *in = irn;
164                                 return 1;
165                         }
166                         return 0;
167                 case NO_CONSTANT:
168                         break;
169                 default:
170                         /* already constant, nothing to do */
171                         return 0;
172                 }
173
174                 mode = get_irn_mode(n);
175                 dbi  = get_irn_dbg_info(n);
176
177                 /* Beware of SubP(P, Is) */
178                 irn = new_rd_Minus(dbi, block, right, rmode);
179                 irn = new_rd_Add(dbi, block, left, irn, mode);
180
181                 DBG((dbg, LEVEL_5, "Applied: %n - %n => %n + (-%n)\n",
182                         get_Sub_left(n), right, get_Sub_left(n), right));
183
184                 if (n == irn)
185                         return 0;
186
187                 exchange(n, irn);
188                 *in = irn;
189
190                 return 1;
191         }
192         return 0;
193 }  /* reassoc_Sub */
194
195 /** Retrieve a mode from the operands. We need this, because
196  * Add and Sub are allowed to operate on (P, Is)
197  */
198 static ir_mode *get_mode_from_ops(ir_node *op1, ir_node *op2)
199 {
200         ir_mode *m1, *m2;
201
202         m1 = get_irn_mode(op1);
203         if (mode_is_reference(m1))
204                 return m1;
205
206         m2 = get_irn_mode(op2);
207         if (mode_is_reference(m2))
208                 return m2;
209
210         assert(m1 == m2);
211
212         return m1;
213 }  /* get_mode_from_ops */
214
215 #ifndef NEW_REASSOC
216
217 /**
218  * reassociate a commutative Binop
219  *
220  * BEWARE: this rule leads to a potential loop, if
221  * two operands are region constants and the third is a
222  * constant, so avoid this situation.
223  */
224 static int reassoc_commutative(ir_node **node)
225 {
226         ir_node *n     = *node;
227         ir_op   *op    = get_irn_op(n);
228         ir_node *block = get_nodes_block(n);
229         ir_node *t1, *c1;
230
231         get_comm_Binop_ops(n, &t1, &c1);
232
233         if (get_irn_op(t1) == op) {
234                 ir_node *t2, *c2;
235                 const_class_t c_c1, c_c2, c_t2;
236
237                 get_comm_Binop_ops(t1, &t2, &c2);
238
239                 /* do not optimize Bad nodes, will fail later */
240                 if (is_Bad(t2))
241                         return 0;
242
243                 c_c1 = get_const_class(c1, block);
244                 c_c2 = get_const_class(c2, block);
245                 c_t2 = get_const_class(t2, block);
246
247                 if ( ((c_c1 > NO_CONSTANT) & (c_t2 > NO_CONSTANT)) &&
248                      ((((c_c1 ^ c_c2 ^ c_t2) & REGION_CONST) == 0) || ((c_c1 & c_c2 & c_t2) == REGION_CONST)) ) {
249                         /* All three are constant and either all are constant expressions
250                          * or two of them are:
251                          * then applying this rule would lead into a cycle
252                          *
253                          * Note that if t2 is a constant so is c2 hence we save one test.
254                          */
255                         return 0;
256                 }
257
258                 if ((c_c1 != NO_CONSTANT) /* & (c_c2 != NO_CONSTANT) */) {
259                         /* handles rules R7, R8, R9, R10:
260                          * convert c1 .OP. (c2 .OP. x) => x .OP. (c1 .OP. c2)
261                          */
262                         ir_node *irn, *in[2];
263                         ir_mode *mode, *mode_c1 = get_irn_mode(c1), *mode_c2 = get_irn_mode(c2);
264                         ir_graph *irg = get_irn_irg(c1);
265
266                         /* It might happen, that c1 and c2 have different modes, for
267                          * instance Is and Iu.
268                          * Handle this here.
269                          */
270                         if (mode_c1 != mode_c2) {
271                                 if (mode_is_int(mode_c1) && mode_is_int(mode_c2)) {
272                                         /* get the bigger one */
273                                         if (get_mode_size_bits(mode_c1) > get_mode_size_bits(mode_c2))
274                                                 c2 = new_r_Conv(block, c2, mode_c1);
275                                         else if (get_mode_size_bits(mode_c1) < get_mode_size_bits(mode_c2))
276                                                 c1 = new_r_Conv(block, c1, mode_c2);
277                                         else {
278                                                 /* Try to cast the real const */
279                                                 if (c_c1 == REAL_CONSTANT)
280                                                         c1 = new_r_Conv(block, c1, mode_c2);
281                                                 else
282                                                         c2 = new_r_Conv(block, c2, mode_c1);
283                                         }
284                                 }
285                         }
286
287                         in[0] = c1;
288                         in[1] = c2;
289
290                         mode  = get_mode_from_ops(in[0], in[1]);
291                         in[1] = optimize_node(new_ir_node(NULL, irg, block, op, mode, 2, in));
292                         in[0] = t2;
293
294                         mode = get_mode_from_ops(in[0], in[1]);
295                         irn   = optimize_node(new_ir_node(NULL, irg, block, op, mode, 2, in));
296
297                         DBG((dbg, LEVEL_5, "Applied: %n .%s. (%n .%s. %n) => %n .%s. (%n .%s. %n)\n",
298                              c1, get_irn_opname(n), c2, get_irn_opname(n), t2,
299                              t2, get_irn_opname(n), c1, get_irn_opname(n), c2));
300                         /*
301                          * In some rare cases it can really happen that we get the same
302                          * node back. This might be happen in dead loops, were the Phi
303                          * nodes are already gone away. So check this.
304                          */
305                         if (n != irn) {
306                                 exchange(n, irn);
307                                 *node = irn;
308                                 return 1;
309                         }
310                 }
311         }
312         if (get_irn_op(c1) == op) {
313                 ir_node *t = c1;
314                 c1 = t1;
315                 t1 = t;
316         }
317         if (get_irn_op(t1) == op) {
318                 ir_node *l = get_binop_left(t1);
319                 ir_node *r = get_binop_right(t1);
320                 const_class_t c_r;
321
322                 if (r == c1) {
323                         ir_node *t = r;
324                         r = l;
325                         l = t;
326                 }
327                 c_r = get_const_class(r, block);
328                 if (c_r != NO_CONSTANT) {
329                         /*
330                          * Beware: don't do the following op if a constant was
331                          * placed below, else we will fall into a loop.
332                          */
333                         return 0;
334                 }
335
336                 if (l == c1) {
337                         /* convert x .OP. (x .OP. y) => y .OP. (x .OP. x) */
338                         ir_mode *mode_res = get_irn_mode(n);
339                         ir_mode *mode_c1  = get_irn_mode(c1);
340                         ir_graph *irg     = get_irn_irg(c1);
341                         ir_node *irn, *in[2];
342
343                         in[0] = c1;
344                         in[1] = c1;
345
346                         in[1] = optimize_node(new_ir_node(NULL, irg, block, op, mode_c1, 2, in));
347                         in[0] = r;
348
349                         irn   = optimize_node(new_ir_node(NULL, irg, block, op, mode_res, 2, in));
350
351                         DBG((dbg, LEVEL_5, "Applied: %n .%s. (%n .%s. %n) => %n .%s. (%n .%s. %n)\n",
352                                 c1, get_irn_opname(n), l, get_irn_opname(n), r,
353                                 r, get_irn_opname(n), c1, get_irn_opname(n), c1));
354
355                         if (n != irn) {
356                                 exchange(n, irn);
357                                 *node = irn;
358                                 return 1;
359                         }
360                 }
361         }
362         return 0;
363 }  /* reassoc_commutative */
364
365 #else
366
367 static ir_op          *commutative_op;
368 static ir_node        *commutative_block;
369 static struct obstack  commutative_args;
370
371 static void collect_args(ir_node *node)
372 {
373         ir_node *left  = get_binop_left(node);
374         ir_node *right = get_binop_right(node);
375
376         if (get_irn_op(left) == commutative_op
377                         && (!get_irn_outs_computed(left) || get_irn_n_outs(left) == 1)) {
378                 collect_args(left);
379         } else {
380                 obstack_ptr_grow(&commutative_args, left);
381         }
382
383         if (get_irn_op(right) == commutative_op
384                         && (!get_irn_outs_computed(right) || get_irn_n_outs(right) == 1)) {
385                 collect_args(right);
386         } else {
387                 obstack_ptr_grow(&commutative_args, right);
388         }
389
390 #ifndef NDEBUG
391         {
392                 ir_mode *mode = get_irn_mode(node);
393                 if (is_Add(node) && mode_is_reference(mode)) {
394                         assert(get_irn_mode(left) == mode || get_irn_mode(right) == mode);
395                 } else {
396                         assert(get_irn_mode(left) == mode);
397                         assert(get_irn_mode(right) == mode);
398                 }
399         }
400 #endif
401 }
402
403 static int compare_nodes(const ir_node *node1, const ir_node *node2)
404 {
405         const_class_t class1 = get_const_class(node1, commutative_block);
406         const_class_t class2 = get_const_class(node2, commutative_block);
407
408         if (class1 == class2)
409                 return 0;
410         // return get_irn_idx(node1) - get_irn_idx(node2);
411
412         if (class1 < class2)
413                 return -1;
414
415         assert(class1 > class2);
416         return 1;
417 }
418
419 static int compare_node_ptr(const void *e1, const void *e2)
420 {
421         const ir_node *node1  = *((const ir_node *const*) e1);
422         const ir_node *node2  = *((const ir_node *const*) e2);
423         return compare_nodes(node1, node2);
424 }
425
426 static int reassoc_commutative(ir_node **n)
427 {
428         int       i;
429         int       n_args;
430         ir_node  *last;
431         ir_node **args;
432         ir_mode  *mode;
433         ir_node  *node = *n;
434
435         commutative_op    = get_irn_op(node);
436         commutative_block = get_nodes_block(node);
437
438         /* collect all nodes with same op type */
439         collect_args(node);
440
441         n_args = obstack_object_size(&commutative_args) / sizeof(ir_node*);
442         args   = obstack_finish(&commutative_args);
443
444         /* shortcut: in most cases there's nothing to do */
445         if (n_args == 2 && compare_nodes(args[0], args[1]) <= 0) {
446                 obstack_free(&commutative_args, args);
447                 return 0;
448         }
449
450         /* sort the arguments */
451         qsort(args, n_args, sizeof(ir_node*), compare_node_ptr);
452
453         /* build new tree */
454         last = args[n_args-1];
455         mode = get_irn_mode(last);
456         for (i = n_args-2; i >= 0; --i) {
457                 ir_mode *mode_right;
458                 ir_node *new_node;
459                 ir_node *in[2];
460                 ir_graph *irg = get_irn_irg(last);
461
462                 in[0] = last;
463                 in[1] = args[i];
464
465                 /* AddP violates the assumption that all modes in args are equal...
466                  * we need some hacks to cope with this */
467                 mode_right = get_irn_mode(in[1]);
468                 if (mode_is_reference(mode_right)) {
469                         assert(is_Add(node) && mode_is_reference(get_irn_mode(node)));
470                         mode = get_irn_mode(in[1]);
471                 }
472                 if (mode_right != mode) {
473                         assert(is_Add(node) && mode_is_reference(get_irn_mode(node)));
474                         in[1] = new_r_Conv(irg, commutative_block,in[1], mode);
475                 }
476
477                 /* TODO: produce useful debug info! */
478                 new_node = new_ir_node(NULL, irg, commutative_block,
479                                        commutative_op, mode, 2, in);
480                 new_node = optimize_node(new_node);
481                 last     = new_node;
482         }
483
484         /* CSE often returns the old node again, only exchange if needed */
485         if (last != node) {
486                 exchange(node, last);
487                 *n = last;
488                 return 1;
489         }
490         return 0;
491 }
492
493 #endif
494
495 #define reassoc_Add  reassoc_commutative
496 #define reassoc_And  reassoc_commutative
497 #define reassoc_Or   reassoc_commutative
498 #define reassoc_Eor  reassoc_commutative
499
500 /**
501  * Reassociate using commutative law for Mul and distributive law for Mul and Add/Sub:
502  */
503 static int reassoc_Mul(ir_node **node)
504 {
505         ir_node *n = *node;
506         ir_node *add_sub, *c;
507         ir_op *op;
508
509         if (reassoc_commutative(&n))
510                 return 1;
511
512         get_comm_Binop_ops(n, &add_sub, &c);
513         op = get_irn_op(add_sub);
514
515         /* handles rules R11, R12, R13, R14, R15, R16, R17, R18, R19, R20 */
516         if (op == op_Add || op == op_Sub) {
517                 ir_mode *mode = get_irn_mode(n);
518                 ir_node *irn, *block, *t1, *t2, *in[2];
519
520                 block = get_nodes_block(n);
521                 t1 = get_binop_left(add_sub);
522                 t2 = get_binop_right(add_sub);
523
524                 /* we can only multiplication rules on integer arithmetic */
525                 if (mode_is_int(get_irn_mode(t1)) && mode_is_int(get_irn_mode(t2))) {
526                         ir_graph *irg = get_irn_irg(t1);
527                         in[0] = new_rd_Mul(NULL, block, c, t1, mode);
528                         in[1] = new_rd_Mul(NULL, block, c, t2, mode);
529
530                         irn   = optimize_node(new_ir_node(NULL, irg, block, op, mode, 2, in));
531
532                         /* In some cases it might happen that the new irn is equal the old one, for
533                          * instance in:
534                          * (x - 1) * y == x * y - y
535                          * will be transformed back by simpler optimization
536                          * We could switch simple optimizations off, but this only happens iff y
537                          * is a loop-invariant expression and that it is not clear if the new form
538                          * is better.
539                          * So, we let the old one.
540                          */
541                         if (irn != n) {
542                                 DBG((dbg, LEVEL_5, "Applied: (%n .%s. %n) %n %n => (%n %n %n) .%s. (%n %n %n)\n",
543                                         t1, get_op_name(op), t2, n, c, t1, n, c, get_op_name(op), t2, n, c));
544                                 exchange(n, irn);
545                                 *node = irn;
546
547                                 return 1;
548                         }
549                 }
550         }
551         return 0;
552 }  /* reassoc_Mul */
553
554 /**
555  * Reassociate Shl. We transform Shl(x, const) into Mul's if possible.
556  */
557 static int reassoc_Shl(ir_node **node)
558 {
559         ir_node   *n = *node;
560         ir_node   *c = get_Shl_right(n);
561         ir_node   *x, *blk, *irn;
562         ir_graph  *irg;
563         ir_mode   *mode;
564         ir_tarval *tv;
565
566         if (! is_Const(c))
567                 return 0;
568
569         x = get_Shl_left(n);
570         mode = get_irn_mode(x);
571
572         tv = get_mode_one(mode);
573         tv = tarval_shl(tv, get_Const_tarval(c));
574
575         if (tv == tarval_bad)
576                 return 0;
577
578         blk = get_nodes_block(n);
579         irg = get_irn_irg(blk);
580         c   = new_r_Const(irg, tv);
581         irn = new_rd_Mul(get_irn_dbg_info(n), blk, x, c, mode);
582
583         if (irn != n) {
584                 exchange(n, irn);
585                 *node = irn;
586                 return 1;
587         }
588         return 0;
589 }  /* reassoc_Shl */
590
591 /**
592  * The walker for the reassociation.
593  */
594 static void wq_walker(ir_node *n, void *env)
595 {
596         walker_t *wenv = (walker_t*)env;
597
598         set_irn_link(n, NULL);
599         if (!is_Block(n)) {
600                 waitq_put(wenv->wq, n);
601                 set_irn_link(n, wenv->wq);
602         }
603 }  /* wq_walker */
604
605 /**
606  * The walker for the reassociation.
607  */
608 static void do_reassociation(walker_t *wenv)
609 {
610         int i, res, changed;
611         ir_node *n, *blk;
612
613         while (! waitq_empty(wenv->wq)) {
614                 n = (ir_node*)waitq_get(wenv->wq);
615                 set_irn_link(n, NULL);
616
617                 blk = get_nodes_block(n);
618
619                 hook_reassociate(1);
620
621                 /* reassociation must run until a fixpoint is reached. */
622                 changed = 0;
623                 do {
624                         ir_op    *op   = get_irn_op(n);
625                         ir_mode  *mode = get_irn_mode(n);
626
627                         res = 0;
628
629                         /* for FP these optimizations are only allowed if fp_strict_algebraic is disabled */
630                         if (mode_is_float(mode) && get_irg_fp_model(wenv->irg) & fp_strict_algebraic)
631                                 break;
632
633                         if (op->ops.reassociate) {
634                                 res = op->ops.reassociate(&n);
635
636                                 changed |= res;
637                         }
638                 } while (res == 1);
639                 hook_reassociate(0);
640
641                 wenv->changes |= changed;
642
643                 if (changed) {
644                         for (i = get_irn_arity(n) - 1; i >= 0; --i) {
645                                 ir_node *pred = get_irn_n(n, i);
646
647                                 if (get_irn_link(pred) != wenv->wq) {
648                                         waitq_put(wenv->wq, pred);
649                                         set_irn_link(pred, wenv->wq);
650                                 }
651                         }
652                 }
653         }
654 }  /* do_reassociation */
655
656 /**
657  * Returns the earliest were a,b are available.
658  * Note that we know that a, b both dominate
659  * the block of the previous operation, so one must dominate the other.
660  *
661  * If the earliest block is the start block, return curr_blk instead
662  */
663 static ir_node *earliest_block(ir_node *a, ir_node *b, ir_node *curr_blk)
664 {
665         ir_node *blk_a = get_nodes_block(a);
666         ir_node *blk_b = get_nodes_block(b);
667         ir_node *res;
668
669         /* if blk_a != blk_b, one must dominate the other */
670         if (block_dominates(blk_a, blk_b))
671                 res = blk_b;
672         else
673                 res = blk_a;
674         if (res == get_irg_start_block(get_irn_irg(curr_blk)))
675                 return curr_blk;
676         return res;
677 }  /* earliest_block */
678
679 /**
680  * Checks whether a node is a Constant expression.
681  * The following trees are constant expressions:
682  *
683  * Const, SymConst, Const + SymConst
684  *
685  * Handling SymConsts as const might be not a good idea for all
686  * architectures ...
687  */
688 static int is_constant_expr(ir_node *irn)
689 {
690         ir_op *op;
691
692         switch (get_irn_opcode(irn)) {
693         case iro_Const:
694         case iro_SymConst:
695                 return 1;
696         case iro_Add:
697                 op = get_irn_op(get_Add_left(irn));
698                 if (op != op_Const && op != op_SymConst)
699                         return 0;
700                 op = get_irn_op(get_Add_right(irn));
701                 if (op != op_Const && op != op_SymConst)
702                         return 0;
703                 return 1;
704         default:
705                 return 0;
706         }
707 }  /* is_constant_expr */
708
709 /**
710  * Apply distributive Law for Mul and Add/Sub
711  */
712 static int reverse_rule_distributive(ir_node **node)
713 {
714         ir_node *n = *node;
715         ir_node *left  = get_binop_left(n);
716         ir_node *right = get_binop_right(n);
717         ir_node *x, *blk, *curr_blk;
718         ir_node *a, *b, *irn;
719         ir_op *op;
720         ir_mode *mode;
721         dbg_info *dbg;
722
723         op = get_irn_op(left);
724         if (op != get_irn_op(right))
725                 return 0;
726
727         if (op == op_Shl) {
728                 x = get_Shl_right(left);
729
730                 if (x == get_Shl_right(right)) {
731                         /* (a << x) +/- (b << x) ==> (a +/- b) << x */
732                         a = get_Shl_left(left);
733                         b = get_Shl_left(right);
734                         goto transform;
735                 }
736         } else if (op == op_Mul) {
737                 x = get_Mul_left(left);
738
739                 if (x == get_Mul_left(right)) {
740                         /* (x * a) +/- (x * b) ==> (a +/- b) * x */
741                         a = get_Mul_right(left);
742                         b = get_Mul_right(right);
743                         goto transform;
744                 } else if (x == get_Mul_right(right)) {
745                         /* (x * a) +/- (b * x) ==> (a +/- b) * x */
746                         a = get_Mul_right(left);
747                         b = get_Mul_left(right);
748                         goto transform;
749                 }
750
751                 x = get_Mul_right(left);
752
753                 if (x == get_Mul_right(right)) {
754                         /* (a * x) +/- (b * x) ==> (a +/- b) * x */
755                         a = get_Mul_left(left);
756                         b = get_Mul_left(right);
757                         goto transform;
758                 } else if (x == get_Mul_left(right)) {
759                         /* (a * x) +/- (x * b) ==> (a +/- b) * x */
760                         a = get_Mul_left(left);
761                         b = get_Mul_right(right);
762                         goto transform;
763                 }
764         }
765         return 0;
766
767 transform:
768         curr_blk = get_nodes_block(n);
769
770         blk = earliest_block(a, b, curr_blk);
771
772         dbg  = get_irn_dbg_info(n);
773         mode = get_irn_mode(n);
774
775         if (is_Add(n))
776                 irn = new_rd_Add(dbg, blk, a, b, mode);
777         else
778                 irn = new_rd_Sub(dbg, blk, a, b, mode);
779
780         blk  = earliest_block(irn, x, curr_blk);
781
782         if (op == op_Mul)
783                 irn = new_rd_Mul(dbg, blk, irn, x, mode);
784         else
785                 irn = new_rd_Shl(dbg, blk, irn, x, mode);
786
787         exchange(n, irn);
788         *node = irn;
789         return 1;
790 }  /* reverse_rule_distributive */
791
792 /**
793  * Move Constants towards the root.
794  */
795 static int move_consts_up(ir_node **node)
796 {
797         ir_node *n = *node;
798         ir_op *op;
799         ir_node *l, *r, *a, *b, *c, *blk, *irn, *in[2];
800         ir_mode *mode, *ma, *mb;
801         dbg_info *dbg;
802         ir_graph *irg;
803
804         l = get_binop_left(n);
805         r = get_binop_right(n);
806
807         /* check if one is already a constant expression */
808         if (is_constant_expr(l) || is_constant_expr(r))
809                 return 0;
810
811         dbg = get_irn_dbg_info(n);
812         op = get_irn_op(n);
813         if (get_irn_op(l) == op) {
814                 /* (a .op. b) .op. r */
815                 a = get_binop_left(l);
816                 b = get_binop_right(l);
817
818                 if (is_constant_expr(a)) {
819                         /* (C .op. b) .op. r ==> (r .op. b) .op. C */
820                         c = a;
821                         a = r;
822                         blk = get_nodes_block(l);
823                         dbg = dbg == get_irn_dbg_info(l) ? dbg : NULL;
824                         goto transform;
825                 } else if (is_constant_expr(b)) {
826                         /* (a .op. C) .op. r ==> (a .op. r) .op. C */
827                         c = b;
828                         b = r;
829                         blk = get_nodes_block(l);
830                         dbg = dbg == get_irn_dbg_info(l) ? dbg : NULL;
831                         goto transform;
832                 }
833         }
834         if (get_irn_op(r) == op) {
835                 /* l .op. (a .op. b) */
836                 a = get_binop_left(r);
837                 b = get_binop_right(r);
838
839                 if (is_constant_expr(a)) {
840                         /* l .op. (C .op. b) ==> (l .op. b) .op. C */
841                         c = a;
842                         a = l;
843                         blk = get_nodes_block(r);
844                         dbg = dbg == get_irn_dbg_info(r) ? dbg : NULL;
845                         goto transform;
846                 } else if (is_constant_expr(b)) {
847                         /* l .op. (a .op. C) ==> (a .op. l) .op. C */
848                         c = b;
849                         b = l;
850                         blk = get_nodes_block(r);
851                         dbg = dbg == get_irn_dbg_info(r) ? dbg : NULL;
852                         goto transform;
853                 }
854         }
855         return 0;
856
857 transform:
858         /* In some cases a and b might be both of different integer mode, and c a SymConst.
859          * in that case we could either
860          * 1.) cast into unsigned mode
861          * 2.) ignore
862          * we implement the second here
863          */
864         ma = get_irn_mode(a);
865         mb = get_irn_mode(b);
866         if (ma != mb && mode_is_int(ma) && mode_is_int(mb))
867                 return 0;
868
869         /* check if (a .op. b) can be calculated in the same block is the old instruction */
870         if (! block_dominates(get_nodes_block(a), blk))
871                 return 0;
872         if (! block_dominates(get_nodes_block(b), blk))
873                 return 0;
874         /* ok */
875         in[0] = a;
876         in[1] = b;
877
878         mode = get_mode_from_ops(a, b);
879         irg  = get_irn_irg(blk);
880         in[0] = irn = optimize_node(new_ir_node(dbg, irg, blk, op, mode, 2, in));
881
882         /* beware: optimize_node might have changed the opcode, check again */
883         if (is_Add(irn) || is_Sub(irn)) {
884                 reverse_rule_distributive(&in[0]);
885         }
886         in[1] = c;
887
888         mode = get_mode_from_ops(in[0], in[1]);
889         irn = optimize_node(new_ir_node(dbg, irg, blk, op, mode, 2, in));
890
891         exchange(n, irn);
892         *node = irn;
893         return 1;
894 }  /* move_consts_up */
895
896 /**
897  * Apply the rules in reverse order, removing code that was not collapsed
898  */
899 static void reverse_rules(ir_node *node, void *env)
900 {
901         walker_t *wenv = (walker_t*)env;
902         ir_graph *irg  = get_irn_irg(node);
903         ir_mode  *mode = get_irn_mode(node);
904         int res;
905
906         /* for FP these optimizations are only allowed if fp_strict_algebraic is disabled */
907         if (mode_is_float(mode) && get_irg_fp_model(irg) & fp_strict_algebraic)
908                 return;
909
910         do {
911                 ir_op *op = get_irn_op(node);
912
913                 res = 0;
914                 if (is_op_commutative(op)) {
915                         wenv->changes |= res = move_consts_up(&node);
916                 }
917                 /* beware: move_consts_up might have changed the opcode, check again */
918                 if (is_Add(node) || is_Sub(node)) {
919                         wenv->changes |= res = reverse_rule_distributive(&node);
920                 }
921         } while (res);
922 }
923
924 /*
925  * do the reassociation
926  */
927 int optimize_reassociation(ir_graph *irg)
928 {
929         walker_t env;
930         irg_loopinfo_state state;
931
932         assert(get_irg_phase_state(irg) != phase_building);
933         assert(get_irg_pinned(irg) != op_pin_state_floats &&
934                 "Reassociation needs pinned graph to work properly");
935
936         /* we use dominance to detect dead blocks */
937         assure_doms(irg);
938
939 #ifdef NEW_REASSOC
940         assure_irg_outs(irg);
941         obstack_init(&commutative_args);
942 #endif
943
944         /*
945          * Calculate loop info, so we could identify loop-invariant
946          * code and threat it like a constant.
947          * We only need control flow loops here but can handle generic
948          * INTRA info as well.
949          */
950         state = get_irg_loopinfo_state(irg);
951         if ((state & loopinfo_inter) ||
952                 (state & (loopinfo_constructed | loopinfo_valid)) != (loopinfo_constructed | loopinfo_valid))
953                 construct_cf_backedges(irg);
954
955         env.changes = 0;
956         env.irg     = irg;
957         env.wq      = new_waitq();
958
959         /* disable some optimizations while reassoc is running to prevent endless loops */
960         set_reassoc_running(1);
961         {
962                 /* now we have collected enough information, optimize */
963                 irg_walk_graph(irg, NULL, wq_walker, &env);
964                 do_reassociation(&env);
965
966                 /* reverse those rules that do not result in collapsed constants */
967                 irg_walk_graph(irg, NULL, reverse_rules, &env);
968         }
969         set_reassoc_running(0);
970
971 #ifdef NEW_REASSOC
972         obstack_free(&commutative_args, NULL);
973 #endif
974
975         del_waitq(env.wq);
976         return env.changes;
977 }  /* optimize_reassociation */
978
979 /* create a pass for the reassociation */
980 ir_graph_pass_t *optimize_reassociation_pass(const char *name)
981 {
982         return def_graph_pass_ret(name ? name : "reassoc", optimize_reassociation);
983 }  /* optimize_reassociation_pass */
984
985 /* Sets the default reassociation operation for an ir_op_ops. */
986 ir_op_ops *firm_set_default_reassoc(unsigned code, ir_op_ops *ops)
987 {
988 #define CASE(a) case iro_##a: ops->reassociate  = reassoc_##a; break
989
990         switch (code) {
991         CASE(Mul);
992         CASE(Add);
993         CASE(Sub);
994         CASE(And);
995         CASE(Or);
996         CASE(Eor);
997         CASE(Shl);
998         default:
999                 /* leave NULL */;
1000         }
1001
1002         return ops;
1003 #undef CASE
1004 }  /* firm_set_default_reassoc */
1005
1006 /* initialize the reassociation by adding operations to some opcodes */
1007 void firm_init_reassociation(void)
1008 {
1009         FIRM_DBG_REGISTER(dbg, "firm.opt.reassoc");
1010 }  /* firm_init_reassociation */