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