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