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 "firmstat.h"
  28
  29 typedef struct _walker_t {
  30   int changes;          /* set, if a reassociation take place */
  31 } walker_t;
  32
  33 typedef enum {
  34   NO_CONSTANT   = 0,    /**< node is not constant */
  35   REAL_CONSTANT = 1,    /**< node is a constnt that is suitable for constant folding */
  36   CONST_EXPR    = 4     /**< node is not constnt expression in the current context,
  37                              use 4 here to simplify implementation of get_comm_Binop_ops() */
  38 } const_class_t;
  39
  40 /**
  41  * returns wheater a node is constant, ie is a constant or
  42  * is loop invariant
  43  */
  44 static const_class_t get_const_class(ir_node *n)
  45 {
  46   ir_op *op = get_irn_op(n);
  47
  48   if (op == op_Const)
  49     return REAL_CONSTANT;
  50   if (op == op_SymConst)
  51     return CONST_EXPR;
  52
  53   return NO_CONSTANT;
  54 }
  55
  56 /**
  57  * returns the operands of a commutative bin-op, if one operand is
  58  * a constant in the current context, it is returned as the second one.
  59  *
  60  * Beware: Real constrants must be returned with higher priority than
  61  * constnt expression, because they might be folded.
  62  */
  63 static void get_comm_Binop_ops(ir_node *binop, ir_node **a, ir_node **c)
  64 {
  65   ir_node *op_a = get_binop_left(binop);
  66   ir_node *op_b = get_binop_right(binop);
  67   int class_a = get_const_class(op_a);
  68   int class_b = get_const_class(op_b);
  69
  70   assert(is_op_commutative(get_irn_op(binop)));
  71
  72   switch (class_a + 2*class_b) {
  73     case REAL_CONSTANT + 2*NO_CONSTANT:
  74     case REAL_CONSTANT + 2*REAL_CONSTANT:
  75     case REAL_CONSTANT + 2*CONST_EXPR:
  76     case CONST_EXPR    + 2*NO_CONSTANT:
  77       *a = op_b;
  78       *c = op_a;
  79       break;
  80     default:
  81       *a = op_a;
  82       *c = op_b;
  83       break;
  84   }
  85 }
  86
  87 /**
  88  * reassociate a Sub: x - c = (-c) + x
  89  */
  90 static int reassoc_Sub(ir_node *n)
  91 {
  92   ir_node *right = get_Sub_right(n);
  93
  94   /* FIXME: Do not apply this rule for unsigned Sub's because our code
  95    * generation is currently buggy :-)
  96    */
  97   if (! mode_is_signed(get_irn_mode(n)))
  98       return 0;
  99
 100   /* handles rule R6:
 101    * convert x - c => (-c) + x
 102    *
 103    * As there is NO real Minus in Firm it makes no sense to do this
 104    * for non-real constants yet.
 105    * */
 106   if (get_const_class(right) == REAL_CONSTANT) {
 107     ir_node *left  = get_Sub_left(n);
 108     ir_node *block = get_nodes_block(n);
 109     ir_mode *mode  = get_irn_mode(n);
 110     dbg_info *dbg  = get_irn_dbg_info(n);
 111     ir_node *irn, *c;
 112
 113     switch (get_const_class(left)) {
 114       case REAL_CONSTANT:
 115         irn = optimize_in_place(n);
 116         if (irn != n) {
 117           exchange(n, irn);
 118           return 1;
 119         }
 120         return 0;
 121       case NO_CONSTANT:
 122         break;
 123       default:
 124         /* already constant, nothing to do */
 125         return 0;
 126     }
 127
 128     c   = new_r_Const(current_ir_graph, block, mode, get_mode_null(mode));
 129     irn = new_rd_Sub(dbg, current_ir_graph, block, c, right, mode);
 130
 131     irn = new_rd_Add(dbg, current_ir_graph, block, left, irn, get_irn_mode(n));
 132
 133     printf("Applied: %s - %s => %s + (-%s)\n",
 134         get_irn_opname(get_Sub_left(n)), get_irn_opname(c),
 135         get_irn_opname(get_Sub_left(n)), get_irn_opname(c) );
 136
 137     exchange(n, irn);
 138
 139     return 1;
 140   }
 141   return 0;
 142 }
 143
 144 /** Retrieve a mode form the operands. We need this, because
 145  * Add and Sub are allowed to operate on (P, Is)
 146  */
 147 static ir_mode *get_mode_from_ops(ir_node *op1, ir_node *op2)
 148 {
 149   ir_mode *m1, *m2;
 150
 151   m1 = get_irn_mode(op1);
 152   if (mode_is_reference(m1))
 153     return m1;
 154
 155   m2 = get_irn_mode(op2);
 156   if (mode_is_reference(m2))
 157     return m2;
 158
 159   assert(m1 == m2);
 160
 161   return m1;
 162 }
 163
 164 /**
 165  * reassociate a commutative Binop
 166  *
 167  * BEWARE: this rule leads to a potential loop, if
 168  * all two operands are are constant expressions and the third is a
 169  * constant, so avoid this situation.
 170  */
 171 static int reassoc_commutative(ir_node *n)
 172 {
 173   ir_op *op      = get_irn_op(n);
 174   ir_node *block = get_nodes_block(n);
 175   ir_node *t1, *c1;
 176
 177   get_comm_Binop_ops(n, &t1, &c1);
 178
 179   if (get_irn_op(t1) == op) {
 180     ir_node *t2, *c2;
 181     const_class_t c_c1, c_c2, c_t2;
 182
 183     get_comm_Binop_ops(t1, &t2, &c2);
 184
 185     c_c1 = get_const_class(c1);
 186     c_c2 = get_const_class(c2);
 187     c_t2 = get_const_class(t2);
 188
 189     if ( ((c_c1 > NO_CONSTANT) & (c_t2 > NO_CONSTANT)) &&
 190          ((((c_c1 ^ c_c2 ^ c_t2) & CONST_EXPR) == 0) || ((c_c1 & c_c2 & c_t2) == CONST_EXPR)) ) {
 191       /* all three are constant and either all are constant expressions or two of them are:
 192        * then, applying this rule would lead into a cycle
 193        *
 194        * Note that if t2 is a onstant so is c2, so we save one test.
 195        */
 196       return 0;
 197     }
 198
 199     if ((c_c1 != NO_CONSTANT) & (c_c2 != NO_CONSTANT)) {
 200       /* handles rules R7, R8, R9, R10:
 201        * convert c1 .OP. (c2 .OP. x) => (c1 .OP. c2) .OP. x
 202        */
 203       ir_node *irn, *in[2];
 204       ir_mode *mode;
 205
 206       in[0] = c1;
 207       in[1] = c2;
 208
 209       mode = get_mode_from_ops(in[0], in[1]);
 210       in[0] = optimize_node(new_ir_node(NULL, current_ir_graph, block, op, mode, 2, in));
 211       in[1] = t2;
 212
 213       mode = get_mode_from_ops(in[0], in[1]);
 214       irn   = optimize_node(new_ir_node(NULL, current_ir_graph, block, op, mode, 2, in));
 215
 216       printf("Applied: %s .%s. (%s .%s. %s) => (%s .%s. %s) .%s. %s\n",
 217           get_irn_opname(c1), get_irn_opname(n), get_irn_opname(c2), get_irn_opname(n), get_irn_opname(t2),
 218           get_irn_opname(c1), get_irn_opname(n), get_irn_opname(c2), get_irn_opname(n), get_irn_opname(t2));
 219
 220       exchange(n, irn);
 221
 222       return 1;
 223     }
 224   }
 225   return 0;
 226 }
 227
 228 #define reassoc_Add  reassoc_commutative
 229
 230 /**
 231  * reassociate using distibutive law for Mul and Add/Sub
 232  */
 233 static int reassoc_Mul(ir_node *n)
 234 {
 235   ir_node *add_sub, *c;
 236   ir_op *op;
 237
 238   if (reassoc_commutative(n))
 239     return 1;
 240
 241   get_comm_Binop_ops(n, &add_sub, &c);
 242   op = get_irn_op(add_sub);
 243
 244   /* handles rules R11, R12, R13, R14, R15, R16, R17, R18, R19, R20 */
 245   if (op == op_Add || op == op_Sub) {
 246     ir_mode *mode = get_irn_mode(n);
 247     ir_node *irn, *block, *t1, *t2, *in[2];
 248
 249     block = get_nodes_block(n);
 250     t1 = get_binop_left(add_sub);
 251     t2 = get_binop_right(add_sub);
 252
 253     in[0] = new_rd_Mul(NULL, current_ir_graph, block, c, t1, mode);
 254     in[1] = new_rd_Mul(NULL, current_ir_graph, block, c, t2, mode);
 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     printf("Applied: (%s .%s. %s) %s %s => (%s %s %s) .%s. (%s %s %s)\n",
 260         get_irn_opname(t1), get_op_name(op), get_irn_opname(t2), get_irn_opname(n), get_irn_opname(c),
 261         get_irn_opname(t1), get_irn_opname(n), get_irn_opname(c),
 262         get_op_name(op),
 263         get_irn_opname(t2), get_irn_opname(n), get_irn_opname(c));
 264
 265     exchange(n, irn);
 266
 267     return 1;
 268   }
 269   return 0;
 270 }
 271
 272 /**
 273  * The walker for the reassociation
 274  */
 275 static void do_reassociation(ir_node *n, void *env)
 276 {
 277   walker_t *wenv = env;
 278   int res;
 279
 280   /* reassociation must run until fixpoint */
 281   do {
 282     ir_op   *op    = get_irn_op(n);
 283     ir_mode *mode  = get_irn_mode(n);
 284
 285     res = 0;
 286
 287     /* reassociation works only for integer or reference modes */
 288     if (op->reassociate && (mode_is_int(mode) || mode_is_reference(mode))) {
 289       res = op->reassociate(n);
 290       if (res) {
 291         wenv->changes = 1;
 292
 293         /* we need a skip here, or we will see an Id in the next iteration */
 294         n = skip_Id(n);
 295       }
 296     }
 297   } while (res == 1);
 298 }
 299
 300 /*
 301  * do the reassociation
 302  */
 303 void optimize_reassociation(ir_graph *irg)
 304 {
 305   walker_t env;
 306
 307   assert(get_irg_phase_state(irg) != phase_building);
 308
 309   /* reassociation needs constant folding */
 310   if (!get_opt_reassociation() || !get_opt_constant_folding())
 311     return;
 312
 313   env.changes = 0;
 314
 315   irg_walk_graph(irg, NULL, do_reassociation, &env);
 316
 317   /* now we have collected enough information, optimize */
 318   irg_walk_graph(irg, NULL, do_reassociation, &env);
 319
 320   /* Handle graph state */
 321   if (env.changes) {
 322     if (get_irg_outs_state(current_ir_graph) == outs_consistent)
 323       set_irg_outs_inconsistent(current_ir_graph);
 324   }
 325 }
 326
 327 /* initialise the reassociation by adding operations to some opcodes */
 328 void firm_init_reassociation(void)
 329 {
 330 #define INIT(a) op_##a->reassociate  = reassoc_##a;
 331   INIT(Mul);
 332   INIT(Add);
 333   INIT(Sub);
 334 #undef CASE
 335 }