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