36b727f473ccc4797f1d9d6ae56fba266f6ed111
[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 static storage_class_class_t classify_pointer(ir_graph *irg, ir_node *irn)
447 {
448         if(is_SymConst_addr_ent(irn)) {
449                 ir_entity *entity = get_SymConst_entity(irn);
450                 storage_class_class_t res = STORAGE_CLASS_GLOBALVAR;
451                 if (get_entity_address_taken(entity) == ir_address_not_taken) {
452                         res |= STORAGE_CLASS_MODIFIER_NOTTAKEN;
453                 }
454                 return res;
455         } else if(irn == get_irg_frame(irg)) {
456                 /* TODO: we already skipped sels so we can't determine address_taken */
457                 return STORAGE_CLASS_LOCALVAR;
458         } else if(is_arg_Proj(irn)) {
459                 return STORAGE_CLASS_ARGUMENT;
460         } else if(irn == get_irg_tls(irg)) {
461                 /* TODO: we already skipped sels so we can't determine address_taken */
462                 return STORAGE_CLASS_TLS;
463         } else if (is_Proj(irn) && is_malloc_Result(irn)) {
464                 return STORAGE_CLASS_MALLOCED;
465         }
466
467         return STORAGE_CLASS_POINTER;
468 }
469
470 /**
471  * Determine the alias relation between two addresses.
472  */
473 static ir_alias_relation _get_alias_relation(
474         ir_graph *irg,
475         ir_node *adr1, ir_mode *mode1,
476         ir_node *adr2, ir_mode *mode2)
477 {
478         ir_entity             *ent1, *ent2;
479         unsigned               options;
480         long                   offset1 = 0;
481         long                   offset2 = 0;
482         ir_node               *base1;
483         ir_node               *base2;
484         ir_node               *orig_adr1 = adr1;
485         ir_node               *orig_adr2 = adr2;
486         unsigned               mode_size;
487         storage_class_class_t  class1;
488         storage_class_class_t  class2;
489
490         if (! get_opt_alias_analysis())
491                 return may_alias;
492
493         if (adr1 == adr2)
494                 return sure_alias;
495
496         options = get_irg_memory_disambiguator_options(irg);
497
498         /* The Armageddon switch */
499         if (options & aa_opt_no_alias)
500                 return no_alias;
501
502         /* do the addresses have constants offsets?
503          *  Note: nodes are normalized to have constants at right inputs,
504          *        sub X, C is normalized to add X, -C
505          * */
506         while (is_Add(adr1)) {
507                 ir_node *add_right = get_Add_right(adr1);
508                 if (is_Const(add_right)) {
509                         tarval *tv  = get_Const_tarval(add_right);
510                         offset1    += get_tarval_long(tv);
511                         adr1        = get_Add_left(adr1);
512                         continue;
513                 }
514                 break;
515         }
516         while (is_Add(adr2)) {
517                 ir_node *add_right = get_Add_right(adr2);
518                 if (is_Const(add_right)) {
519                         tarval *tv  = get_Const_tarval(add_right);
520                         offset2    += get_tarval_long(tv);
521                         adr2        = get_Add_left(adr2);
522                         continue;
523                 }
524                 break;
525         }
526
527         mode_size = get_mode_size_bytes(mode1);
528         if (get_mode_size_bytes(mode2) > mode_size) {
529                 mode_size = get_mode_size_bytes(mode2);
530         }
531
532         /* same base address -> compare offsets */
533         if (adr1 == adr2) {
534                 if(labs(offset2 - offset1) >= mode_size)
535                         return no_alias;
536                 else
537                         return sure_alias;
538         }
539
540         /* skip sels */
541         base1 = adr1;
542         base2 = adr2;
543         if (is_Sel(adr1)) {
544                 adr1 = find_base_adr(adr1, &ent1);
545         }
546         if (is_Sel(adr2)) {
547                 adr2 = find_base_adr(adr2, &ent2);
548         }
549
550         /* same base address -> compare sel entities*/
551         if (adr1 == adr2 && base1 != adr1 && base2 != adr2) {
552                 if (ent1 != ent2)
553                         return no_alias;
554                 else
555                         return different_sel_offsets(base1, base2);
556         }
557
558         class1 = classify_pointer(irg, adr1);
559         class2 = classify_pointer(irg, adr2);
560
561         if (class1 == STORAGE_CLASS_POINTER) {
562                 if (class2 & STORAGE_CLASS_MODIFIER_NOTTAKEN) {
563                         return no_alias;
564                 } else {
565                         return may_alias;
566                 }
567         } else if (class2 == STORAGE_CLASS_POINTER) {
568                 if (class1 & STORAGE_CLASS_MODIFIER_NOTTAKEN) {
569                         return no_alias;
570                 } else {
571                         return may_alias;
572                 }
573         }
574
575         if (class1 != class2) {
576                 return no_alias;
577         }
578
579         if (class1 == STORAGE_CLASS_GLOBALVAR) {
580                 ir_entity *entity1 = get_SymConst_entity(adr1);
581                 ir_entity *entity2 = get_SymConst_entity(adr2);
582                 if(entity1 != entity2)
583                         return no_alias;
584
585                 /* for some reason CSE didn't work for the 2 symconsts... */
586                 return may_alias;
587         }
588
589         /* Type based alias analysis */
590         if (options & aa_opt_type_based) {
591                 ir_alias_relation rel;
592
593                 if (options & aa_opt_byte_type_may_alias) {
594                         if (get_mode_size_bits(mode1) == 8 || get_mode_size_bits(mode2) == 8) {
595                                 /* One of the modes address a byte. Assume a may_alias and leave
596                                    the type based check. */
597                                 goto leave_type_based_alias;
598                         }
599                 }
600                 /* cheap check: If the mode sizes did not match, the types MUST be different */
601                 if (get_mode_size_bits(mode1) != get_mode_size_bits(mode2))
602                         return no_alias;
603
604                 /* cheap test: if only one is a reference mode, no alias */
605                 if (mode_is_reference(mode1) != mode_is_reference(mode2))
606                         return no_alias;
607
608                 /* try rule R5 */
609                 rel = different_types(adr1, adr2);
610                 if (rel != may_alias)
611                         return rel;
612 leave_type_based_alias:;
613         }
614
615         /* do we have a language specific memory disambiguator? */
616         if (language_disambuigator) {
617                 ir_alias_relation rel = (*language_disambuigator)(irg, orig_adr1, mode1, orig_adr2, mode2);
618                 if (rel != may_alias)
619                         return rel;
620         }
621
622         /* access points-to information here */
623         return may_alias;
624 }  /* _get_alias_relation */
625
626 /*
627  * Determine the alias relation between two addresses.
628  */
629 ir_alias_relation get_alias_relation(
630         ir_graph *irg,
631         ir_node *adr1, ir_mode *mode1,
632         ir_node *adr2, ir_mode *mode2)
633 {
634         ir_alias_relation rel = _get_alias_relation(irg, adr1, mode1, adr2, mode2);
635         DB((dbg, LEVEL_1, "alias(%+F, %+F) = %s\n", adr1, adr2, get_ir_alias_relation_name(rel)));
636         return rel;
637 }  /* get_alias_relation */
638
639 /* Set a source language specific memory disambiguator function. */
640 void set_language_memory_disambiguator(DISAMBIGUATOR_FUNC func) {
641         language_disambuigator = func;
642 }  /* set_language_memory_disambiguator */
643
644 /** The result cache for the memory disambiguator. */
645 static set *result_cache = NULL;
646
647 /** An entry in the relation cache. */
648 typedef struct mem_disambig_entry {
649         ir_node           *adr1;    /**< The first address. */
650         ir_node           *adr2;    /**< The second address. */
651         ir_alias_relation result;   /**< The alias relation result. */
652 } mem_disambig_entry;
653
654 #define HASH_ENTRY(adr1, adr2)  (HASH_PTR(adr1) ^ HASH_PTR(adr2))
655
656 /**
657  * Compare two relation cache entries.
658  */
659 static int cmp_mem_disambig_entry(const void *elt, const void *key, size_t size) {
660         const mem_disambig_entry *p1 = elt;
661         const mem_disambig_entry *p2 = key;
662         (void) size;
663
664         return p1->adr1 == p2->adr1 && p1->adr2 == p2->adr2;
665 }  /* cmp_mem_disambig_entry */
666
667 /**
668  * Initialize the relation cache.
669  */
670 void mem_disambig_init(void) {
671         result_cache = new_set(cmp_mem_disambig_entry, 8);
672 }  /* mem_disambig_init */
673
674 /*
675  * Determine the alias relation between two addresses.
676  */
677 ir_alias_relation get_alias_relation_ex(
678         ir_graph *irg,
679         ir_node *adr1, ir_mode *mode1,
680         ir_node *adr2, ir_mode *mode2)
681 {
682         mem_disambig_entry key, *entry;
683
684         ir_fprintf(stderr, "%+F <-> %+F\n", adr1, adr2);
685
686         if (! get_opt_alias_analysis())
687                 return may_alias;
688
689         if (get_irn_opcode(adr1) > get_irn_opcode(adr2)) {
690                 ir_node *t = adr1;
691                 adr1 = adr2;
692                 adr2 = t;
693         }
694
695         key.adr1 = adr1;
696         key.adr2 = adr2;
697         entry = set_find(result_cache, &key, sizeof(key), HASH_ENTRY(adr1, adr2));
698         if (entry)
699                 return entry->result;
700
701         key.result = get_alias_relation(irg, adr1, mode1, adr2, mode2);
702
703         set_insert(result_cache, &key, sizeof(key), HASH_ENTRY(adr1, adr2));
704         return key.result;
705 }  /* get_alias_relation_ex */
706
707 /* Free the relation cache. */
708 void mem_disambig_term(void) {
709         if (result_cache) {
710                 del_set(result_cache);
711                 result_cache = NULL;
712         }
713 }  /* mem_disambig_term */
714
715 /**
716  * Check the mode of a Load/Store with the mode of the entity
717  * that is accessed.
718  * If the mode of the entity and the Load/Store mode do not match, we
719  * have the bad reinterpret case:
720  *
721  * int i;
722  * char b = *(char *)&i;
723  *
724  * We do NOT count this as one value and return address_taken
725  * in that case.
726  * However, we support an often used case. If the mode is two-complement
727  * we allow casts between signed/unsigned.
728  *
729  * @param mode     the mode of the Load/Store
730  * @param ent_mode the mode of the accessed entity
731  *
732  * @return non-zero if the Load/Store is a hidden cast, zero else
733  */
734 static int is_hidden_cast(ir_mode *mode, ir_mode *ent_mode) {
735         if (ent_mode != mode) {
736                 if (ent_mode == NULL ||
737                         get_mode_size_bits(ent_mode) != get_mode_size_bits(mode) ||
738                         get_mode_sort(ent_mode) != get_mode_sort(mode) ||
739                         get_mode_arithmetic(ent_mode) != irma_twos_complement ||
740                         get_mode_arithmetic(mode) != irma_twos_complement)
741                         return 1;
742         }
743         return 0;
744 }  /* is_hidden_cast */
745
746 /**
747  * Determine the address_taken state of a node (or it's successor Sels).
748  *
749  * @param irn  the node
750  */
751 static ir_address_taken_state find_address_taken_state(ir_node *irn) {
752         int     i, j;
753         ir_mode *emode, *mode;
754         ir_node *value;
755         ir_entity *ent;
756
757         for (i = get_irn_n_outs(irn) - 1; i >= 0; --i) {
758                 ir_node *succ = get_irn_out(irn, i);
759
760                 switch (get_irn_opcode(succ)) {
761                 case iro_Load:
762                         /* check if this load is not a hidden conversion */
763                         mode = get_Load_mode(succ);
764                         ent = is_SymConst(irn) ? get_SymConst_entity(irn) : get_Sel_entity(irn);
765                         emode = get_type_mode(get_entity_type(ent));
766                         if (is_hidden_cast(mode, emode))
767                                 return ir_address_taken;
768                         break;
769
770                 case iro_Store:
771                         /* check that the node is not the Store's value */
772                         value = get_Store_value(succ);
773                         if (value == irn)
774                                 return ir_address_taken;
775                         /* check if this Store is not a hidden conversion */
776                         mode = get_irn_mode(value);
777                         ent = is_SymConst(irn) ? get_SymConst_entity(irn) : get_Sel_entity(irn);
778                         emode = get_type_mode(get_entity_type(ent));
779                         if (is_hidden_cast(mode, emode))
780                                 return ir_address_taken;
781                         break;
782
783                 case iro_Sel: {
784                         /* Check the successor of irn. */
785                         ir_address_taken_state res = find_address_taken_state(succ);
786                         if (res != ir_address_not_taken)
787                                 return res;
788                         break;
789                 }
790
791                 case iro_Call:
792                         /* Only the call address is not an address taker but
793                            this is an uninteresting case, so we ignore it here. */
794                         for (j = get_Call_n_params(succ) - 1; j >= 0; --j) {
795                                 ir_node *param = get_Call_param(succ, j);
796                                 if (param == irn)
797                                         return ir_address_taken;
798                         }
799                         break;
800
801                 default:
802                         /* another op, the address may be taken */
803                         return ir_address_taken_unknown;
804                 }
805         }
806         /* All successors finished, the address is not taken. */
807         return ir_address_not_taken;
808 }  /* find_address_taken_state */
809
810 /**
811  * Update the "address taken" flag of all frame entities.
812  */
813 static void analyse_irg_address_taken(ir_graph *irg) {
814         ir_type *ft = get_irg_frame_type(irg);
815         ir_node *irg_frame;
816         int i;
817
818         /* set initial state to not_taken, as this is the "smallest" state */
819         for (i = get_class_n_members(ft) - 1; i >= 0; --i) {
820                 ir_entity *ent = get_class_member(ft, i);
821
822                 set_entity_address_taken(ent, ir_address_not_taken);
823         }
824
825         assure_irg_outs(irg);
826
827         irg_frame = get_irg_frame(irg);
828
829         for (i = get_irn_n_outs(irg_frame) - 1; i >= 0; --i) {
830                 ir_node *succ = get_irn_out(irg_frame, i);
831                 ir_address_taken_state state;
832
833             if (is_Sel(succ)) {
834                         ir_entity *ent = get_Sel_entity(succ);
835
836                         if (get_entity_address_taken(ent) == ir_address_taken)
837                                 continue;
838
839                         state = find_address_taken_state(succ);
840                         if (state > get_entity_address_taken(ent))
841                                 set_entity_address_taken(ent, state);
842                 }
843         }
844         /* now computed */
845         irg->adr_taken_state = ir_address_taken_computed;
846 }  /* analyse_address_taken */
847
848 /* Returns the current address taken state of the graph. */
849 ir_address_taken_computed_state get_irg_address_taken_state(const ir_graph *irg) {
850         return irg->adr_taken_state;
851 }  /* get_irg_address_taken_state */
852
853 /* Sets the current address taken state of the graph. */
854 void set_irg_address_taken_state(ir_graph *irg, ir_address_taken_computed_state state) {
855         irg->adr_taken_state = state;
856 }  /* set_irg_address_taken_state */
857
858 /* Assure that the address taken flag is computed for the given graph. */
859 void assure_irg_address_taken_computed(ir_graph *irg) {
860         if (irg->adr_taken_state == ir_address_taken_not_computed)
861                 analyse_irg_address_taken(irg);
862 }  /* assure_irg_address_taken_computed */
863
864
865 /**
866  * Initialize the address_taken flag for a global type like type.
867  */
868 static void init_taken_flag(ir_type * tp) {
869         int i;
870
871         /* All external visible entities are at least
872            ir_address_taken_unknown. This is very conservative. */
873         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
874                 ir_entity *ent = get_compound_member(tp, i);
875                 ir_address_taken_state state;
876
877                 state = get_entity_visibility(ent) == visibility_external_visible ?
878                                 ir_address_taken_unknown : ir_address_not_taken ;
879                 set_entity_address_taken(ent, state);
880         }
881 }  /* init_taken_flag */
882
883 static void check_initializer_nodes(ir_initializer_t *initializer)
884 {
885         switch(initializer->kind) {
886         case IR_INITIALIZER_CONST: {
887                 ir_node *n = initializer->consti.value;
888
889                 /* let's check if it's an address */
890                 if (is_SymConst_addr_ent(n)) {
891                         ir_entity *ent = get_SymConst_entity(n);
892                         set_entity_address_taken(ent, ir_address_taken);
893                 }
894                 return;
895         }
896         case IR_INITIALIZER_TARVAL:
897         case IR_INITIALIZER_NULL:
898                 return;
899         case IR_INITIALIZER_COMPOUND: {
900                 size_t i;
901
902                 for(i = 0; i < initializer->compound.n_initializers; ++i) {
903                         ir_initializer_t *sub_initializer
904                                 = initializer->compound.initializers[i];
905                         check_initializer_nodes(sub_initializer);
906                 }
907                 return;
908         }
909         }
910         panic("invalid initialzier found");
911 }
912
913 /**
914  * Mark all entities used in the initializer for the given entity as address taken
915  */
916 static void check_initializer(ir_entity *ent) {
917         ir_node *n;
918         int i;
919
920         /* do not check uninitialized values */
921         if (get_entity_variability(ent) == variability_uninitialized)
922                 return;
923
924         /* Beware: Methods initialized with "themself". This does not count as a taken
925            address. */
926         if (is_Method_type(get_entity_type(ent)))
927                 return;
928
929         if (ent->has_initializer) {
930                 check_initializer_nodes(ent->attr.initializer);
931         } else if (is_atomic_entity(ent)) {
932                 /* let's check if it's an address */
933                 n = get_atomic_ent_value(ent);
934                 if (is_SymConst_addr_ent(n)) {
935                         ir_entity *ent = get_SymConst_entity(n);
936                         set_entity_address_taken(ent, ir_address_taken);
937                 }
938         } else {
939                 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i) {
940                         n = get_compound_ent_value(ent, i);
941
942                         /* let's check if it's an address */
943                         if (is_SymConst_addr_ent(n)) {
944                                 ir_entity *ent = get_SymConst_entity(n);
945                                 set_entity_address_taken(ent, ir_address_taken);
946                         }
947                 }
948         }
949 }  /* check_initializer */
950
951
952 /**
953  * Mark all entities used in initializers as address taken
954  */
955 static void check_initializers(ir_type *tp) {
956         int i;
957
958         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
959                 ir_entity *ent = get_compound_member(tp, i);
960
961                 check_initializer(ent);
962         }
963 }  /* check_initializers */
964
965 #ifdef DEBUG_libfirm
966 /**
967  * Print the address taken state of all entities of a given type for debugging.
968  */
969 static void print_address_taken_state(ir_type *tp) {
970         int i;
971         for (i = get_compound_n_members(tp) - 1; i >= 0; --i) {
972                 ir_entity *ent = get_compound_member(tp, i);
973                 ir_address_taken_state state = get_entity_address_taken(ent);
974
975                 if (state != ir_address_not_taken) {
976                         assert(ir_address_not_taken <= (int) state && state <= ir_address_taken);
977                         ir_printf("%+F: %s\n", ent, get_address_taken_state_name(state));
978                 }
979         }
980 }  /* print_address_taken_state */
981 #endif /* DEBUG_libfirm */
982
983 /**
984  * Post-walker: check for global entity address
985  */
986 static void check_global_address(ir_node *irn, void *env) {
987         ir_node *tls = env;
988         ir_entity *ent;
989         ir_address_taken_state state;
990
991         if (is_SymConst_addr_ent(irn)) {
992                 /* A global. */
993                 ent = get_SymConst_entity(irn);
994         } else if (is_Sel(irn) && get_Sel_ptr(irn) == tls) {
995                 /* A TLS variable. */
996                 ent = get_Sel_entity(irn);
997         } else
998                 return;
999
1000         if (get_entity_address_taken(ent) >= ir_address_taken) {
1001                 /* Already at the maximum. */
1002                 return;
1003         }
1004         state = find_address_taken_state(irn);
1005         if (state > get_entity_address_taken(ent))
1006                 set_entity_address_taken(ent, state);
1007 }  /* check_global_address */
1008
1009 /**
1010  * Update the "address taken" flag of all global entities.
1011  */
1012 static void analyse_irp_globals_address_taken(void) {
1013         int i;
1014
1015         FIRM_DBG_REGISTER(dbg, "firm.ana.irmemory");
1016
1017         init_taken_flag(get_glob_type());
1018         init_taken_flag(get_tls_type());
1019
1020         check_initializers(get_glob_type());
1021         check_initializers(get_tls_type());
1022
1023         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1024                 ir_graph *irg = get_irp_irg(i);
1025
1026                 assure_irg_outs(irg);
1027                 irg_walk_graph(irg, NULL, check_global_address, get_irg_tls(irg));
1028         }
1029
1030 #ifdef DEBUG_libfirm
1031         if (firm_dbg_get_mask(dbg) & LEVEL_1) {
1032                 print_address_taken_state(get_glob_type());
1033                 print_address_taken_state(get_tls_type());
1034         }
1035 #endif /* DEBUG_libfirm */
1036
1037         /* now computed */
1038         irp->globals_adr_taken_state = ir_address_taken_computed;
1039 }  /* analyse_irp_globals_address_taken */
1040
1041 /* Returns the current address taken state of the globals. */
1042 ir_address_taken_computed_state get_irp_globals_address_taken_state(void) {
1043         return irp->globals_adr_taken_state;
1044 }  /* get_irp_globals_address_taken_state */
1045
1046 /* Sets the current address taken state of the graph. */
1047 void set_irp_globals_address_taken_state(ir_address_taken_computed_state state) {
1048         irp->globals_adr_taken_state = state;
1049 }  /* set_irg_address_taken_state */
1050
1051 /* Assure that the address taken flag is computed for the globals. */
1052 void assure_irp_globals_address_taken_computed(void) {
1053         if (irp->globals_adr_taken_state == ir_address_taken_not_computed)
1054                 analyse_irp_globals_address_taken();
1055 }  /* assure_irp_globals_address_taken_computed */
1056
1057
1058 #include <adt/pmap.h>
1059 #include "typerep.h"
1060
1061 DEBUG_ONLY(static firm_dbg_module_t *dbgcall = NULL;)
1062
1063 /** Maps method types to cloned method types. */
1064 static pmap *mtp_map;
1065
1066 /**
1067  * Clone a method type if not already cloned.
1068  */
1069 static ir_type *clone_type_and_cache(ir_type *tp) {
1070         static ident *prefix = NULL;
1071         ir_type *res;
1072         pmap_entry *e = pmap_find(mtp_map, tp);
1073
1074         if (e)
1075                 return e->value;
1076
1077         if (prefix == NULL)
1078                 prefix = new_id_from_chars("C", 1);
1079
1080         res = clone_type_method(tp, prefix);
1081         pmap_insert(mtp_map, tp, res);
1082         DB((dbgcall, LEVEL_2, "cloned type %+F into %+F\n", tp, res));
1083
1084         return res;
1085 }  /* clone_type_and_cache */
1086
1087 /**
1088  * Copy the calling conventions from the entities to the call type.
1089  */
1090 static void update_calls_to_private(ir_node *call, void *env) {
1091         (void) env;
1092         if (is_Call(call)) {
1093                 ir_node *ptr = get_Call_ptr(call);
1094
1095                 if (is_SymConst(ptr)) {
1096                         ir_entity *ent = get_SymConst_entity(ptr);
1097                         ir_type *ctp = get_Call_type(call);
1098
1099                         if (get_entity_additional_properties(ent) & mtp_property_private) {
1100                                 if ((get_method_additional_properties(ctp) & mtp_property_private) == 0) {
1101                                         ctp = clone_type_and_cache(ctp);
1102                                         set_method_additional_property(ctp, mtp_property_private);
1103                                         set_Call_type(call, ctp);
1104                                         DB((dbgcall, LEVEL_1, "changed call to private method %+F\n", ent));
1105                                 }
1106                         }
1107                 }
1108         }
1109 }  /* update_calls_to_private */
1110
1111 /* Mark all private methods, i.e. those of which all call sites are known. */
1112 void mark_private_methods(void) {
1113         int i;
1114         int changed = 0;
1115
1116         FIRM_DBG_REGISTER(dbgcall, "firm.opt.cc");
1117
1118         assure_irp_globals_address_taken_computed();
1119
1120         mtp_map = pmap_create();
1121
1122         /* first step: change the calling conventions of the local non-escaped entities */
1123         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1124                 ir_graph               *irg = get_irp_irg(i);
1125                 ir_entity              *ent = get_irg_entity(irg);
1126                 ir_address_taken_state state = get_entity_address_taken(ent);
1127
1128                 if (get_entity_visibility(ent) == visibility_local &&
1129                     state == ir_address_not_taken) {
1130                         ir_type *mtp = get_entity_type(ent);
1131
1132                         set_entity_additional_property(ent, mtp_property_private);
1133                         DB((dbgcall, LEVEL_1, "found private method %+F\n", ent));
1134                         if ((get_method_additional_properties(mtp) & mtp_property_private) == 0) {
1135                                 /* need a new type */
1136                                 mtp = clone_type_and_cache(mtp);
1137                                 set_entity_type(ent, mtp);
1138                                 set_method_additional_property(mtp, mtp_property_private);
1139                                 changed = 1;
1140                         }
1141                 }
1142         }
1143
1144         if (changed)
1145                 all_irg_walk(NULL, update_calls_to_private, NULL);
1146
1147         pmap_destroy(mtp_map);
1148 }  /* mark_private_methods */