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