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