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