Added overflow mode for interger operations (was already implemented, but had no IF)
[libfirm] / ir / opt / ldstopt.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/opt/ldstopt.c
4  * Purpose:     load store optimizations
5  * Author:
6  * Created:
7  * CVS-ID:      $Id$
8  * Copyright:   (c) 1998-2004 Universit\81ät Karlsruhe
9  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
10  */
11 # include "irnode_t.h"
12 # include "irgraph_t.h"
13 # include "irmode_t.h"
14 # include "iropt_t.h"
15 # include "ircons_t.h"
16 # include "irgmod.h"
17 # include "irgwalk.h"
18 # include "irvrfy.h"
19 # include "tv_t.h"
20 # include "dbginfo_t.h"
21 # include "iropt_dbg.h"
22 # include "irflag_t.h"
23 # include "array.h"
24 # include "firmstat.h"
25
26 #undef IMAX
27 #define IMAX(a,b)       ((a) > (b) ? (a) : (b))
28
29 #define MAX_PROJ        IMAX(pn_Load_max, pn_Store_max)
30
31 /**
32  * walker environment
33  */
34 typedef struct _walk_env_t {
35   struct obstack obst;          /**< list of all stores */
36   int changes;
37 } walk_env_t;
38
39 /**
40  * a Load/Store info
41  */
42 typedef struct _ldst_info_t {
43   ir_node *projs[MAX_PROJ];     /**< list of Proj's of this node */
44   ir_node *exc_block;           /**< the exception block if available */
45   int     exc_idx;              /**< predecessor index in the exception block */
46 } ldst_info_t;
47
48 /**
49  * flags for control flow
50  */
51 enum block_flags_t {
52   BLOCK_HAS_COND = 1,      /**< Block has conditional control flow */
53   BLOCK_HAS_EXC  = 2       /**< Block has exceptionl control flow */
54 };
55
56 /**
57  * a Block info
58  */
59 typedef struct _block_info_t {
60   unsigned flags;               /**< flags for the block */
61 } block_info_t;
62
63 /**
64  * walker, clears all links first
65  */
66 static void init_links(ir_node *n, void *env)
67 {
68   set_irn_link(n, NULL);
69 }
70
71 /**
72  * get the Load/Store info of a node
73  */
74 static ldst_info_t *get_ldst_info(ir_node *node, walk_env_t *env)
75 {
76   ldst_info_t *info = get_irn_link(node);
77
78   if (! info) {
79     info = obstack_alloc(&env->obst, sizeof(*info));
80
81     memset(info, 0, sizeof(*info));
82
83     set_irn_link(node, info);
84   }
85   return info;
86 }
87
88 /**
89  * get the Block info of a node
90  */
91 static block_info_t *get_block_info(ir_node *node, walk_env_t *env)
92 {
93   block_info_t *info = get_irn_link(node);
94
95   if (! info) {
96     info = obstack_alloc(&env->obst, sizeof(*info));
97
98     memset(info, 0, sizeof(*info));
99
100     set_irn_link(node, info);
101   }
102   return info;
103 }
104
105 /**
106  * update the projection info for a Load/Store
107  */
108 static int update_projs(ldst_info_t *info, ir_node *proj)
109 {
110   long nr = get_Proj_proj(proj);
111
112   assert(0 <= nr && nr <= MAX_PROJ && "Wrong proj from LoadStore");
113
114   if (info->projs[nr]) {
115     /* there is already one, do CSE */
116     exchange(proj, info->projs[nr]);
117     return 1;
118   }
119   else {
120     info->projs[nr] = proj;
121     return 0;
122   }
123 }
124
125 /**
126  * update the exception block info for a Load/Store
127  */
128 static int update_exc(ldst_info_t *info, ir_node *block, int pos)
129 {
130   assert(info->exc_block == NULL && "more than one exception block found");
131
132   info->exc_block = block;
133   info->exc_idx   = pos;
134   return 0;
135 }
136
137 /**
138  * walker, collects all Load/Store/Proj nodes
139  *
140  * walks form Start -> End
141  */
142 static void collect_nodes(ir_node *node, void *env)
143 {
144   ir_node     *pred;
145   ldst_info_t *ldst_info;
146   walk_env_t  *wenv = env;
147
148   if (get_irn_op(node) == op_Proj) {
149     pred = get_Proj_pred(node);
150
151     if (get_irn_op(pred) == op_Load || get_irn_op(pred) == op_Store) {
152       ldst_info = get_ldst_info(pred, wenv);
153
154       wenv->changes |= update_projs(ldst_info, node);
155     }
156   }
157   else if (get_irn_op(node) == op_Block) { /* check, if it's an exception block */
158     int i, n;
159
160     for (i = 0, n = get_Block_n_cfgpreds(node); i < n; ++i) {
161       ir_node      *pred_block;
162       block_info_t *bl_info;
163
164       pred = skip_Proj(get_Block_cfgpred(node, i));
165
166       /* ignore Bad predecessors, they will be removed later */
167       if (is_Bad(pred))
168         continue;
169
170       pred_block = get_nodes_block(pred);
171       bl_info    = get_block_info(pred_block, wenv);
172
173       if (is_fragile_op(pred))
174         bl_info->flags |= BLOCK_HAS_EXC;
175       else if (is_forking_op(pred))
176         bl_info->flags |= BLOCK_HAS_COND;
177
178       if (get_irn_op(pred) == op_Load || get_irn_op(pred) == op_Store) {
179         ldst_info = get_ldst_info(pred, wenv);
180
181         wenv->changes |= update_exc(ldst_info, node, i);
182       }
183     }
184   }
185 }
186
187 /**
188  * optimize a Load
189  */
190 static int optimize_load(ir_node *load)
191 {
192   ldst_info_t *info = get_irn_link(load);
193   ir_mode *load_mode = get_Load_mode(load);
194   ir_node *pred, *mem, *ptr;
195   int res = 1;
196
197   if (get_Load_volatility(load) == volatility_is_volatile)
198     return 0;
199
200   /*
201    * BEWARE: one might think that checking the modes is useless, because
202    * if the pointers are identical, they refer to the same object.
203    * This is only true in strong typed languages, not is C were the following
204    * is possible a = *(type1 *)p; b = *(type2 *)p ...
205    */
206
207   ptr  = get_Load_ptr(load);
208   mem  = get_Load_mem(load);
209   pred = skip_Proj(mem);
210
211   if (! info->projs[pn_Load_res] && ! info->projs[pn_Load_X_except]) {
212     /* a Load which value is neither used nor exception checked, remove it */
213     exchange(info->projs[pn_Load_M], mem);
214     res = 1;
215   }
216   else if (get_irn_op(pred) == op_Store && get_Store_ptr(pred) == ptr &&
217            get_irn_mode(get_Store_value(pred)) == load_mode) {
218     /*
219      * a load immediately after a store -- a read after write.
220      * We may remove the Load, if it does not have an exception handler
221      * OR they are in the same block. In the latter case the Load cannot
222      * throw an exception when the previous Store was quiet.
223      */
224     if (! info->projs[pn_Load_X_except] || get_nodes_block(load) == get_nodes_block(pred)) {
225       DBG_OPT_RAW(pred, load);
226       exchange( info->projs[pn_Load_res], get_Store_value(pred) );
227
228       if (info->projs[pn_Load_M])
229         exchange(info->projs[pn_Load_M], mem);
230
231       /* no exception */
232       if (info->projs[pn_Load_X_except])
233         exchange( info->projs[pn_Load_X_except], new_Bad());
234       res = 1;
235     }
236   }
237   else if (get_irn_op(pred) == op_Load && get_Load_ptr(pred) == ptr &&
238            get_Load_mode(pred) == load_mode) {
239     /*
240      * a load immediately after a load -- a read after read.
241      * We may remove the second Load, if it does not have an exception handler
242      * OR they are in the same block. In the later case the Load cannot
243      * throw an exception when the previous Load was quiet.
244      */
245     if (! info->projs[pn_Load_X_except] || get_nodes_block(load) == get_nodes_block(pred)) {
246       ldst_info_t *pred_info = get_irn_link(pred);
247
248       DBG_OPT_RAR(pred, load);
249
250       if (pred_info->projs[pn_Load_res]) {
251         /* we need a data proj from the previous load for this optimization */
252         exchange( info->projs[pn_Load_res], pred_info->projs[pn_Load_res] );
253         if (info->projs[pn_Load_M])
254           exchange(info->projs[pn_Load_M], mem);
255       }
256       else {
257         if (info->projs[pn_Load_res]) {
258           set_Proj_pred(info->projs[pn_Load_res], pred);
259           set_nodes_block(info->projs[pn_Load_res], get_nodes_block(pred));
260         }
261         if (info->projs[pn_Load_M]) {
262           /* Actually, this if should not be necessary.  Construct the Loads
263              properly!!! */
264           exchange(info->projs[pn_Load_M], mem);
265         }
266       }
267
268       /* no exception */
269       if (info->projs[pn_Load_X_except])
270         exchange(info->projs[pn_Load_X_except], new_Bad());
271
272       res = 1;
273     }
274   }
275   return res;
276 }
277
278 /**
279  * optimize a Store
280  */
281 static int optimize_store(ir_node *store)
282 {
283   ldst_info_t *info = get_irn_link(store);
284   ir_node *pred, *mem, *ptr, *value, *block;
285   ir_mode *mode;
286   ldst_info_t *pred_info;
287   int res = 0;
288
289   if (get_Store_volatility(store) == volatility_is_volatile)
290     return 0;
291
292   /*
293    * BEWARE: one might think that checking the modes is useless, because
294    * if the pointers are identical, they refer to the same object.
295    * This is only true in strong typed languages, not is C were the following
296    * is possible *(type1 *)p = a; *(type2 *)p = b ...
297    */
298
299   block = get_nodes_block(store);
300   ptr   = get_Store_ptr(store);
301   mem   = get_Store_mem(store);
302   value = get_Store_value(store);
303   pred  = skip_Proj(mem);
304   mode  = get_irn_mode(value);
305
306   pred_info = get_irn_link(pred);
307
308   if (get_irn_op(pred) == op_Store && get_Store_ptr(pred) == ptr &&
309       get_nodes_block(pred) == block && get_irn_mode(get_Store_value(pred)) == mode) {
310     /*
311      * a store immediately after a store in the same block -- a write after write.
312      * We may remove the first Store, if it does not have an exception handler.
313      *
314      * TODO: What, if both have the same exception handler ???
315      */
316     if (get_Store_volatility(pred) != volatility_is_volatile && !pred_info->projs[pn_Store_X_except]) {
317       DBG_OPT_WAW(pred, store);
318       exchange( pred_info->projs[pn_Store_M], get_Store_mem(pred) );
319       res = 1;
320     }
321   }
322   else if (get_irn_op(pred) == op_Load && get_Load_ptr(pred) == ptr &&
323            value == pred_info->projs[pn_Load_res]) {
324     /*
325      * a store a value immediately after a load -- a write after read.
326      * We may remove the second Store, if it does not have an exception handler.
327      */
328     if (! info->projs[pn_Store_X_except]) {
329       DBG_OPT_WAR(pred, store);
330       exchange( info->projs[pn_Store_M], mem );
331       res = 1;
332     }
333   }
334   return res;
335 }
336
337 /**
338  * walker, optimizes Phi after Stores:
339  * Does the following optimization:
340  *
341  *   val1   val2   val3          val1  val2  val3
342  *    |      |      |               \    |    /
343  *   Str    Str    Str               \   |   /
344  *      \    |    /                     Phi
345  *       \   |   /                       |
346  *        \  |  /                       Str
347  *          Phi
348  *
349  * This removes the number of stores and allows for predicated execution.
350  * Moves Stores back to the end of a function which may be bad
351  *
352  * Is only allowed if the predecessor blocks have only one successor.
353  */
354 static int optimize_phi(ir_node *phi, void *env)
355 {
356   walk_env_t *wenv = env;
357   int i, n;
358   ir_node *store, *ptr, *block, *phiM, *phiD, *exc, *projM;
359   ir_mode *mode;
360   ir_node **inM, **inD;
361   int *idx;
362   dbg_info *db = NULL;
363   ldst_info_t *info;
364   block_info_t *bl_info;
365
366   /* Must be a memory Phi */
367   if (get_irn_mode(phi) != mode_M)
368     return 0;
369
370   n = get_Phi_n_preds(phi);
371   if (n <= 0)
372     return 0;
373
374   store = skip_Proj(get_Phi_pred(phi, 0));
375   if (get_irn_op(store) != op_Store)
376     return 0;
377
378   /* abort on bad blocks */
379   if (is_Bad(get_nodes_block(store)))
380     return 0;
381
382   /* check if the block has only one output */
383   bl_info = get_irn_link(get_nodes_block(store));
384   if (bl_info->flags)
385     return 0;
386
387   /* this is the address of the store */
388   ptr  = get_Store_ptr(store);
389   mode = get_irn_mode(get_Store_value(store));
390   info = get_irn_link(store);
391   exc  = info->exc_block;
392
393   for (i = 1; i < n; ++i) {
394     ir_node *pred = skip_Proj(get_Phi_pred(phi, i));
395
396     if (get_irn_op(pred) != op_Store)
397       return 0;
398
399     if (mode != get_irn_mode(get_Store_value(pred)) || ptr != get_Store_ptr(pred))
400       return 0;
401
402     info = get_irn_link(pred);
403
404     /* check, if all stores have the same exception flow */
405     if (exc != info->exc_block)
406       return 0;
407
408     /* abort on bad blocks */
409     if (is_Bad(get_nodes_block(store)))
410       return 0;
411
412     /* check if the block has only one output */
413     bl_info = get_irn_link(get_nodes_block(store));
414     if (bl_info->flags)
415       return 0;
416   }
417
418   /*
419    * ok, when we are here, we found all predecessors of a Phi that
420    * are Stores to the same address. That means whatever we do before
421    * we enter the block of the Phi, we do a Store.
422    * So, we can move the store to the current block:
423    *
424    *   val1    val2    val3          val1  val2  val3
425    *    |       |       |               \    |    /
426    * | Str | | Str | | Str |             \   |   /
427    *      \     |     /                     Phi
428    *       \    |    /                       |
429    *        \   |   /                       Str
430    *           Phi
431    *
432    * Is only allowed if the predecessor blocks have only one successor.
433    */
434
435   /* first step: collect all inputs */
436   NEW_ARR_A(ir_node *, inM, n);
437   NEW_ARR_A(ir_node *, inD, n);
438   NEW_ARR_A(int, idx, n);
439
440   for (i = 0; i < n; ++i) {
441     ir_node *pred = skip_Proj(get_Phi_pred(phi, i));
442     info = get_irn_link(pred);
443
444     inM[i] = get_Store_mem(pred);
445     inD[i] = get_Store_value(pred);
446     idx[i] = info->exc_idx;
447   }
448   block = get_nodes_block(phi);
449
450   /* second step: create a new memory Phi */
451   phiM = new_rd_Phi(get_irn_dbg_info(phi), current_ir_graph, block, n, inM, mode_M);
452
453   /* third step: create a new data Phi */
454   phiD = new_rd_Phi(get_irn_dbg_info(phi), current_ir_graph, block, n, inD, mode);
455
456   /* fourth step: create the Store */
457   store = new_rd_Store(db, current_ir_graph, block, phiM, ptr, phiD);
458   projM = new_rd_Proj(NULL, current_ir_graph, block, store, mode_M, pn_Store_M);
459
460   info = get_ldst_info(store, wenv);
461   info->projs[pn_Store_M] = projM;
462
463   /* fifths step: repair exception flow */
464   if (exc) {
465     ir_node *projX = new_rd_Proj(NULL, current_ir_graph, block, store, mode_X, pn_Store_X_except);
466
467     info->projs[pn_Store_X_except] = projX;
468     info->exc_block                = exc;
469     info->exc_idx                  = idx[0];
470
471     for (i = 0; i < n; ++i) {
472       set_Block_cfgpred(exc, idx[i], projX);
473     }
474
475     if (n > 1) {
476       /* the exception block should be optimized as some inputs are identical now */
477     }
478   }
479
480   /* sixt step: replace old Phi */
481   exchange(phi, projM);
482
483   return 1;
484 }
485
486 /**
487  * walker, collects all Load/Store/Proj nodes
488  */
489 static void do_load_store_optimize(ir_node *n, void *env)
490 {
491   walk_env_t *wenv = env;
492
493   switch (get_irn_opcode(n)) {
494
495   case iro_Load:
496     wenv->changes |= optimize_load(n);
497     break;
498
499   case iro_Store:
500     wenv->changes |= optimize_store(n);
501     break;
502
503   case iro_Phi:
504     wenv->changes |= optimize_phi(n, env);
505
506   default:
507     ;
508   }
509 }
510
511 /*
512  * do the load store optimization
513  */
514 void optimize_load_store(ir_graph *irg)
515 {
516   walk_env_t env;
517
518   assert(get_irg_phase_state(irg) != phase_building);
519
520   if (!get_opt_redundant_LoadStore())
521     return;
522
523   obstack_init(&env.obst);
524   env.changes = 0;
525
526   /* init the links, then collect Loads/Stores/Proj's in lists */
527   irg_walk_graph(irg, init_links, collect_nodes, &env);
528
529   /* now we have collected enough information, optimize */
530   irg_walk_graph(irg, NULL, do_load_store_optimize, &env);
531
532   obstack_free(&env.obst, NULL);
533
534   /* Handle graph state */
535   if (env.changes) {
536     if (get_irg_outs_state(current_ir_graph) == outs_consistent)
537       set_irg_outs_inconsistent(current_ir_graph);
538
539     /* is this really needed: Yes, as exception block may get bad but this might be tested */
540     if (get_irg_dom_state(current_ir_graph) == dom_consistent)
541       set_irg_dom_inconsistent(current_ir_graph);
542   }
543 }