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