BugFix: find_constant_entity() now checks global entities to be constant
[libfirm] / ir / opt / ldstopt.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/opt/ldstopt.c
4  * Purpose:     load store optimizations
5  * Author:      Michael Beck
6  * Created:
7  * CVS-ID:      $Id$
8  * Copyright:   (c) 1998-2007 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 #ifdef HAVE_ALLOCA_H
16 #include <alloca.h>
17 #endif
18 #ifdef HAVE_MALLOC_H
19 #include <malloc.h>
20 #endif
21 #ifdef HAVE_STRING_H
22 # include <string.h>
23 #endif
24
25 #include "irnode_t.h"
26 #include "irgraph_t.h"
27 #include "irmode_t.h"
28 #include "iropt_t.h"
29 #include "ircons_t.h"
30 #include "irgmod.h"
31 #include "irgwalk.h"
32 #include "irvrfy.h"
33 #include "tv_t.h"
34 #include "dbginfo_t.h"
35 #include "iropt_dbg.h"
36 #include "irflag_t.h"
37 #include "array.h"
38 #include "irhooks.h"
39 #include "iredges.h"
40 #include "irtools.h"
41 #include "opt_polymorphy.h"
42 #include "irmemory.h"
43
44 #ifdef DO_CACHEOPT
45 #include "cacheopt/cachesim.h"
46 #endif
47
48 #undef IMAX
49 #define IMAX(a,b)       ((a) > (b) ? (a) : (b))
50
51 #define MAX_PROJ        IMAX(pn_Load_max, pn_Store_max)
52
53 enum changes_t {
54         DF_CHANGED = 1,       /**< data flow changed */
55         CF_CHANGED = 2,       /**< control flow changed */
56 };
57
58 /**
59  * walker environment
60  */
61 typedef struct _walk_env_t {
62         struct obstack obst;          /**< list of all stores */
63         unsigned changes;             /**< a bitmask of graph changes */
64 } walk_env_t;
65
66 /**
67  * flags for Load/Store
68  */
69 enum ldst_flags_t {
70         LDST_VISITED = 1              /**< if set, this Load/Store is already visited */
71 };
72
73 /** A Load/Store info. */
74 typedef struct _ldst_info_t {
75         ir_node  *projs[MAX_PROJ];    /**< list of Proj's of this node */
76         ir_node  *exc_block;          /**< the exception block if available */
77         int      exc_idx;             /**< predecessor index in the exception block */
78         unsigned flags;               /**< flags */
79         unsigned visited;             /**< visited counter for breaking loops */
80 } ldst_info_t;
81
82 /**
83  * flags for control flow.
84  */
85 enum block_flags_t {
86         BLOCK_HAS_COND = 1,      /**< Block has conditional control flow */
87         BLOCK_HAS_EXC  = 2       /**< Block has exceptional control flow */
88 };
89
90 /**
91  * a Block info.
92  */
93 typedef struct _block_info_t {
94         unsigned flags;               /**< flags for the block */
95 } block_info_t;
96
97 /** the master visited flag for loop detection. */
98 static unsigned master_visited = 0;
99
100 #define INC_MASTER()       ++master_visited
101 #define MARK_NODE(info)    (info)->visited = master_visited
102 #define NODE_VISITED(info) (info)->visited >= master_visited
103
104 /**
105  * get the Load/Store info of a node
106  */
107 static ldst_info_t *get_ldst_info(ir_node *node, walk_env_t *env) {
108         ldst_info_t *info = get_irn_link(node);
109
110         if (! info) {
111                 info = obstack_alloc(&env->obst, sizeof(*info));
112                 memset(info, 0, sizeof(*info));
113                 set_irn_link(node, info);
114         }
115         return info;
116 }  /* get_ldst_info */
117
118 /**
119  * get the Block info of a node
120  */
121 static block_info_t *get_block_info(ir_node *node, walk_env_t *env) {
122         block_info_t *info = get_irn_link(node);
123
124         if (! info) {
125                 info = obstack_alloc(&env->obst, sizeof(*info));
126                 memset(info, 0, sizeof(*info));
127                 set_irn_link(node, info);
128         }
129         return info;
130 }  /* get_block_info */
131
132 /**
133  * update the projection info for a Load/Store
134  */
135 static unsigned update_projs(ldst_info_t *info, ir_node *proj)
136 {
137         long nr = get_Proj_proj(proj);
138
139         assert(0 <= nr && nr <= MAX_PROJ && "Wrong proj from LoadStore");
140
141         if (info->projs[nr]) {
142                 /* there is already one, do CSE */
143                 exchange(proj, info->projs[nr]);
144                 return DF_CHANGED;
145         }
146         else {
147                 info->projs[nr] = proj;
148                 return 0;
149         }
150 }  /* update_projs */
151
152 /**
153  * update the exception block info for a Load/Store node.
154  *
155  * @param info   the load/store info struct
156  * @param block  the exception handler block for this load/store
157  * @param pos    the control flow input of the block
158  */
159 static unsigned update_exc(ldst_info_t *info, ir_node *block, int pos)
160 {
161         assert(info->exc_block == NULL && "more than one exception block found");
162
163         info->exc_block = block;
164         info->exc_idx   = pos;
165         return 0;
166 }  /* update_exc */
167
168 /** Return the number of uses of an address node */
169 #define get_irn_n_uses(adr)     get_irn_n_edges(adr)
170
171 /**
172  * walker, collects all Load/Store/Proj nodes
173  *
174  * walks from Start -> End
175  */
176 static void collect_nodes(ir_node *node, void *env)
177 {
178         ir_op       *op = get_irn_op(node);
179         ir_node     *pred, *blk, *pred_blk;
180         ldst_info_t *ldst_info;
181         walk_env_t  *wenv = env;
182
183         if (op == op_Proj) {
184                 ir_node *adr;
185                 ir_op *op;
186
187                 pred = get_Proj_pred(node);
188                 op   = get_irn_op(pred);
189
190                 if (op == op_Load) {
191                         ldst_info = get_ldst_info(pred, wenv);
192
193                         wenv->changes |= update_projs(ldst_info, node);
194
195                         if ((ldst_info->flags & LDST_VISITED) == 0) {
196                                 adr = get_Load_ptr(pred);
197                                 ldst_info->flags |= LDST_VISITED;
198                         }
199
200                         /*
201                         * Place the Proj's to the same block as the
202                         * predecessor Load. This is always ok and prevents
203                         * "non-SSA" form after optimizations if the Proj
204                         * is in a wrong block.
205                         */
206                         blk      = get_nodes_block(node);
207                         pred_blk = get_nodes_block(pred);
208                         if (blk != pred_blk) {
209                                 wenv->changes |= DF_CHANGED;
210                                 set_nodes_block(node, pred_blk);
211                         }
212                 } else if (op == op_Store) {
213                         ldst_info = get_ldst_info(pred, wenv);
214
215                         wenv->changes |= update_projs(ldst_info, node);
216
217                         if ((ldst_info->flags & LDST_VISITED) == 0) {
218                                 adr = get_Store_ptr(pred);
219                                 ldst_info->flags |= LDST_VISITED;
220                         }
221
222                         /*
223                         * Place the Proj's to the same block as the
224                         * predecessor Store. This is always ok and prevents
225                         * "non-SSA" form after optimizations if the Proj
226                         * is in a wrong block.
227                         */
228                         blk      = get_nodes_block(node);
229                         pred_blk = get_nodes_block(pred);
230                         if (blk != pred_blk) {
231                                 wenv->changes |= DF_CHANGED;
232                                 set_nodes_block(node, pred_blk);
233                         }
234                 }
235         } else if (op == op_Block) {
236                 int i;
237
238                 for (i = get_Block_n_cfgpreds(node) - 1; i >= 0; --i) {
239                         ir_node      *pred_block;
240                         block_info_t *bl_info;
241
242                         pred = skip_Proj(get_Block_cfgpred(node, i));
243
244                         /* ignore Bad predecessors, they will be removed later */
245                         if (is_Bad(pred))
246                                 continue;
247
248                         pred_block = get_nodes_block(pred);
249                         bl_info    = get_block_info(pred_block, wenv);
250
251                         if (is_fragile_op(pred))
252                                 bl_info->flags |= BLOCK_HAS_EXC;
253                         else if (is_irn_forking(pred))
254                                 bl_info->flags |= BLOCK_HAS_COND;
255
256                         if (get_irn_op(pred) == op_Load || get_irn_op(pred) == op_Store) {
257                                 ldst_info = get_ldst_info(pred, wenv);
258
259                                 wenv->changes |= update_exc(ldst_info, node, i);
260                         }
261                 }
262         }
263 }  /* collect_nodes */
264
265 /**
266  * Returns an entity if the address ptr points to a constant one.
267  *
268  * @param ptr  the address
269  *
270  * @return an entity or NULL
271  */
272 static ir_entity *find_constant_entity(ir_node *ptr)
273 {
274         for (;;) {
275                 ir_op *op = get_irn_op(ptr);
276
277                 if (op == op_SymConst && (get_SymConst_kind(ptr) == symconst_addr_ent)) {
278                         ir_entity *ent = get_SymConst_entity(ptr);
279                         if (variability_constant == get_entity_variability(ent))
280                                 return ent;
281                         return NULL;
282                 } else if (op == op_Sel) {
283                         ir_entity *ent = get_Sel_entity(ptr);
284                         ir_type   *tp  = get_entity_owner(ent);
285
286                         /* Do not fiddle with polymorphism. */
287                         if (is_Class_type(get_entity_owner(ent)) &&
288                                 ((get_entity_n_overwrites(ent)    != 0) ||
289                                 (get_entity_n_overwrittenby(ent) != 0)   ) )
290                                 return NULL;
291
292                         if (is_Array_type(tp)) {
293                                 /* check bounds */
294                                 int i, n;
295
296                                 for (i = 0, n = get_Sel_n_indexs(ptr); i < n; ++i) {
297                                         ir_node *bound;
298                                         tarval *tlower, *tupper;
299                                         ir_node *index = get_Sel_index(ptr, i);
300                                         tarval *tv     = computed_value(index);
301
302                                         /* check if the index is constant */
303                                         if (tv == tarval_bad)
304                                                 return NULL;
305
306                                         bound  = get_array_lower_bound(tp, i);
307                                         tlower = computed_value(bound);
308                                         bound  = get_array_upper_bound(tp, i);
309                                         tupper = computed_value(bound);
310
311                                         if (tlower == tarval_bad || tupper == tarval_bad)
312                                                 return NULL;
313
314                                         if (tarval_cmp(tv, tlower) & pn_Cmp_Lt)
315                                                 return NULL;
316                                         if (tarval_cmp(tupper, tv) & pn_Cmp_Lt)
317                                                 return NULL;
318
319                                         /* ok, bounds check finished */
320                                 }
321                         }
322
323                         if (variability_constant == get_entity_variability(ent))
324                                 return ent;
325
326                         /* try next */
327                         ptr = get_Sel_ptr(ptr);
328                 } else
329                         return NULL;
330         }
331 }  /* find_constant_entity */
332
333 /**
334  * Return the Selection index of a Sel node from dimension n
335  */
336 static long get_Sel_array_index_long(ir_node *n, int dim) {
337         ir_node *index = get_Sel_index(n, dim);
338         assert(get_irn_op(index) == op_Const);
339         return get_tarval_long(get_Const_tarval(index));
340 }  /* get_Sel_array_index_long */
341
342 /**
343  * Returns the accessed component graph path for an
344  * node computing an address.
345  *
346  * @param ptr    the node computing the address
347  * @param depth  current depth in steps upward from the root
348  *               of the address
349  */
350 static compound_graph_path *rec_get_accessed_path(ir_node *ptr, int depth) {
351         compound_graph_path *res = NULL;
352         ir_entity           *root, *field;
353         int                 path_len, pos;
354
355         if (get_irn_op(ptr) == op_SymConst) {
356                 /* a SymConst. If the depth is 0, this is an access to a global
357                  * entity and we don't need a component path, else we know
358                  * at least it's length.
359                  */
360                 assert(get_SymConst_kind(ptr) == symconst_addr_ent);
361                 root = get_SymConst_entity(ptr);
362                 res = (depth == 0) ? NULL : new_compound_graph_path(get_entity_type(root), depth);
363         } else {
364                 assert(get_irn_op(ptr) == op_Sel);
365                 /* it's a Sel, go up until we find the root */
366                 res = rec_get_accessed_path(get_Sel_ptr(ptr), depth+1);
367
368                 /* fill up the step in the path at the current position */
369                 field    = get_Sel_entity(ptr);
370                 path_len = get_compound_graph_path_length(res);
371                 pos      = path_len - depth - 1;
372                 set_compound_graph_path_node(res, pos, field);
373
374                 if (is_Array_type(get_entity_owner(field))) {
375                         assert(get_Sel_n_indexs(ptr) == 1 && "multi dim arrays not implemented");
376                         set_compound_graph_path_array_index(res, pos, get_Sel_array_index_long(ptr, 0));
377                 }
378         }
379         return res;
380 }  /* rec_get_accessed_path */
381
382 /** Returns an access path or NULL.  The access path is only
383  *  valid, if the graph is in phase_high and _no_ address computation is used.
384  */
385 static compound_graph_path *get_accessed_path(ir_node *ptr) {
386         return rec_get_accessed_path(ptr, 0);
387 }  /* get_accessed_path */
388
389 /* forward */
390 static void reduce_adr_usage(ir_node *ptr);
391
392 /**
393  * Update a Load that may lost it's usage.
394  */
395 static void handle_load_update(ir_node *load) {
396         ldst_info_t *info = get_irn_link(load);
397
398         /* do NOT touch volatile loads for now */
399         if (get_Load_volatility(load) == volatility_is_volatile)
400                 return;
401
402         if (! info->projs[pn_Load_res] && ! info->projs[pn_Load_X_except]) {
403                 ir_node *ptr = get_Load_ptr(load);
404                 ir_node *mem = get_Load_mem(load);
405
406                 /* a Load which value is neither used nor exception checked, remove it */
407                 exchange(info->projs[pn_Load_M], mem);
408                 exchange(load, new_Bad());
409                 reduce_adr_usage(ptr);
410         }
411 }  /* handle_load_update */
412
413 /**
414  * A Use of an address node is vanished. Check if this was a Proj
415  * node and update the counters.
416  */
417 static void reduce_adr_usage(ir_node *ptr) {
418         if (is_Proj(ptr)) {
419                 if (get_irn_n_edges(ptr) <= 0) {
420                         /* this Proj is dead now */
421                         ir_node *pred = get_Proj_pred(ptr);
422
423                         if (is_Load(pred)) {
424                                 ldst_info_t *info = get_irn_link(pred);
425                                 info->projs[get_Proj_proj(ptr)] = NULL;
426
427                                 /* this node lost it's result proj, handle that */
428                                 handle_load_update(pred);
429                         }
430                 }
431         }
432 }  /* reduce_adr_usage */
433
434 /**
435  * Follow the memory chain as long as there are only Loads
436  * and alias free Stores and try to replace current Load or Store
437  * by a previous ones.
438  * Note that in unreachable loops it might happen that we reach
439  * load again, as well as we can fall into a cycle.
440  * We break such cycles using a special visited flag.
441  *
442  * INC_MASTER() must be called before dive into
443  */
444 static unsigned follow_Mem_chain(ir_node *load, ir_node *curr) {
445         unsigned res = 0;
446         ldst_info_t *info = get_irn_link(load);
447         ir_node *pred;
448         ir_node *ptr       = get_Load_ptr(load);
449         ir_node *mem       = get_Load_mem(load);
450         ir_mode *load_mode = get_Load_mode(load);
451
452         for (pred = curr; load != pred; ) {
453                 ldst_info_t *pred_info = get_irn_link(pred);
454
455                 /*
456                  * BEWARE: one might think that checking the modes is useless, because
457                  * if the pointers are identical, they refer to the same object.
458                  * This is only true in strong typed languages, not in C were the following
459                  * is possible a = *(ir_type1 *)p; b = *(ir_type2 *)p ...
460                  */
461                 if (get_irn_op(pred) == op_Store && get_Store_ptr(pred) == ptr &&
462                         get_irn_mode(get_Store_value(pred)) == load_mode) {
463                         /*
464                          * a Load immediately after a Store -- a read after write.
465                          * We may remove the Load, if both Load & Store does not have an exception handler
466                          * OR they are in the same block. In the latter case the Load cannot
467                          * throw an exception when the previous Store was quiet.
468                          *
469                          * Why we need to check for Store Exception? If the Store cannot
470                          * be executed (ROM) the exception handler might simply jump into
471                          * the load block :-(
472                          * We could make it a little bit better if we would know that the exception
473                          * handler of the Store jumps directly to the end...
474                          */
475                         if ((!pred_info->projs[pn_Store_X_except] && !info->projs[pn_Load_X_except]) ||
476                             get_nodes_block(load) == get_nodes_block(pred)) {
477                                 ir_node *value = get_Store_value(pred);
478
479                                 DBG_OPT_RAW(load, value);
480                                 if (info->projs[pn_Load_M])
481                                         exchange(info->projs[pn_Load_M], mem);
482
483                                 /* no exception */
484                                 if (info->projs[pn_Load_X_except]) {
485                                         exchange( info->projs[pn_Load_X_except], new_Bad());
486                                         res |= CF_CHANGED;
487                                 }
488
489                                 if (info->projs[pn_Load_res])
490                                         exchange(info->projs[pn_Load_res], value);
491
492                                 exchange(load, new_Bad());
493                                 reduce_adr_usage(ptr);
494                                 return res | DF_CHANGED;
495                         }
496                 } else if (get_irn_op(pred) == op_Load && get_Load_ptr(pred) == ptr &&
497                            get_Load_mode(pred) == load_mode) {
498                         /*
499                          * a Load after a Load -- a read after read.
500                          * We may remove the second Load, if it does not have an exception handler
501                          * OR they are in the same block. In the later case the Load cannot
502                          * throw an exception when the previous Load was quiet.
503                          *
504                          * Here, there is no need to check if the previous Load has an exception
505                          * hander because they would have exact the same exception...
506                          */
507                         if (! info->projs[pn_Load_X_except] || get_nodes_block(load) == get_nodes_block(pred)) {
508                                 DBG_OPT_RAR(load, pred);
509
510                                 if (pred_info->projs[pn_Load_res]) {
511                                         /* we need a data proj from the previous load for this optimization */
512                                         if (info->projs[pn_Load_res])
513                                                 exchange(info->projs[pn_Load_res], pred_info->projs[pn_Load_res]);
514
515                                         if (info->projs[pn_Load_M])
516                                                 exchange(info->projs[pn_Load_M], mem);
517                                 } else {
518                                         if (info->projs[pn_Load_res]) {
519                                                 set_Proj_pred(info->projs[pn_Load_res], pred);
520                                                 set_nodes_block(info->projs[pn_Load_res], get_nodes_block(pred));
521                                                 pred_info->projs[pn_Load_res] = info->projs[pn_Load_res];
522                                         }
523                                         if (info->projs[pn_Load_M]) {
524                                                 /* Actually, this if should not be necessary.  Construct the Loads
525                                                 properly!!! */
526                                                 exchange(info->projs[pn_Load_M], mem);
527                                         }
528                                 }
529
530                                 /* no exception */
531                                 if (info->projs[pn_Load_X_except]) {
532                                         exchange(info->projs[pn_Load_X_except], new_Bad());
533                                         res |= CF_CHANGED;
534                                 }
535
536                                 exchange(load, new_Bad());
537                                 reduce_adr_usage(ptr);
538                                 return res |= DF_CHANGED;
539                         }
540                 }
541
542                 if (get_irn_op(pred) == op_Store) {
543                         /* check if we can pass thru this store */
544                         ir_alias_relation rel = get_alias_relation(
545                                 current_ir_graph,
546                                 get_Store_ptr(pred),
547                                 get_irn_mode(get_Store_value(pred)),
548                                 ptr, load_mode, opt_non_opt);
549                         /* if the might be an alias, we cannot pass this Store */
550                         if (rel != no_alias)
551                                 break;
552                         pred = skip_Proj(get_Store_mem(pred));
553                 } else if (get_irn_op(pred) == op_Load) {
554                         pred = skip_Proj(get_Load_mem(pred));
555                 } else {
556                         /* follow only Load chains */
557                         break;
558                 }
559
560                 /* check for cycles */
561                 if (NODE_VISITED(pred_info))
562                         break;
563                 MARK_NODE(pred_info);
564         }
565
566         if (get_irn_op(pred) == op_Sync) {
567                 int i;
568
569                 /* handle all Sync predecessors */
570                 for (i = get_Sync_n_preds(pred) - 1; i >= 0; --i) {
571                         res |= follow_Mem_chain(load, skip_Proj(get_Sync_pred(pred, i)));
572                         if (res)
573                                 break;
574                 }
575         }
576
577         return res;
578 }  /* follow_Mem_chain */
579
580 /**
581  * optimize a Load
582  *
583  * @param load  the Load node
584  */
585 static unsigned optimize_load(ir_node *load)
586 {
587         ldst_info_t *info = get_irn_link(load);
588         ir_node *mem, *ptr, *new_node;
589         ir_entity *ent;
590         unsigned res = 0;
591
592         /* do NOT touch volatile loads for now */
593         if (get_Load_volatility(load) == volatility_is_volatile)
594                 return 0;
595
596         /* the address of the load to be optimized */
597         ptr = get_Load_ptr(load);
598
599         /*
600          * Check if we can remove the exception from a Load:
601          * This can be done, if the address is from an Sel(Alloc) and
602          * the Sel type is a subtype of the allocated type.
603          *
604          * This optimizes some often used OO constructs,
605          * like x = new O; x->t;
606          */
607         if (info->projs[pn_Load_X_except]) {
608                 if (is_Sel(ptr)) {
609                         ir_node *mem = get_Sel_mem(ptr);
610
611                         /* FIXME: works with the current FE, but better use the base */
612                         if (get_irn_op(skip_Proj(mem)) == op_Alloc) {
613                                 /* ok, check the types */
614                                 ir_entity *ent    = get_Sel_entity(ptr);
615                                 ir_type   *s_type = get_entity_type(ent);
616                                 ir_type   *a_type = get_Alloc_type(mem);
617
618                                 if (is_SubClass_of(s_type, a_type)) {
619                                         /* ok, condition met: there can't be an exception because
620                                         * Alloc guarantees that enough memory was allocated */
621
622                                         exchange(info->projs[pn_Load_X_except], new_Bad());
623                                         info->projs[pn_Load_X_except] = NULL;
624                                         res |= CF_CHANGED;
625                                 }
626                         }
627                 } else if ((get_irn_op(skip_Proj(ptr)) == op_Alloc) ||
628                         ((get_irn_op(ptr) == op_Cast) && (get_irn_op(skip_Proj(get_Cast_op(ptr))) == op_Alloc))) {
629                                 /* simple case: a direct load after an Alloc. Firm Alloc throw
630                                  * an exception in case of out-of-memory. So, there is no way for an
631                                  * exception in this load.
632                                  * This code is constructed by the "exception lowering" in the Jack compiler.
633                                  */
634                                 exchange(info->projs[pn_Load_X_except], new_Bad());
635                                 info->projs[pn_Load_X_except] = NULL;
636                                 res |= CF_CHANGED;
637                 }
638         }
639
640         /* The mem of the Load. Must still be returned after optimization. */
641         mem  = get_Load_mem(load);
642
643         if (! info->projs[pn_Load_res] && ! info->projs[pn_Load_X_except]) {
644                 /* a Load which value is neither used nor exception checked, remove it */
645                 exchange(info->projs[pn_Load_M], mem);
646
647                 exchange(load, new_Bad());
648                 reduce_adr_usage(ptr);
649                 return res | DF_CHANGED;
650         }
651
652         /* Load from a constant polymorphic field, where we can resolve
653            polymorphism. */
654         new_node = transform_node_Load(load);
655         if (new_node != load) {
656                 if (info->projs[pn_Load_M]) {
657                         exchange(info->projs[pn_Load_M], mem);
658                         info->projs[pn_Load_M] = NULL;
659                 }
660                 if (info->projs[pn_Load_X_except]) {
661                         exchange(info->projs[pn_Load_X_except], new_Bad());
662                         info->projs[pn_Load_X_except] = NULL;
663                 }
664                 if (info->projs[pn_Load_res])
665                         exchange(info->projs[pn_Load_res], new_node);
666
667                 exchange(load, new_Bad());
668                 reduce_adr_usage(ptr);
669                 return res | DF_CHANGED;
670         }
671
672         /* check if we can determine the entity that will be loaded */
673         ent = find_constant_entity(ptr);
674         if (ent) {
675                 if ((allocation_static == get_entity_allocation(ent)) &&
676                         (visibility_external_allocated != get_entity_visibility(ent))) {
677                         /* a static allocation that is not external: there should be NO exception
678                          * when loading. */
679
680                         /* no exception, clear the info field as it might be checked later again */
681                         if (info->projs[pn_Load_X_except]) {
682                                 exchange(info->projs[pn_Load_X_except], new_Bad());
683                                 info->projs[pn_Load_X_except] = NULL;
684                                 res |= CF_CHANGED;
685                         }
686
687                         if (variability_constant == get_entity_variability(ent)
688                                 && is_atomic_entity(ent)) {
689                                 /* Might not be atomic after
690                                    lowering of Sels.  In this
691                                    case we could also load, but
692                                    it's more complicated. */
693                                 /* more simpler case: we load the content of a constant value:
694                                  * replace it by the constant itself
695                                  */
696
697                                 /* no memory */
698                                 if (info->projs[pn_Load_M]) {
699                                         exchange(info->projs[pn_Load_M], mem);
700                                         res |= DF_CHANGED;
701                                 }
702                                 /* no result :-) */
703                                 if (info->projs[pn_Load_res]) {
704                                         if (is_atomic_entity(ent)) {
705                                                 ir_node *c = copy_const_value(get_irn_dbg_info(load), get_atomic_ent_value(ent));
706
707                                                 DBG_OPT_RC(load, c);
708                                                 exchange(info->projs[pn_Load_res], c);
709                                                 res |= DF_CHANGED;
710                                         }
711                                 }
712                                 exchange(load, new_Bad());
713                                 reduce_adr_usage(ptr);
714                                 return res;
715                         } else if (variability_constant == get_entity_variability(ent)) {
716                                 compound_graph_path *path = get_accessed_path(ptr);
717
718                                 if (path) {
719                                         ir_node *c;
720
721                                         assert(is_proper_compound_graph_path(path, get_compound_graph_path_length(path)-1));
722                                         /*
723                                         {
724                                                 int j;
725                                                 for (j = 0; j < get_compound_graph_path_length(path); ++j) {
726                                                         ir_entity *node = get_compound_graph_path_node(path, j);
727                                                         fprintf(stdout, ".%s", get_entity_name(node));
728                                                         if (is_Array_type(get_entity_owner(node)))
729                                                                 fprintf(stdout, "[%d]", get_compound_graph_path_array_index(path, j));
730                                                 }
731                                                 printf("\n");
732                                         }
733                                         */
734
735                                         c = get_compound_ent_value_by_path(ent, path);
736                                         free_compound_graph_path(path);
737
738                                         /* printf("  cons: "); DDMN(c); */
739
740                                         if (info->projs[pn_Load_M]) {
741                                                 exchange(info->projs[pn_Load_M], mem);
742                                                 res |= DF_CHANGED;
743                                         }
744                                         if (info->projs[pn_Load_res]) {
745                                                 exchange(info->projs[pn_Load_res], copy_const_value(get_irn_dbg_info(load), c));
746                                                 res |= DF_CHANGED;
747                                         }
748                                         exchange(load, new_Bad());
749                                         reduce_adr_usage(ptr);
750                                         return res;
751                                 } else {
752                                         /*  We can not determine a correct access path.  E.g., in jack, we load
753                                         a byte from an object to generate an exception.   Happens in test program
754                                         Reflectiontest.
755                                         printf(">>>>>>>>>>>>> Found access to constant entity %s in function %s\n", get_entity_name(ent),
756                                         get_entity_name(get_irg_entity(current_ir_graph)));
757                                         printf("  load: "); DDMN(load);
758                                         printf("  ptr:  "); DDMN(ptr);
759                                         */
760                                 }
761                         }
762                 }
763         }
764
765         /* Check, if the address of this load is used more than once.
766          * If not, this load cannot be removed in any case. */
767         if (get_irn_n_uses(ptr) <= 1)
768                 return res;
769
770         /*
771          * follow the memory chain as long as there are only Loads
772          * and try to replace current Load or Store by a previous one.
773          * Note that in unreachable loops it might happen that we reach
774          * load again, as well as we can fall into a cycle.
775          * We break such cycles using a special visited flag.
776          */
777         INC_MASTER();
778         res = follow_Mem_chain(load, skip_Proj(mem));
779         return res;
780 }  /* optimize_load */
781
782 /**
783  * follow the memory chain as long as there are only Loads and alias free Stores.
784  *
785  * INC_MASTER() must be called before dive into
786  */
787 static unsigned follow_Mem_chain_for_Store(ir_node *store, ir_node *curr) {
788         unsigned res = 0;
789         ldst_info_t *info = get_irn_link(store);
790         ir_node *pred;
791         ir_node *ptr = get_Store_ptr(store);
792         ir_node *mem = get_Store_mem(store);
793         ir_node *value = get_Store_value(store);
794         ir_mode *mode  = get_irn_mode(value);
795         ir_node *block = get_nodes_block(store);
796
797         for (pred = curr; pred != store;) {
798                 ldst_info_t *pred_info = get_irn_link(pred);
799
800                 /*
801                  * BEWARE: one might think that checking the modes is useless, because
802                  * if the pointers are identical, they refer to the same object.
803                  * This is only true in strong typed languages, not is C were the following
804                  * is possible *(ir_type1 *)p = a; *(ir_type2 *)p = b ...
805                  */
806                 if (get_irn_op(pred) == op_Store && get_Store_ptr(pred) == ptr &&
807                     get_nodes_block(pred) == block && get_irn_mode(get_Store_value(pred)) == mode) {
808                         /*
809                          * a Store after a Store in the same block -- a write after write.
810                          * We may remove the first Store, if it does not have an exception handler.
811                          *
812                          * TODO: What, if both have the same exception handler ???
813                          */
814                         if (get_Store_volatility(pred) != volatility_is_volatile && !pred_info->projs[pn_Store_X_except]) {
815                                 DBG_OPT_WAW(pred, store);
816                                 exchange( pred_info->projs[pn_Store_M], get_Store_mem(pred) );
817                                 exchange(pred, new_Bad());
818                                 reduce_adr_usage(ptr);
819                                 return DF_CHANGED;
820                         }
821                 } else if (get_irn_op(pred) == op_Load && get_Load_ptr(pred) == ptr &&
822                            value == pred_info->projs[pn_Load_res]) {
823                         /*
824                          * a Store of a value after a Load -- a write after read.
825                          * We may remove the second Store, if it does not have an exception handler.
826                          */
827                         if (! info->projs[pn_Store_X_except]) {
828                                 DBG_OPT_WAR(store, pred);
829                                 exchange( info->projs[pn_Store_M], mem );
830                                 exchange(store, new_Bad());
831                                 reduce_adr_usage(ptr);
832                                 return DF_CHANGED;
833                         }
834                 }
835
836                 if (get_irn_op(pred) == op_Store) {
837                         /* check if we can pass thru this store */
838                         ir_alias_relation rel = get_alias_relation(
839                                 current_ir_graph,
840                                 get_Store_ptr(pred),
841                                 get_irn_mode(get_Store_value(pred)),
842                                 ptr, mode, opt_non_opt);
843                         /* if the might be an alias, we cannot pass this Store */
844                         if (rel != no_alias)
845                                 break;
846                         pred = skip_Proj(get_Store_mem(pred));
847                 } else if (get_irn_op(pred) == op_Load) {
848                         pred = skip_Proj(get_Load_mem(pred));
849                 } else {
850                         /* follow only Load chains */
851                         break;
852                 }
853
854                 /* check for cycles */
855                 if (NODE_VISITED(pred_info))
856                         break;
857                 MARK_NODE(pred_info);
858         }
859
860         if (get_irn_op(pred) == op_Sync) {
861                 int i;
862
863                 /* handle all Sync predecessors */
864                 for (i = get_Sync_n_preds(pred) - 1; i >= 0; --i) {
865                         res |= follow_Mem_chain_for_Store(store, skip_Proj(get_Sync_pred(pred, i)));
866                         if (res)
867                                 break;
868                 }
869         }
870         return res;
871 }  /* follow_Mem_chain_for_Store */
872
873 /**
874  * optimize a Store
875  *
876  * @param store  the Store node
877  */
878 static unsigned optimize_store(ir_node *store) {
879         ir_node *ptr, *mem;
880
881         if (get_Store_volatility(store) == volatility_is_volatile)
882                 return 0;
883
884         ptr = get_Store_ptr(store);
885
886         /* Check, if the address of this Store is used more than once.
887          * If not, this Store cannot be removed in any case. */
888         if (get_irn_n_uses(ptr) <= 1)
889                 return 0;
890
891         mem = get_Store_mem(store);
892
893         /* follow the memory chain as long as there are only Loads */
894         INC_MASTER();
895         return follow_Mem_chain_for_Store(store, skip_Proj(mem));
896 }  /* optimize_store */
897
898 /**
899  * walker, optimizes Phi after Stores to identical places:
900  * Does the following optimization:
901  * @verbatim
902  *
903  *   val1   val2   val3          val1  val2  val3
904  *    |      |      |               \    |    /
905  *  Store  Store  Store              \   |   /
906  *      \    |    /                   PhiData
907  *       \   |   /                       |
908  *        \  |  /                      Store
909  *          PhiM
910  *
911  * @endverbatim
912  * This reduces the number of stores and allows for predicated execution.
913  * Moves Stores back to the end of a function which may be bad.
914  *
915  * This is only possible if the predecessor blocks have only one successor.
916  */
917 static unsigned optimize_phi(ir_node *phi, walk_env_t *wenv)
918 {
919         int i, n;
920         ir_node *store, *old_store, *ptr, *block, *phi_block, *phiM, *phiD, *exc, *projM;
921         ir_mode *mode;
922         ir_node **inM, **inD, **stores;
923         int *idx;
924         dbg_info *db = NULL;
925         ldst_info_t *info;
926         block_info_t *bl_info;
927         unsigned res = 0;
928
929         /* Must be a memory Phi */
930         if (get_irn_mode(phi) != mode_M)
931                 return 0;
932
933         n = get_Phi_n_preds(phi);
934         if (n <= 0)
935                 return 0;
936
937         store = skip_Proj(get_Phi_pred(phi, 0));
938         old_store = store;
939         if (get_irn_op(store) != op_Store)
940                 return 0;
941
942         block = get_nodes_block(store);
943
944         /* abort on dead blocks */
945         if (is_Block_dead(block))
946                 return 0;
947
948         /* check if the block is post dominated by Phi-block
949            and has no exception exit */
950         bl_info = get_irn_link(block);
951         if (bl_info->flags & BLOCK_HAS_EXC)
952                 return 0;
953
954         phi_block = get_nodes_block(phi);
955         if (! block_postdominates(phi_block, block))
956                 return 0;
957
958         /* this is the address of the store */
959         ptr  = get_Store_ptr(store);
960         mode = get_irn_mode(get_Store_value(store));
961         info = get_irn_link(store);
962         exc  = info->exc_block;
963
964         for (i = 1; i < n; ++i) {
965                 ir_node *pred = skip_Proj(get_Phi_pred(phi, i));
966
967                 if (get_irn_op(pred) != op_Store)
968                         return 0;
969
970                 if (ptr != get_Store_ptr(pred) || mode != get_irn_mode(get_Store_value(pred)))
971                         return 0;
972
973                 info = get_irn_link(pred);
974
975                 /* check, if all stores have the same exception flow */
976                 if (exc != info->exc_block)
977                         return 0;
978
979                 /* abort on dead blocks */
980                 block = get_nodes_block(pred);
981                 if (is_Block_dead(block))
982                         return 0;
983
984                 /* check if the block is post dominated by Phi-block
985                    and has no exception exit. Note that block must be different from
986                    Phi-block, else we would move a Store from end End of a block to its
987                    Start... */
988                 bl_info = get_irn_link(block);
989                 if (bl_info->flags & BLOCK_HAS_EXC)
990                         return 0;
991                 if (block == phi_block || ! block_postdominates(phi_block, block))
992                         return 0;
993         }
994
995         /*
996          * ok, when we are here, we found all predecessors of a Phi that
997          * are Stores to the same address and size. That means whatever
998          * we do before we enter the block of the Phi, we do a Store.
999          * So, we can move the Store to the current block:
1000          *
1001          *   val1    val2    val3          val1  val2  val3
1002          *    |       |       |               \    |    /
1003          * | Str | | Str | | Str |             \   |   /
1004          *      \     |     /                   PhiData
1005          *       \    |    /                       |
1006          *        \   |   /                       Str
1007          *           PhiM
1008          *
1009          * Is only allowed if the predecessor blocks have only one successor.
1010          */
1011
1012         NEW_ARR_A(ir_node *, stores, n);
1013         NEW_ARR_A(ir_node *, inM, n);
1014         NEW_ARR_A(ir_node *, inD, n);
1015         NEW_ARR_A(int, idx, n);
1016
1017         /* Prepare: Collect all Store nodes.  We must do this
1018            first because we otherwise may loose a store when exchanging its
1019            memory Proj.
1020          */
1021         for (i = 0; i < n; ++i)
1022                 stores[i] = skip_Proj(get_Phi_pred(phi, i));
1023
1024         /* Prepare: Skip the memory Proj: we need this in the case some stores
1025            are cascaded.
1026            Beware: One Store might be included more than once in the stores[]
1027            list, so we must prevent to do the exchange more than once.
1028          */
1029         for (i = 0; i < n; ++i) {
1030                 ir_node *store = stores[i];
1031                 ir_node *proj_m;
1032
1033                 info = get_irn_link(store);
1034                 proj_m = info->projs[pn_Store_M];
1035
1036                 if (is_Proj(proj_m) && get_Proj_pred(proj_m) == store)
1037                         exchange(proj_m, get_Store_mem(store));
1038         }
1039
1040         /* first step: collect all inputs */
1041         for (i = 0; i < n; ++i) {
1042                 ir_node *store = stores[i];
1043                 info = get_irn_link(store);
1044
1045                 inM[i] = get_Store_mem(store);
1046                 inD[i] = get_Store_value(store);
1047                 idx[i] = info->exc_idx;
1048         }
1049         block = get_nodes_block(phi);
1050
1051         /* second step: create a new memory Phi */
1052         phiM = new_rd_Phi(get_irn_dbg_info(phi), current_ir_graph, block, n, inM, mode_M);
1053
1054         /* third step: create a new data Phi */
1055         phiD = new_rd_Phi(get_irn_dbg_info(phi), current_ir_graph, block, n, inD, mode);
1056
1057         /* fourth step: create the Store */
1058         store = new_rd_Store(db, current_ir_graph, block, phiM, ptr, phiD);
1059 #ifdef DO_CACHEOPT
1060         co_set_irn_name(store, co_get_irn_ident(old_store));
1061 #endif
1062
1063         projM = new_rd_Proj(NULL, current_ir_graph, block, store, mode_M, pn_Store_M);
1064
1065         info = get_ldst_info(store, wenv);
1066         info->projs[pn_Store_M] = projM;
1067
1068         /* fifths step: repair exception flow */
1069         if (exc) {
1070                 ir_node *projX = new_rd_Proj(NULL, current_ir_graph, block, store, mode_X, pn_Store_X_except);
1071
1072                 info->projs[pn_Store_X_except] = projX;
1073                 info->exc_block                = exc;
1074                 info->exc_idx                  = idx[0];
1075
1076                 for (i = 0; i < n; ++i) {
1077                         set_Block_cfgpred(exc, idx[i], projX);
1078                 }
1079
1080                 if (n > 1) {
1081                         /* the exception block should be optimized as some inputs are identical now */
1082                 }
1083
1084                 res |= CF_CHANGED;
1085         }
1086
1087         /* sixth step: replace old Phi */
1088         exchange(phi, projM);
1089
1090         return res | DF_CHANGED;
1091 }  /* optimize_phi */
1092
1093 /**
1094  * walker, do the optimizations
1095  */
1096 static void do_load_store_optimize(ir_node *n, void *env) {
1097         walk_env_t *wenv = env;
1098
1099         switch (get_irn_opcode(n)) {
1100
1101   case iro_Load:
1102           wenv->changes |= optimize_load(n);
1103           break;
1104
1105   case iro_Store:
1106           wenv->changes |= optimize_store(n);
1107           break;
1108
1109   case iro_Phi:
1110           wenv->changes |= optimize_phi(n, wenv);
1111
1112   default:
1113           ;
1114         }
1115 }  /* do_load_store_optimize */
1116
1117 /*
1118  * do the load store optimization
1119  */
1120 void optimize_load_store(ir_graph *irg) {
1121         walk_env_t env;
1122
1123         assert(get_irg_phase_state(irg) != phase_building);
1124         assert(get_irg_pinned(irg) != op_pin_state_floats &&
1125                 "LoadStore optimization needs pinned graph");
1126
1127         if (! get_opt_redundant_loadstore())
1128                 return;
1129
1130         edges_assure(irg);
1131
1132         /* for Phi optimization post-dominators are needed ... */
1133         assure_postdoms(irg);
1134
1135         if (get_opt_alias_analysis()) {
1136                 assure_irg_address_taken_computed(irg);
1137                 assure_irp_globals_address_taken_computed();
1138         }
1139
1140         obstack_init(&env.obst);
1141         env.changes = 0;
1142
1143         /* init the links, then collect Loads/Stores/Proj's in lists */
1144         master_visited = 0;
1145         irg_walk_graph(irg, firm_clear_link, collect_nodes, &env);
1146
1147         /* now we have collected enough information, optimize */
1148         irg_walk_graph(irg, NULL, do_load_store_optimize, &env);
1149
1150         obstack_free(&env.obst, NULL);
1151
1152         /* Handle graph state */
1153         if (env.changes) {
1154                 if (get_irg_outs_state(irg) == outs_consistent)
1155                         set_irg_outs_inconsistent(irg);
1156         }
1157
1158         if (env.changes & CF_CHANGED) {
1159                 /* is this really needed: Yes, control flow changed, block might
1160                 have Bad() predecessors. */
1161                 set_irg_doms_inconsistent(irg);
1162         }
1163 }  /* optimize_load_store */