nsz Git - libfirm/blob - 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 "irhooks.h"
  28 # include "irloop.h"
  29 # include "debug.h"
  30
  31 static firm_dbg_module_t *dbg;
  32
  33 typedef struct _walker_t {
  34   int changes;          /* set, if a reassociation take place */
  35 } walker_t;
  36
  37 typedef enum {
  38   NO_CONSTANT   = 0,    /**< node is not constant */
  39   REAL_CONSTANT = 1,    /**< node is a Const that is suitable for constant folding */
  40   CONST_EXPR    = 4     /**< node is a constant expression in the current context,
  41                              use 4 here to simplify implementation of get_comm_Binop_ops() */
  42 } const_class_t;
  43
  44 /**
  45  * returns whether a node is constant ie is a constant or
  46  * is loop invariant
  47  *
  48  * @param n     the node to be checked for constant
  49  * @param block a block that might be in a loop
  50  */
  51 static const_class_t get_const_class(ir_node *n, ir_node *block)
  52 {
  53   ir_op *op = get_irn_op(n);
  54
  55   if (op == op_Const)
  56     return REAL_CONSTANT;
  57   if (op == op_SymConst)
  58     return CONST_EXPR;
  59   /*
  60    * Beware: Bad nodes are always loop-invariant, but
  61    * cannot handles in later code, so filter them here
  62    */
  63   if (! is_Bad(n) && is_loop_invariant(n, block))
  64     return CONST_EXPR;
  65
  66   return NO_CONSTANT;
  67 }
  68
  69 /**
  70  * returns the operands of a commutative bin-op, if one operand is
  71  * a constant in the current context, it is returned as the second one.
  72  *
  73  * Beware: Real constants must be returned with higher priority than
  74  * constant expression, because they might be folded.
  75  */
  76 static void get_comm_Binop_ops(ir_node *binop, ir_node **a, ir_node **c)
  77 {
  78   ir_node *op_a = get_binop_left(binop);
  79   ir_node *op_b = get_binop_right(binop);
  80   ir_node *block = get_nodes_block(binop);
  81   int class_a = get_const_class(op_a, block);
  82   int class_b = get_const_class(op_b, block);
  83
  84   assert(is_op_commutative(get_irn_op(binop)));
  85
  86   switch (class_a + 2*class_b) {
  87     case REAL_CONSTANT + 2*NO_CONSTANT:
  88     case REAL_CONSTANT + 2*REAL_CONSTANT:
  89     case REAL_CONSTANT + 2*CONST_EXPR:
  90     case CONST_EXPR    + 2*NO_CONSTANT:
  91       *a = op_b;
  92       *c = op_a;
  93       break;
  94     default:
  95       *a = op_a;
  96       *c = op_b;
  97       break;
  98   }
  99 }
 100
 101 /**
 102  * reassociate a Sub: x - c = (-c) + x
 103  */
 104 static int reassoc_Sub(ir_node **in)
 105 {
 106   ir_node *n = *in;
 107   ir_node *block = get_nodes_block(n);
 108   ir_node *right = get_Sub_right(n);
 109
 110   /* FIXME: Do not apply this rule for unsigned Sub's because our code
 111    * generation is currently buggy :-)
 112    */
 113   if (! mode_is_signed(get_irn_mode(n)))
 114       return 0;
 115
 116   /* handles rule R6:
 117    * convert x - c => (-c) + x
 118    *
 119    * As there is NO real Minus in Firm it makes no sense to do this
 120    * for non-real constants yet.
 121    * */
 122   if (get_const_class(right, block) == REAL_CONSTANT) {
 123     ir_node *left  = get_Sub_left(n);
 124     ir_node *block = get_nodes_block(n);
 125     ir_mode *mode  = get_irn_mode(n);
 126     dbg_info *dbi  = get_irn_dbg_info(n);
 127     ir_node *irn, *c;
 128
 129     switch (get_const_class(left, block)) {
 130       case REAL_CONSTANT:
 131         irn = optimize_in_place(n);
 132         if (irn != n) {
 133           exchange(n, irn);
 134                                         *in = irn;
 135           return 1;
 136         }
 137         return 0;
 138       case NO_CONSTANT:
 139         break;
 140       default:
 141         /* already constant, nothing to do */
 142         return 0;
 143     }
 144
 145     c   = new_r_Const(current_ir_graph, block, mode, get_mode_null(mode));
 146     irn = new_rd_Sub(dbi, current_ir_graph, block, c, right, mode);
 147
 148     irn = new_rd_Add(dbi, current_ir_graph, block, left, irn, get_irn_mode(n));
 149
 150     DBG((dbg, LEVEL_5, "Applied: %n - %n => %n + (-%n)\n",
 151         get_Sub_left(n), c, get_Sub_left(n), c));
 152
 153     exchange(n, irn);
 154                 *in = irn;
 155
 156     return 1;
 157   }
 158   return 0;
 159 }
 160
 161 /** Retrieve a mode from the operands. We need this, because
 162  * Add and Sub are allowed to operate on (P, Is)
 163  */
 164 static ir_mode *get_mode_from_ops(ir_node *op1, ir_node *op2)
 165 {
 166   ir_mode *m1, *m2;
 167
 168   m1 = get_irn_mode(op1);
 169   if (mode_is_reference(m1))
 170     return m1;
 171
 172   m2 = get_irn_mode(op2);
 173   if (mode_is_reference(m2))
 174     return m2;
 175
 176   assert(m1 == m2);
 177
 178   return m1;
 179 }
 180
 181 /**
 182  * reassociate a commutative Binop
 183  *
 184  * BEWARE: this rule leads to a potential loop, if
 185  * two operands are are constant expressions and the third is a
 186  * constant, so avoid this situation.
 187  */
 188 static int reassoc_commutative(ir_node **node)
 189 {
 190   ir_node *n     = *node;
 191   ir_op *op      = get_irn_op(n);
 192   ir_node *block = get_nodes_block(n);
 193   ir_node *t1, *c1;
 194
 195   get_comm_Binop_ops(n, &t1, &c1);
 196
 197   if (get_irn_op(t1) == op) {
 198     ir_node *t2, *c2;
 199     const_class_t c_c1, c_c2, c_t2;
 200
 201     get_comm_Binop_ops(t1, &t2, &c2);
 202
 203     /* do not optimize Bad nodes, will fail later */
 204     if (is_Bad(t2))
 205       return 0;
 206
 207     c_c1 = get_const_class(c1, block);
 208     c_c2 = get_const_class(c2, block);
 209     c_t2 = get_const_class(t2, block);
 210
 211     if ( ((c_c1 > NO_CONSTANT) & (c_t2 > NO_CONSTANT)) &&
 212          ((((c_c1 ^ c_c2 ^ c_t2) & CONST_EXPR) == 0) || ((c_c1 & c_c2 & c_t2) == CONST_EXPR)) ) {
 213       /* All three are constant and either all are constant expressions or two of them are:
 214        * then applying this rule would lead into a cycle
 215        *
 216        * Note that if t2 is a constant so is c2 hence we save one test.
 217        */
 218       return 0;
 219     }
 220
 221     if ((c_c1 != NO_CONSTANT) & (c_c2 != NO_CONSTANT)) {
 222       /* handles rules R7, R8, R9, R10:
 223        * convert c1 .OP. (c2 .OP. x) => (c1 .OP. c2) .OP. x
 224        */
 225       ir_node *irn, *in[2];
 226       ir_mode *mode, *mode_c1 = get_irn_mode(c1), *mode_c2 = get_irn_mode(c2);
 227
 228       /* It might happen, that c1 and c2 have different modes, for instance Is and Iu.
 229        * Handle this here.
 230        */
 231       if (mode_c1 != mode_c2) {
 232         if (mode_is_int(mode_c1) && mode_is_int(mode_c2)) {
 233           /* get the bigger one */
 234           if (get_mode_size_bits(mode_c1) > get_mode_size_bits(mode_c2))
 235             c2 = new_r_Conv(current_ir_graph, block, c2, mode_c1);
 236           else if (get_mode_size_bits(mode_c1) < get_mode_size_bits(mode_c2))
 237             c1 = new_r_Conv(current_ir_graph, block, c1, mode_c2);
 238           else {
 239             /* Try to cast the real const */
 240             if (c_c1 == REAL_CONSTANT)
 241               c1 = new_r_Conv(current_ir_graph, block, c1, mode_c2);
 242             else
 243               c2 = new_r_Conv(current_ir_graph, block, c2, mode_c1);
 244           }
 245         }
 246       }
 247
 248       in[0] = c1;
 249       in[1] = c2;
 250
 251       mode = get_mode_from_ops(in[0], in[1]);
 252       in[0] = optimize_node(new_ir_node(NULL, current_ir_graph, block, op, mode, 2, in));
 253       in[1] = t2;
 254
 255       mode = get_mode_from_ops(in[0], in[1]);
 256       irn   = optimize_node(new_ir_node(NULL, current_ir_graph, block, op, mode, 2, in));
 257
 258       DBG((dbg, LEVEL_5, "Applied: %n .%s. (%n .%s. %n) => (%n .%s. %n) .%s. %n\n",
 259           c1, get_irn_opname(n), c2, get_irn_opname(n),
 260                                         t2, c1, get_irn_opname(n), c2, get_irn_opname(n), t2));
 261       /*
 262        * In some rare cases it can really happen that we get the same node back.
 263        * This might be happen in dead loops, were the Phi nodes are already gone away.
 264        * So check this.
 265        */
 266       if (n != irn) {
 267         exchange(n, irn);
 268                                 *node = irn;
 269         return 1;
 270       }
 271     }
 272   }
 273   return 0;
 274 }
 275
 276 #define reassoc_Add  reassoc_commutative
 277 #define reassoc_And  reassoc_commutative
 278 #define reassoc_Or   reassoc_commutative
 279 #define reassoc_Eor  reassoc_commutative
 280
 281 /**
 282  * reassociate using distributive law for Mul and Add/Sub
 283  */
 284 static int reassoc_Mul(ir_node **node)
 285 {
 286   ir_node *n = *node;
 287   ir_node *add_sub, *c;
 288   ir_op *op;
 289
 290   if (reassoc_commutative(&n))
 291     return 1;
 292
 293   get_comm_Binop_ops(n, &add_sub, &c);
 294   op = get_irn_op(add_sub);
 295
 296   /* handles rules R11, R12, R13, R14, R15, R16, R17, R18, R19, R20 */
 297   if (op == op_Add || op == op_Sub) {
 298     ir_mode *mode = get_irn_mode(n);
 299     ir_node *irn, *block, *t1, *t2, *in[2];
 300
 301     block = get_nodes_block(n);
 302     t1 = get_binop_left(add_sub);
 303     t2 = get_binop_right(add_sub);
 304
 305     in[0] = new_rd_Mul(NULL, current_ir_graph, block, c, t1, mode);
 306     in[1] = new_rd_Mul(NULL, current_ir_graph, block, c, t2, mode);
 307
 308     mode  = get_mode_from_ops(in[0], in[1]);
 309     irn   = optimize_node(new_ir_node(NULL, current_ir_graph, block, op, mode, 2, in));
 310
 311     DBG((dbg, LEVEL_5, "Applied: (%n .%s. %n) %n %n => (%n %n %n) .%s. (%n %n %n)\n",
 312         t1, get_op_name(op), t2, n, c, t1, n, c, get_op_name(op), t2, n, c));
 313     exchange(n, irn);
 314                 *node = irn;
 315
 316     return 1;
 317   }
 318   return 0;
 319 }
 320
 321 /**
 322  * The walker for the reassociation.
 323  */
 324 static void do_reassociation(ir_node *n, void *env)
 325 {
 326   walker_t *wenv = env;
 327   int res;
 328
 329   hook_reassociate(1);
 330
 331   /* Reassociation must run until a fixpoint is reached. */
 332   do {
 333     ir_op   *op    = get_irn_op(n);
 334     ir_mode *mode  = get_irn_mode(n);
 335
 336     res = 0;
 337
 338     /* reassociation works only for integer or reference modes */
 339     if (op->reassociate && (mode_is_int(mode) || mode_is_reference(mode))) {
 340       res = op->reassociate(&n);
 341
 342                         wenv->changes |= res;
 343     }
 344   } while (res == 1);
 345
 346   hook_reassociate(0);
 347 }
 348
 349 /*
 350  * do the reassociation
 351  */
 352 void optimize_reassociation(ir_graph *irg)
 353 {
 354   walker_t env;
 355   irg_loopinfo_state state;
 356
 357   assert(get_irg_phase_state(irg) != phase_building);
 358
 359   /* reassociation needs constant folding */
 360   if (!get_opt_reassociation() || !get_opt_constant_folding())
 361     return;
 362
 363   /*
 364    * Calculate loop info, so we could identify loop-invariant
 365    * code and threat it like a constant.
 366    * We only need control flow loops here but can handle generic
 367    * INTRA info as well.
 368    */
 369   state = get_irg_loopinfo_state(irg);
 370   if ((state & loopinfo_inter) ||
 371       (state & (loopinfo_constructed | loopinfo_valid)) != (loopinfo_constructed | loopinfo_valid))
 372     construct_cf_backedges(irg);
 373
 374   env.changes = 0;
 375
 376   /* now we have collected enough information, optimize */
 377   irg_walk_graph(irg, NULL, do_reassociation, &env);
 378
 379   /* Handle graph state */
 380   if (env.changes) {
 381     if (get_irg_outs_state(irg) == outs_consistent)
 382       set_irg_outs_inconsistent(irg);
 383     set_irg_loopinfo_inconsistent(irg);
 384   }
 385 }
 386
 387 /* initialize the reassociation by adding operations to some opcodes */
 388 void firm_init_reassociation(void)
 389 {
 390 #define INIT(a) op_##a->reassociate  = reassoc_##a;
 391   INIT(Mul);
 392   INIT(Add);
 393   INIT(Sub);
 394   INIT(And);
 395   INIT(Or);
 396   INIT(Eor);
 397 #undef INIT
 398
 399   dbg = firm_dbg_register("firm.opt.reassoc");
 400 }