new register allocator
[libfirm] / ir / ana / irmemory.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Memory disambiguator
23  * @author   Michael Beck
24  * @date     27.12.2006
25  * @version  $Id$
26  */
27 #include "config.h"
28
29 #include <stdlib.h>
30 #include <stdbool.h>
31
32 #include "adt/pmap.h"
33 #include "irnode_t.h"
34 #include "irgraph_t.h"
35 #include "irprog_t.h"
36 #include "irmemory_t.h"
37 #include "irmemory.h"
38 #include "irflag.h"
39 #include "hashptr.h"
40 #include "irflag.h"
41 #include "irouts.h"
42 #include "irgwalk.h"
43 #include "irprintf.h"
44 #include "debug.h"
45 #include "error.h"
46 #include "typerep.h"
47
48 /** The debug handle. */
49 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
50 DEBUG_ONLY(static firm_dbg_module_t *dbgcall = NULL;)
51
52 /** The source language specific language disambiguator function. */
53 static DISAMBIGUATOR_FUNC language_disambuigator = NULL;
54
55 /** The global memory disambiguator options. */
56 static unsigned global_mem_disamgig_opt = aa_opt_no_opt;
57
58 /* Returns a human readable name for an alias relation. */
59 const char *get_ir_alias_relation_name(ir_alias_relation rel) {
60 #define X(a) case a: return #a
61         switch (rel) {
62         X(ir_no_alias);
63         X(ir_may_alias);
64         X(ir_sure_alias);
65         default: assert(0); return "UNKNOWN";
66         }
67 #undef X
68 }
69
70 /* Get the memory disambiguator options for a graph. */
71 unsigned get_irg_memory_disambiguator_options(ir_graph *irg) {
72         unsigned opt = irg->mem_disambig_opt;
73         if (opt & aa_opt_inherited)
74                 return global_mem_disamgig_opt;
75         return opt;
76 }  /* get_irg_memory_disambiguator_options */
77
78 /*  Set the memory disambiguator options for a graph. */
79 void set_irg_memory_disambiguator_options(ir_graph *irg, unsigned options) {
80         irg->mem_disambig_opt = options & ~aa_opt_inherited;
81 }  /* set_irg_memory_disambiguator_options */
82
83 /* Set the global disambiguator options for all graphs not having local options. */
84 void set_irp_memory_disambiguator_options(unsigned options) {
85         global_mem_disamgig_opt = options;
86 }  /* set_irp_memory_disambiguator_options */
87
88 /**
89  * Find the base address and entity of an Sel node.
90  *
91  * @param sel  the node
92  * @param pEnt after return points to the base entity.
93  *
94  * @return the base address.
95  */
96 static ir_node *find_base_adr(ir_node *sel, ir_entity **pEnt) {
97         ir_node *ptr = get_Sel_ptr(sel);
98
99         while (is_Sel(ptr)) {
100                 sel = ptr;
101                 ptr = get_Sel_ptr(sel);
102         }
103         *pEnt = get_Sel_entity(sel);
104         return ptr;
105 }  /* find_base_adr */
106
107 /**
108  * Check if a given Const node is greater or equal a given size.
109  *
110  * @param cns   a Const node
111  * @param size  a integer size
112  *
113  * @return ir_no_alias if the Const is greater, ir_may_alias else
114  */
115 static ir_alias_relation check_const(ir_node *cns, int size) {
116         tarval *tv = get_Const_tarval(cns);
117         tarval *tv_size;
118
119         if (size == 0)
120                 return tarval_is_null(tv) ? ir_may_alias : ir_no_alias;
121         tv_size = new_tarval_from_long(size, get_tarval_mode(tv));
122         return tarval_cmp(tv_size, tv) & (pn_Cmp_Eq|pn_Cmp_Lt) ? ir_no_alias : ir_may_alias;
123 }  /* check_const */
124
125 /**
126  * Treat idx1 and idx2 as integer indexes and check if they differ always more than size.
127  *
128  * @param idx1  a node representing the first index
129  * @param idx2  a node representing the second index
130  * @param size  an integer size
131  *
132  * @return ir_sure_alias iff idx1 == idx2
133  *         ir_no_alias iff they ALWAYS differ more than size
134  *         ir_may_alias else
135  */
136 static ir_alias_relation different_index(ir_node *idx1, ir_node *idx2, int size) {
137         if (idx1 == idx2)
138                 return ir_sure_alias;
139         if (is_Const(idx1) && is_Const(idx2)) {
140                 /* both are const, we can compare them */
141                 tarval *tv1 = get_Const_tarval(idx1);
142                 tarval *tv2 = get_Const_tarval(idx2);
143                 tarval *tv, *tv_size;
144                 ir_mode *m1, *m2;
145
146                 if (size == 0)
147                         return tv1 == tv2 ? ir_sure_alias : ir_no_alias;
148
149                 /* arg, modes may be different */
150                 m1 = get_tarval_mode(tv1);
151                 m2 = get_tarval_mode(tv2);
152                 if (m1 != m2) {
153                         int size = get_mode_size_bits(m1) - get_mode_size_bits(m2);
154
155                         if (size < 0) {
156                                 /* m1 is a small mode, cast up */
157                                 m1 = mode_is_signed(m1) ? find_signed_mode(m2) : find_unsigned_mode(m2);
158                                 if (m1 == NULL) {
159                                         /* should NOT happen, but if it does we give up here */
160                                         return ir_may_alias;
161                                 }
162                                 tv1 = tarval_convert_to(tv1, m1);
163                         } else if (size > 0) {
164                                 /* m2 is a small mode, cast up */
165                                 m2 = mode_is_signed(m2) ? find_signed_mode(m1) : find_unsigned_mode(m1);
166                                 if (m2 == NULL) {
167                                         /* should NOT happen, but if it does we give up here */
168                                         return ir_may_alias;
169                                 }
170                                 tv2 = tarval_convert_to(tv2, m2);
171                         }
172                         /* here the size should be identical, check for signed */
173                         if (get_mode_sign(m1) != get_mode_sign(m2)) {
174                                 /* find the signed */
175                                 if (mode_is_signed(m2)) {
176                                         tarval *t = tv1;
177                                         ir_mode *tm = m1;
178                                         tv1 = tv2; m1 = m2;
179                                         tv2 = t;   m2 = tm;
180                                 }
181
182                                 /* m1 is now the signed one */
183                                 if (tarval_cmp(tv1, get_tarval_null(m1)) & (pn_Cmp_Eq|pn_Cmp_Gt)) {
184                                         /* tv1 is signed, but >= 0, simply cast into unsigned */
185                                         tv1 = tarval_convert_to(tv1, m2);
186                                 } else {
187                                         tv_size = new_tarval_from_long(size, m2);
188
189                                         if (tarval_cmp(tv2, tv_size) & (pn_Cmp_Eq|pn_Cmp_Gt)) {
190                                                 /* tv1 is negative and tv2 >= tv_size, so the difference is bigger than size */
191                                                 return ir_no_alias;
192                                         }
193                                         /* tv_size > tv2, so we can subtract without overflow */
194                                         tv2 = tarval_sub(tv_size, tv2, NULL);
195
196                                         /* tv1 is < 0, so we can negate it */
197                                         tv1 = tarval_neg(tv1);
198
199                                         /* cast it into unsigned. for two-complement it does the right thing for MIN_INT */
200                                         tv1 = tarval_convert_to(tv1, m2);
201
202                                         /* now we can compare without overflow */
203                                         return tarval_cmp(tv1, tv2) & (pn_Cmp_Eq|pn_Cmp_Gt) ? ir_no_alias : ir_may_alias;
204                                 }
205                         }
206                 }
207                 if (tarval_cmp(tv1, tv2) == pn_Cmp_Gt) {
208                         tarval *t = tv1;
209                         tv1 = tv2;
210                         tv2 = t;
211                 }
212                 /* tv1 is now the "smaller" one */
213                 tv      = tarval_sub(tv2, tv1, NULL);
214                 tv_size = new_tarval_from_long(size, get_tarval_mode(tv));
215                 return tarval_cmp(tv_size, tv) & (pn_Cmp_Eq|pn_Cmp_Lt) ? ir_no_alias : ir_may_alias;
216         }
217
218         /* Note: we rely here on the fact that normalization puts constants on the RIGHT side */
219         if (is_Add(idx1)) {
220                 ir_node *l1 = get_Add_left(idx1);
221                 ir_node *r1 = get_Add_right(idx1);
222
223                 if (l1 == idx2) {
224                         /* x + c == y */
225                         if (is_Const(r1))
226                                 return check_const(r1, size);
227                 }
228                 if (is_Add(idx2)) {
229                         /* both are Adds, check if they are of x + a == x + b kind */
230                         ir_node *l2 = get_Add_left(idx2);
231                         ir_node *r2 = get_Add_right(idx2);
232
233                         if (l1 == l2)
234                                 return different_index(r1, r2, size);
235                         else if (l1 == r2)
236                                 return different_index(r1, l2, size);
237                         else if (r1 == r2)
238                                 return different_index(l1, l2, size);
239                         else if (r1 == l2)
240                                 return different_index(l1, r2, size);
241                 }
242         }
243         if (is_Add(idx2)) {
244                 ir_node *l2 = get_Add_left(idx2);
245                 ir_node *r2 = get_Add_right(idx2);
246
247                 if (l2 == idx1) {
248                         /* x + c == y */
249                         if (is_Const(r2))
250                                 return check_const(r2, size);
251                 }
252         }
253
254         if (is_Sub(idx1)) {
255                 ir_node *l1 = get_Sub_left(idx1);
256                 ir_node *r1 = get_Sub_right(idx1);
257
258                 if (l1 == idx2) {
259                         /* x - c == y */
260                         if (is_Const(r1))
261                                 return check_const(r1, size);
262                 }
263
264                 if (is_Sub(idx2)) {
265                         /* both are Subs, check if they are of x - a == x - b kind */
266                         ir_node *l2 = get_Sub_left(idx2);
267
268                         if (l1 == l2) {
269                                 ir_node *r2 = get_Sub_right(idx2);
270                                 return different_index(r1, r2, size);
271                         }
272                 }
273         }
274         if (is_Sub(idx2)) {
275                 ir_node *l2 = get_Sub_left(idx2);
276                 ir_node *r2 = get_Sub_right(idx2);
277
278                 if (l2 == idx1) {
279                         /* x - c == y */
280                         if (is_Const(r2))
281                                 return check_const(r2, size);
282                 }
283
284         }
285         return ir_may_alias;
286 }  /* different_index */
287
288 /**
289  * Two Sel addresses have the same base address, check if there offsets are
290  * different.
291  *
292  * @param adr1  The first address.
293  * @param adr2  The second address.
294  */
295 static ir_alias_relation different_sel_offsets(ir_node *sel1, ir_node *sel2) {
296         /* seems to be broken */
297         (void) sel1;
298         (void) sel2;
299 #if 0
300         ir_entity *ent1 = get_Sel_entity(sel1);
301         ir_entity *ent2 = get_Sel_entity(sel2);
302         int i, check_arr = 0;
303
304         if (ent1 == ent2)
305                 check_arr = 1;
306         else {
307                 ir_type *tp1 = get_entity_type(ent1);
308                 ir_type *tp2 = get_entity_type(ent2);
309
310                 if (tp1 == tp2)
311                         check_arr = 1;
312                 else if (get_type_state(tp1) == layout_fixed && get_type_state(tp2) == layout_fixed &&
313                          get_type_size_bits(tp1) == get_type_size_bits(tp2))
314                         check_arr = 1;
315         }
316         if (check_arr) {
317                 /* we select an entity of same size, check for indexes */
318                 int n = get_Sel_n_indexs(sel1);
319                 int have_no = 0;
320
321                 if (n > 0 && n == get_Sel_n_indexs(sel2)) {
322                         /* same non-zero number of indexes, an array access, check */
323                         for (i = 0; i < n; ++i) {
324                                 ir_node *idx1 = get_Sel_index(sel1, i);
325                                 ir_node *idx2 = get_Sel_index(sel2, i);
326                                 ir_alias_relation res = different_index(idx1, idx2, 0); /* we can safely IGNORE the size here if it's at least >0 */
327
328                                 if (res == may_alias)
329                                         return may_alias;
330                                 else if (res == no_alias)
331                                         have_no = 1;
332                         }
333                         /* if we have at least one no_alias, there is no alias relation, else we have sure */
334                         return have_no > 0 ? no_alias : sure_alias;
335                 }
336         }
337 #else
338         (void) different_index;
339 #endif
340         return ir_may_alias;
341 }  /* different_sel_offsets */
342
343 /**
344  * Determine the alias relation by checking if adr1 and adr2 are pointer
345  * to different type.
346  *
347  * @param adr1    The first address.
348  * @param adr2    The second address.
349  */
350 static ir_alias_relation different_types(ir_node *adr1, ir_node *adr2)
351 {
352         ir_entity *ent1 = NULL, *ent2 = NULL;
353
354         if (is_Global(adr1))
355                 ent1 = get_Global_entity(adr1);
356         else if (is_Sel(adr1))
357                 ent1 = get_Sel_entity(adr1);
358
359         if (is_Global(adr2))
360                 ent2 = get_Global_entity(adr2);
361         else if (is_Sel(adr2))
362                 ent2 = get_Sel_entity(adr2);
363
364         if (ent1 != NULL && ent2 != NULL) {
365                 ir_type *tp1 = get_entity_type(ent1);
366                 ir_type *tp2 = get_entity_type(ent2);
367
368                 if (tp1 != tp2) {
369                         /* do deref until no pointer types are found */
370                         while (is_Pointer_type(tp1) && is_Pointer_type(tp2)) {
371                                 tp1 = get_pointer_points_to_type(tp1);
372                                 tp2 = get_pointer_points_to_type(tp2);
373                         }
374
375                         if (get_type_tpop(tp1) != get_type_tpop(tp2)) {
376                                 /* different type structure */
377                                 return ir_no_alias;
378                         }
379                         if (is_Class_type(tp1)) {
380                                 /* check class hierarchy */
381                                 if (! is_SubClass_of(tp1, tp2) &&
382                                         ! is_SubClass_of(tp2, tp1))
383                                         return ir_no_alias;
384                         } else {
385                                 /* different types */
386                                 return ir_no_alias;
387                         }
388                 }
389         }
390         return ir_may_alias;
391 }  /* different_types */
392
393 /**
394  * Returns non-zero if a node is a result on a malloc-like routine.
395  *
396  * @param node  the Proj node to test
397  */
398 static int is_malloc_Result(ir_node *node) {
399         node = get_Proj_pred(node);
400         if (! is_Proj(node))
401                 return 0;
402         node = get_Proj_pred(node);
403         if (! is_Call(node))
404                 return 0;
405         node = get_Call_ptr(node);
406         if (is_Global(node)) {
407                 ir_entity *ent = get_Global_entity(node);
408
409                 if (get_entity_additional_properties(ent) & mtp_property_malloc)
410                         return 1;
411                 return 0;
412         }
413         return 0;
414 }  /* is_malloc_Result */
415
416 /**
417  * Classify a base pointer.
418  *
419  * @param irg  the graph of the pointer
420  * @param irn  the node representing the base address
421  * @param ent  the base entity of the base address iff any
422  */
423 ir_storage_class_class_t classify_pointer(ir_graph *irg, ir_node *irn, ir_entity *ent)
424 {
425         ir_storage_class_class_t res = ir_sc_pointer;
426         if (is_Global(irn)) {
427                 ir_entity *entity = get_Global_entity(irn);
428                 res = ir_sc_globalvar;
429                 if (! (get_entity_usage(entity) & ir_usage_address_taken))
430                         res |= ir_sc_modifier_nottaken;
431         } else if (irn == get_irg_frame(irg)) {
432                 res = ir_sc_localvar;
433                 if (ent != NULL && !(get_entity_usage(ent) & ir_usage_address_taken))
434                         res |= ir_sc_modifier_nottaken;
435         } else if (is_arg_Proj(irn)) {
436                 return ir_sc_argument;
437         } else if (irn == get_irg_tls(irg)) {
438                 res = ir_sc_tls;
439                 if (ent != NULL && !(get_entity_usage(ent) & ir_usage_address_taken))
440                         res |= ir_sc_modifier_nottaken;
441         } else if (is_Proj(irn) && is_malloc_Result(irn)) {
442                 return ir_sc_malloced;
443         } else if (is_Const(irn)) {
444                 return ir_sc_globaladdr;
445         }
446
447         return res;
448 }
449
450 /**
451  * If adr represents a Bitfield Sel, skip it
452  */
453 static ir_node *skip_Bitfield_Sels(ir_node *adr) {
454         if (is_Sel(adr)) {
455                 ir_entity *ent     = get_Sel_entity(adr);
456                 ir_type   *bf_type = get_entity_type(ent);
457
458                 /* is it a bitfield type? */
459                 if (is_Primitive_type(bf_type) && get_primitive_base_type(bf_type) != NULL)
460                         adr = get_Sel_ptr(adr);
461         }
462         return adr;
463 }
464
465 /**
466  * Determine the alias relation between two addresses.
467  *
468  * @param irg    the graph of both memory operations
469  * @param addr1  pointer address of the first memory operation
470  * @param mode1  the mode of the accessed data through addr1
471  * @param addr2  pointer address of the second memory operation
472  * @param mode2  the mode of the accessed data through addr2
473  *
474  * @return found memory relation
475  */
476 static ir_alias_relation _get_alias_relation(
477         ir_graph *irg,
478         ir_node *adr1, ir_mode *mode1,
479         ir_node *adr2, ir_mode *mode2)
480 {
481         ir_entity             *ent1, *ent2;
482         unsigned              options;
483         long                  offset1 = 0;
484         long                  offset2 = 0;
485         ir_node               *base1;
486         ir_node               *base2;
487         ir_node               *orig_adr1 = adr1;
488         ir_node               *orig_adr2 = adr2;
489         unsigned              mode_size;
490         ir_storage_class_class_t class1, class2, mod1, mod2;
491         int                   have_const_offsets;
492
493         if (! get_opt_alias_analysis())
494                 return ir_may_alias;
495
496         if (adr1 == adr2)
497                 return ir_sure_alias;
498
499         options = get_irg_memory_disambiguator_options(irg);
500
501         /* The Armageddon switch */
502         if (options & aa_opt_no_alias)
503                 return ir_no_alias;
504
505         /* do the addresses have constants offsets?
506          *  Note: nodes are normalized to have constants at right inputs,
507          *        sub X, C is normalized to add X, -C
508          */
509         have_const_offsets = 1;
510         while (is_Add(adr1)) {
511                 ir_node *add_right = get_Add_right(adr1);
512                 if (is_Const(add_right) && !mode_is_reference(get_irn_mode(add_right))) {
513                         tarval *tv  = get_Const_tarval(add_right);
514                         offset1    += get_tarval_long(tv);
515                         adr1        = get_Add_left(adr1);
516                 } else if (mode_is_reference(get_irn_mode(add_right))) {
517                         adr1 = add_right;
518                         have_const_offsets = 0;
519                 } else {
520                         adr1 = get_Add_left(adr1);
521                         have_const_offsets = 0;
522                 }
523         }
524         while (is_Add(adr2)) {
525                 ir_node *add_right = get_Add_right(adr2);
526                 if (is_Const(add_right) && !mode_is_reference(get_irn_mode(add_right))) {
527                         tarval *tv  = get_Const_tarval(add_right);
528                         offset2    += get_tarval_long(tv);
529                         adr2        = get_Add_left(adr2);
530                 } else if (mode_is_reference(get_irn_mode(add_right))) {
531                         adr2 = add_right;
532                         have_const_offsets = 0;
533                 } else {
534                         adr2 = get_Add_left(adr2);
535                         have_const_offsets = 0;
536                 }
537         }
538
539         mode_size = get_mode_size_bytes(mode1);
540         if (get_mode_size_bytes(mode2) > mode_size) {
541                 mode_size = get_mode_size_bytes(mode2);
542         }
543
544         /* same base address -> compare offsets if possible.
545          * FIXME: type long is not sufficient for this task ...
546          */
547         if (adr1 == adr2 && have_const_offsets) {
548                 if ((unsigned long)labs(offset2 - offset1) >= mode_size)
549                         return ir_no_alias;
550                 else
551                         return ir_sure_alias;
552         }
553
554         /*
555          * Bitfields can be constructed as Sels from its base address.
556          * As they have different entities, the disambiguator would find that they are
557          * alias free. While this is true for it's values, it is false for the addresses
558          * (strictly speaking, the Sel's are NOT the addresses of the bitfields).
559          * So, skip those bitfield selecting Sel's.
560          */
561         adr1 = skip_Bitfield_Sels(adr1);
562         adr2 = skip_Bitfield_Sels(adr2);
563
564         /* skip Sels */
565         base1 = adr1;
566         base2 = adr2;
567         ent1  = NULL;
568         ent2  = NULL;
569         if (is_Sel(adr1)) {
570                 base1 = find_base_adr(adr1, &ent1);
571         }
572         if (is_Sel(adr2)) {
573                 base2 = find_base_adr(adr2, &ent2);
574         }
575
576         /* same base address -> compare Sel entities */
577         if (base1 == base2 && ent1 != NULL && ent2 != NULL) {
578                 if (ent1 != ent2)
579                         return ir_no_alias;
580                 else if (have_const_offsets)
581                         return different_sel_offsets(adr1, adr2);
582         }
583
584         mod1 = classify_pointer(irg, base1, ent1);
585         mod2 = classify_pointer(irg, base2, ent2);
586
587         class1 = GET_BASE_SC(mod1);
588         class2 = GET_BASE_SC(mod2);
589
590         if (class1 == ir_sc_pointer) {
591                 if (mod2 & ir_sc_modifier_nottaken) {
592                         /* a pointer and an object whose objects was never taken */
593                         return ir_no_alias;
594                 }
595         } else if (class2 == ir_sc_pointer) {
596                 if (mod1 & ir_sc_modifier_nottaken) {
597                         /* a pointer and an object whose objects was never taken */
598                         return ir_no_alias;
599                 }
600         } else if (class1 != class2) {
601                 /* two objects from different memory spaces */
602                 return ir_no_alias;
603         } else {
604                 /* both classes are equal */
605                 if (class1 == ir_sc_globalvar) {
606                         ir_entity *entity1 = get_SymConst_entity(base1);
607                         ir_entity *entity2 = get_SymConst_entity(base2);
608                         if (entity1 != entity2)
609                                 return ir_no_alias;
610
611                         /* for some reason CSE didn't happen yet for the 2 SymConsts... */
612                         return ir_may_alias;
613                 } else if (class1 == ir_sc_globaladdr) {
614                         tarval *tv  = get_Const_tarval(base1);
615                         offset1    += get_tarval_long(tv);
616                         tv          = get_Const_tarval(base2);
617                         offset2    += get_tarval_long(tv);
618
619                         if ((unsigned long)labs(offset2 - offset1) >= mode_size)
620                                 return ir_no_alias;
621                         else
622                                 return ir_sure_alias;
623                 }
624         }
625
626         /* Type based alias analysis */
627         if (options & aa_opt_type_based) {
628                 ir_alias_relation rel;
629
630                 if (options & aa_opt_byte_type_may_alias) {
631                         if (get_mode_size_bits(mode1) == 8 || get_mode_size_bits(mode2) == 8) {
632                                 /* One of the modes address a byte. Assume a ir_may_alias and leave
633                                    the type based check. */
634                                 goto leave_type_based_alias;
635                         }
636                 }
637                 /* cheap check: If the mode sizes did not match, the types MUST be different */
638                 if (get_mode_size_bits(mode1) != get_mode_size_bits(mode2))
639                         return ir_no_alias;
640
641                 /* cheap test: if only one is a reference mode, no alias */
642                 if (mode_is_reference(mode1) != mode_is_reference(mode2))
643                         return ir_no_alias;
644
645                 /* cheap test: if arithmetic is different, no alias */
646                 if (get_mode_arithmetic(mode1) != get_mode_arithmetic(mode2))
647                         return ir_no_alias;
648
649                 /* try rule R5 */
650                 rel = different_types(orig_adr1, orig_adr2);
651                 if (rel != ir_may_alias)
652                         return rel;
653 leave_type_based_alias:;
654         }
655
656         /* do we have a language specific memory disambiguator? */
657         if (language_disambuigator) {
658                 ir_alias_relation rel = (*language_disambuigator)(irg, orig_adr1, mode1, orig_adr2, mode2);
659                 if (rel != ir_may_alias)
660                         return rel;
661         }
662
663         /* access points-to information here */
664         return ir_may_alias;
665 }  /* _get_alias_relation */
666
667 /*
668  * Determine the alias relation between two addresses.
669  */
670 ir_alias_relation get_alias_relation(
671         ir_graph *irg,
672         ir_node *adr1, ir_mode *mode1,
673         ir_node *adr2, ir_mode *mode2)
674 {
675         ir_alias_relation rel = _get_alias_relation(irg, adr1, mode1, adr2, mode2);
676         DB((dbg, LEVEL_1, "alias(%+F, %+F) = %s\n", adr1, adr2, get_ir_alias_relation_name(rel)));
677         return rel;
678 }  /* get_alias_relation */
679
680 /* Set a source language specific memory disambiguator function. */
681 void set_language_memory_disambiguator(DISAMBIGUATOR_FUNC func) {
682         language_disambuigator = func;
683 }  /* set_language_memory_disambiguator */
684
685 /** The result cache for the memory disambiguator. */
686 static set *result_cache = NULL;
687
688 /** An entry in the relation cache. */
689 typedef struct mem_disambig_entry {
690         ir_node           *adr1;    /**< The first address. */
691         ir_node           *adr2;    /**< The second address. */
692         ir_alias_relation result;   /**< The alias relation result. */
693 } mem_disambig_entry;
694
695 #define HASH_ENTRY(adr1, adr2)  (HASH_PTR(adr1) ^ HASH_PTR(adr2))
696
697 /**
698  * Compare two relation cache entries.
699  */
700 static int cmp_mem_disambig_entry(const void *elt, const void *key, size_t size) {
701         const mem_disambig_entry *p1 = elt;
702         const mem_disambig_entry *p2 = key;
703         (void) size;
704
705         return p1->adr1 == p2->adr1 && p1->adr2 == p2->adr2;
706 }  /* cmp_mem_disambig_entry */
707
708 /**
709  * Initialize the relation cache.
710  */
711 void mem_disambig_init(void) {
712         result_cache = new_set(cmp_mem_disambig_entry, 8);
713 }  /* mem_disambig_init */
714
715 /*
716  * Determine the alias relation between two addresses.
717  */
718 ir_alias_relation get_alias_relation_ex(
719         ir_graph *irg,
720         ir_node *adr1, ir_mode *mode1,
721         ir_node *adr2, ir_mode *mode2)
722 {
723         mem_disambig_entry key, *entry;
724
725         ir_fprintf(stderr, "%+F <-> %+F\n", adr1, adr2);
726
727         if (! get_opt_alias_analysis())
728                 return ir_may_alias;
729
730         if (get_irn_opcode(adr1) > get_irn_opcode(adr2)) {
731                 ir_node *t = adr1;
732                 adr1 = adr2;
733                 adr2 = t;
734         }
735
736         key.adr1 = adr1;
737         key.adr2 = adr2;
738         entry = set_find(result_cache, &key, sizeof(key), HASH_ENTRY(adr1, adr2));
739         if (entry)
740                 return entry->result;
741
742         key.result = get_alias_relation(irg, adr1, mode1, adr2, mode2);
743
744         set_insert(result_cache, &key, sizeof(key), HASH_ENTRY(adr1, adr2));
745         return key.result;
746 }  /* get_alias_relation_ex */
747
748 /* Free the relation cache. */
749 void mem_disambig_term(void) {
750         if (result_cache) {
751                 del_set(result_cache);
752                 result_cache = NULL;
753         }
754 }  /* mem_disambig_term */
755
756 /**
757  * Check the mode of a Load/Store with the mode of the entity
758  * that is accessed.
759  * If the mode of the entity and the Load/Store mode do not match, we
760  * have the bad reinterpret case:
761  *
762  * int i;
763  * char b = *(char *)&i;
764  *
765  * We do NOT count this as one value and return address_taken
766  * in that case.
767  * However, we support an often used case. If the mode is two-complement
768  * we allow casts between signed/unsigned.
769  *
770  * @param mode     the mode of the Load/Store
771  * @param ent_mode the mode of the accessed entity
772  *
773  * @return non-zero if the Load/Store is a hidden cast, zero else
774  */
775 static int is_hidden_cast(ir_mode *mode, ir_mode *ent_mode) {
776         if (ent_mode == NULL)
777                 return false;
778
779         if (ent_mode != mode) {
780                 if (ent_mode == NULL ||
781                         get_mode_size_bits(ent_mode) != get_mode_size_bits(mode) ||
782                         get_mode_sort(ent_mode) != get_mode_sort(mode) ||
783                         get_mode_arithmetic(ent_mode) != irma_twos_complement ||
784                         get_mode_arithmetic(mode) != irma_twos_complement)
785                         return true;
786         }
787         return false;
788 }  /* is_hidden_cast */
789
790 /**
791  * Determine the usage state of a node (or its successor Sels).
792  *
793  * @param irn  the node
794  */
795 static ir_entity_usage determine_entity_usage(const ir_node *irn, ir_entity *entity) {
796         int       i;
797         ir_mode   *emode, *mode;
798         ir_node   *value;
799         ir_type   *tp;
800         ir_entity_usage res = 0;
801
802         for (i = get_irn_n_outs(irn) - 1; i >= 0; --i) {
803                 ir_node *succ = get_irn_out(irn, i);
804
805                 switch (get_irn_opcode(succ)) {
806                 case iro_Load:
807                         /* beware: irn might be a Id node here, so irn might be not
808                            equal to get_Load_ptr(succ) */
809                         res |= ir_usage_read;
810
811                         /* check if this load is not a hidden conversion */
812                         mode  = get_Load_mode(succ);
813                         emode = get_type_mode(get_entity_type(entity));
814                         if (is_hidden_cast(mode, emode))
815                                 res |= ir_usage_reinterpret_cast;
816                         break;
817
818                 case iro_Store:
819                         /* check that the node is not the Store's value */
820                         if (irn == get_Store_value(succ)) {
821                                 res |= ir_usage_unknown;
822                         }
823                         if (irn == get_Store_ptr(succ)) {
824                                 res |= ir_usage_write;
825
826                                 /* check if this Store is not a hidden conversion */
827                                 value = get_Store_value(succ);
828                                 mode  = get_irn_mode(value);
829                                 emode = get_type_mode(get_entity_type(entity));
830                                 if (is_hidden_cast(mode, emode))
831                                         res |= ir_usage_reinterpret_cast;
832                         }
833                         assert(irn != get_Store_mem(succ));
834                         break;
835
836                 case iro_CopyB:
837                         /* CopyB are like Loads/Stores */
838                         tp  = get_entity_type(entity);
839                         if (tp != get_CopyB_type(succ)) {
840                                 /* bad, different types, might be a hidden conversion */
841                                 res |= ir_usage_reinterpret_cast;
842                         }
843                         if (irn == get_CopyB_dst(succ)) {
844                                 res |= ir_usage_write;
845                         } else {
846                                 assert(irn == get_CopyB_src(succ));
847                                 res |= ir_usage_read;
848                         }
849                         break;
850
851                 case iro_Add:
852                 case iro_Sub:
853                         /* Check the successor of irn. */
854                         res |= determine_entity_usage(succ, entity);
855                         break;
856                 case iro_Sel: {
857                         ir_entity *entity = get_Sel_entity(succ);
858                         /* this analyis can't handle unions correctly */
859                         if (is_Union_type(get_entity_owner(entity))) {
860                                 res |= ir_usage_unknown;
861                                 break;
862                         }
863                         /* Check the successor of irn. */
864                         res |= determine_entity_usage(succ, entity);
865                         break;
866                 }
867
868                 case iro_Call:
869                         if (irn == get_Call_ptr(succ)) {
870                                 /* TODO: we could check for reinterpret casts here...
871                                  * But I doubt anyone is interested in that bit for
872                                  * function entities and I'm too lazy to write the code now.
873                                  */
874                                 res |= ir_usage_read;
875                         } else {
876                                 assert(irn != get_Call_mem(succ));
877                                 res |= ir_usage_unknown;
878                         }
879                         break;
880
881                 /* skip identities */
882                 case iro_Id:
883                         res |= determine_entity_usage(succ, entity);
884                         break;
885
886                 /* skip tuples */
887                 case iro_Tuple: {
888                         int input_nr;
889                         for (input_nr = get_Tuple_n_preds(succ) - 1; input_nr >= 0;
890                                         --input_nr) {
891                                 ir_node *pred = get_Tuple_pred(succ, input_nr);
892                                 if (pred == irn) {
893                                         int k;
894                                         /* we found one input */
895                                         for (k = get_irn_n_outs(succ) - 1; k >= 0; --k) {
896                                                 ir_node *proj = get_irn_out(succ, k);
897
898                                                 if (is_Proj(proj) && get_Proj_proj(proj) == input_nr) {
899                                                         res |= determine_entity_usage(proj, entity);
900                                                         break;
901                                                 }
902                                         }
903                                 }
904                         }
905                         break;
906                 }
907
908                 default:
909                         /* another op, we don't know anything (we could do more advanced
910                          * things like a dataflow analysis here) */
911                         res |= ir_usage_unknown;
912                         break;
913                 }
914         }
915
916         return res;
917 }
918
919 /**
920  * Update the usage flags of all frame entities.
921  */
922 static void analyse_irg_entity_usage(ir_graph *irg) {
923         ir_type *ft = get_irg_frame_type(irg);
924         ir_node *irg_frame;
925         int i, j, k, static_link_arg;
926
927         /* set initial state to not_taken, as this is the "smallest" state */
928         for (i = get_class_n_members(ft) - 1; i >= 0; --i) {
929                 ir_entity *ent = get_class_member(ft, i);
930
931                 /* methods can only be analyzed globally */
932                 if (! is_method_entity(ent)) {
933                         ir_entity_usage  flags =
934                                 get_entity_stickyness(ent) == stickyness_sticky ? ir_usage_unknown : 0;
935                         set_entity_usage(ent, flags);
936                 }
937         }
938
939         assure_irg_outs(irg);
940
941         irg_frame = get_irg_frame(irg);
942
943         for (i = get_irn_n_outs(irg_frame) - 1; i >= 0; --i) {
944                 ir_node        *succ = get_irn_out(irg_frame, i);
945                 ir_entity      *entity;
946                 ir_entity_usage flags;
947
948             if (!is_Sel(succ))
949                         continue;
950
951                 entity = get_Sel_entity(succ);
952                 flags  = get_entity_usage(entity);
953                 flags |= determine_entity_usage(succ, entity);
954                 set_entity_usage(entity, flags);
955         }
956
957         /* check inner functions accessing outer frame */
958         static_link_arg = 0;
959         for (i = get_class_n_members(ft) - 1; i >= 0; --i) {
960                 ir_entity *ent = get_class_member(ft, i);
961                 ir_graph  *inner_irg;
962                 ir_node   *args;
963
964                 if (! is_method_entity(ent))
965                         continue;
966                 if (get_entity_peculiarity(ent) == peculiarity_description)
967                         continue;
968
969                 inner_irg = get_entity_irg(ent);
970                 assure_irg_outs(inner_irg);
971                 args = get_irg_args(inner_irg);
972                 for (j = get_irn_n_outs(args) - 1; j >= 0; --j) {
973                         ir_node *arg = get_irn_out(args, j);
974
975                         if (get_Proj_proj(arg) == static_link_arg) {
976                                 for (k = get_irn_n_outs(arg) - 1; k >= 0; --k) {
977                                         ir_node *succ = get_irn_out(arg, k);
978
979                                         if (is_Sel(succ)) {
980                                                 ir_entity *entity = get_Sel_entity(succ);
981
982                                                 if (get_entity_owner(entity) == ft) {
983                                                         /* found an access to the outer frame */
984                                                         ir_entity_usage flags;
985
986                                                         flags  = get_entity_usage(entity);
987                                                         flags |= determine_entity_usage(succ, entity);
988                                                         set_entity_usage(entity, flags);
989                                                 }
990                                         }
991                                 }
992                         }
993                 }
994         }
995
996
997         /* now computed */
998         irg->entity_usage_state = ir_entity_usage_computed;
999 }
1000
1001 ir_entity_usage_computed_state get_irg_entity_usage_state(const ir_graph *irg) {
1002         return irg->entity_usage_state;
1003 }
1004
1005 void set_irg_entity_usage_state(ir_graph *irg, ir_entity_usage_computed_state state) {
1006         irg->entity_usage_state = state;
1007 }
1008
1009 void assure_irg_entity_usage_computed(ir_graph *irg) {
1010         if (irg->entity_usage_state != ir_entity_usage_not_computed)
1011                 return;
1012
1013         analyse_irg_entity_usage(irg);
1014 }
1015
1016
1017 /**
1018  * Initialize the entity_usage flag for a global type like type.
1019  */
1020 static void init_entity_usage(ir_type * tp) {
1021         int i;
1022
1023         /* We have to be conservative: All external visible entities are unknown */
1024         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
1025                 ir_entity       *ent  = get_compound_member(tp, i);
1026                 ir_entity_usage flags = ir_usage_none;
1027                 ir_visibility   vis   = get_entity_visibility(ent);
1028
1029                 if (vis == visibility_external_visible   ||
1030                     vis == visibility_external_allocated ||
1031                     get_entity_stickyness(ent) == stickyness_sticky) {
1032                         flags |= ir_usage_unknown;
1033                 }
1034                 set_entity_usage(ent, flags);
1035         }
1036 }
1037
1038 /**
1039  * Mark all entities used in the initializer as unknown usage.
1040  *
1041  * @param initializer  the initializer to check
1042  */
1043 static void check_initializer_nodes(ir_initializer_t *initializer)
1044 {
1045         unsigned i;
1046         ir_node  *n;
1047
1048         switch (initializer->kind) {
1049         case IR_INITIALIZER_CONST:
1050                 /* let's check if it's an address */
1051                 n = initializer->consti.value;
1052                 if (is_Global(n)) {
1053                         ir_entity *ent = get_Global_entity(n);
1054                         set_entity_usage(ent, ir_usage_unknown);
1055                 }
1056                 return;
1057         case IR_INITIALIZER_TARVAL:
1058         case IR_INITIALIZER_NULL:
1059                 return;
1060         case IR_INITIALIZER_COMPOUND:
1061                 for (i = 0; i < initializer->compound.n_initializers; ++i) {
1062                         ir_initializer_t *sub_initializer
1063                                 = initializer->compound.initializers[i];
1064                         check_initializer_nodes(sub_initializer);
1065                 }
1066                 return;
1067         }
1068         panic("invalid initializer found");
1069 }  /* check_initializer_nodes */
1070
1071 /**
1072  * Mark all entities used in the initializer for the given entity as unknown
1073  * usage.
1074  *
1075  * @param ent  the entity
1076  */
1077 static void check_initializer(ir_entity *ent) {
1078         ir_node *n;
1079         int i;
1080
1081         /* do not check uninitialized values */
1082         if (get_entity_variability(ent) == variability_uninitialized)
1083                 return;
1084
1085         /* Beware: Methods are always initialized with "themself". This does not
1086            count as a taken address. */
1087         if (is_Method_type(get_entity_type(ent)))
1088                 return;
1089
1090         if (ent->has_initializer) {
1091                 check_initializer_nodes(ent->attr.initializer);
1092         } else if (is_atomic_entity(ent)) {
1093                 /* let's check if it's an address */
1094                 n = get_atomic_ent_value(ent);
1095                 if (is_Global(n)) {
1096                         ir_entity *ent = get_Global_entity(n);
1097                         set_entity_usage(ent, ir_usage_unknown);
1098                 }
1099         } else {
1100                 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
1101                         n = get_compound_ent_value(ent, i);
1102
1103                         /* let's check if it's an address */
1104                         if (is_Global(n)) {
1105                                 ir_entity *ent = get_Global_entity(n);
1106                                 set_entity_usage(ent, ir_usage_unknown);
1107                         }
1108                 }
1109         }
1110 }  /* check_initializer */
1111
1112
1113 /**
1114  * Mark all entities used in initializers as unknown usage.
1115  *
1116  * @param tp  a compound type
1117  */
1118 static void check_initializers(ir_type *tp) {
1119         int i;
1120
1121         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
1122                 ir_entity *ent = get_compound_member(tp, i);
1123
1124                 check_initializer(ent);
1125         }
1126 }  /* check_initializers */
1127
1128 #ifdef DEBUG_libfirm
1129 /**
1130  * Print the entity usage flags of all entities of a given type for debugging.
1131  *
1132  * @param tp  a compound type
1133  */
1134 static void print_entity_usage_flags(ir_type *tp) {
1135         int i;
1136         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
1137                 ir_entity *ent = get_compound_member(tp, i);
1138                 ir_entity_usage flags = get_entity_usage(ent);
1139
1140                 if (flags == 0)
1141                         continue;
1142                 ir_printf("%+F:", ent);
1143                 if (flags & ir_usage_address_taken)
1144                         printf(" address_taken");
1145                 if (flags & ir_usage_read)
1146                         printf(" read");
1147                 if (flags & ir_usage_write)
1148                         printf(" write");
1149                 if (flags & ir_usage_reinterpret_cast)
1150                         printf(" reinterp_cast");
1151                 printf("\n");
1152         }
1153 }
1154 #endif /* DEBUG_libfirm */
1155
1156 /**
1157  * Post-walker: check for global entity address
1158  */
1159 static void check_global_address(ir_node *irn, void *env) {
1160         ir_node *tls = env;
1161         ir_entity *ent;
1162         ir_entity_usage flags;
1163
1164         if (is_Global(irn)) {
1165                 /* A global. */
1166                 ent = get_Global_entity(irn);
1167         } else if (is_Sel(irn) && get_Sel_ptr(irn) == tls) {
1168                 /* A TLS variable. */
1169                 ent = get_Sel_entity(irn);
1170         } else
1171                 return;
1172
1173         flags = get_entity_usage(ent);
1174         flags |= determine_entity_usage(irn, ent);
1175         set_entity_usage(ent, flags);
1176 }  /* check_global_address */
1177
1178 /**
1179  * Update the entity usage flags of all global entities.
1180  */
1181 static void analyse_irp_globals_entity_usage(void) {
1182         int i;
1183         ir_segment_t s;
1184
1185         for (s = IR_SEGMENT_FIRST; s < IR_SEGMENT_COUNT; ++s) {
1186                 ir_type *type = get_segment_type(s);
1187                 init_entity_usage(type);
1188         }
1189
1190         for (s = IR_SEGMENT_FIRST; s < IR_SEGMENT_COUNT; ++s) {
1191                 ir_type *type = get_segment_type(s);
1192                 check_initializers(type);
1193         }
1194
1195         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1196                 ir_graph *irg = get_irp_irg(i);
1197
1198                 assure_irg_outs(irg);
1199                 irg_walk_graph(irg, NULL, check_global_address, get_irg_tls(irg));
1200         }
1201
1202 #ifdef DEBUG_libfirm
1203         if (firm_dbg_get_mask(dbg) & LEVEL_1) {
1204                 ir_segment_t s;
1205                 for (s = IR_SEGMENT_FIRST; s < IR_SEGMENT_COUNT; ++s) {
1206                         print_entity_usage_flags(get_segment_type(s));
1207                 }
1208         }
1209 #endif /* DEBUG_libfirm */
1210
1211         /* now computed */
1212         irp->globals_entity_usage_state = ir_entity_usage_computed;
1213 }
1214
1215 /* Returns the current address taken state of the globals. */
1216 ir_entity_usage_computed_state get_irp_globals_entity_usage_state(void) {
1217         return irp->globals_entity_usage_state;
1218 }
1219
1220 /* Sets the current address taken state of the graph. */
1221 void set_irp_globals_entity_usage_state(ir_entity_usage_computed_state state) {
1222         irp->globals_entity_usage_state = state;
1223 }
1224
1225 /* Assure that the address taken flag is computed for the globals. */
1226 void assure_irp_globals_entity_usage_computed(void) {
1227         if (irp->globals_entity_usage_state != ir_entity_usage_not_computed)
1228                 return;
1229
1230         analyse_irp_globals_entity_usage();
1231 }
1232
1233 void firm_init_memory_disambiguator(void) {
1234         FIRM_DBG_REGISTER(dbg, "firm.ana.irmemory");
1235         FIRM_DBG_REGISTER(dbgcall, "firm.opt.cc");
1236 }
1237
1238
1239 /** Maps method types to cloned method types. */
1240 static pmap *mtp_map;
1241
1242 /**
1243  * Clone a method type if not already cloned.
1244  *
1245  * @param tp  the type to clone
1246  */
1247 static ir_type *clone_type_and_cache(ir_type *tp) {
1248         static ident *prefix = NULL;
1249         ir_type *res;
1250         pmap_entry *e = pmap_find(mtp_map, tp);
1251
1252         if (e)
1253                 return e->value;
1254
1255         if (prefix == NULL)
1256                 prefix = new_id_from_chars("C", 1);
1257
1258         res = clone_type_method(tp, prefix);
1259         pmap_insert(mtp_map, tp, res);
1260         DB((dbgcall, LEVEL_2, "cloned type %+F into %+F\n", tp, res));
1261
1262         return res;
1263 }  /* clone_type_and_cache */
1264
1265 /**
1266  * Walker: clone all call types of Calls to methods having the
1267  * mtp_property_private property set.
1268  */
1269 static void update_calls_to_private(ir_node *call, void *env) {
1270         (void) env;
1271         if (is_Call(call)) {
1272                 ir_node *ptr = get_Call_ptr(call);
1273
1274                 if (is_SymConst(ptr)) {
1275                         ir_entity *ent = get_SymConst_entity(ptr);
1276                         ir_type *ctp = get_Call_type(call);
1277
1278                         if (get_entity_additional_properties(ent) & mtp_property_private) {
1279                                 if ((get_method_additional_properties(ctp) & mtp_property_private) == 0) {
1280                                         ctp = clone_type_and_cache(ctp);
1281                                         set_method_additional_property(ctp, mtp_property_private);
1282                                         set_Call_type(call, ctp);
1283                                         DB((dbgcall, LEVEL_1, "changed call to private method %+F\n", ent));
1284                                 }
1285                         }
1286                 }
1287         }
1288 }  /* update_calls_to_private */
1289
1290 /* Mark all private methods, i.e. those of which all call sites are known. */
1291 void mark_private_methods(void) {
1292         int i;
1293         int changed = 0;
1294
1295         assure_irp_globals_entity_usage_computed();
1296
1297         mtp_map = pmap_create();
1298
1299         /* first step: change the calling conventions of the local non-escaped entities */
1300         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1301                 ir_graph        *irg   = get_irp_irg(i);
1302                 ir_entity       *ent   = get_irg_entity(irg);
1303                 ir_entity_usage  flags = get_entity_usage(ent);
1304
1305                 /* If an entity is sticky, it might be called from external
1306                    places (like inline assembler), so do NOT mark it as private. */
1307                 if (get_entity_visibility(ent) == visibility_local &&
1308                     !(flags & ir_usage_address_taken) &&
1309                     get_entity_stickyness(ent) != stickyness_sticky) {
1310                         ir_type *mtp = get_entity_type(ent);
1311
1312                         set_entity_additional_property(ent, mtp_property_private);
1313                         DB((dbgcall, LEVEL_1, "found private method %+F\n", ent));
1314                         if ((get_method_additional_properties(mtp) & mtp_property_private) == 0) {
1315                                 /* need a new type */
1316                                 mtp = clone_type_and_cache(mtp);
1317                                 set_entity_type(ent, mtp);
1318                                 set_method_additional_property(mtp, mtp_property_private);
1319                                 changed = 1;
1320                         }
1321                 }
1322         }
1323
1324         if (changed)
1325                 all_irg_walk(NULL, update_calls_to_private, NULL);
1326
1327         pmap_destroy(mtp_map);
1328 }  /* mark_private_methods */