0cc2913ffe5e81cfba25bae81bf52b7e73ed1854
[libfirm] / ir / ana / irmemory.c
1 /*
2  * Copyright (C) 1995-2007 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 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <stdlib.h>
32
33 #include "irnode_t.h"
34 #include "irgraph_t.h"
35 #include "irprog_t.h"
36 #include "irmemory.h"
37 #include "irflag.h"
38 #include "hashptr.h"
39 #include "irflag.h"
40 #include "irouts.h"
41 #include "irgwalk.h"
42 #include "irprintf.h"
43 #include "debug.h"
44
45 /** The debug handle. */
46 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
47
48 /** The source language specific language disambiguator function. */
49 static DISAMBIGUATOR_FUNC language_disambuigator = NULL;
50
51 /** The global memory disambiguator options. */
52 static unsigned global_mem_disamgig_opt = aa_opt_no_opt;
53
54 /* Get the memory disambiguator options for a graph. */
55 unsigned get_irg_memory_disambiguator_options(ir_graph *irg) {
56         unsigned opt = irg->mem_disambig_opt;
57         if (opt & aa_opt_inherited)
58                 return global_mem_disamgig_opt;
59         return opt;
60 }  /* get_irg_memory_disambiguator_options */
61
62 /*  Set the memory disambiguator options for a graph. */
63 void set_irg_memory_disambiguator_options(ir_graph *irg, unsigned options) {
64         irg->mem_disambig_opt = options & ~aa_opt_inherited;
65 }  /* set_irg_memory_disambiguator_options */
66
67 /* Set the global disambiguator options for all graphs not having local options. */
68 void set_irp_memory_disambiguator_options(unsigned options) {
69         global_mem_disamgig_opt = options;
70 }  /* set_irp_memory_disambiguator_options */
71
72 /**
73  * Find the base address and entity of an Sel node.
74  *
75  * @param sel  the node
76  * @param pEnt after return points to the base entity.
77  *
78  * @return the base address.
79  */
80 static ir_node *find_base_adr(ir_node *sel, ir_entity **pEnt) {
81         ir_node *ptr = get_Sel_ptr(sel);
82
83         while (is_Sel(ptr)) {
84                 sel = ptr;
85                 ptr = get_Sel_ptr(sel);
86         }
87         *pEnt = get_Sel_entity(sel);
88         return ptr;
89 }  /* find_base_adr */
90
91 /**
92  * Check if a given Const node is greater or equal a given size.
93  *
94  * @return no_alias if the Const is greater, may_alias else
95  */
96 static ir_alias_relation check_const(ir_node *cns, int size) {
97         tarval *tv = get_Const_tarval(cns);
98         tarval *tv_size;
99
100         if (size == 0)
101                 return tarval_is_null(tv) ? may_alias : no_alias;
102         tv_size = new_tarval_from_long(size, get_tarval_mode(tv));
103         return tarval_cmp(tv_size, tv) & (pn_Cmp_Eq|pn_Cmp_Lt) ? no_alias : may_alias;
104 }  /* check_const */
105
106 /**
107  * Treat idx1 and idx2 as integer indexes and check if they differ always more than size.
108  *
109  * @return sure_alias iff idx1 == idx2
110  *         no_alias iff they ALWAYS differ more than size
111  *         may_alias else
112  */
113 static ir_alias_relation different_index(ir_node *idx1, ir_node *idx2, int size) {
114         if (idx1 == idx2)
115                 return sure_alias;
116         if (is_Const(idx1) && is_Const(idx2)) {
117                 /* both are const, we can compare them */
118                 tarval *tv1 = get_Const_tarval(idx1);
119                 tarval *tv2 = get_Const_tarval(idx2);
120                 tarval *tv, *tv_size;
121                 ir_mode *m1, *m2;
122
123                 if (size == 0)
124                         return tv1 == tv2 ? sure_alias : no_alias;
125
126                 /* arg, modes may be different */
127                 m1 = get_tarval_mode(tv1);
128                 m2 = get_tarval_mode(tv2);
129                 if (m1 != m2) {
130                         int size = get_mode_size_bits(m1) - get_mode_size_bits(m2);
131
132                         if (size < 0) {
133                                 /* m1 is a small mode, cast up */
134                                 m1 = mode_is_signed(m1) ? find_signed_mode(m2) : find_unsigned_mode(m2);
135                                 if (m1 == NULL) {
136                                         /* should NOT happen, but if it does we give up here */
137                                         return may_alias;
138                                 }
139                                 tv1 = tarval_convert_to(tv1, m1);
140                         } else if (size > 0) {
141                                 /* m2 is a small mode, cast up */
142                                 m2 = mode_is_signed(m2) ? find_signed_mode(m1) : find_unsigned_mode(m1);
143                                 if (m2 == NULL) {
144                                         /* should NOT happen, but if it does we give up here */
145                                         return may_alias;
146                                 }
147                                 tv2 = tarval_convert_to(tv2, m2);
148                         }
149                         /* here the size should be identical, check for signed */
150                         if (get_mode_sign(m1) != get_mode_sign(m2)) {
151                                 /* find the signed */
152                                 if (mode_is_signed(m2)) {
153                                         tarval *t = tv1;
154                                         ir_mode *tm = m1;
155                                         tv1 = tv2; m1 = m2;
156                                         tv2 = t;   m2 = tm;
157                                 }
158
159                                 /* m1 is now the signed one */
160                                 if (tarval_cmp(tv1, get_tarval_null(m1)) & (pn_Cmp_Eq|pn_Cmp_Gt)) {
161                                         /* tv1 is signed, but >= 0, simply cast into unsigned */
162                                         tv1 = tarval_convert_to(tv1, m2);
163                                 } else {
164                                         tv_size = new_tarval_from_long(size, m2);
165
166                                         if (tarval_cmp(tv2, tv_size) & (pn_Cmp_Eq|pn_Cmp_Gt)) {
167                                                 /* tv1 is negative and tv2 >= tv_size, so the difference is bigger than size */
168                                                 return no_alias;
169                                         }
170                                         /* tv_size > tv2, so we can subtract without overflow */
171                                         tv2 = tarval_sub(tv_size, tv2);
172
173                                         /* tv1 is < 0, so we can negate it */
174                                         tv1 = tarval_neg(tv1);
175
176                                         /* cast it into unsigned. for two-complement it does the right thing for MIN_INT */
177                                         tv1 = tarval_convert_to(tv1, m2);
178
179                                         /* now we can compare without overflow */
180                                         return tarval_cmp(tv1, tv2) & (pn_Cmp_Eq|pn_Cmp_Gt) ? no_alias : may_alias;
181                                 }
182                         }
183                 }
184                 if (tarval_cmp(tv1, tv2) == pn_Cmp_Gt) {
185                         tarval *t = tv1;
186                         tv1 = tv2;
187                         tv2 = t;
188                 }
189                 /* tv1 is now the "smaller" one */
190                 tv      = tarval_sub(tv2, tv1);
191                 tv_size = new_tarval_from_long(size, get_tarval_mode(tv));
192                 return tarval_cmp(tv_size, tv) & (pn_Cmp_Eq|pn_Cmp_Lt) ? no_alias : may_alias;
193         }
194
195         /* Note: we rely here on the fact that normalization puts constants on the RIGHT side */
196         if (is_Add(idx1)) {
197                 ir_node *l1 = get_Add_left(idx1);
198                 ir_node *r1 = get_Add_right(idx1);
199
200                 if (l1 == idx2) {
201                         /* x + c == y */
202                         if (is_Const(r1))
203                                 return check_const(r1, size);
204                 }
205                 if (is_Add(idx2)) {
206                         /* both are Adds, check if they are of x + a == x + b kind */
207                         ir_node *l2 = get_Add_left(idx2);
208                         ir_node *r2 = get_Add_right(idx2);
209
210                         if (l1 == l2)
211                                 return different_index(r1, r2, size);
212                         else if (l1 == r2)
213                                 return different_index(r1, l2, size);
214                         else if (r1 == r2)
215                                 return different_index(l1, l2, size);
216                         else if (r1 == l2)
217                                 return different_index(l1, r2, size);
218                 }
219         }
220         if (is_Add(idx2)) {
221                 ir_node *l2 = get_Add_left(idx2);
222                 ir_node *r2 = get_Add_right(idx2);
223
224                 if (l2 == idx1) {
225                         /* x + c == y */
226                         if (is_Const(r2))
227                                 return check_const(r2, size);
228                 }
229         }
230
231         if (is_Sub(idx1)) {
232                 ir_node *l1 = get_Sub_left(idx1);
233                 ir_node *r1 = get_Sub_right(idx1);
234
235                 if (l1 == idx2) {
236                         /* x - c == y */
237                         if (is_Const(r1))
238                                 return check_const(r1, size);
239                 }
240
241                 if (is_Sub(idx2)) {
242                         /* both are Subs, check if they are of x - a == x - b kind */
243                         ir_node *l2 = get_Sub_left(idx2);
244
245                         if (l1 == l2) {
246                                 ir_node *r2 = get_Sub_right(idx2);
247                                 return different_index(r1, r2, size);
248                         }
249                 }
250         }
251         if (is_Sub(idx2)) {
252                 ir_node *l2 = get_Sub_left(idx2);
253                 ir_node *r2 = get_Sub_right(idx2);
254
255                 if (l2 == idx1) {
256                         /* x - c == y */
257                         if (is_Const(r2))
258                                 return check_const(r2, size);
259                 }
260
261         }
262         return may_alias;
263 }  /* different_index */
264
265 /**
266  * Two Sel addresses have the same base address, check if there offsets are different.
267  *
268  * @param adr1  The first address.
269  * @param adr2  The second address.
270  */
271 static ir_alias_relation different_sel_offsets(ir_node *sel1, ir_node *sel2) {
272         ir_entity *ent1 = get_Sel_entity(sel1);
273         ir_entity *ent2 = get_Sel_entity(sel2);
274         int i, check_arr = 0;
275
276         if (ent1 == ent2)
277                 check_arr = 1;
278         else {
279                 ir_type *tp1 = get_entity_type(ent1);
280                 ir_type *tp2 = get_entity_type(ent2);
281
282                 if (tp1 == tp2)
283                         check_arr = 1;
284                 else if (get_type_state(tp1) == layout_fixed && get_type_state(tp2) == layout_fixed &&
285                          get_type_size_bits(tp1) == get_type_size_bits(tp2))
286                         check_arr = 1;
287         }
288         if (check_arr) {
289                 /* we select an entity of same size, check for indexes */
290                 int n = get_Sel_n_indexs(sel1);
291                 int have_no = 0;
292
293                 if (n > 0 && n == get_Sel_n_indexs(sel2)) {
294                         /* same non-zero number of indexes, an array access, check */
295                         for (i = 0; i < n; ++i) {
296                                 ir_node *idx1 = get_Sel_index(sel1, i);
297                                 ir_node *idx2 = get_Sel_index(sel2, i);
298                                 ir_alias_relation res = different_index(idx1, idx2, 0); /* we can safely IGNORE the size here if it's at least >0 */
299
300                                 if (res == may_alias)
301                                         return may_alias;
302                                 else if (res == no_alias)
303                                         have_no = 1;
304                         }
305                         /* if we have at least one no_alias, there is no alias relation, else we have sure */
306                         return have_no > 0 ? no_alias : sure_alias;
307                 }
308         }
309         return may_alias;
310 }  /* different_sel_offsets */
311
312 /**
313  * Determine the alias relation by checking if adr1 and adr2 are pointer
314  * to different type.
315  *
316  * @param adr1    The first address.
317  * @param adr2    The second address.
318  */
319 static ir_alias_relation different_types(ir_node *adr1, ir_node *adr2)
320 {
321         ir_entity *ent1 = NULL, *ent2 = NULL;
322
323         if (is_SymConst(adr1) && get_SymConst_kind(adr1) == symconst_addr_ent)
324                 ent1 = get_SymConst_entity(adr1);
325         else if (is_Sel(adr1))
326                 ent1 = get_Sel_entity(adr1);
327
328         if (is_SymConst(adr2) && get_SymConst_kind(adr2) == symconst_addr_ent)
329                 ent2 = get_SymConst_entity(adr2);
330         else if (is_Sel(adr2))
331                 ent2 = get_Sel_entity(adr2);
332
333         if (ent1 != NULL && ent2 != NULL) {
334                 ir_type *tp1 = get_entity_type(ent1);
335                 ir_type *tp2 = get_entity_type(ent2);
336
337                 if (tp1 != tp2) {
338                         if (is_Pointer_type(tp1) && is_Pointer_type(tp2)) {
339                                 /* do deref until no pointer types are found */
340                                 do {
341                                         tp1 = get_pointer_points_to_type(tp1);
342                                         tp2 = get_pointer_points_to_type(tp2);
343                                 } while (is_Pointer_type(tp1) && is_Pointer_type(tp2));
344                         }
345
346                         if (get_type_tpop(tp1) != get_type_tpop(tp2)) {
347                                 /* different type structure */
348                                 return no_alias;
349                         }
350                         if (is_Class_type(tp1)) {
351                                 /* check class hierarchy */
352                                 if (! is_SubClass_of(tp1, tp2) &&
353                                         ! is_SubClass_of(tp2, tp1))
354                                         return no_alias;
355                         } else {
356                                 /* different types */
357                                 return no_alias;
358                         }
359                 }
360         }
361         return may_alias;
362 }  /* different_types */
363
364 /**
365  * Check if an offset is a constant and these constant is bigger or equal
366  * than a given size.
367  */
368 static int check_const_offset(ir_node *offset, int size) {
369         ir_mode *mode = get_irn_mode(offset);
370
371         /* ok, we found an offset, check for constant */
372         if (is_Const(offset) && mode_is_int(mode)) {
373                 tarval *tv = new_tarval_from_long(size, mode);
374
375                 /* size <= offset ? */
376                 if (tarval_cmp(tv, get_Const_tarval(offset)) & (pn_Cmp_Eq|pn_Cmp_Lt))
377                         return 1;
378         }
379         return 0;
380 }  /* check_const_offset */
381
382 /**
383  * Check if we can determine that the two pointers always have an offset bigger then size
384  */
385 static ir_alias_relation _different_pointer(ir_node *adr1, ir_node *adr2, int size) {
386         int found = 0;
387
388         if (is_Add(adr1)) {
389                 /* first address is the result of a pointer addition */
390                 ir_node *l1 = get_Add_left(adr1);
391                 ir_node *r1  = get_Add_right(adr1);
392
393                 if (l1 == adr2) {
394                         found = check_const_offset(r1, size);
395                 } else if (r1 == adr2) {
396                         found = check_const_offset(l1, size);
397                 } else if (is_Add(adr2)) {
398                         /* second address is the result of a pointer addition */
399                         ir_node *l2 = get_Add_left(adr2);
400                         ir_node *r2 = get_Add_right(adr2);
401
402                         if (l1 == l2) {
403                                 return _different_pointer(r1, r2, size);
404                         } else if (l1 == r2) {
405                                 return _different_pointer(r1, l2, size);
406                         } else if (r1 == l2) {
407                                 return _different_pointer(l1, r2, size);
408                         } else if (r1 == r2) {
409                                 return _different_pointer(l1, l2, size);
410                         }
411                 }
412         } else if (is_Add(adr2)) {
413                 /* second address is the result of a pointer addition */
414                 ir_node *l2 = get_Add_left(adr2);
415                 ir_node *r2  = get_Add_right(adr2);
416
417                 if (l2 == adr1) {
418                         found = check_const_offset(r2, size);
419                 } else if (r2 == adr1) {
420                         found = check_const_offset(l2, size);
421                 }
422         } else {
423                 return different_index(adr1, adr2, size);
424         }
425         return found ? no_alias : may_alias;
426 }  /* _different_pointer */
427
428 /**
429  * Check if we can determine that the two pointers always have an offset bigger then the maximum size of mode1, mode2
430  */
431 static ir_alias_relation different_pointer(ir_node *adr1, ir_mode *mode1, ir_node *adr2, ir_mode *mode2) {
432         int size = get_mode_size_bytes(mode1);
433         int n    = get_mode_size_bytes(mode2);
434
435         if (n > size)
436                 size = n;
437         return _different_pointer(adr1, adr2, size);
438 }  /* different_pointer */
439
440 /**
441  * Returns non-zero if a node is a routine parameter.
442  *
443  * @param node  the node to test
444  */
445 static int is_arg_Proj(ir_node *node) {
446         if (! is_Proj(node))
447                 return 0;
448         node = get_Proj_pred(node);
449         if (! is_Proj(node))
450                 return 0;
451         return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
452 }  /* is_arg_Proj */
453
454 /**
455  * Returns true if an address represents a global variable.
456  */
457 static INLINE int is_global_var(ir_node *irn) {
458         return is_SymConst(irn) && get_SymConst_kind(irn) == symconst_addr_ent;
459 }  /* is_global_var */
460
461 /**
462  * Determine the alias relation between two addresses.
463  */
464 static ir_alias_relation _get_alias_relation(
465         ir_graph *irg,
466         ir_node *adr1, ir_mode *mode1,
467         ir_node *adr2, ir_mode *mode2)
468 {
469         ir_opcode op1, op2;
470         ir_entity *ent1, *ent2;
471         unsigned options;
472
473         if (! get_opt_alias_analysis())
474                 return may_alias;
475
476         if (adr1 == adr2)
477                 return sure_alias;
478
479         options = get_irg_memory_disambiguator_options(irg);
480
481         /* The Armageddon switch */
482         if (options & aa_opt_no_alias)
483                 return no_alias;
484
485         /* Two save some code, sort the addresses by its id's. Beware, this
486            might break some things, so better check here. */
487         assert(iro_SymConst < iro_Sel && iro_Sel < iro_Proj && "Code dependence broken");
488         op1 = get_irn_opcode(adr1);
489         op2 = get_irn_opcode(adr2);
490
491         if (op1 > op2) {
492                 ir_node *t = adr1;
493                 ir_mode *m = mode1;
494                 adr1  = adr2;
495                 mode1 = mode2;
496                 adr2  = t;
497                 mode2 = m;
498         }
499
500         if (is_global_var(adr1)) {
501                 /* first address is a global variable */
502
503                 if (is_global_var(adr2)) {
504                         /* both addresses are global variables and we know
505                            they are different (R1 a) */
506                         if (get_SymConst_entity(adr1) != get_SymConst_entity(adr2))
507                                 return no_alias;
508                         else {
509                                 /* equal entity addresses */
510                                 return sure_alias;
511                         }
512                 }
513                 if (is_Sel(adr2)) {
514                         ir_node *base2 = find_base_adr(adr2, &ent2);
515
516                         if (is_global_var(base2)) {
517                                 /* base2 address is a global var (R1 a) */
518                                 if (adr1 != base2)
519                                         return no_alias;
520                         } else if (base2 == get_irg_frame(irg)) {
521                                 /* the second one is a local variable so they are always
522                                    different (R1 b) */
523                                 return no_alias;
524                         } else if (base2 == get_irg_tls(irg)) {
525                                 /* the second one is a TLS variable so they are always
526                                    different (R1 c) */
527                                 return no_alias;
528                         }
529                 }
530
531                 /* Here we are: the first is a global var, the second some pointer. */
532                 ent1 = get_SymConst_entity(adr1);
533                 if (get_entity_address_taken(ent1) == ir_address_not_taken) {
534                         /* The address of the global variable was never taken, so
535                            the pointer cannot match (R2). */
536                         return no_alias;
537                 }
538         } else if (is_Sel(adr1)) {
539                 /* the first address is a Sel */
540                 ir_node *base1 = find_base_adr(adr1, &ent1);
541
542                 if (base1 == get_irg_frame(irg)) {
543                         /* first is a local variable ent1 */
544                         if (is_Sel(adr2)) {
545                                 /* the second address is a Sel */
546                                 ir_node *base2 = find_base_adr(adr2, &ent2);
547
548                                 if (base1 == base2) {
549                                         /* identical bases: check for different offsets */
550                                         return different_sel_offsets(adr1, adr2);
551                                 } else if (base2 == get_irg_frame(irg)) {
552                                         /* both addresses are local variables and we know
553                                            they are different (R1 a) */
554                                         if (ent1 != ent2)
555                                                 return no_alias;
556                                 } else if (base2 == get_irg_tls(irg)) {
557                                         /* the second one is a TLS variable so they are always
558                                        different (R1 d) */
559                                         return no_alias;
560                                 } else if (is_arg_Proj(base2)) {
561                                         /* the second one is an offset from a parameter so they are
562                                            always different (R1 e) */
563                                         return no_alias;
564                                 }
565                         } else if (is_arg_Proj(adr2)) {
566                                 /* a local variable and a parameter are always different (R1 e) */
567                                 return no_alias;
568                         }
569                 } else if (base1 == get_irg_tls(irg)) {
570                         /* the first is a TLS variable */
571                         if (is_Sel(adr2)) {
572                                 /* the second address is a Sel */
573                                 ir_node *base2 = find_base_adr(adr2, &ent2);
574
575                                 if (base1 == base2)
576                                         return different_sel_offsets(adr1, adr2);
577                                 else if (base2 == get_irg_frame(irg)) {
578                                         /* the second one is a local variable so they are always
579                                        different (R1 d) */
580                                         return no_alias;
581                                 } else if (base2 == get_irg_tls(irg)) {
582                                         /* both addresses are TLS variables and we know
583                                            they are different (R1 a) */
584                                         if (ent1 != ent2)
585                                                 return no_alias;
586                                 }
587                         }
588                 } else if (is_arg_Proj(base1)) {
589                         /* the first one is an offset from a parameter */
590                         if (is_Sel(adr2)) {
591                                 /* the second address is a Sel */
592                                 ir_node *base2 = find_base_adr(adr2, &ent2);
593
594                                 if (base2 == get_irg_frame(irg)) {
595                                         /* the second one is a local variable so they are always
596                                        different (R1 e) */
597                                         return no_alias;
598                                 }
599                         }
600                 } else if (is_global_var(base1)) {
601                         /* the first one is a global variable */
602                         ent1 = get_SymConst_entity(base1);
603                         if (is_Sel(adr2)) {
604                                 /* the second address is a Sel */
605                                 ir_node *base2 = find_base_adr(adr2, &ent2);
606
607                                 if (base1 == base2)
608                                         return different_sel_offsets(adr1, adr2);
609                                 else if (base2 == get_irg_frame(irg)) {
610                                         /* the second one is a local variable so they are always
611                                        different (R1 a) */
612                                         return no_alias;
613                                 } else if (base2 == get_irg_tls(irg)) {
614                                         /* the second one is a TLS variable so they are always
615                                        different (R1 a) */
616                                         return no_alias;
617                                 } else if (is_arg_Proj(base2)) {
618                                         if (get_entity_address_taken(ent1) == ir_address_not_taken) {
619                                                 /* The address of the global variable was never taken, so
620                                                    the pointer cannot match (R2). */
621                                                 return no_alias;
622                                         }
623                                 } else if (is_global_var(base2)) {
624                                         ent2 = get_SymConst_entity(base2);
625                                         /* both addresses are global variables and we know
626                                            they are different (R1 a) */
627                                         if (ent1 != ent2)
628                                                 return no_alias;
629                                 }
630                         }
631                 }
632         } else {
633                 /* some pointers, check if they have the same base buf constant offset */
634                 ir_alias_relation rel = different_pointer(adr1, mode1, adr2, mode2);
635                 if (rel != may_alias)
636                         return rel;
637         }
638
639
640         if (options & aa_opt_type_based) { /* Type based alias analysis */
641                 ir_alias_relation rel;
642
643                 if (options & aa_opt_byte_type_may_alias) {
644                         if (get_mode_size_bits(mode1) == 8 || get_mode_size_bits(mode2) == 8) {
645                                 /* One of the modes address a byte. Assume a may_alias and leave
646                                    the type based check. */
647                                 goto leave_type_based_alias;
648                         }
649                 }
650                 /* cheap check: If the mode sizes did not match, the types MUST be different */
651                 if (get_mode_size_bits(mode1) != get_mode_size_bits(mode2))
652                         return no_alias;
653
654                 /* cheap test: if only one is a reference mode, no alias */
655                 if (mode_is_reference(mode1) != mode_is_reference(mode2))
656                         return no_alias;
657
658                 /* try rule R5 */
659                 rel = different_types(adr1, adr2);
660                 if (rel != may_alias)
661                         return rel;
662 leave_type_based_alias:;
663         }
664
665         /* do we have a language specific memory disambiguator? */
666         if (language_disambuigator) {
667                 ir_alias_relation rel = (*language_disambuigator)(irg, adr1, mode1, adr2, mode2);
668                 if (rel != may_alias)
669                         return rel;
670         }
671
672         /* access points-to information here */
673         return may_alias;
674 }  /* _get_alias_relation */
675
676 /*
677  * Determine the alias relation between two addresses.
678  */
679 ir_alias_relation get_alias_relation(
680         ir_graph *irg,
681         ir_node *adr1, ir_mode *mode1,
682         ir_node *adr2, ir_mode *mode2)
683 {
684         ir_alias_relation rel = _get_alias_relation(irg, adr1, mode1, adr2, mode2);
685         return rel;
686 }  /* get_alias_relation */
687
688 /* Set a source language specific memory disambiguator function. */
689 void set_language_memory_disambiguator(DISAMBIGUATOR_FUNC func) {
690         language_disambuigator = func;
691 }  /* set_language_memory_disambiguator */
692
693 /** The result cache for the memory disambiguator. */
694 static set *result_cache = NULL;
695
696 /** An entry in the relation cache. */
697 typedef struct mem_disambig_entry {
698         ir_node           *adr1;    /**< The first address. */
699         ir_node           *adr2;    /**< The second address. */
700         ir_alias_relation result;   /**< The alias relation result. */
701 } mem_disambig_entry;
702
703 #define HASH_ENTRY(adr1, adr2)  (HASH_PTR(adr1) ^ HASH_PTR(adr2))
704
705 /**
706  * Compare two relation cache entries.
707  */
708 static int cmp_mem_disambig_entry(const void *elt, const void *key, size_t size) {
709         const mem_disambig_entry *p1 = elt;
710         const mem_disambig_entry *p2 = key;
711         (void) size;
712
713         return p1->adr1 == p2->adr1 && p1->adr2 == p2->adr2;
714 }  /* cmp_mem_disambig_entry */
715
716 /**
717  * Initialize the relation cache.
718  */
719 void mem_disambig_init(void) {
720         result_cache = new_set(cmp_mem_disambig_entry, 8);
721 }  /* mem_disambig_init */
722
723 /*
724  * Determine the alias relation between two addresses.
725  */
726 ir_alias_relation get_alias_relation_ex(
727         ir_graph *irg,
728         ir_node *adr1, ir_mode *mode1,
729         ir_node *adr2, ir_mode *mode2)
730 {
731         mem_disambig_entry key, *entry;
732
733         if (! get_opt_alias_analysis())
734                 return may_alias;
735
736         if (get_irn_opcode(adr1) > get_irn_opcode(adr2)) {
737                 ir_node *t = adr1;
738                 adr1 = adr2;
739                 adr2 = t;
740         }
741
742         key.adr1 = adr1;
743         key.adr2 = adr2;
744         entry = set_find(result_cache, &key, sizeof(key), HASH_ENTRY(adr1, adr2));
745         if (entry)
746                 return entry->result;
747
748         key.result = get_alias_relation(irg, adr1, mode1, adr2, mode2);
749
750         set_insert(result_cache, &key, sizeof(key), HASH_ENTRY(adr1, adr2));
751         return key.result;
752 }  /* get_alias_relation_ex */
753
754 /* Free the relation cache. */
755 void mem_disambig_term(void) {
756         if (result_cache) {
757                 del_set(result_cache);
758                 result_cache = NULL;
759         }
760 }  /* mem_disambig_term */
761
762 /**
763  * Check the mode of a Load/Store with the mode of the entity
764  * that is accessed.
765  * If the mode of the entity and the Load/Store mode do not match, we
766  * have the bad reinterpret case:
767  *
768  * int i;
769  * char b = *(char *)&i;
770  *
771  * We do NOT count this as one value and return address_taken
772  * in that case.
773  * However, we support an often used case. If the mode is two-complement
774  * we allow casts between signed/unsigned.
775  *
776  * @param mode     the mode of the Load/Store
777  * @param ent_mode the mode of the accessed entity
778  *
779  * @return non-zero if the Load/Store is a hidden cast, zero else
780  */
781 static int is_hidden_cast(ir_mode *mode, ir_mode *ent_mode) {
782         if (ent_mode != mode) {
783                 if (ent_mode == NULL ||
784                         get_mode_size_bits(ent_mode) != get_mode_size_bits(mode) ||
785                         get_mode_sort(ent_mode) != get_mode_sort(mode) ||
786                         get_mode_arithmetic(ent_mode) != irma_twos_complement ||
787                         get_mode_arithmetic(mode) != irma_twos_complement)
788                         return 1;
789         }
790         return 0;
791 }  /* is_hidden_cast */
792
793 /**
794  * Determine the address_taken state of a node (or it's successor Sels).
795  *
796  * @param irn  the node
797  */
798 static ir_address_taken_state find_address_taken_state(ir_node *irn) {
799         int     i, j;
800         ir_mode *emode, *mode;
801         ir_node *value;
802         ir_entity *ent;
803
804         for (i = get_irn_n_outs(irn) - 1; i >= 0; --i) {
805                 ir_node *succ = get_irn_out(irn, i);
806
807                 switch (get_irn_opcode(succ)) {
808                 case iro_Load:
809                         /* check if this load is not a hidden conversion */
810                         mode = get_Load_mode(succ);
811                         ent = is_SymConst(irn) ? get_SymConst_entity(irn) : get_Sel_entity(irn);
812                         emode = get_type_mode(get_entity_type(ent));
813                         if (is_hidden_cast(mode, emode))
814                                 return ir_address_taken;
815                         break;
816
817                 case iro_Store:
818                         /* check that the node is not the Store's value */
819                         value = get_Store_value(succ);
820                         if (value == irn)
821                                 return ir_address_taken;
822                         /* check if this Store is not a hidden conversion */
823                         mode = get_irn_mode(value);
824                         ent = is_SymConst(irn) ? get_SymConst_entity(irn) : get_Sel_entity(irn);
825                         emode = get_type_mode(get_entity_type(ent));
826                         if (is_hidden_cast(mode, emode))
827                                 return ir_address_taken;
828                         break;
829
830                 case iro_Sel: {
831                         /* Check the successor of irn. */
832                         ir_address_taken_state res = find_address_taken_state(succ);
833                         if (res != ir_address_not_taken)
834                                 return res;
835                         break;
836                 }
837
838                 case iro_Call:
839                         /* Only the call address is not an address taker but
840                            this is an uninteresting case, so we ignore it here. */
841                         for (j = get_Call_n_params(succ) - 1; j >= 0; --j) {
842                                 ir_node *param = get_Call_param(succ, j);
843                                 if (param == irn)
844                                         return ir_address_taken;
845                         }
846                         break;
847
848                 default:
849                         /* another op, the address may be taken */
850                         return ir_address_taken_unknown;
851                 }
852         }
853         /* All successors finished, the address is not taken. */
854         return ir_address_not_taken;
855 }  /* find_address_taken_state */
856
857 /**
858  * Update the "address taken" flag of all frame entities.
859  */
860 static void analyse_irg_address_taken(ir_graph *irg) {
861         ir_type *ft = get_irg_frame_type(irg);
862         ir_node *irg_frame;
863         int i;
864
865         /* set initial state to not_taken, as this is the "smallest" state */
866         for (i = get_class_n_members(ft) - 1; i >= 0; --i) {
867                 ir_entity *ent = get_class_member(ft, i);
868
869                 set_entity_address_taken(ent, ir_address_not_taken);
870         }
871
872         assure_irg_outs(irg);
873
874         irg_frame = get_irg_frame(irg);
875
876         for (i = get_irn_n_outs(irg_frame) - 1; i >= 0; --i) {
877                 ir_node *succ = get_irn_out(irg_frame, i);
878                 ir_address_taken_state state;
879
880             if (is_Sel(succ)) {
881                         ir_entity *ent = get_Sel_entity(succ);
882
883                         if (get_entity_address_taken(ent) == ir_address_taken)
884                                 continue;
885
886                         state = find_address_taken_state(succ);
887                         if (state > get_entity_address_taken(ent))
888                                 set_entity_address_taken(ent, state);
889                 }
890         }
891         /* now computed */
892         irg->adr_taken_state = ir_address_taken_computed;
893 }  /* analyse_address_taken */
894
895 /* Returns the current address taken state of the graph. */
896 ir_address_taken_computed_state get_irg_address_taken_state(const ir_graph *irg) {
897         return irg->adr_taken_state;
898 }  /* get_irg_address_taken_state */
899
900 /* Sets the current address taken state of the graph. */
901 void set_irg_address_taken_state(ir_graph *irg, ir_address_taken_computed_state state) {
902         irg->adr_taken_state = state;
903 }  /* set_irg_address_taken_state */
904
905 /* Assure that the address taken flag is computed for the given graph. */
906 void assure_irg_address_taken_computed(ir_graph *irg) {
907         if (irg->adr_taken_state == ir_address_taken_not_computed)
908                 analyse_irg_address_taken(irg);
909 }  /* assure_irg_address_taken_computed */
910
911
912 /**
913  * Initialize the address_taken flag for a global type like type.
914  */
915 static void init_taken_flag(ir_type * tp) {
916         int i;
917
918         /* All external visible entities are at least
919            ir_address_taken_unknown. This is very conservative. */
920         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
921                 ir_entity *ent = get_compound_member(tp, i);
922                 ir_address_taken_state state;
923
924                 state = get_entity_visibility(ent) == visibility_external_visible ?
925                                 ir_address_taken_unknown : ir_address_not_taken ;
926                 set_entity_address_taken(ent, state);
927         }
928 }  /* init_taken_flag */
929
930 /**
931  * Mark all entities used in the initializer for the given entity as address taken
932  */
933 static void check_initializer(ir_entity *ent) {
934         ir_node *n;
935         int i;
936
937         /* do not check uninitialized values */
938         if (get_entity_variability(ent) == variability_uninitialized)
939                 return;
940
941         /* Beware: Methods initialized with "themself". This does not count as a taken
942            address. */
943         if (is_Method_type(get_entity_type(ent)))
944                 return;
945
946         if (is_atomic_entity(ent)) {
947                 /* let's check if it's an address */
948                 n = get_atomic_ent_value(ent);
949                 if (is_SymConst(n) && get_SymConst_kind(n) == symconst_addr_ent) {
950                         ir_entity *ent = get_SymConst_entity(n);
951                         set_entity_address_taken(ent, ir_address_taken);
952                 }
953         } else {
954                 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
955                         n = get_compound_ent_value(ent, i);
956
957                         /* let's check if it's an address */
958                         if (is_SymConst(n) && get_SymConst_kind(n) == symconst_addr_ent) {
959                                 ir_entity *ent = get_SymConst_entity(n);
960                                 set_entity_address_taken(ent, ir_address_taken);
961                         }
962                 }
963         }
964 }  /* check_initializer */
965
966
967 /**
968  * Mark all entities used in initializers as address taken
969  */
970 static void check_initializers(ir_type *tp) {
971         int i;
972
973         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
974                 ir_entity *ent = get_compound_member(tp, i);
975
976                 check_initializer(ent);
977         }
978 }  /* check_initializers */
979
980 #ifdef DEBUG_libfirm
981 /**
982  * Print the address taken state of all entities of a given type for debugging.
983  */
984 static void print_address_taken_state(ir_type *tp) {
985         int i;
986         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
987                 ir_entity *ent = get_compound_member(tp, i);
988                 ir_address_taken_state state = get_entity_address_taken(ent);
989
990                 if (state != ir_address_not_taken) {
991                         assert(ir_address_not_taken <= (int) state && state <= ir_address_taken);
992                         ir_printf("%+F: %s\n", ent, get_address_taken_state_name(state));
993                 }
994         }
995 }  /* print_address_taken_state */
996 #endif /* DEBUG_libfirm */
997
998 /**
999  * Post-walker: check for global entity address
1000  */
1001 static void check_global_address(ir_node *irn, void *env) {
1002         ir_node *tls = env;
1003         ir_entity *ent;
1004         ir_address_taken_state state;
1005
1006         if (is_SymConst(irn) && get_SymConst_kind(irn) == symconst_addr_ent) {
1007                 /* A global. */
1008                 ent = get_SymConst_entity(irn);
1009         } else if (is_Sel(irn) && get_Sel_ptr(irn) == tls) {
1010                 /* A TLS variable. */
1011                 ent = get_Sel_entity(irn);
1012         } else
1013                 return;
1014
1015         if (get_entity_address_taken(ent) >= ir_address_taken) {
1016                 /* Already at the maximum. */
1017                 return;
1018         }
1019         state = find_address_taken_state(irn);
1020         if (state > get_entity_address_taken(ent))
1021                 set_entity_address_taken(ent, state);
1022 }  /* check_global_address */
1023
1024 /**
1025  * Update the "address taken" flag of all global entities.
1026  */
1027 static void analyse_irp_globals_address_taken(void) {
1028         int i;
1029
1030         FIRM_DBG_REGISTER(dbg, "firm.ana.irmemory");
1031
1032         init_taken_flag(get_glob_type());
1033         init_taken_flag(get_tls_type());
1034
1035         check_initializers(get_glob_type());
1036         check_initializers(get_tls_type());
1037
1038         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1039                 ir_graph *irg = get_irp_irg(i);
1040
1041                 assure_irg_outs(irg);
1042                 irg_walk_graph(irg, NULL, check_global_address, get_irg_tls(irg));
1043         }
1044
1045 #ifdef DEBUG_libfirm
1046         if (firm_dbg_get_mask(dbg) & LEVEL_1) {
1047                 print_address_taken_state(get_glob_type());
1048                 print_address_taken_state(get_tls_type());
1049         }
1050 #endif /* DEBUG_libfirm */
1051
1052         /* now computed */
1053         irp->globals_adr_taken_state = ir_address_taken_computed;
1054 }  /* analyse_irp_globals_address_taken */
1055
1056 /* Returns the current address taken state of the globals. */
1057 ir_address_taken_computed_state get_irp_globals_address_taken_state(void) {
1058         return irp->globals_adr_taken_state;
1059 }  /* get_irp_globals_address_taken_state */
1060
1061 /* Sets the current address taken state of the graph. */
1062 void set_irp_globals_address_taken_state(ir_address_taken_computed_state state) {
1063         irp->globals_adr_taken_state = state;
1064 }  /* set_irg_address_taken_state */
1065
1066 /* Assure that the address taken flag is computed for the globals. */
1067 void assure_irp_globals_address_taken_computed(void) {
1068         if (irp->globals_adr_taken_state == ir_address_taken_not_computed)
1069                 analyse_irp_globals_address_taken();
1070 }  /* assure_irp_globals_address_taken_computed */
1071
1072
1073 DEBUG_ONLY(static firm_dbg_module_t *dbgcall = NULL;)
1074
1075 /**
1076  * Copy the calling conventions from the entities to the call type.
1077  */
1078 static void update_calls(ir_node *call, void *env) {
1079         (void) env;
1080         if (is_Call(call)) {
1081                 ir_node *ptr = get_Call_ptr(call);
1082
1083                 if (is_SymConst(ptr)) {
1084                         ir_entity *ent = get_SymConst_entity(ptr);
1085                         ir_type *mtp = get_entity_type(ent);
1086                         ir_type *ctp = get_Call_type(call);
1087
1088                         if (mtp != ctp && get_method_additional_properties(mtp) & mtp_property_private) {
1089                                 set_method_additional_property(ctp, mtp_property_private);
1090                                 DB((dbgcall, LEVEL_1, "changed call to private method %+F\n", ent));
1091                         }
1092                 }
1093         }
1094 }
1095
1096 /* Mark all private methods, i.e. those of which all call sites are known. */
1097 void mark_private_methods(void) {
1098         int i;
1099         int changed = 0;
1100
1101         FIRM_DBG_REGISTER(dbgcall, "firm.opt.cc");
1102
1103         assure_irp_globals_address_taken_computed();
1104
1105         /* first step: change the calling conventions of the local non-escaped entities */
1106         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1107                 ir_graph               *irg = get_irp_irg(i);
1108                 ir_entity              *ent = get_irg_entity(irg);
1109                 ir_address_taken_state state = get_entity_address_taken(ent);
1110
1111                 if (get_entity_visibility(ent) == visibility_local &&
1112                     state == ir_address_not_taken) {
1113                         ir_type *mtp = get_entity_type(ent);
1114
1115                         set_method_additional_property(mtp, mtp_property_private);
1116                         changed = 1;
1117                         DB((dbgcall, LEVEL_1, "found private method %+F\n", ent));
1118                 }
1119         }
1120
1121         if (changed)
1122                 all_irg_walk(NULL, update_calls, NULL);
1123 }