for twoscomplement convert AddP(P, Const<signed>) into AddP(P, Const<unsigned>),...
[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(no_alias);
60         X(may_alias);
61         X(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 no_alias if the Const is greater, 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) ? may_alias : 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) ? no_alias : 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 sure_alias iff idx1 == idx2
123  *         no_alias iff they ALWAYS differ more than size
124  *         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 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 ? sure_alias : 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 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 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 no_alias;
182                                         }
183                                         /* tv_size > tv2, so we can subtract without overflow */
184                                         tv2 = tarval_sub(tv_size, tv2);
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) ? no_alias : 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);
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) ? no_alias : 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 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 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_SymConst_addr_ent(adr1))
343                 ent1 = get_SymConst_entity(adr1);
344         else if (is_Sel(adr1))
345                 ent1 = get_Sel_entity(adr1);
346
347         if (is_SymConst_addr_ent(adr2))
348                 ent2 = get_SymConst_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 (is_Pointer_type(tp1) && is_Pointer_type(tp2)) {
358                                 /* do deref until no pointer types are found */
359                                 do {
360                                         tp1 = get_pointer_points_to_type(tp1);
361                                         tp2 = get_pointer_points_to_type(tp2);
362                                 } while (is_Pointer_type(tp1) && is_Pointer_type(tp2));
363                         }
364
365                         if (get_type_tpop(tp1) != get_type_tpop(tp2)) {
366                                 /* different type structure */
367                                 return no_alias;
368                         }
369                         if (is_Class_type(tp1)) {
370                                 /* check class hierarchy */
371                                 if (! is_SubClass_of(tp1, tp2) &&
372                                         ! is_SubClass_of(tp2, tp1))
373                                         return no_alias;
374                         } else {
375                                 /* different types */
376                                 return no_alias;
377                         }
378                 }
379         }
380         return may_alias;
381 }  /* different_types */
382
383 /**
384  * Returns non-zero if a node is a routine parameter.
385  *
386  * @param node  the Proj node to test
387  */
388 static int is_arg_Proj(ir_node *node) {
389         if (! is_Proj(node))
390                 return 0;
391         node = get_Proj_pred(node);
392         if (! is_Proj(node))
393                 return 0;
394         return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
395 }  /* is_arg_Proj */
396
397 /**
398  * Returns non-zero if a node is a result on a malloc-like routine.
399  *
400  * @param node  the Proj node to test
401  */
402 static int is_malloc_Result(ir_node *node) {
403         node = get_Proj_pred(node);
404         if (! is_Proj(node))
405                 return 0;
406         node = get_Proj_pred(node);
407         if (! is_Call(node))
408                 return 0;
409         node = get_Call_ptr(node);
410         if (is_SymConst_addr_ent(node)) {
411                 ir_entity *ent = get_SymConst_entity(node);
412
413                 if (get_entity_additional_properties(ent) & mtp_property_malloc)
414                         return 1;
415                 return 0;
416         }
417         return 0;
418 }  /* is_malloc_Result */
419
420 /**
421  * Returns true if an address represents a global variable.
422  *
423  * @param irn  the node representing the address
424  */
425 static INLINE int is_global_var(ir_node *irn) {
426         return is_SymConst_addr_ent(irn);
427 }  /* is_global_var */
428
429 /**
430  * classify storage locations.
431  * Except STORAGE_CLASS_POINTER they are all disjoint.
432  * STORAGE_CLASS_POINTER potentially aliases all classes which don't have a
433  * NOTTAKEN modifier.
434  */
435 typedef enum {
436         STORAGE_CLASS_POINTER           = 0x0000,
437         STORAGE_CLASS_GLOBALVAR         = 0x0001,
438         STORAGE_CLASS_LOCALVAR          = 0x0002,
439         STORAGE_CLASS_ARGUMENT          = 0x0003,
440         STORAGE_CLASS_TLS               = 0x0004,
441         STORAGE_CLASS_MALLOCED          = 0x0005,
442
443         STORAGE_CLASS_MODIFIER_NOTTAKEN = 0x1000,
444 } storage_class_class_t;
445
446 /**
447  * Classify a base pointer.
448  *
449  * @param irg  the graph of the pointer
450  * @param irn  the node representing the base address
451  * @param ent  the base entity of the base address iff any
452  */
453 static storage_class_class_t classify_pointer(ir_graph *irg, ir_node *irn, ir_entity *ent)
454 {
455         storage_class_class_t res = STORAGE_CLASS_POINTER;
456         if (is_SymConst_addr_ent(irn)) {
457                 ir_entity *entity = get_SymConst_entity(irn);
458                 res = STORAGE_CLASS_GLOBALVAR;
459                 if (get_entity_address_taken(entity) == ir_address_not_taken)
460                         res |= STORAGE_CLASS_MODIFIER_NOTTAKEN;
461         } else if (irn == get_irg_frame(irg)) {
462                 res = STORAGE_CLASS_LOCALVAR;
463                 if (ent != NULL && get_entity_address_taken(ent) == ir_address_not_taken)
464                         res |= STORAGE_CLASS_MODIFIER_NOTTAKEN;
465         } else if (is_arg_Proj(irn)) {
466                 return STORAGE_CLASS_ARGUMENT;
467         } else if (irn == get_irg_tls(irg)) {
468                 res = STORAGE_CLASS_TLS;
469                 if (ent != NULL && get_entity_address_taken(ent) == ir_address_not_taken)
470                         res |= STORAGE_CLASS_MODIFIER_NOTTAKEN;
471         } else if (is_Proj(irn) && is_malloc_Result(irn)) {
472                 return STORAGE_CLASS_MALLOCED;
473         }
474
475         return res;
476 }
477
478 /**
479  * Determine the alias relation between two addresses.
480  */
481 static ir_alias_relation _get_alias_relation(
482         ir_graph *irg,
483         ir_node *adr1, ir_mode *mode1,
484         ir_node *adr2, ir_mode *mode2)
485 {
486         ir_entity             *ent1, *ent2;
487         unsigned              options;
488         long                  offset1 = 0;
489         long                  offset2 = 0;
490         ir_node               *base1;
491         ir_node               *base2;
492         ir_node               *orig_adr1 = adr1;
493         ir_node               *orig_adr2 = adr2;
494         unsigned              mode_size;
495         storage_class_class_t class1, class2;
496         int                   have_const_offsets;
497
498         if (! get_opt_alias_analysis())
499                 return may_alias;
500
501         if (adr1 == adr2)
502                 return sure_alias;
503
504         options = get_irg_memory_disambiguator_options(irg);
505
506         /* The Armageddon switch */
507         if (options & aa_opt_no_alias)
508                 return no_alias;
509
510         /* do the addresses have constants offsets?
511          *  Note: nodes are normalized to have constants at right inputs,
512          *        sub X, C is normalized to add X, -C
513          */
514         have_const_offsets = 1;
515         while (is_Add(adr1)) {
516                 ir_node *add_right = get_Add_right(adr1);
517                 if (is_Const(add_right)) {
518                         tarval *tv  = get_Const_tarval(add_right);
519                         offset1    += get_tarval_long(tv);
520                         adr1        = get_Add_left(adr1);
521                         continue;
522                 } else if (mode_is_reference(get_irn_mode(add_right))) {
523                         adr1 = add_right;
524                         have_const_offsets = 0;
525                 } else {
526                         adr1 = get_Add_left(adr1);
527                         have_const_offsets = 0;
528                 }
529         }
530         while (is_Add(adr2)) {
531                 ir_node *add_right = get_Add_right(adr2);
532                 if (is_Const(add_right)) {
533                         tarval *tv  = get_Const_tarval(add_right);
534                         offset2    += get_tarval_long(tv);
535                         adr2        = get_Add_left(adr2);
536                         continue;
537                 } else if (mode_is_reference(get_irn_mode(add_right))) {
538                         adr2 = add_right;
539                         have_const_offsets = 0;
540                 } else {
541                         adr2 = get_Add_left(adr2);
542                         have_const_offsets = 0;
543                 }
544         }
545
546         mode_size = get_mode_size_bytes(mode1);
547         if (get_mode_size_bytes(mode2) > mode_size) {
548                 mode_size = get_mode_size_bytes(mode2);
549         }
550
551         /* same base address -> compare offsets if possible.
552          * FIXME: type long is not sufficient for this task ...
553          */
554         if (adr1 == adr2 && have_const_offsets) {
555                 if ((unsigned long)labs(offset2 - offset1) >= mode_size)
556                         return no_alias;
557                 else
558                         return sure_alias;
559         }
560
561         /* skip sels */
562         base1 = adr1;
563         base2 = adr2;
564         ent1  = NULL;
565         ent2  = NULL;
566         if (is_Sel(adr1)) {
567                 base1 = find_base_adr(adr1, &ent1);
568         }
569         if (is_Sel(adr2)) {
570                 base2 = find_base_adr(adr2, &ent2);
571         }
572
573         /* same base address -> compare sel entities */
574         if (base1 == base2 && ent1 != NULL && ent2 != NULL) {
575                 if (ent1 != ent2)
576                         return no_alias;
577                 else if (have_const_offsets)
578                         return different_sel_offsets(adr1, adr2);
579         }
580
581         class1 = classify_pointer(irg, base1, ent1);
582         class2 = classify_pointer(irg, base2, ent2);
583
584         if (class1 == STORAGE_CLASS_POINTER) {
585                 if (class2 & STORAGE_CLASS_MODIFIER_NOTTAKEN) {
586                         return no_alias;
587                 } else {
588                         return may_alias;
589                 }
590         } else if (class2 == STORAGE_CLASS_POINTER) {
591                 if (class1 & STORAGE_CLASS_MODIFIER_NOTTAKEN) {
592                         return no_alias;
593                 } else {
594                         return may_alias;
595                 }
596         }
597
598         if (class1 != class2) {
599                 return no_alias;
600         }
601
602         if (class1 == STORAGE_CLASS_GLOBALVAR) {
603                 ir_entity *entity1 = get_SymConst_entity(base1);
604                 ir_entity *entity2 = get_SymConst_entity(base2);
605                 if (entity1 != entity2)
606                         return no_alias;
607
608                 /* for some reason CSE didn't happen yet for the 2 SymConsts... */
609                 return may_alias;
610         }
611
612         /* Type based alias analysis */
613         if (options & aa_opt_type_based) {
614                 ir_alias_relation rel;
615
616                 if (options & aa_opt_byte_type_may_alias) {
617                         if (get_mode_size_bits(mode1) == 8 || get_mode_size_bits(mode2) == 8) {
618                                 /* One of the modes address a byte. Assume a may_alias and leave
619                                    the type based check. */
620                                 goto leave_type_based_alias;
621                         }
622                 }
623                 /* cheap check: If the mode sizes did not match, the types MUST be different */
624                 if (get_mode_size_bits(mode1) != get_mode_size_bits(mode2))
625                         return no_alias;
626
627                 /* cheap test: if only one is a reference mode, no alias */
628                 if (mode_is_reference(mode1) != mode_is_reference(mode2))
629                         return no_alias;
630
631                 /* try rule R5 */
632                 rel = different_types(orig_adr1, orig_adr2);
633                 if (rel != 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 != may_alias)
642                         return rel;
643         }
644
645         /* access points-to information here */
646         return 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 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 != mode) {
759                 if (ent_mode == NULL ||
760                         get_mode_size_bits(ent_mode) != get_mode_size_bits(mode) ||
761                         get_mode_sort(ent_mode) != get_mode_sort(mode) ||
762                         get_mode_arithmetic(ent_mode) != irma_twos_complement ||
763                         get_mode_arithmetic(mode) != irma_twos_complement)
764                         return 1;
765         }
766         return 0;
767 }  /* is_hidden_cast */
768
769 /**
770  * Determine the address_taken state of a node (or it's successor Sels).
771  *
772  * @param irn  the node
773  */
774 static ir_address_taken_state find_address_taken_state(ir_node *irn) {
775         int     i, j;
776         ir_mode *emode, *mode;
777         ir_node *value;
778         ir_entity *ent;
779
780         for (i = get_irn_n_outs(irn) - 1; i >= 0; --i) {
781                 ir_node *succ = get_irn_out(irn, i);
782
783                 switch (get_irn_opcode(succ)) {
784                 case iro_Load:
785                         /* check if this load is not a hidden conversion */
786                         mode = get_Load_mode(succ);
787                         ent = is_SymConst(irn) ? get_SymConst_entity(irn) : get_Sel_entity(irn);
788                         emode = get_type_mode(get_entity_type(ent));
789                         if (is_hidden_cast(mode, emode))
790                                 return ir_address_taken;
791                         break;
792
793                 case iro_Store:
794                         /* check that the node is not the Store's value */
795                         value = get_Store_value(succ);
796                         if (value == irn)
797                                 return ir_address_taken;
798                         /* check if this Store is not a hidden conversion */
799                         mode = get_irn_mode(value);
800                         ent = is_SymConst(irn) ? get_SymConst_entity(irn) : get_Sel_entity(irn);
801                         emode = get_type_mode(get_entity_type(ent));
802                         if (is_hidden_cast(mode, emode))
803                                 return ir_address_taken;
804                         break;
805
806                 case iro_Sel: {
807                         /* Check the successor of irn. */
808                         ir_address_taken_state res = find_address_taken_state(succ);
809                         if (res != ir_address_not_taken)
810                                 return res;
811                         break;
812                 }
813
814                 case iro_Call:
815                         /* Only the call address is not an address taker but
816                            this is an uninteresting case, so we ignore it here. */
817                         for (j = get_Call_n_params(succ) - 1; j >= 0; --j) {
818                                 ir_node *param = get_Call_param(succ, j);
819                                 if (param == irn)
820                                         return ir_address_taken;
821                         }
822                         break;
823
824                 default:
825                         /* another op, the address may be taken */
826                         return ir_address_taken_unknown;
827                 }
828         }
829         /* All successors finished, the address is not taken. */
830         return ir_address_not_taken;
831 }  /* find_address_taken_state */
832
833 /**
834  * Update the "address taken" flag of all frame entities.
835  */
836 static void analyse_irg_address_taken(ir_graph *irg) {
837         ir_type *ft = get_irg_frame_type(irg);
838         ir_node *irg_frame;
839         int i;
840
841         /* set initial state to not_taken, as this is the "smallest" state */
842         for (i = get_class_n_members(ft) - 1; i >= 0; --i) {
843                 ir_entity *ent = get_class_member(ft, i);
844
845                 set_entity_address_taken(ent, ir_address_not_taken);
846         }
847
848         assure_irg_outs(irg);
849
850         irg_frame = get_irg_frame(irg);
851
852         for (i = get_irn_n_outs(irg_frame) - 1; i >= 0; --i) {
853                 ir_node *succ = get_irn_out(irg_frame, i);
854                 ir_address_taken_state state;
855
856             if (is_Sel(succ)) {
857                         ir_entity *ent = get_Sel_entity(succ);
858
859                         if (get_entity_address_taken(ent) == ir_address_taken)
860                                 continue;
861
862                         state = find_address_taken_state(succ);
863                         if (state > get_entity_address_taken(ent))
864                                 set_entity_address_taken(ent, state);
865                 }
866         }
867         /* now computed */
868         irg->adr_taken_state = ir_address_taken_computed;
869 }  /* analyse_address_taken */
870
871 /* Returns the current address taken state of the graph. */
872 ir_address_taken_computed_state get_irg_address_taken_state(const ir_graph *irg) {
873         return irg->adr_taken_state;
874 }  /* get_irg_address_taken_state */
875
876 /* Sets the current address taken state of the graph. */
877 void set_irg_address_taken_state(ir_graph *irg, ir_address_taken_computed_state state) {
878         irg->adr_taken_state = state;
879 }  /* set_irg_address_taken_state */
880
881 /* Assure that the address taken flag is computed for the given graph. */
882 void assure_irg_address_taken_computed(ir_graph *irg) {
883         if (irg->adr_taken_state == ir_address_taken_not_computed)
884                 analyse_irg_address_taken(irg);
885 }  /* assure_irg_address_taken_computed */
886
887
888 /**
889  * Initialize the address_taken flag for a global type like type.
890  */
891 static void init_taken_flag(ir_type * tp) {
892         int i;
893
894         /* All external visible entities are at least
895            ir_address_taken_unknown. This is very conservative. */
896         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
897                 ir_entity *ent = get_compound_member(tp, i);
898                 ir_address_taken_state state;
899
900                 state = get_entity_visibility(ent) == visibility_external_visible ?
901                                 ir_address_taken_unknown : ir_address_not_taken ;
902                 set_entity_address_taken(ent, state);
903         }
904 }  /* init_taken_flag */
905
906 static void check_initializer_nodes(ir_initializer_t *initializer)
907 {
908         switch(initializer->kind) {
909         case IR_INITIALIZER_CONST: {
910                 ir_node *n = initializer->consti.value;
911
912                 /* let's check if it's an address */
913                 if (is_SymConst_addr_ent(n)) {
914                         ir_entity *ent = get_SymConst_entity(n);
915                         set_entity_address_taken(ent, ir_address_taken);
916                 }
917                 return;
918         }
919         case IR_INITIALIZER_TARVAL:
920         case IR_INITIALIZER_NULL:
921                 return;
922         case IR_INITIALIZER_COMPOUND: {
923                 size_t i;
924
925                 for(i = 0; i < initializer->compound.n_initializers; ++i) {
926                         ir_initializer_t *sub_initializer
927                                 = initializer->compound.initializers[i];
928                         check_initializer_nodes(sub_initializer);
929                 }
930                 return;
931         }
932         }
933         panic("invalid initialzier found");
934 }
935
936 /**
937  * Mark all entities used in the initializer for the given entity as address taken
938  */
939 static void check_initializer(ir_entity *ent) {
940         ir_node *n;
941         int i;
942
943         /* do not check uninitialized values */
944         if (get_entity_variability(ent) == variability_uninitialized)
945                 return;
946
947         /* Beware: Methods initialized with "themself". This does not count as a taken
948            address. */
949         if (is_Method_type(get_entity_type(ent)))
950                 return;
951
952         if (ent->has_initializer) {
953                 check_initializer_nodes(ent->attr.initializer);
954         } else if (is_atomic_entity(ent)) {
955                 /* let's check if it's an address */
956                 n = get_atomic_ent_value(ent);
957                 if (is_SymConst_addr_ent(n)) {
958                         ir_entity *ent = get_SymConst_entity(n);
959                         set_entity_address_taken(ent, ir_address_taken);
960                 }
961         } else {
962                 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
963                         n = get_compound_ent_value(ent, i);
964
965                         /* let's check if it's an address */
966                         if (is_SymConst_addr_ent(n)) {
967                                 ir_entity *ent = get_SymConst_entity(n);
968                                 set_entity_address_taken(ent, ir_address_taken);
969                         }
970                 }
971         }
972 }  /* check_initializer */
973
974
975 /**
976  * Mark all entities used in initializers as address taken
977  */
978 static void check_initializers(ir_type *tp) {
979         int i;
980
981         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
982                 ir_entity *ent = get_compound_member(tp, i);
983
984                 check_initializer(ent);
985         }
986 }  /* check_initializers */
987
988 #ifdef DEBUG_libfirm
989 /**
990  * Print the address taken state of all entities of a given type for debugging.
991  */
992 static void print_address_taken_state(ir_type *tp) {
993         int i;
994         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
995                 ir_entity *ent = get_compound_member(tp, i);
996                 ir_address_taken_state state = get_entity_address_taken(ent);
997
998                 if (state != ir_address_not_taken) {
999                         assert(ir_address_not_taken <= (int) state && state <= ir_address_taken);
1000                         ir_printf("%+F: %s\n", ent, get_address_taken_state_name(state));
1001                 }
1002         }
1003 }  /* print_address_taken_state */
1004 #endif /* DEBUG_libfirm */
1005
1006 /**
1007  * Post-walker: check for global entity address
1008  */
1009 static void check_global_address(ir_node *irn, void *env) {
1010         ir_node *tls = env;
1011         ir_entity *ent;
1012         ir_address_taken_state state;
1013
1014         if (is_SymConst_addr_ent(irn)) {
1015                 /* A global. */
1016                 ent = get_SymConst_entity(irn);
1017         } else if (is_Sel(irn) && get_Sel_ptr(irn) == tls) {
1018                 /* A TLS variable. */
1019                 ent = get_Sel_entity(irn);
1020         } else
1021                 return;
1022
1023         if (get_entity_address_taken(ent) >= ir_address_taken) {
1024                 /* Already at the maximum. */
1025                 return;
1026         }
1027         state = find_address_taken_state(irn);
1028         if (state > get_entity_address_taken(ent))
1029                 set_entity_address_taken(ent, state);
1030 }  /* check_global_address */
1031
1032 /**
1033  * Update the "address taken" flag of all global entities.
1034  */
1035 static void analyse_irp_globals_address_taken(void) {
1036         int i;
1037
1038         FIRM_DBG_REGISTER(dbg, "firm.ana.irmemory");
1039
1040         init_taken_flag(get_glob_type());
1041         init_taken_flag(get_tls_type());
1042
1043         check_initializers(get_glob_type());
1044         check_initializers(get_tls_type());
1045
1046         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1047                 ir_graph *irg = get_irp_irg(i);
1048
1049                 assure_irg_outs(irg);
1050                 irg_walk_graph(irg, NULL, check_global_address, get_irg_tls(irg));
1051         }
1052
1053 #ifdef DEBUG_libfirm
1054         if (firm_dbg_get_mask(dbg) & LEVEL_1) {
1055                 print_address_taken_state(get_glob_type());
1056                 print_address_taken_state(get_tls_type());
1057         }
1058 #endif /* DEBUG_libfirm */
1059
1060         /* now computed */
1061         irp->globals_adr_taken_state = ir_address_taken_computed;
1062 }  /* analyse_irp_globals_address_taken */
1063
1064 /* Returns the current address taken state of the globals. */
1065 ir_address_taken_computed_state get_irp_globals_address_taken_state(void) {
1066         return irp->globals_adr_taken_state;
1067 }  /* get_irp_globals_address_taken_state */
1068
1069 /* Sets the current address taken state of the graph. */
1070 void set_irp_globals_address_taken_state(ir_address_taken_computed_state state) {
1071         irp->globals_adr_taken_state = state;
1072 }  /* set_irg_address_taken_state */
1073
1074 /* Assure that the address taken flag is computed for the globals. */
1075 void assure_irp_globals_address_taken_computed(void) {
1076         if (irp->globals_adr_taken_state == ir_address_taken_not_computed)
1077                 analyse_irp_globals_address_taken();
1078 }  /* assure_irp_globals_address_taken_computed */
1079
1080
1081 #include <adt/pmap.h>
1082 #include "typerep.h"
1083
1084 DEBUG_ONLY(static firm_dbg_module_t *dbgcall = NULL;)
1085
1086 /** Maps method types to cloned method types. */
1087 static pmap *mtp_map;
1088
1089 /**
1090  * Clone a method type if not already cloned.
1091  */
1092 static ir_type *clone_type_and_cache(ir_type *tp) {
1093         static ident *prefix = NULL;
1094         ir_type *res;
1095         pmap_entry *e = pmap_find(mtp_map, tp);
1096
1097         if (e)
1098                 return e->value;
1099
1100         if (prefix == NULL)
1101                 prefix = new_id_from_chars("C", 1);
1102
1103         res = clone_type_method(tp, prefix);
1104         pmap_insert(mtp_map, tp, res);
1105         DB((dbgcall, LEVEL_2, "cloned type %+F into %+F\n", tp, res));
1106
1107         return res;
1108 }  /* clone_type_and_cache */
1109
1110 /**
1111  * Copy the calling conventions from the entities to the call type.
1112  */
1113 static void update_calls_to_private(ir_node *call, void *env) {
1114         (void) env;
1115         if (is_Call(call)) {
1116                 ir_node *ptr = get_Call_ptr(call);
1117
1118                 if (is_SymConst(ptr)) {
1119                         ir_entity *ent = get_SymConst_entity(ptr);
1120                         ir_type *ctp = get_Call_type(call);
1121
1122                         if (get_entity_additional_properties(ent) & mtp_property_private) {
1123                                 if ((get_method_additional_properties(ctp) & mtp_property_private) == 0) {
1124                                         ctp = clone_type_and_cache(ctp);
1125                                         set_method_additional_property(ctp, mtp_property_private);
1126                                         set_Call_type(call, ctp);
1127                                         DB((dbgcall, LEVEL_1, "changed call to private method %+F\n", ent));
1128                                 }
1129                         }
1130                 }
1131         }
1132 }  /* update_calls_to_private */
1133
1134 /* Mark all private methods, i.e. those of which all call sites are known. */
1135 void mark_private_methods(void) {
1136         int i;
1137         int changed = 0;
1138
1139         FIRM_DBG_REGISTER(dbgcall, "firm.opt.cc");
1140
1141         assure_irp_globals_address_taken_computed();
1142
1143         mtp_map = pmap_create();
1144
1145         /* first step: change the calling conventions of the local non-escaped entities */
1146         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1147                 ir_graph               *irg = get_irp_irg(i);
1148                 ir_entity              *ent = get_irg_entity(irg);
1149                 ir_address_taken_state state = get_entity_address_taken(ent);
1150
1151                 if (get_entity_visibility(ent) == visibility_local &&
1152                     state == ir_address_not_taken) {
1153                         ir_type *mtp = get_entity_type(ent);
1154
1155                         set_entity_additional_property(ent, mtp_property_private);
1156                         DB((dbgcall, LEVEL_1, "found private method %+F\n", ent));
1157                         if ((get_method_additional_properties(mtp) & mtp_property_private) == 0) {
1158                                 /* need a new type */
1159                                 mtp = clone_type_and_cache(mtp);
1160                                 set_entity_type(ent, mtp);
1161                                 set_method_additional_property(mtp, mtp_property_private);
1162                                 changed = 1;
1163                         }
1164                 }
1165         }
1166
1167         if (changed)
1168                 all_irg_walk(NULL, update_calls_to_private, NULL);
1169
1170         pmap_destroy(mtp_map);
1171 }  /* mark_private_methods */