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