29b34c6464311bf8f63c88240ea4337d0192a1d3
[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       exchange( info->projs[pn_Load_res], get_Store_value(pred) );
226       if (info->projs[pn_Load_M])
227         exchange(info->projs[pn_Load_M], mem);
228
229       /* no exception */
230       if (info->projs[pn_Load_X_except])
231         exchange( info->projs[pn_Load_X_except], new_Bad());
232       res = 1;
233     }
234   }
235   else if (get_irn_op(pred) == op_Load && get_Load_ptr(pred) == ptr &&
236            get_Load_mode(pred) == load_mode) {
237     /*
238      * a load immediately after a load -- a read after read.
239      * We may remove the second Load, if it does not have an exception handler
240      * OR they are in the same block. In the later case the Load cannot
241      * throw an exception when the previous Load was quiet.
242      */
243     if (! info->projs[pn_Load_X_except] || get_nodes_block(load) == get_nodes_block(pred)) {
244       ldst_info_t *pred_info = get_irn_link(pred);
245
246       if (pred_info->projs[pn_Load_res]) {
247         /* we need a data proj from the previous load for this optimization */
248         exchange( info->projs[pn_Load_res], pred_info->projs[pn_Load_res] );
249         if (info->projs[pn_Load_M])
250           exchange(info->projs[pn_Load_M], mem);
251       }
252       else {
253         if (info->projs[pn_Load_res]) {
254           set_Proj_pred(info->projs[pn_Load_res], pred);
255           set_nodes_block(info->projs[pn_Load_res], get_nodes_block(pred));
256         }
257         if (info->projs[pn_Load_M]) {
258           /* Actually, this if should not be necessary.  Construct the Loads
259              properly!!! */
260           exchange(info->projs[pn_Load_M], mem);
261         }
262       }
263
264       /* no exception */
265       if (info->projs[pn_Load_X_except])
266         exchange(info->projs[pn_Load_X_except], new_Bad());
267
268       res = 1;
269     }
270   }
271   return res;
272 }
273
274 /**
275  * optimize a Store
276  */
277 static int optimize_store(ir_node *store)
278 {
279   ldst_info_t *info = get_irn_link(store);
280   ir_node *pred, *mem, *ptr, *value, *block;
281   ir_mode *mode;
282   ldst_info_t *pred_info;
283   int res = 0;
284
285   if (get_Store_volatility(store) == volatility_is_volatile)
286     return 0;
287
288   /*
289    * BEWARE: one might think that checking the modes is useless, because
290    * if the pointers are identical, they refer to the same object.
291    * This is only true in strong typed languages, not is C were the following
292    * is possible *(type1 *)p = a; *(type2 *)p = b ...
293    */
294
295   block = get_nodes_block(store);
296   ptr   = get_Store_ptr(store);
297   mem   = get_Store_mem(store);
298   value = get_Store_value(store);
299   pred  = skip_Proj(mem);
300   mode  = get_irn_mode(value);
301
302   pred_info = get_irn_link(pred);
303
304   if (get_irn_op(pred) == op_Store && get_Store_ptr(pred) == ptr &&
305       get_nodes_block(pred) == block && get_irn_mode(get_Store_value(pred)) == mode) {
306     /*
307      * a store immediately after a store in the same block -- a write after write.
308      * We may remove the first Store, if it does not have an exception handler.
309      *
310      * TODO: What, if both have the same exception handler ???
311      */
312     if (get_Store_volatility(pred) != volatility_is_volatile && !pred_info->projs[pn_Store_X_except]) {
313       exchange( pred_info->projs[pn_Store_M], get_Store_mem(pred) );
314       res = 1;
315     }
316   }
317   else if (get_irn_op(pred) == op_Load && get_Load_ptr(pred) == ptr &&
318            value == pred_info->projs[pn_Load_res]) {
319     /*
320      * a store a value immediately after a load -- a write after read.
321      * We may remove the second Store, if it does not have an exception handler.
322      */
323     if (! info->projs[pn_Store_X_except]) {
324       exchange( info->projs[pn_Store_M], mem );
325       res = 1;
326     }
327   }
328   return res;
329 }
330
331 /**
332  * walker, optimizes Phi after Stores:
333  * Does the following optimization:
334  *
335  *   val1   val2   val3          val1  val2  val3
336  *    |      |      |               \    |    /
337  *   Str    Str    Str               \   |   /
338  *      \    |    /                     Phi
339  *       \   |   /                       |
340  *        \  |  /                       Str
341  *          Phi
342  *
343  * This removes the number of stores and allows for predicated execution.
344  * Moves Stores back to the end of a function which may be bad
345  *
346  * Is only allowed if the predecessor blocks have only one successor.
347  */
348 static int optimize_phi(ir_node *phi, void *env)
349 {
350   walk_env_t *wenv = env;
351   int i, n;
352   ir_node *store, *ptr, *block, *phiM, *phiD, *exc, *projM;
353   ir_mode *mode;
354   ir_node **inM, **inD;
355   int *idx;
356   dbg_info *db = NULL;
357   ldst_info_t *info;
358   block_info_t *bl_info;
359
360   /* Must be a memory Phi */
361   if (get_irn_mode(phi) != mode_M)
362     return 0;
363
364   n = get_Phi_n_preds(phi);
365   if (n <= 0)
366     return 0;
367
368   store = skip_Proj(get_Phi_pred(phi, 0));
369   if (get_irn_op(store) != op_Store)
370     return 0;
371
372   /* abort on bad blocks */
373   if (is_Bad(get_nodes_block(store)))
374     return 0;
375
376   /* check if the block has only one output */
377   bl_info = get_irn_link(get_nodes_block(store));
378   if (bl_info->flags)
379     return 0;
380
381   /* this is the address of the store */
382   ptr  = get_Store_ptr(store);
383   mode = get_irn_mode(get_Store_value(store));
384   info = get_irn_link(store);
385   exc  = info->exc_block;
386
387   for (i = 1; i < n; ++i) {
388     ir_node *pred = skip_Proj(get_Phi_pred(phi, i));
389
390     if (get_irn_op(pred) != op_Store)
391       return 0;
392
393     if (mode != get_irn_mode(get_Store_value(pred)) || ptr != get_Store_ptr(pred))
394       return 0;
395
396     info = get_irn_link(pred);
397
398     /* check, if all stores have the same exception flow */
399     if (exc != info->exc_block)
400       return 0;
401
402     /* abort on bad blocks */
403     if (is_Bad(get_nodes_block(store)))
404       return 0;
405
406     /* check if the block has only one output */
407     bl_info = get_irn_link(get_nodes_block(store));
408     if (bl_info->flags)
409       return 0;
410   }
411
412   /*
413    * ok, when we are here, we found all predecessors of a Phi that
414    * are Stores to the same address. That means whatever we do before
415    * we enter the block of the Phi, we do a Store.
416    * So, we can move the store to the current block:
417    *
418    *   val1    val2    val3          val1  val2  val3
419    *    |       |       |               \    |    /
420    * | Str | | Str | | Str |             \   |   /
421    *      \     |     /                     Phi
422    *       \    |    /                       |
423    *        \   |   /                       Str
424    *           Phi
425    *
426    * Is only allowed if the predecessor blocks have only one successor.
427    */
428
429   /* first step: collect all inputs */
430   NEW_ARR_A(ir_node *, inM, n);
431   NEW_ARR_A(ir_node *, inD, n);
432   NEW_ARR_A(int, idx, n);
433
434   for (i = 0; i < n; ++i) {
435     ir_node *pred = skip_Proj(get_Phi_pred(phi, i));
436     info = get_irn_link(pred);
437
438     inM[i] = get_Store_mem(pred);
439     inD[i] = get_Store_value(pred);
440     idx[i] = info->exc_idx;
441   }
442   block = get_nodes_block(phi);
443
444   /* second step: create a new memory Phi */
445   phiM = new_rd_Phi(get_irn_dbg_info(phi), current_ir_graph, block, n, inM, mode_M);
446
447   /* third step: create a new data Phi */
448   phiD = new_rd_Phi(get_irn_dbg_info(phi), current_ir_graph, block, n, inD, mode);
449
450   /* fourth step: create the Store */
451   store = new_rd_Store(db, current_ir_graph, block, phiM, ptr, phiD);
452   projM = new_rd_Proj(NULL, current_ir_graph, block, store, mode_M, pn_Store_M);
453
454   info = get_ldst_info(store, wenv);
455   info->projs[pn_Store_M] = projM;
456
457   /* fifths step: repair exception flow */
458   if (exc) {
459     ir_node *projX = new_rd_Proj(NULL, current_ir_graph, block, store, mode_X, pn_Store_X_except);
460
461     info->projs[pn_Store_X_except] = projX;
462     info->exc_block                = exc;
463     info->exc_idx                  = idx[0];
464
465     for (i = 0; i < n; ++i) {
466       set_Block_cfgpred(exc, idx[i], projX);
467     }
468
469     if (n > 1) {
470       /* the exception block should be optimized as some inputs are identical now */
471     }
472   }
473
474   /* sixt step: replace old Phi */
475   exchange(phi, projM);
476
477   return 1;
478 }
479
480 /**
481  * walker, collects all Load/Store/Proj nodes
482  */
483 static void do_load_store_optimize(ir_node *n, void *env)
484 {
485   walk_env_t *wenv = env;
486
487   switch (get_irn_opcode(n)) {
488
489   case iro_Load:
490     wenv->changes |= optimize_load(n);
491     break;
492
493   case iro_Store:
494     wenv->changes |= optimize_store(n);
495     break;
496
497   case iro_Phi:
498     wenv->changes |= optimize_phi(n, env);
499
500   default:
501     ;
502   }
503 }
504
505 /*
506  * do the load store optimization
507  */
508 void optimize_load_store(ir_graph *irg)
509 {
510   walk_env_t env;
511
512   assert(get_irg_phase_state(irg) != phase_building);
513
514   if (!get_opt_redundant_LoadStore())
515     return;
516
517   obstack_init(&env.obst);
518   env.changes = 0;
519
520   /* init the links, then collect Loads/Stores/Proj's in lists */
521   irg_walk_graph(irg, init_links, collect_nodes, &env);
522
523   /* now we have collected enough information, optimize */
524   irg_walk_graph(irg, NULL, do_load_store_optimize, &env);
525
526   obstack_free(&env.obst, NULL);
527
528   /* Handle graph state */
529   if (env.changes) {
530     if (get_irg_outs_state(current_ir_graph) == outs_consistent)
531       set_irg_outs_inconsistent(current_ir_graph);
532
533     /* is this really needed: Yes, as exception block may get bad but this might be tested */
534     if (get_irg_dom_state(current_ir_graph) == dom_consistent)
535       set_irg_dom_inconsistent(current_ir_graph);
536   }
537 }