PR tree-optimization/19633
[official-gcc.git] / gcc / tree-ssa-alias.c
blob6a95bcd2a11ec471f9d79fe7db4fd2384e57315d
1 /* Alias analysis for trees.
2 Copyright (C) 2004, 2005 Free Software Foundation, Inc.
3 Contributed by Diego Novillo <dnovillo@redhat.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include "config.h"
23 #include "system.h"
24 #include "coretypes.h"
25 #include "tm.h"
26 #include "tree.h"
27 #include "rtl.h"
28 #include "tm_p.h"
29 #include "hard-reg-set.h"
30 #include "basic-block.h"
31 #include "timevar.h"
32 #include "expr.h"
33 #include "ggc.h"
34 #include "langhooks.h"
35 #include "flags.h"
36 #include "function.h"
37 #include "diagnostic.h"
38 #include "tree-dump.h"
39 #include "tree-gimple.h"
40 #include "tree-flow.h"
41 #include "tree-inline.h"
42 #include "tree-pass.h"
43 #include "convert.h"
44 #include "params.h"
47 /* Structure to map a variable to its alias set and keep track of the
48 virtual operands that will be needed to represent it. */
49 struct alias_map_d
51 /* Variable and its alias set. */
52 tree var;
53 HOST_WIDE_INT set;
55 /* Total number of virtual operands that will be needed to represent
56 all the aliases of VAR. */
57 long total_alias_vops;
59 /* Nonzero if the aliases for this memory tag have been grouped
60 already. Used in group_aliases. */
61 unsigned int grouped_p : 1;
63 /* Set of variables aliased with VAR. This is the exact same
64 information contained in VAR_ANN (VAR)->MAY_ALIASES, but in
65 bitmap form to speed up alias grouping. */
66 sbitmap may_aliases;
70 /* Alias information used by compute_may_aliases and its helpers. */
71 struct alias_info
73 /* SSA names visited while collecting points-to information. If bit I
74 is set, it means that SSA variable with version I has already been
75 visited. */
76 sbitmap ssa_names_visited;
78 /* Array of SSA_NAME pointers processed by the points-to collector. */
79 varray_type processed_ptrs;
81 /* Variables whose address is still needed. */
82 bitmap addresses_needed;
84 /* ADDRESSABLE_VARS contains all the global variables and locals that
85 have had their address taken. */
86 struct alias_map_d **addressable_vars;
87 size_t num_addressable_vars;
89 /* POINTERS contains all the _DECL pointers with unique memory tags
90 that have been referenced in the program. */
91 struct alias_map_d **pointers;
92 size_t num_pointers;
94 /* Number of function calls found in the program. */
95 size_t num_calls_found;
97 /* Array of counters to keep track of how many times each pointer has
98 been dereferenced in the program. This is used by the alias grouping
99 heuristic in compute_flow_insensitive_aliasing. */
100 varray_type num_references;
102 /* Total number of virtual operands that will be needed to represent
103 all the aliases of all the pointers found in the program. */
104 long total_alias_vops;
106 /* Variables that have been written to. */
107 bitmap written_vars;
109 /* Pointers that have been used in an indirect store operation. */
110 bitmap dereferenced_ptrs_store;
112 /* Pointers that have been used in an indirect load operation. */
113 bitmap dereferenced_ptrs_load;
117 /* Counters used to display statistics on alias analysis. */
118 struct alias_stats_d
120 unsigned int alias_queries;
121 unsigned int alias_mayalias;
122 unsigned int alias_noalias;
123 unsigned int simple_queries;
124 unsigned int simple_resolved;
125 unsigned int tbaa_queries;
126 unsigned int tbaa_resolved;
130 /* Local variables. */
131 static struct alias_stats_d alias_stats;
133 /* Local functions. */
134 static void compute_flow_insensitive_aliasing (struct alias_info *);
135 static void dump_alias_stats (FILE *);
136 static bool may_alias_p (tree, HOST_WIDE_INT, tree, HOST_WIDE_INT);
137 static tree create_memory_tag (tree type, bool is_type_tag);
138 static tree get_tmt_for (tree, struct alias_info *);
139 static tree get_nmt_for (tree);
140 static void add_may_alias (tree, tree);
141 static void replace_may_alias (tree, size_t, tree);
142 static struct alias_info *init_alias_info (void);
143 static void delete_alias_info (struct alias_info *);
144 static void compute_points_to_and_addr_escape (struct alias_info *);
145 static void compute_flow_sensitive_aliasing (struct alias_info *);
146 static void setup_pointers_and_addressables (struct alias_info *);
147 static bool collect_points_to_info_r (tree, tree, void *);
148 static bool is_escape_site (tree, size_t *);
149 static void add_pointed_to_var (struct alias_info *, tree, tree);
150 static void create_global_var (void);
151 static void collect_points_to_info_for (struct alias_info *, tree);
152 static void maybe_create_global_var (struct alias_info *ai);
153 static void group_aliases (struct alias_info *);
154 static void set_pt_anything (tree ptr);
155 static void set_pt_malloc (tree ptr);
157 /* Global declarations. */
159 /* Call clobbered variables in the function. If bit I is set, then
160 REFERENCED_VARS (I) is call-clobbered. */
161 bitmap call_clobbered_vars;
163 /* Addressable variables in the function. If bit I is set, then
164 REFERENCED_VARS (I) has had its address taken. Note that
165 CALL_CLOBBERED_VARS and ADDRESSABLE_VARS are not related. An
166 addressable variable is not necessarily call-clobbered (e.g., a
167 local addressable whose address does not escape) and not all
168 call-clobbered variables are addressable (e.g., a local static
169 variable). */
170 bitmap addressable_vars;
172 /* When the program has too many call-clobbered variables and call-sites,
173 this variable is used to represent the clobbering effects of function
174 calls. In these cases, all the call clobbered variables in the program
175 are forced to alias this variable. This reduces compile times by not
176 having to keep track of too many V_MAY_DEF expressions at call sites. */
177 tree global_var;
180 /* Compute may-alias information for every variable referenced in function
181 FNDECL.
183 Alias analysis proceeds in 3 main phases:
185 1- Points-to and escape analysis.
187 This phase walks the use-def chains in the SSA web looking for three
188 things:
190 * Assignments of the form P_i = &VAR
191 * Assignments of the form P_i = malloc()
192 * Pointers and ADDR_EXPR that escape the current function.
194 The concept of 'escaping' is the same one used in the Java world. When
195 a pointer or an ADDR_EXPR escapes, it means that it has been exposed
196 outside of the current function. So, assignment to global variables,
197 function arguments and returning a pointer are all escape sites, as are
198 conversions between pointers and integers.
200 This is where we are currently limited. Since not everything is renamed
201 into SSA, we lose track of escape properties when a pointer is stashed
202 inside a field in a structure, for instance. In those cases, we are
203 assuming that the pointer does escape.
205 We use escape analysis to determine whether a variable is
206 call-clobbered. Simply put, if an ADDR_EXPR escapes, then the variable
207 is call-clobbered. If a pointer P_i escapes, then all the variables
208 pointed-to by P_i (and its memory tag) also escape.
210 2- Compute flow-sensitive aliases
212 We have two classes of memory tags. Memory tags associated with the
213 pointed-to data type of the pointers in the program. These tags are
214 called "type memory tag" (TMT). The other class are those associated
215 with SSA_NAMEs, called "name memory tag" (NMT). The basic idea is that
216 when adding operands for an INDIRECT_REF *P_i, we will first check
217 whether P_i has a name tag, if it does we use it, because that will have
218 more precise aliasing information. Otherwise, we use the standard type
219 tag.
221 In this phase, we go through all the pointers we found in points-to
222 analysis and create alias sets for the name memory tags associated with
223 each pointer P_i. If P_i escapes, we mark call-clobbered the variables
224 it points to and its tag.
227 3- Compute flow-insensitive aliases
229 This pass will compare the alias set of every type memory tag and every
230 addressable variable found in the program. Given a type memory tag TMT
231 and an addressable variable V. If the alias sets of TMT and V conflict
232 (as computed by may_alias_p), then V is marked as an alias tag and added
233 to the alias set of TMT.
235 For instance, consider the following function:
237 foo (int i)
239 int *p, a, b;
241 if (i > 10)
242 p = &a;
243 else
244 p = &b;
246 *p = 3;
247 a = b + 2;
248 return *p;
251 After aliasing analysis has finished, the type memory tag for pointer
252 'p' will have two aliases, namely variables 'a' and 'b'. Every time
253 pointer 'p' is dereferenced, we want to mark the operation as a
254 potential reference to 'a' and 'b'.
256 foo (int i)
258 int *p, a, b;
260 if (i_2 > 10)
261 p_4 = &a;
262 else
263 p_6 = &b;
264 # p_1 = PHI <p_4(1), p_6(2)>;
266 # a_7 = V_MAY_DEF <a_3>;
267 # b_8 = V_MAY_DEF <b_5>;
268 *p_1 = 3;
270 # a_9 = V_MAY_DEF <a_7>
271 # VUSE <b_8>
272 a_9 = b_8 + 2;
274 # VUSE <a_9>;
275 # VUSE <b_8>;
276 return *p_1;
279 In certain cases, the list of may aliases for a pointer may grow too
280 large. This may cause an explosion in the number of virtual operands
281 inserted in the code. Resulting in increased memory consumption and
282 compilation time.
284 When the number of virtual operands needed to represent aliased
285 loads and stores grows too large (configurable with @option{--param
286 max-aliased-vops}), alias sets are grouped to avoid severe
287 compile-time slow downs and memory consumption. See group_aliases. */
289 static void
290 compute_may_aliases (void)
292 struct alias_info *ai;
294 memset (&alias_stats, 0, sizeof (alias_stats));
296 /* Initialize aliasing information. */
297 ai = init_alias_info ();
299 /* For each pointer P_i, determine the sets of variables that P_i may
300 point-to. For every addressable variable V, determine whether the
301 address of V escapes the current function, making V call-clobbered
302 (i.e., whether &V is stored in a global variable or if its passed as a
303 function call argument). */
304 compute_points_to_and_addr_escape (ai);
306 /* Collect all pointers and addressable variables, compute alias sets,
307 create memory tags for pointers and promote variables whose address is
308 not needed anymore. */
309 setup_pointers_and_addressables (ai);
311 /* Compute flow-sensitive, points-to based aliasing for all the name
312 memory tags. Note that this pass needs to be done before flow
313 insensitive analysis because it uses the points-to information
314 gathered before to mark call-clobbered type tags. */
315 compute_flow_sensitive_aliasing (ai);
317 /* Compute type-based flow-insensitive aliasing for all the type
318 memory tags. */
319 compute_flow_insensitive_aliasing (ai);
321 /* If the program has too many call-clobbered variables and/or function
322 calls, create .GLOBAL_VAR and use it to model call-clobbering
323 semantics at call sites. This reduces the number of virtual operands
324 considerably, improving compile times at the expense of lost
325 aliasing precision. */
326 maybe_create_global_var (ai);
328 /* Debugging dumps. */
329 if (dump_file)
331 dump_referenced_vars (dump_file);
332 if (dump_flags & TDF_STATS)
333 dump_alias_stats (dump_file);
334 dump_points_to_info (dump_file);
335 dump_alias_info (dump_file);
338 /* Deallocate memory used by aliasing data structures. */
339 delete_alias_info (ai);
342 struct tree_opt_pass pass_may_alias =
344 "alias", /* name */
345 NULL, /* gate */
346 compute_may_aliases, /* execute */
347 NULL, /* sub */
348 NULL, /* next */
349 0, /* static_pass_number */
350 TV_TREE_MAY_ALIAS, /* tv_id */
351 PROP_cfg | PROP_ssa, /* properties_required */
352 PROP_alias, /* properties_provided */
353 0, /* properties_destroyed */
354 0, /* todo_flags_start */
355 TODO_dump_func | TODO_rename_vars
356 | TODO_ggc_collect | TODO_verify_ssa
357 | TODO_verify_stmts, /* todo_flags_finish */
358 0 /* letter */
362 /* Data structure used to count the number of dereferences to PTR
363 inside an expression. */
364 struct count_ptr_d
366 tree ptr;
367 unsigned count;
371 /* Helper for count_uses_and_derefs. Called by walk_tree to look for
372 (ALIGN/MISALIGNED_)INDIRECT_REF nodes for the pointer passed in DATA. */
374 static tree
375 count_ptr_derefs (tree *tp, int *walk_subtrees ATTRIBUTE_UNUSED, void *data)
377 struct count_ptr_d *count_p = (struct count_ptr_d *) data;
379 if (INDIRECT_REF_P (*tp) && TREE_OPERAND (*tp, 0) == count_p->ptr)
380 count_p->count++;
382 return NULL_TREE;
386 /* Count the number of direct and indirect uses for pointer PTR in
387 statement STMT. The two counts are stored in *NUM_USES_P and
388 *NUM_DEREFS_P respectively. *IS_STORE_P is set to 'true' if at
389 least one of those dereferences is a store operation. */
391 static void
392 count_uses_and_derefs (tree ptr, tree stmt, unsigned *num_uses_p,
393 unsigned *num_derefs_p, bool *is_store)
395 ssa_op_iter i;
396 tree use;
398 *num_uses_p = 0;
399 *num_derefs_p = 0;
400 *is_store = false;
402 /* Find out the total number of uses of PTR in STMT. */
403 FOR_EACH_SSA_TREE_OPERAND (use, stmt, i, SSA_OP_USE)
404 if (use == ptr)
405 (*num_uses_p)++;
407 /* Now count the number of indirect references to PTR. This is
408 truly awful, but we don't have much choice. There are no parent
409 pointers inside INDIRECT_REFs, so an expression like
410 '*x_1 = foo (x_1, *x_1)' needs to be traversed piece by piece to
411 find all the indirect and direct uses of x_1 inside. The only
412 shortcut we can take is the fact that GIMPLE only allows
413 INDIRECT_REFs inside the expressions below. */
414 if (TREE_CODE (stmt) == MODIFY_EXPR
415 || (TREE_CODE (stmt) == RETURN_EXPR
416 && TREE_CODE (TREE_OPERAND (stmt, 0)) == MODIFY_EXPR)
417 || TREE_CODE (stmt) == ASM_EXPR
418 || TREE_CODE (stmt) == CALL_EXPR)
420 tree lhs, rhs;
422 if (TREE_CODE (stmt) == MODIFY_EXPR)
424 lhs = TREE_OPERAND (stmt, 0);
425 rhs = TREE_OPERAND (stmt, 1);
427 else if (TREE_CODE (stmt) == RETURN_EXPR)
429 tree e = TREE_OPERAND (stmt, 0);
430 lhs = TREE_OPERAND (e, 0);
431 rhs = TREE_OPERAND (e, 1);
433 else if (TREE_CODE (stmt) == ASM_EXPR)
435 lhs = ASM_OUTPUTS (stmt);
436 rhs = ASM_INPUTS (stmt);
438 else
440 lhs = NULL_TREE;
441 rhs = stmt;
444 if (lhs && EXPR_P (lhs))
446 struct count_ptr_d count;
447 count.ptr = ptr;
448 count.count = 0;
449 walk_tree (&lhs, count_ptr_derefs, &count, NULL);
450 *is_store = true;
451 *num_derefs_p = count.count;
454 if (rhs && EXPR_P (rhs))
456 struct count_ptr_d count;
457 count.ptr = ptr;
458 count.count = 0;
459 walk_tree (&rhs, count_ptr_derefs, &count, NULL);
460 *num_derefs_p += count.count;
464 gcc_assert (*num_uses_p >= *num_derefs_p);
468 /* Count the number of calls in the function and conditionally
469 create GLOBAL_VAR. This is performed before translation
470 into SSA (and thus before alias analysis) to avoid compile time
471 and memory utilization explosions in functions with many
472 of calls and call clobbered variables. */
474 static void
475 count_calls_and_maybe_create_global_var (void)
477 struct alias_info ai;
478 basic_block bb;
479 bool temp;
481 memset (&ai, 0, sizeof (struct alias_info));
483 /* First count the number of calls in the IL. */
484 FOR_EACH_BB (bb)
486 block_stmt_iterator si;
488 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
490 tree stmt = bsi_stmt (si);
492 if (get_call_expr_in (stmt) != NULL_TREE)
493 ai.num_calls_found++;
497 /* If there are no call clobbered variables, then maybe_create_global_var
498 will always create a GLOBAL_VAR. At this point we do not want that
499 behavior. So we turn on one bit in CALL_CLOBBERED_VARs, call
500 maybe_create_global_var, then reset the bit to its original state. */
501 temp = bitmap_bit_p (call_clobbered_vars, 0);
502 bitmap_set_bit (call_clobbered_vars, 0);
503 maybe_create_global_var (&ai);
504 if (!temp)
505 bitmap_clear_bit (call_clobbered_vars, 0);
508 struct tree_opt_pass pass_maybe_create_global_var =
510 "maybe_create_global_var", /* name */
511 NULL, /* gate */
512 count_calls_and_maybe_create_global_var, /* execute */
513 NULL, /* sub */
514 NULL, /* next */
515 0, /* static_pass_number */
516 TV_TREE_MAY_ALIAS, /* tv_id */
517 PROP_cfg, /* properties_required */
518 0, /* properties_provided */
519 0, /* properties_destroyed */
520 0, /* todo_flags_start */
521 0, /* todo_flags_finish */
522 0 /* letter */
525 /* Initialize the data structures used for alias analysis. */
527 static struct alias_info *
528 init_alias_info (void)
530 struct alias_info *ai;
531 static bool aliases_computed_p = false;
533 ai = xcalloc (1, sizeof (struct alias_info));
534 ai->ssa_names_visited = sbitmap_alloc (num_ssa_names);
535 sbitmap_zero (ai->ssa_names_visited);
536 VARRAY_TREE_INIT (ai->processed_ptrs, 50, "processed_ptrs");
537 ai->addresses_needed = BITMAP_XMALLOC ();
538 VARRAY_UINT_INIT (ai->num_references, num_referenced_vars, "num_references");
539 ai->written_vars = BITMAP_XMALLOC ();
540 ai->dereferenced_ptrs_store = BITMAP_XMALLOC ();
541 ai->dereferenced_ptrs_load = BITMAP_XMALLOC ();
543 /* If aliases have been computed before, clear existing information. */
544 if (aliases_computed_p)
546 unsigned i;
547 basic_block bb;
549 /* Make sure that every statement has a valid set of operands.
550 If a statement needs to be scanned for operands while we
551 compute aliases, it may get erroneous operands because all
552 the alias relations are not built at that point.
553 FIXME: This code will become obsolete when operands are not
554 lazily updated. */
555 FOR_EACH_BB (bb)
557 block_stmt_iterator si;
558 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
559 get_stmt_operands (bsi_stmt (si));
562 /* Similarly, clear the set of addressable variables. In this
563 case, we can just clear the set because addressability is
564 only computed here. */
565 bitmap_clear (addressable_vars);
567 /* Clear flow-insensitive alias information from each symbol. */
568 for (i = 0; i < num_referenced_vars; i++)
570 tree var = referenced_var (i);
571 var_ann_t ann = var_ann (var);
573 ann->is_alias_tag = 0;
574 ann->may_aliases = NULL;
576 /* Since we are about to re-discover call-clobbered
577 variables, clear the call-clobbered flag. Variables that
578 are intrinsically call-clobbered (globals, local statics,
579 etc) will not be marked by the aliasing code, so we can't
580 remove them from CALL_CLOBBERED_VARS. */
581 if (ann->mem_tag_kind != NOT_A_TAG || !is_global_var (var))
582 clear_call_clobbered (var);
585 /* Clear flow-sensitive points-to information from each SSA name. */
586 for (i = 1; i < num_ssa_names; i++)
588 tree name = ssa_name (i);
590 if (!name || !POINTER_TYPE_P (TREE_TYPE (name)))
591 continue;
593 if (SSA_NAME_PTR_INFO (name))
595 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (name);
597 /* Clear all the flags but keep the name tag to
598 avoid creating new temporaries unnecessarily. If
599 this pointer is found to point to a subset or
600 superset of its former points-to set, then a new
601 tag will need to be created in create_name_tags. */
602 pi->pt_anything = 0;
603 pi->pt_malloc = 0;
604 pi->pt_null = 0;
605 pi->value_escapes_p = 0;
606 pi->is_dereferenced = 0;
607 if (pi->pt_vars)
608 bitmap_clear (pi->pt_vars);
613 /* Next time, we will need to reset alias information. */
614 aliases_computed_p = true;
616 return ai;
620 /* Deallocate memory used by alias analysis. */
622 static void
623 delete_alias_info (struct alias_info *ai)
625 size_t i;
627 sbitmap_free (ai->ssa_names_visited);
628 ai->processed_ptrs = NULL;
629 BITMAP_XFREE (ai->addresses_needed);
631 for (i = 0; i < ai->num_addressable_vars; i++)
633 sbitmap_free (ai->addressable_vars[i]->may_aliases);
634 free (ai->addressable_vars[i]);
636 free (ai->addressable_vars);
638 for (i = 0; i < ai->num_pointers; i++)
640 sbitmap_free (ai->pointers[i]->may_aliases);
641 free (ai->pointers[i]);
643 free (ai->pointers);
645 ai->num_references = NULL;
646 BITMAP_XFREE (ai->written_vars);
647 BITMAP_XFREE (ai->dereferenced_ptrs_store);
648 BITMAP_XFREE (ai->dereferenced_ptrs_load);
650 free (ai);
654 /* Walk use-def chains for pointer PTR to determine what variables is PTR
655 pointing to. */
657 static void
658 collect_points_to_info_for (struct alias_info *ai, tree ptr)
660 gcc_assert (POINTER_TYPE_P (TREE_TYPE (ptr)));
662 if (!TEST_BIT (ai->ssa_names_visited, SSA_NAME_VERSION (ptr)))
664 SET_BIT (ai->ssa_names_visited, SSA_NAME_VERSION (ptr));
665 walk_use_def_chains (ptr, collect_points_to_info_r, ai, true);
666 VARRAY_PUSH_TREE (ai->processed_ptrs, ptr);
671 /* Traverse use-def links for all the pointers in the program to collect
672 address escape and points-to information.
674 This is loosely based on the same idea described in R. Hasti and S.
675 Horwitz, ``Using static single assignment form to improve
676 flow-insensitive pointer analysis,'' in SIGPLAN Conference on
677 Programming Language Design and Implementation, pp. 97-105, 1998. */
679 static void
680 compute_points_to_and_addr_escape (struct alias_info *ai)
682 basic_block bb;
683 unsigned i;
684 tree op;
685 ssa_op_iter iter;
687 timevar_push (TV_TREE_PTA);
689 FOR_EACH_BB (bb)
691 bb_ann_t block_ann = bb_ann (bb);
692 block_stmt_iterator si;
694 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
696 bitmap addr_taken;
697 tree stmt = bsi_stmt (si);
698 bool stmt_escapes_p = is_escape_site (stmt, &ai->num_calls_found);
699 bitmap_iterator bi;
701 /* Mark all the variables whose address are taken by the
702 statement. Note that this will miss all the addresses taken
703 in PHI nodes (those are discovered while following the use-def
704 chains). */
705 get_stmt_operands (stmt);
706 addr_taken = addresses_taken (stmt);
707 if (addr_taken)
708 EXECUTE_IF_SET_IN_BITMAP (addr_taken, 0, i, bi)
710 tree var = referenced_var (i);
711 bitmap_set_bit (ai->addresses_needed, var_ann (var)->uid);
712 if (stmt_escapes_p)
713 mark_call_clobbered (var);
716 if (stmt_escapes_p)
717 block_ann->has_escape_site = 1;
719 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_USE)
721 var_ann_t v_ann = var_ann (SSA_NAME_VAR (op));
722 struct ptr_info_def *pi;
723 bool is_store;
724 unsigned num_uses, num_derefs;
726 /* If the operand's variable may be aliased, keep track
727 of how many times we've referenced it. This is used
728 for alias grouping in compute_flow_sensitive_aliasing.
729 Note that we don't need to grow AI->NUM_REFERENCES
730 because we are processing regular variables, not
731 memory tags (the array's initial size is set to
732 NUM_REFERENCED_VARS). */
733 if (may_be_aliased (SSA_NAME_VAR (op)))
734 (VARRAY_UINT (ai->num_references, v_ann->uid))++;
736 if (!POINTER_TYPE_P (TREE_TYPE (op)))
737 continue;
739 collect_points_to_info_for (ai, op);
741 pi = SSA_NAME_PTR_INFO (op);
742 count_uses_and_derefs (op, stmt, &num_uses, &num_derefs,
743 &is_store);
745 if (num_derefs > 0)
747 /* Mark OP as dereferenced. In a subsequent pass,
748 dereferenced pointers that point to a set of
749 variables will be assigned a name tag to alias
750 all the variables OP points to. */
751 pi->is_dereferenced = 1;
753 /* Keep track of how many time we've dereferenced each
754 pointer. Again, we don't need to grow
755 AI->NUM_REFERENCES because we're processing
756 existing program variables. */
757 (VARRAY_UINT (ai->num_references, v_ann->uid))++;
759 /* If this is a store operation, mark OP as being
760 dereferenced to store, otherwise mark it as being
761 dereferenced to load. */
762 if (is_store)
763 bitmap_set_bit (ai->dereferenced_ptrs_store, v_ann->uid);
764 else
765 bitmap_set_bit (ai->dereferenced_ptrs_load, v_ann->uid);
768 if (stmt_escapes_p && num_derefs < num_uses)
770 /* If STMT is an escape point and STMT contains at
771 least one direct use of OP, then the value of OP
772 escapes and so the pointed-to variables need to
773 be marked call-clobbered. */
774 pi->value_escapes_p = 1;
776 /* If the statement makes a function call, assume
777 that pointer OP will be dereferenced in a store
778 operation inside the called function. */
779 if (get_call_expr_in (stmt))
781 bitmap_set_bit (ai->dereferenced_ptrs_store, v_ann->uid);
782 pi->is_dereferenced = 1;
787 /* Update reference counter for definitions to any
788 potentially aliased variable. This is used in the alias
789 grouping heuristics. */
790 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_DEF)
792 tree var = SSA_NAME_VAR (op);
793 var_ann_t ann = var_ann (var);
794 bitmap_set_bit (ai->written_vars, ann->uid);
795 if (may_be_aliased (var))
796 (VARRAY_UINT (ai->num_references, ann->uid))++;
798 if (POINTER_TYPE_P (TREE_TYPE (op)))
799 collect_points_to_info_for (ai, op);
802 /* Mark variables in V_MAY_DEF operands as being written to. */
803 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_VIRTUAL_DEFS)
805 tree var = SSA_NAME_VAR (op);
806 var_ann_t ann = var_ann (var);
807 bitmap_set_bit (ai->written_vars, ann->uid);
810 /* After promoting variables and computing aliasing we will
811 need to re-scan most statements. FIXME: Try to minimize the
812 number of statements re-scanned. It's not really necessary to
813 re-scan *all* statements. */
814 modify_stmt (stmt);
818 timevar_pop (TV_TREE_PTA);
822 /* Create name tags for all the pointers that have been dereferenced.
823 We only create a name tag for a pointer P if P is found to point to
824 a set of variables (so that we can alias them to *P) or if it is
825 the result of a call to malloc (which means that P cannot point to
826 anything else nor alias any other variable).
828 If two pointers P and Q point to the same set of variables, they
829 are assigned the same name tag. */
831 static void
832 create_name_tags (struct alias_info *ai)
834 size_t i;
836 for (i = 0; i < VARRAY_ACTIVE_SIZE (ai->processed_ptrs); i++)
838 tree ptr = VARRAY_TREE (ai->processed_ptrs, i);
839 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
841 if (pi->pt_anything || !pi->is_dereferenced)
843 /* No name tags for pointers that have not been
844 dereferenced or point to an arbitrary location. */
845 pi->name_mem_tag = NULL_TREE;
846 continue;
849 if (pi->pt_vars && !bitmap_empty_p (pi->pt_vars))
851 size_t j;
852 tree old_name_tag = pi->name_mem_tag;
854 /* If PTR points to a set of variables, check if we don't
855 have another pointer Q with the same points-to set before
856 creating a tag. If so, use Q's tag instead of creating a
857 new one.
859 This is important for not creating unnecessary symbols
860 and also for copy propagation. If we ever need to
861 propagate PTR into Q or vice-versa, we would run into
862 problems if they both had different name tags because
863 they would have different SSA version numbers (which
864 would force us to take the name tags in and out of SSA). */
865 for (j = 0; j < i; j++)
867 tree q = VARRAY_TREE (ai->processed_ptrs, j);
868 struct ptr_info_def *qi = SSA_NAME_PTR_INFO (q);
870 if (qi
871 && qi->pt_vars
872 && qi->name_mem_tag
873 && bitmap_equal_p (pi->pt_vars, qi->pt_vars))
875 pi->name_mem_tag = qi->name_mem_tag;
876 break;
880 /* If we didn't find a pointer with the same points-to set
881 as PTR, create a new name tag if needed. */
882 if (pi->name_mem_tag == NULL_TREE)
883 pi->name_mem_tag = get_nmt_for (ptr);
885 /* If the new name tag computed for PTR is different than
886 the old name tag that it used to have, then the old tag
887 needs to be removed from the IL, so we mark it for
888 renaming. */
889 if (old_name_tag && old_name_tag != pi->name_mem_tag)
890 bitmap_set_bit (vars_to_rename, var_ann (old_name_tag)->uid);
892 else if (pi->pt_malloc)
894 /* Otherwise, create a unique name tag for this pointer. */
895 pi->name_mem_tag = get_nmt_for (ptr);
897 else
899 /* Only pointers that may point to malloc or other variables
900 may receive a name tag. If the pointer does not point to
901 a known spot, we should use type tags. */
902 set_pt_anything (ptr);
903 continue;
906 TREE_THIS_VOLATILE (pi->name_mem_tag)
907 |= TREE_THIS_VOLATILE (TREE_TYPE (TREE_TYPE (ptr)));
909 /* Mark the new name tag for renaming. */
910 bitmap_set_bit (vars_to_rename, var_ann (pi->name_mem_tag)->uid);
916 /* For every pointer P_i in AI->PROCESSED_PTRS, create may-alias sets for
917 the name memory tag (NMT) associated with P_i. If P_i escapes, then its
918 name tag and the variables it points-to are call-clobbered. Finally, if
919 P_i escapes and we could not determine where it points to, then all the
920 variables in the same alias set as *P_i are marked call-clobbered. This
921 is necessary because we must assume that P_i may take the address of any
922 variable in the same alias set. */
924 static void
925 compute_flow_sensitive_aliasing (struct alias_info *ai)
927 size_t i;
929 create_name_tags (ai);
931 for (i = 0; i < VARRAY_ACTIVE_SIZE (ai->processed_ptrs); i++)
933 unsigned j;
934 tree ptr = VARRAY_TREE (ai->processed_ptrs, i);
935 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
936 var_ann_t v_ann = var_ann (SSA_NAME_VAR (ptr));
937 bitmap_iterator bi;
939 if (pi->value_escapes_p || pi->pt_anything)
941 /* If PTR escapes or may point to anything, then its associated
942 memory tags and pointed-to variables are call-clobbered. */
943 if (pi->name_mem_tag)
944 mark_call_clobbered (pi->name_mem_tag);
946 if (v_ann->type_mem_tag)
947 mark_call_clobbered (v_ann->type_mem_tag);
949 if (pi->pt_vars)
950 EXECUTE_IF_SET_IN_BITMAP (pi->pt_vars, 0, j, bi)
952 mark_call_clobbered (referenced_var (j));
956 /* Set up aliasing information for PTR's name memory tag (if it has
957 one). Note that only pointers that have been dereferenced will
958 have a name memory tag. */
959 if (pi->name_mem_tag && pi->pt_vars)
960 EXECUTE_IF_SET_IN_BITMAP (pi->pt_vars, 0, j, bi)
962 add_may_alias (pi->name_mem_tag, referenced_var (j));
963 add_may_alias (v_ann->type_mem_tag, referenced_var (j));
966 /* If the name tag is call clobbered, so is the type tag
967 associated with the base VAR_DECL. */
968 if (pi->name_mem_tag
969 && v_ann->type_mem_tag
970 && is_call_clobbered (pi->name_mem_tag))
971 mark_call_clobbered (v_ann->type_mem_tag);
976 /* Compute type-based alias sets. Traverse all the pointers and
977 addressable variables found in setup_pointers_and_addressables.
979 For every pointer P in AI->POINTERS and addressable variable V in
980 AI->ADDRESSABLE_VARS, add V to the may-alias sets of P's type
981 memory tag (TMT) if their alias sets conflict. V is then marked as
982 an alias tag so that the operand scanner knows that statements
983 containing V have aliased operands. */
985 static void
986 compute_flow_insensitive_aliasing (struct alias_info *ai)
988 size_t i;
990 /* Initialize counter for the total number of virtual operands that
991 aliasing will introduce. When AI->TOTAL_ALIAS_VOPS goes beyond the
992 threshold set by --params max-alias-vops, we enable alias
993 grouping. */
994 ai->total_alias_vops = 0;
996 /* For every pointer P, determine which addressable variables may alias
997 with P's type memory tag. */
998 for (i = 0; i < ai->num_pointers; i++)
1000 size_t j;
1001 struct alias_map_d *p_map = ai->pointers[i];
1002 tree tag = var_ann (p_map->var)->type_mem_tag;
1003 var_ann_t tag_ann = var_ann (tag);
1005 p_map->total_alias_vops = 0;
1006 p_map->may_aliases = sbitmap_alloc (num_referenced_vars);
1007 sbitmap_zero (p_map->may_aliases);
1009 for (j = 0; j < ai->num_addressable_vars; j++)
1011 struct alias_map_d *v_map;
1012 var_ann_t v_ann;
1013 tree var;
1014 bool tag_stored_p, var_stored_p;
1016 v_map = ai->addressable_vars[j];
1017 var = v_map->var;
1018 v_ann = var_ann (var);
1020 /* Skip memory tags and variables that have never been
1021 written to. We also need to check if the variables are
1022 call-clobbered because they may be overwritten by
1023 function calls.
1025 Note this is effectively random accessing elements in
1026 the sparse bitset, which can be highly inefficient.
1027 So we first check the call_clobbered status of the
1028 tag and variable before querying the bitmap. */
1029 tag_stored_p = is_call_clobbered (tag)
1030 || bitmap_bit_p (ai->written_vars, tag_ann->uid);
1031 var_stored_p = is_call_clobbered (var)
1032 || bitmap_bit_p (ai->written_vars, v_ann->uid);
1033 if (!tag_stored_p && !var_stored_p)
1034 continue;
1036 if (may_alias_p (p_map->var, p_map->set, var, v_map->set))
1038 size_t num_tag_refs, num_var_refs;
1040 num_tag_refs = VARRAY_UINT (ai->num_references, tag_ann->uid);
1041 num_var_refs = VARRAY_UINT (ai->num_references, v_ann->uid);
1043 /* Add VAR to TAG's may-aliases set. */
1044 add_may_alias (tag, var);
1046 /* Update the total number of virtual operands due to
1047 aliasing. Since we are adding one more alias to TAG's
1048 may-aliases set, the total number of virtual operands due
1049 to aliasing will be increased by the number of references
1050 made to VAR and TAG (every reference to TAG will also
1051 count as a reference to VAR). */
1052 ai->total_alias_vops += (num_var_refs + num_tag_refs);
1053 p_map->total_alias_vops += (num_var_refs + num_tag_refs);
1055 /* Update the bitmap used to represent TAG's alias set
1056 in case we need to group aliases. */
1057 SET_BIT (p_map->may_aliases, var_ann (var)->uid);
1062 /* Since this analysis is based exclusively on symbols, it fails to
1063 handle cases where two pointers P and Q have different memory
1064 tags with conflicting alias set numbers but no aliased symbols in
1065 common.
1067 For example, suppose that we have two memory tags TMT.1 and TMT.2
1068 such that
1070 may-aliases (TMT.1) = { a }
1071 may-aliases (TMT.2) = { b }
1073 and the alias set number of TMT.1 conflicts with that of TMT.2.
1074 Since they don't have symbols in common, loads and stores from
1075 TMT.1 and TMT.2 will seem independent of each other, which will
1076 lead to the optimizers making invalid transformations (see
1077 testsuite/gcc.c-torture/execute/pr15262-[12].c).
1079 To avoid this problem, we do a final traversal of AI->POINTERS
1080 looking for pairs of pointers that have no aliased symbols in
1081 common and yet have conflicting alias set numbers. */
1082 for (i = 0; i < ai->num_pointers; i++)
1084 size_t j;
1085 struct alias_map_d *p_map1 = ai->pointers[i];
1086 tree tag1 = var_ann (p_map1->var)->type_mem_tag;
1087 sbitmap may_aliases1 = p_map1->may_aliases;
1089 for (j = i + 1; j < ai->num_pointers; j++)
1091 struct alias_map_d *p_map2 = ai->pointers[j];
1092 tree tag2 = var_ann (p_map2->var)->type_mem_tag;
1093 sbitmap may_aliases2 = p_map2->may_aliases;
1095 /* If the pointers may not point to each other, do nothing. */
1096 if (!may_alias_p (p_map1->var, p_map1->set, p_map2->var, p_map2->set))
1097 continue;
1099 /* The two pointers may alias each other. If they already have
1100 symbols in common, do nothing. */
1101 if (sbitmap_any_common_bits (may_aliases1, may_aliases2))
1102 continue;
1104 if (sbitmap_first_set_bit (may_aliases2) >= 0)
1106 size_t k;
1108 /* Add all the aliases for TAG2 into TAG1's alias set.
1109 FIXME, update grouping heuristic counters. */
1110 EXECUTE_IF_SET_IN_SBITMAP (may_aliases2, 0, k,
1111 add_may_alias (tag1, referenced_var (k)));
1112 sbitmap_a_or_b (may_aliases1, may_aliases1, may_aliases2);
1114 else
1116 /* Since TAG2 does not have any aliases of its own, add
1117 TAG2 itself to the alias set of TAG1. */
1118 add_may_alias (tag1, tag2);
1123 if (dump_file)
1124 fprintf (dump_file, "%s: Total number of aliased vops: %ld\n",
1125 get_name (current_function_decl),
1126 ai->total_alias_vops);
1128 /* Determine if we need to enable alias grouping. */
1129 if (ai->total_alias_vops >= MAX_ALIASED_VOPS)
1130 group_aliases (ai);
1134 /* Comparison function for qsort used in group_aliases. */
1136 static int
1137 total_alias_vops_cmp (const void *p, const void *q)
1139 const struct alias_map_d **p1 = (const struct alias_map_d **)p;
1140 const struct alias_map_d **p2 = (const struct alias_map_d **)q;
1141 long n1 = (*p1)->total_alias_vops;
1142 long n2 = (*p2)->total_alias_vops;
1144 /* We want to sort in descending order. */
1145 return (n1 > n2 ? -1 : (n1 == n2) ? 0 : 1);
1148 /* Group all the aliases for TAG to make TAG represent all the
1149 variables in its alias set. Update the total number
1150 of virtual operands due to aliasing (AI->TOTAL_ALIAS_VOPS). This
1151 function will make TAG be the unique alias tag for all the
1152 variables in its may-aliases. So, given:
1154 may-aliases(TAG) = { V1, V2, V3 }
1156 This function will group the variables into:
1158 may-aliases(V1) = { TAG }
1159 may-aliases(V2) = { TAG }
1160 may-aliases(V2) = { TAG } */
1162 static void
1163 group_aliases_into (tree tag, sbitmap tag_aliases, struct alias_info *ai)
1165 size_t i;
1166 var_ann_t tag_ann = var_ann (tag);
1167 size_t num_tag_refs = VARRAY_UINT (ai->num_references, tag_ann->uid);
1169 EXECUTE_IF_SET_IN_SBITMAP (tag_aliases, 0, i,
1171 tree var = referenced_var (i);
1172 var_ann_t ann = var_ann (var);
1174 /* Make TAG the unique alias of VAR. */
1175 ann->is_alias_tag = 0;
1176 ann->may_aliases = NULL;
1178 /* Note that VAR and TAG may be the same if the function has no
1179 addressable variables (see the discussion at the end of
1180 setup_pointers_and_addressables). */
1181 if (var != tag)
1182 add_may_alias (var, tag);
1184 /* Reduce total number of virtual operands contributed
1185 by TAG on behalf of VAR. Notice that the references to VAR
1186 itself won't be removed. We will merely replace them with
1187 references to TAG. */
1188 ai->total_alias_vops -= num_tag_refs;
1191 /* We have reduced the number of virtual operands that TAG makes on
1192 behalf of all the variables formerly aliased with it. However,
1193 we have also "removed" all the virtual operands for TAG itself,
1194 so we add them back. */
1195 ai->total_alias_vops += num_tag_refs;
1197 /* TAG no longer has any aliases. */
1198 tag_ann->may_aliases = NULL;
1202 /* Group may-aliases sets to reduce the number of virtual operands due
1203 to aliasing.
1205 1- Sort the list of pointers in decreasing number of contributed
1206 virtual operands.
1208 2- Take the first entry in AI->POINTERS and revert the role of
1209 the memory tag and its aliases. Usually, whenever an aliased
1210 variable Vi is found to alias with a memory tag T, we add Vi
1211 to the may-aliases set for T. Meaning that after alias
1212 analysis, we will have:
1214 may-aliases(T) = { V1, V2, V3, ..., Vn }
1216 This means that every statement that references T, will get 'n'
1217 virtual operands for each of the Vi tags. But, when alias
1218 grouping is enabled, we make T an alias tag and add it to the
1219 alias set of all the Vi variables:
1221 may-aliases(V1) = { T }
1222 may-aliases(V2) = { T }
1224 may-aliases(Vn) = { T }
1226 This has two effects: (a) statements referencing T will only get
1227 a single virtual operand, and, (b) all the variables Vi will now
1228 appear to alias each other. So, we lose alias precision to
1229 improve compile time. But, in theory, a program with such a high
1230 level of aliasing should not be very optimizable in the first
1231 place.
1233 3- Since variables may be in the alias set of more than one
1234 memory tag, the grouping done in step (2) needs to be extended
1235 to all the memory tags that have a non-empty intersection with
1236 the may-aliases set of tag T. For instance, if we originally
1237 had these may-aliases sets:
1239 may-aliases(T) = { V1, V2, V3 }
1240 may-aliases(R) = { V2, V4 }
1242 In step (2) we would have reverted the aliases for T as:
1244 may-aliases(V1) = { T }
1245 may-aliases(V2) = { T }
1246 may-aliases(V3) = { T }
1248 But note that now V2 is no longer aliased with R. We could
1249 add R to may-aliases(V2), but we are in the process of
1250 grouping aliases to reduce virtual operands so what we do is
1251 add V4 to the grouping to obtain:
1253 may-aliases(V1) = { T }
1254 may-aliases(V2) = { T }
1255 may-aliases(V3) = { T }
1256 may-aliases(V4) = { T }
1258 4- If the total number of virtual operands due to aliasing is
1259 still above the threshold set by max-alias-vops, go back to (2). */
1261 static void
1262 group_aliases (struct alias_info *ai)
1264 size_t i;
1266 /* Sort the POINTERS array in descending order of contributed
1267 virtual operands. */
1268 qsort (ai->pointers, ai->num_pointers, sizeof (struct alias_map_d *),
1269 total_alias_vops_cmp);
1271 /* For every pointer in AI->POINTERS, reverse the roles of its tag
1272 and the tag's may-aliases set. */
1273 for (i = 0; i < ai->num_pointers; i++)
1275 size_t j;
1276 tree tag1 = var_ann (ai->pointers[i]->var)->type_mem_tag;
1277 sbitmap tag1_aliases = ai->pointers[i]->may_aliases;
1279 /* Skip tags that have been grouped already. */
1280 if (ai->pointers[i]->grouped_p)
1281 continue;
1283 /* See if TAG1 had any aliases in common with other type tags.
1284 If we find a TAG2 with common aliases with TAG1, add TAG2's
1285 aliases into TAG1. */
1286 for (j = i + 1; j < ai->num_pointers; j++)
1288 sbitmap tag2_aliases = ai->pointers[j]->may_aliases;
1290 if (sbitmap_any_common_bits (tag1_aliases, tag2_aliases))
1292 tree tag2 = var_ann (ai->pointers[j]->var)->type_mem_tag;
1294 sbitmap_a_or_b (tag1_aliases, tag1_aliases, tag2_aliases);
1296 /* TAG2 does not need its aliases anymore. */
1297 sbitmap_zero (tag2_aliases);
1298 var_ann (tag2)->may_aliases = NULL;
1300 /* TAG1 is the unique alias of TAG2. */
1301 add_may_alias (tag2, tag1);
1303 ai->pointers[j]->grouped_p = true;
1307 /* Now group all the aliases we collected into TAG1. */
1308 group_aliases_into (tag1, tag1_aliases, ai);
1310 /* If we've reduced total number of virtual operands below the
1311 threshold, stop. */
1312 if (ai->total_alias_vops < MAX_ALIASED_VOPS)
1313 break;
1316 /* Finally, all the variables that have been grouped cannot be in
1317 the may-alias set of name memory tags. Suppose that we have
1318 grouped the aliases in this code so that may-aliases(a) = TMT.20
1320 p_5 = &a;
1322 # a_9 = V_MAY_DEF <a_8>
1323 p_5->field = 0
1324 ... Several modifications to TMT.20 ...
1325 # VUSE <a_9>
1326 x_30 = p_5->field
1328 Since p_5 points to 'a', the optimizers will try to propagate 0
1329 into p_5->field, but that is wrong because there have been
1330 modifications to 'TMT.20' in between. To prevent this we have to
1331 replace 'a' with 'TMT.20' in the name tag of p_5. */
1332 for (i = 0; i < VARRAY_ACTIVE_SIZE (ai->processed_ptrs); i++)
1334 size_t j;
1335 tree ptr = VARRAY_TREE (ai->processed_ptrs, i);
1336 tree name_tag = SSA_NAME_PTR_INFO (ptr)->name_mem_tag;
1337 varray_type aliases;
1339 if (name_tag == NULL_TREE)
1340 continue;
1342 aliases = var_ann (name_tag)->may_aliases;
1343 for (j = 0; aliases && j < VARRAY_ACTIVE_SIZE (aliases); j++)
1345 tree alias = VARRAY_TREE (aliases, j);
1346 var_ann_t ann = var_ann (alias);
1348 if (ann->mem_tag_kind == NOT_A_TAG && ann->may_aliases)
1350 tree new_alias;
1352 gcc_assert (VARRAY_ACTIVE_SIZE (ann->may_aliases) == 1);
1354 new_alias = VARRAY_TREE (ann->may_aliases, 0);
1355 replace_may_alias (name_tag, j, new_alias);
1360 if (dump_file)
1361 fprintf (dump_file,
1362 "%s: Total number of aliased vops after grouping: %ld%s\n",
1363 get_name (current_function_decl),
1364 ai->total_alias_vops,
1365 (ai->total_alias_vops < 0) ? " (negative values are OK)" : "");
1369 /* Create a new alias set entry for VAR in AI->ADDRESSABLE_VARS. */
1371 static void
1372 create_alias_map_for (tree var, struct alias_info *ai)
1374 struct alias_map_d *alias_map;
1375 alias_map = xcalloc (1, sizeof (*alias_map));
1376 alias_map->var = var;
1377 alias_map->set = get_alias_set (var);
1378 ai->addressable_vars[ai->num_addressable_vars++] = alias_map;
1382 /* Create memory tags for all the dereferenced pointers and build the
1383 ADDRESSABLE_VARS and POINTERS arrays used for building the may-alias
1384 sets. Based on the address escape and points-to information collected
1385 earlier, this pass will also clear the TREE_ADDRESSABLE flag from those
1386 variables whose address is not needed anymore. */
1388 static void
1389 setup_pointers_and_addressables (struct alias_info *ai)
1391 size_t i, n_vars, num_addressable_vars, num_pointers;
1393 /* Size up the arrays ADDRESSABLE_VARS and POINTERS. */
1394 num_addressable_vars = num_pointers = 0;
1395 for (i = 0; i < num_referenced_vars; i++)
1397 tree var = referenced_var (i);
1399 if (may_be_aliased (var))
1400 num_addressable_vars++;
1402 if (POINTER_TYPE_P (TREE_TYPE (var)))
1404 /* Since we don't keep track of volatile variables, assume that
1405 these pointers are used in indirect store operations. */
1406 if (TREE_THIS_VOLATILE (var))
1407 bitmap_set_bit (ai->dereferenced_ptrs_store, var_ann (var)->uid);
1409 num_pointers++;
1413 /* Create ADDRESSABLE_VARS and POINTERS. Note that these arrays are
1414 always going to be slightly bigger than we actually need them
1415 because some TREE_ADDRESSABLE variables will be marked
1416 non-addressable below and only pointers with unique type tags are
1417 going to be added to POINTERS. */
1418 ai->addressable_vars = xcalloc (num_addressable_vars,
1419 sizeof (struct alias_map_d *));
1420 ai->pointers = xcalloc (num_pointers, sizeof (struct alias_map_d *));
1421 ai->num_addressable_vars = 0;
1422 ai->num_pointers = 0;
1424 /* Since we will be creating type memory tags within this loop, cache the
1425 value of NUM_REFERENCED_VARS to avoid processing the additional tags
1426 unnecessarily. */
1427 n_vars = num_referenced_vars;
1429 for (i = 0; i < n_vars; i++)
1431 tree var = referenced_var (i);
1432 var_ann_t v_ann = var_ann (var);
1434 /* Name memory tags already have flow-sensitive aliasing
1435 information, so they need not be processed by
1436 compute_flow_insensitive_aliasing. Similarly, type memory
1437 tags are already accounted for when we process their
1438 associated pointer. */
1439 if (v_ann->mem_tag_kind != NOT_A_TAG)
1440 continue;
1442 /* Remove the ADDRESSABLE flag from every addressable variable whose
1443 address is not needed anymore. This is caused by the propagation
1444 of ADDR_EXPR constants into INDIRECT_REF expressions and the
1445 removal of dead pointer assignments done by the early scalar
1446 cleanup passes. */
1447 if (TREE_ADDRESSABLE (var))
1449 if (!bitmap_bit_p (ai->addresses_needed, v_ann->uid)
1450 && TREE_CODE (var) != RESULT_DECL
1451 && !is_global_var (var))
1453 /* The address of VAR is not needed, remove the
1454 addressable bit, so that it can be optimized as a
1455 regular variable. */
1456 mark_non_addressable (var);
1458 /* Since VAR is now a regular GIMPLE register, we will need
1459 to rename VAR into SSA afterwards. */
1460 bitmap_set_bit (vars_to_rename, v_ann->uid);
1462 else
1464 /* Add the variable to the set of addressables. Mostly
1465 used when scanning operands for ASM_EXPRs that
1466 clobber memory. In those cases, we need to clobber
1467 all call-clobbered variables and all addressables. */
1468 bitmap_set_bit (addressable_vars, v_ann->uid);
1472 /* Global variables and addressable locals may be aliased. Create an
1473 entry in ADDRESSABLE_VARS for VAR. */
1474 if (may_be_aliased (var))
1476 create_alias_map_for (var, ai);
1477 bitmap_set_bit (vars_to_rename, var_ann (var)->uid);
1480 /* Add pointer variables that have been dereferenced to the POINTERS
1481 array and create a type memory tag for them. */
1482 if (POINTER_TYPE_P (TREE_TYPE (var)))
1484 if ((bitmap_bit_p (ai->dereferenced_ptrs_store, v_ann->uid)
1485 || bitmap_bit_p (ai->dereferenced_ptrs_load, v_ann->uid)))
1487 tree tag;
1488 var_ann_t t_ann;
1490 /* If pointer VAR still doesn't have a memory tag
1491 associated with it, create it now or re-use an
1492 existing one. */
1493 tag = get_tmt_for (var, ai);
1494 t_ann = var_ann (tag);
1496 /* The type tag will need to be renamed into SSA
1497 afterwards. Note that we cannot do this inside
1498 get_tmt_for because aliasing may run multiple times
1499 and we only create type tags the first time. */
1500 bitmap_set_bit (vars_to_rename, t_ann->uid);
1502 /* Associate the tag with pointer VAR. */
1503 v_ann->type_mem_tag = tag;
1505 /* If pointer VAR has been used in a store operation,
1506 then its memory tag must be marked as written-to. */
1507 if (bitmap_bit_p (ai->dereferenced_ptrs_store, v_ann->uid))
1508 bitmap_set_bit (ai->written_vars, t_ann->uid);
1510 /* If pointer VAR is a global variable or a PARM_DECL,
1511 then its memory tag should be considered a global
1512 variable. */
1513 if (TREE_CODE (var) == PARM_DECL || is_global_var (var))
1514 mark_call_clobbered (tag);
1516 /* All the dereferences of pointer VAR count as
1517 references of TAG. Since TAG can be associated with
1518 several pointers, add the dereferences of VAR to the
1519 TAG. We may need to grow AI->NUM_REFERENCES because
1520 we have been adding name and type tags. */
1521 if (t_ann->uid >= VARRAY_SIZE (ai->num_references))
1522 VARRAY_GROW (ai->num_references, t_ann->uid + 10);
1524 VARRAY_UINT (ai->num_references, t_ann->uid)
1525 += VARRAY_UINT (ai->num_references, v_ann->uid);
1527 else
1529 /* The pointer has not been dereferenced. If it had a
1530 type memory tag, remove it and mark the old tag for
1531 renaming to remove it out of the IL. */
1532 var_ann_t ann = var_ann (var);
1533 tree tag = ann->type_mem_tag;
1534 if (tag)
1536 bitmap_set_bit (vars_to_rename, var_ann (tag)->uid);
1537 ann->type_mem_tag = NULL_TREE;
1545 /* Determine whether to use .GLOBAL_VAR to model call clobbering semantics. At
1546 every call site, we need to emit V_MAY_DEF expressions to represent the
1547 clobbering effects of the call for variables whose address escapes the
1548 current function.
1550 One approach is to group all call-clobbered variables into a single
1551 representative that is used as an alias of every call-clobbered variable
1552 (.GLOBAL_VAR). This works well, but it ties the optimizer hands because
1553 references to any call clobbered variable is a reference to .GLOBAL_VAR.
1555 The second approach is to emit a clobbering V_MAY_DEF for every
1556 call-clobbered variable at call sites. This is the preferred way in terms
1557 of optimization opportunities but it may create too many V_MAY_DEF operands
1558 if there are many call clobbered variables and function calls in the
1559 function.
1561 To decide whether or not to use .GLOBAL_VAR we multiply the number of
1562 function calls found by the number of call-clobbered variables. If that
1563 product is beyond a certain threshold, as determined by the parameterized
1564 values shown below, we use .GLOBAL_VAR.
1566 FIXME. This heuristic should be improved. One idea is to use several
1567 .GLOBAL_VARs of different types instead of a single one. The thresholds
1568 have been derived from a typical bootstrap cycle, including all target
1569 libraries. Compile times were found increase by ~1% compared to using
1570 .GLOBAL_VAR. */
1572 static void
1573 maybe_create_global_var (struct alias_info *ai)
1575 unsigned i, n_clobbered;
1576 bitmap_iterator bi;
1578 /* No need to create it, if we have one already. */
1579 if (global_var == NULL_TREE)
1581 /* Count all the call-clobbered variables. */
1582 n_clobbered = 0;
1583 EXECUTE_IF_SET_IN_BITMAP (call_clobbered_vars, 0, i, bi)
1585 n_clobbered++;
1588 if (ai->num_calls_found * n_clobbered >= (size_t) GLOBAL_VAR_THRESHOLD)
1589 create_global_var ();
1592 /* If the function has calls to clobbering functions and .GLOBAL_VAR has
1593 been created, make it an alias for all call-clobbered variables. */
1594 if (global_var)
1595 EXECUTE_IF_SET_IN_BITMAP (call_clobbered_vars, 0, i, bi)
1597 tree var = referenced_var (i);
1598 if (var != global_var)
1600 add_may_alias (var, global_var);
1601 bitmap_set_bit (vars_to_rename, var_ann (var)->uid);
1607 /* Return TRUE if pointer PTR may point to variable VAR.
1609 MEM_ALIAS_SET is the alias set for the memory location pointed-to by PTR
1610 This is needed because when checking for type conflicts we are
1611 interested in the alias set of the memory location pointed-to by
1612 PTR. The alias set of PTR itself is irrelevant.
1614 VAR_ALIAS_SET is the alias set for VAR. */
1616 static bool
1617 may_alias_p (tree ptr, HOST_WIDE_INT mem_alias_set,
1618 tree var, HOST_WIDE_INT var_alias_set)
1620 tree mem;
1621 var_ann_t v_ann, m_ann;
1623 alias_stats.alias_queries++;
1624 alias_stats.simple_queries++;
1626 /* By convention, a variable cannot alias itself. */
1627 mem = var_ann (ptr)->type_mem_tag;
1628 if (mem == var)
1630 alias_stats.alias_noalias++;
1631 alias_stats.simple_resolved++;
1632 return false;
1635 v_ann = var_ann (var);
1636 m_ann = var_ann (mem);
1638 gcc_assert (m_ann->mem_tag_kind == TYPE_TAG);
1640 alias_stats.tbaa_queries++;
1642 /* If VAR is a pointer with the same alias set as PTR, then dereferencing
1643 PTR can't possibly affect VAR. Note, that we are specifically testing
1644 for PTR's alias set here, not its pointed-to type. We also can't
1645 do this check with relaxed aliasing enabled. */
1646 if (POINTER_TYPE_P (TREE_TYPE (var))
1647 && var_alias_set != 0
1648 && mem_alias_set != 0)
1650 HOST_WIDE_INT ptr_alias_set = get_alias_set (ptr);
1651 if (ptr_alias_set == var_alias_set)
1653 alias_stats.alias_noalias++;
1654 alias_stats.tbaa_resolved++;
1655 return false;
1659 /* If the alias sets don't conflict then MEM cannot alias VAR. */
1660 if (!alias_sets_conflict_p (mem_alias_set, var_alias_set))
1662 alias_stats.alias_noalias++;
1663 alias_stats.tbaa_resolved++;
1664 return false;
1667 alias_stats.alias_mayalias++;
1668 return true;
1672 /* Add ALIAS to the set of variables that may alias VAR. */
1674 static void
1675 add_may_alias (tree var, tree alias)
1677 size_t i;
1678 var_ann_t v_ann = get_var_ann (var);
1679 var_ann_t a_ann = get_var_ann (alias);
1681 gcc_assert (var != alias);
1683 if (v_ann->may_aliases == NULL)
1684 VARRAY_TREE_INIT (v_ann->may_aliases, 2, "aliases");
1686 /* Avoid adding duplicates. */
1687 for (i = 0; i < VARRAY_ACTIVE_SIZE (v_ann->may_aliases); i++)
1688 if (alias == VARRAY_TREE (v_ann->may_aliases, i))
1689 return;
1691 /* If VAR is a call-clobbered variable, so is its new ALIAS.
1692 FIXME, call-clobbering should only depend on whether an address
1693 escapes. It should be independent of aliasing. */
1694 if (is_call_clobbered (var))
1695 mark_call_clobbered (alias);
1697 /* Likewise. If ALIAS is call-clobbered, so is VAR. */
1698 else if (is_call_clobbered (alias))
1699 mark_call_clobbered (var);
1701 VARRAY_PUSH_TREE (v_ann->may_aliases, alias);
1702 a_ann->is_alias_tag = 1;
1706 /* Replace alias I in the alias sets of VAR with NEW_ALIAS. */
1708 static void
1709 replace_may_alias (tree var, size_t i, tree new_alias)
1711 var_ann_t v_ann = var_ann (var);
1712 VARRAY_TREE (v_ann->may_aliases, i) = new_alias;
1714 /* If VAR is a call-clobbered variable, so is NEW_ALIAS.
1715 FIXME, call-clobbering should only depend on whether an address
1716 escapes. It should be independent of aliasing. */
1717 if (is_call_clobbered (var))
1718 mark_call_clobbered (new_alias);
1720 /* Likewise. If NEW_ALIAS is call-clobbered, so is VAR. */
1721 else if (is_call_clobbered (new_alias))
1722 mark_call_clobbered (var);
1726 /* Mark pointer PTR as pointing to an arbitrary memory location. */
1728 static void
1729 set_pt_anything (tree ptr)
1731 struct ptr_info_def *pi = get_ptr_info (ptr);
1733 pi->pt_anything = 1;
1734 pi->pt_malloc = 0;
1736 /* The pointer used to have a name tag, but we now found it pointing
1737 to an arbitrary location. The name tag needs to be renamed and
1738 disassociated from PTR. */
1739 if (pi->name_mem_tag)
1741 bitmap_set_bit (vars_to_rename, var_ann (pi->name_mem_tag)->uid);
1742 pi->name_mem_tag = NULL_TREE;
1747 /* Mark pointer PTR as pointing to a malloc'd memory area. */
1749 static void
1750 set_pt_malloc (tree ptr)
1752 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
1754 /* If the pointer has already been found to point to arbitrary
1755 memory locations, it is unsafe to mark it as pointing to malloc. */
1756 if (pi->pt_anything)
1757 return;
1759 pi->pt_malloc = 1;
1763 /* Given two different pointers DEST and ORIG. Merge the points-to
1764 information in ORIG into DEST. AI is as in
1765 collect_points_to_info. */
1767 static void
1768 merge_pointed_to_info (struct alias_info *ai, tree dest, tree orig)
1770 struct ptr_info_def *dest_pi, *orig_pi;
1772 gcc_assert (dest != orig);
1774 /* Make sure we have points-to information for ORIG. */
1775 collect_points_to_info_for (ai, orig);
1777 dest_pi = get_ptr_info (dest);
1778 orig_pi = SSA_NAME_PTR_INFO (orig);
1780 if (orig_pi)
1782 gcc_assert (orig_pi != dest_pi);
1784 /* Notice that we never merge PT_MALLOC. This attribute is only
1785 true if the pointer is the result of a malloc() call.
1786 Otherwise, we can end up in this situation:
1788 P_i = malloc ();
1790 P_j = P_i + X;
1792 P_j would be marked as PT_MALLOC, however we currently do not
1793 handle cases of more than one pointer pointing to the same
1794 malloc'd area.
1796 FIXME: If the merging comes from an expression that preserves
1797 the PT_MALLOC attribute (copy assignment, address
1798 arithmetic), we ought to merge PT_MALLOC, but then both
1799 pointers would end up getting different name tags because
1800 create_name_tags is not smart enough to determine that the
1801 two come from the same malloc call. Copy propagation before
1802 aliasing should cure this. */
1803 dest_pi->pt_malloc = 0;
1804 if (orig_pi->pt_malloc || orig_pi->pt_anything)
1805 set_pt_anything (dest);
1807 dest_pi->pt_null |= orig_pi->pt_null;
1809 if (!dest_pi->pt_anything
1810 && orig_pi->pt_vars
1811 && !bitmap_empty_p (orig_pi->pt_vars))
1813 if (dest_pi->pt_vars == NULL)
1815 dest_pi->pt_vars = BITMAP_GGC_ALLOC ();
1816 bitmap_copy (dest_pi->pt_vars, orig_pi->pt_vars);
1818 else
1819 bitmap_ior_into (dest_pi->pt_vars, orig_pi->pt_vars);
1822 else
1823 set_pt_anything (dest);
1827 /* Add EXPR to the list of expressions pointed-to by PTR. */
1829 static void
1830 add_pointed_to_expr (struct alias_info *ai, tree ptr, tree expr)
1832 if (TREE_CODE (expr) == WITH_SIZE_EXPR)
1833 expr = TREE_OPERAND (expr, 0);
1835 get_ptr_info (ptr);
1837 if (TREE_CODE (expr) == CALL_EXPR
1838 && (call_expr_flags (expr) & (ECF_MALLOC | ECF_MAY_BE_ALLOCA)))
1840 /* If EXPR is a malloc-like call, then the area pointed to PTR
1841 is guaranteed to not alias with anything else. */
1842 set_pt_malloc (ptr);
1844 else if (TREE_CODE (expr) == ADDR_EXPR)
1846 /* Found P_i = ADDR_EXPR */
1847 add_pointed_to_var (ai, ptr, expr);
1849 else if (TREE_CODE (expr) == SSA_NAME && POINTER_TYPE_P (TREE_TYPE (expr)))
1851 /* Found P_i = Q_j. */
1852 merge_pointed_to_info (ai, ptr, expr);
1854 else if (TREE_CODE (expr) == PLUS_EXPR || TREE_CODE (expr) == MINUS_EXPR)
1856 /* Found P_i = PLUS_EXPR or P_i = MINUS_EXPR */
1857 tree op0 = TREE_OPERAND (expr, 0);
1858 tree op1 = TREE_OPERAND (expr, 1);
1860 /* Both operands may be of pointer type. FIXME: Shouldn't
1861 we just expect PTR + OFFSET always? */
1862 if (POINTER_TYPE_P (TREE_TYPE (op0))
1863 && TREE_CODE (op0) != INTEGER_CST)
1865 if (TREE_CODE (op0) == SSA_NAME)
1866 merge_pointed_to_info (ai, ptr, op0);
1867 else if (TREE_CODE (op0) == ADDR_EXPR)
1868 add_pointed_to_var (ai, ptr, op0);
1869 else
1870 set_pt_anything (ptr);
1873 if (POINTER_TYPE_P (TREE_TYPE (op1))
1874 && TREE_CODE (op1) != INTEGER_CST)
1876 if (TREE_CODE (op1) == SSA_NAME)
1877 merge_pointed_to_info (ai, ptr, op1);
1878 else if (TREE_CODE (op1) == ADDR_EXPR)
1879 add_pointed_to_var (ai, ptr, op1);
1880 else
1881 set_pt_anything (ptr);
1884 /* Neither operand is a pointer? VAR can be pointing anywhere.
1885 FIXME: Shouldn't we abort here? If we get here, we found
1886 PTR = INT_CST + INT_CST, which should not be a valid pointer
1887 expression. */
1888 if (!(POINTER_TYPE_P (TREE_TYPE (op0))
1889 && TREE_CODE (op0) != INTEGER_CST)
1890 && !(POINTER_TYPE_P (TREE_TYPE (op1))
1891 && TREE_CODE (op1) != INTEGER_CST))
1892 set_pt_anything (ptr);
1894 else if (integer_zerop (expr))
1896 /* EXPR is the NULL pointer. Mark PTR as pointing to NULL. */
1897 SSA_NAME_PTR_INFO (ptr)->pt_null = 1;
1899 else
1901 /* If we can't recognize the expression, assume that PTR may
1902 point anywhere. */
1903 set_pt_anything (ptr);
1908 /* If VALUE is of the form &DECL, add DECL to the set of variables
1909 pointed-to by PTR. Otherwise, add VALUE as a pointed-to expression by
1910 PTR. AI is as in collect_points_to_info. */
1912 static void
1913 add_pointed_to_var (struct alias_info *ai, tree ptr, tree value)
1915 struct ptr_info_def *pi = get_ptr_info (ptr);
1916 tree pt_var;
1917 size_t uid;
1919 gcc_assert (TREE_CODE (value) == ADDR_EXPR);
1921 pt_var = TREE_OPERAND (value, 0);
1922 if (REFERENCE_CLASS_P (pt_var))
1923 pt_var = get_base_address (pt_var);
1925 if (pt_var && SSA_VAR_P (pt_var))
1927 uid = var_ann (pt_var)->uid;
1928 bitmap_set_bit (ai->addresses_needed, uid);
1930 if (pi->pt_vars == NULL)
1931 pi->pt_vars = BITMAP_GGC_ALLOC ();
1932 bitmap_set_bit (pi->pt_vars, uid);
1934 /* If the variable is a global, mark the pointer as pointing to
1935 global memory (which will make its tag a global variable). */
1936 if (is_global_var (pt_var))
1937 pi->pt_global_mem = 1;
1942 /* Callback for walk_use_def_chains to gather points-to information from the
1943 SSA web.
1945 VAR is an SSA variable or a GIMPLE expression.
1947 STMT is the statement that generates the SSA variable or, if STMT is a
1948 PHI_NODE, VAR is one of the PHI arguments.
1950 DATA is a pointer to a structure of type ALIAS_INFO. */
1952 static bool
1953 collect_points_to_info_r (tree var, tree stmt, void *data)
1955 struct alias_info *ai = (struct alias_info *) data;
1957 if (dump_file && (dump_flags & TDF_DETAILS))
1959 fprintf (dump_file, "Visiting use-def links for ");
1960 print_generic_expr (dump_file, var, dump_flags);
1961 fprintf (dump_file, "\n");
1964 switch (TREE_CODE (stmt))
1966 case RETURN_EXPR:
1967 if (TREE_CODE (TREE_OPERAND (stmt, 0)) != MODIFY_EXPR)
1968 abort ();
1969 stmt = TREE_OPERAND (stmt, 0);
1970 /* FALLTHRU */
1972 case MODIFY_EXPR:
1974 tree rhs = TREE_OPERAND (stmt, 1);
1975 STRIP_NOPS (rhs);
1976 add_pointed_to_expr (ai, var, rhs);
1977 break;
1980 case ASM_EXPR:
1981 /* Pointers defined by __asm__ statements can point anywhere. */
1982 set_pt_anything (var);
1983 break;
1985 case NOP_EXPR:
1986 if (IS_EMPTY_STMT (stmt))
1988 tree decl = SSA_NAME_VAR (var);
1990 if (TREE_CODE (decl) == PARM_DECL)
1991 add_pointed_to_expr (ai, var, decl);
1992 else if (DECL_INITIAL (decl))
1993 add_pointed_to_expr (ai, var, DECL_INITIAL (decl));
1994 else
1995 add_pointed_to_expr (ai, var, decl);
1997 break;
1999 case PHI_NODE:
2001 /* It STMT is a PHI node, then VAR is one of its arguments. The
2002 variable that we are analyzing is the LHS of the PHI node. */
2003 tree lhs = PHI_RESULT (stmt);
2005 switch (TREE_CODE (var))
2007 case ADDR_EXPR:
2008 add_pointed_to_var (ai, lhs, var);
2009 break;
2011 case SSA_NAME:
2012 /* Avoid unnecessary merges. */
2013 if (lhs != var)
2014 merge_pointed_to_info (ai, lhs, var);
2015 break;
2017 default:
2018 gcc_assert (is_gimple_min_invariant (var));
2019 add_pointed_to_expr (ai, lhs, var);
2020 break;
2022 break;
2025 default:
2026 gcc_unreachable ();
2029 return false;
2033 /* Return true if STMT is an "escape" site from the current function. Escape
2034 sites those statements which might expose the address of a variable
2035 outside the current function. STMT is an escape site iff:
2037 1- STMT is a function call, or
2038 2- STMT is an __asm__ expression, or
2039 3- STMT is an assignment to a non-local variable, or
2040 4- STMT is a return statement.
2042 If NUM_CALLS_P is not NULL, the counter is incremented if STMT contains
2043 a function call. */
2045 static bool
2046 is_escape_site (tree stmt, size_t *num_calls_p)
2048 if (get_call_expr_in (stmt) != NULL_TREE)
2050 if (num_calls_p)
2051 (*num_calls_p)++;
2053 return true;
2055 else if (TREE_CODE (stmt) == ASM_EXPR)
2056 return true;
2057 else if (TREE_CODE (stmt) == MODIFY_EXPR)
2059 tree lhs = TREE_OPERAND (stmt, 0);
2061 /* Get to the base of _REF nodes. */
2062 if (TREE_CODE (lhs) != SSA_NAME)
2063 lhs = get_base_address (lhs);
2065 /* If we couldn't recognize the LHS of the assignment, assume that it
2066 is a non-local store. */
2067 if (lhs == NULL_TREE)
2068 return true;
2070 /* If the RHS is a conversion between a pointer and an integer, the
2071 pointer escapes since we can't track the integer. */
2072 if ((TREE_CODE (TREE_OPERAND (stmt, 1)) == NOP_EXPR
2073 || TREE_CODE (TREE_OPERAND (stmt, 1)) == CONVERT_EXPR
2074 || TREE_CODE (TREE_OPERAND (stmt, 1)) == VIEW_CONVERT_EXPR)
2075 && POINTER_TYPE_P (TREE_TYPE (TREE_OPERAND
2076 (TREE_OPERAND (stmt, 1), 0)))
2077 && !POINTER_TYPE_P (TREE_TYPE (TREE_OPERAND (stmt, 1))))
2078 return true;
2080 /* If the LHS is an SSA name, it can't possibly represent a non-local
2081 memory store. */
2082 if (TREE_CODE (lhs) == SSA_NAME)
2083 return false;
2085 /* FIXME: LHS is not an SSA_NAME. Even if it's an assignment to a
2086 local variables we cannot be sure if it will escape, because we
2087 don't have information about objects not in SSA form. Need to
2088 implement something along the lines of
2090 J.-D. Choi, M. Gupta, M. J. Serrano, V. C. Sreedhar, and S. P.
2091 Midkiff, ``Escape analysis for java,'' in Proceedings of the
2092 Conference on Object-Oriented Programming Systems, Languages, and
2093 Applications (OOPSLA), pp. 1-19, 1999. */
2094 return true;
2096 else if (TREE_CODE (stmt) == RETURN_EXPR)
2097 return true;
2099 return false;
2103 /* Create a new memory tag of type TYPE. If IS_TYPE_TAG is true, the tag
2104 is considered to represent all the pointers whose pointed-to types are
2105 in the same alias set class. Otherwise, the tag represents a single
2106 SSA_NAME pointer variable. */
2108 static tree
2109 create_memory_tag (tree type, bool is_type_tag)
2111 var_ann_t ann;
2112 tree tag = create_tmp_var_raw (type, (is_type_tag) ? "TMT" : "NMT");
2114 /* By default, memory tags are local variables. Alias analysis will
2115 determine whether they should be considered globals. */
2116 DECL_CONTEXT (tag) = current_function_decl;
2118 /* Memory tags are by definition addressable. This also prevents
2119 is_gimple_ref frome confusing memory tags with optimizable
2120 variables. */
2121 TREE_ADDRESSABLE (tag) = 1;
2123 ann = get_var_ann (tag);
2124 ann->mem_tag_kind = (is_type_tag) ? TYPE_TAG : NAME_TAG;
2125 ann->type_mem_tag = NULL_TREE;
2127 /* Add the tag to the symbol table. */
2128 add_referenced_tmp_var (tag);
2130 return tag;
2134 /* Create a name memory tag to represent a specific SSA_NAME pointer P_i.
2135 This is used if P_i has been found to point to a specific set of
2136 variables or to a non-aliased memory location like the address returned
2137 by malloc functions. */
2139 static tree
2140 get_nmt_for (tree ptr)
2142 struct ptr_info_def *pi = get_ptr_info (ptr);
2143 tree tag = pi->name_mem_tag;
2145 if (tag == NULL_TREE)
2146 tag = create_memory_tag (TREE_TYPE (TREE_TYPE (ptr)), false);
2148 /* If PTR is a PARM_DECL, it points to a global variable or malloc,
2149 then its name tag should be considered a global variable. */
2150 if (TREE_CODE (SSA_NAME_VAR (ptr)) == PARM_DECL
2151 || pi->pt_malloc
2152 || pi->pt_global_mem)
2153 mark_call_clobbered (tag);
2155 return tag;
2159 /* Return the type memory tag associated to pointer PTR. A memory tag is an
2160 artificial variable that represents the memory location pointed-to by
2161 PTR. It is used to model the effects of pointer de-references on
2162 addressable variables.
2164 AI points to the data gathered during alias analysis. This function
2165 populates the array AI->POINTERS. */
2167 static tree
2168 get_tmt_for (tree ptr, struct alias_info *ai)
2170 size_t i;
2171 tree tag;
2172 tree tag_type = TREE_TYPE (TREE_TYPE (ptr));
2173 HOST_WIDE_INT tag_set = get_alias_set (tag_type);
2175 /* To avoid creating unnecessary memory tags, only create one memory tag
2176 per alias set class. Note that it may be tempting to group
2177 memory tags based on conflicting alias sets instead of
2178 equivalence. That would be wrong because alias sets are not
2179 necessarily transitive (as demonstrated by the libstdc++ test
2180 23_containers/vector/cons/4.cc). Given three alias sets A, B, C
2181 such that conflicts (A, B) == true and conflicts (A, C) == true,
2182 it does not necessarily follow that conflicts (B, C) == true. */
2183 for (i = 0, tag = NULL_TREE; i < ai->num_pointers; i++)
2185 struct alias_map_d *curr = ai->pointers[i];
2186 if (tag_set == curr->set)
2188 tag = var_ann (curr->var)->type_mem_tag;
2189 break;
2193 /* If VAR cannot alias with any of the existing memory tags, create a new
2194 tag for PTR and add it to the POINTERS array. */
2195 if (tag == NULL_TREE)
2197 struct alias_map_d *alias_map;
2199 /* If PTR did not have a type tag already, create a new TMT.*
2200 artificial variable representing the memory location
2201 pointed-to by PTR. */
2202 if (var_ann (ptr)->type_mem_tag == NULL_TREE)
2203 tag = create_memory_tag (tag_type, true);
2204 else
2205 tag = var_ann (ptr)->type_mem_tag;
2207 /* Add PTR to the POINTERS array. Note that we are not interested in
2208 PTR's alias set. Instead, we cache the alias set for the memory that
2209 PTR points to. */
2210 alias_map = xcalloc (1, sizeof (*alias_map));
2211 alias_map->var = ptr;
2212 alias_map->set = tag_set;
2213 ai->pointers[ai->num_pointers++] = alias_map;
2216 /* If the pointed-to type is volatile, so is the tag. */
2217 TREE_THIS_VOLATILE (tag) |= TREE_THIS_VOLATILE (tag_type);
2219 /* Make sure that the type tag has the same alias set as the
2220 pointed-to type. */
2221 gcc_assert (tag_set == get_alias_set (tag));
2223 return tag;
2227 /* Create GLOBAL_VAR, an artificial global variable to act as a
2228 representative of all the variables that may be clobbered by function
2229 calls. */
2231 static void
2232 create_global_var (void)
2234 global_var = build_decl (VAR_DECL, get_identifier (".GLOBAL_VAR"),
2235 void_type_node);
2236 DECL_ARTIFICIAL (global_var) = 1;
2237 TREE_READONLY (global_var) = 0;
2238 DECL_EXTERNAL (global_var) = 1;
2239 TREE_STATIC (global_var) = 1;
2240 TREE_USED (global_var) = 1;
2241 DECL_CONTEXT (global_var) = NULL_TREE;
2242 TREE_THIS_VOLATILE (global_var) = 0;
2243 TREE_ADDRESSABLE (global_var) = 0;
2245 add_referenced_tmp_var (global_var);
2246 bitmap_set_bit (vars_to_rename, var_ann (global_var)->uid);
2250 /* Dump alias statistics on FILE. */
2252 static void
2253 dump_alias_stats (FILE *file)
2255 const char *funcname
2256 = lang_hooks.decl_printable_name (current_function_decl, 2);
2257 fprintf (file, "\nAlias statistics for %s\n\n", funcname);
2258 fprintf (file, "Total alias queries:\t%u\n", alias_stats.alias_queries);
2259 fprintf (file, "Total alias mayalias results:\t%u\n",
2260 alias_stats.alias_mayalias);
2261 fprintf (file, "Total alias noalias results:\t%u\n",
2262 alias_stats.alias_noalias);
2263 fprintf (file, "Total simple queries:\t%u\n",
2264 alias_stats.simple_queries);
2265 fprintf (file, "Total simple resolved:\t%u\n",
2266 alias_stats.simple_resolved);
2267 fprintf (file, "Total TBAA queries:\t%u\n",
2268 alias_stats.tbaa_queries);
2269 fprintf (file, "Total TBAA resolved:\t%u\n",
2270 alias_stats.tbaa_resolved);
2274 /* Dump alias information on FILE. */
2276 void
2277 dump_alias_info (FILE *file)
2279 size_t i;
2280 const char *funcname
2281 = lang_hooks.decl_printable_name (current_function_decl, 2);
2283 fprintf (file, "\nFlow-insensitive alias information for %s\n\n", funcname);
2285 fprintf (file, "Aliased symbols\n\n");
2286 for (i = 0; i < num_referenced_vars; i++)
2288 tree var = referenced_var (i);
2289 if (may_be_aliased (var))
2290 dump_variable (file, var);
2293 fprintf (file, "\nDereferenced pointers\n\n");
2294 for (i = 0; i < num_referenced_vars; i++)
2296 tree var = referenced_var (i);
2297 var_ann_t ann = var_ann (var);
2298 if (ann->type_mem_tag)
2299 dump_variable (file, var);
2302 fprintf (file, "\nType memory tags\n\n");
2303 for (i = 0; i < num_referenced_vars; i++)
2305 tree var = referenced_var (i);
2306 var_ann_t ann = var_ann (var);
2307 if (ann->mem_tag_kind == TYPE_TAG)
2308 dump_variable (file, var);
2311 fprintf (file, "\n\nFlow-sensitive alias information for %s\n\n", funcname);
2313 fprintf (file, "SSA_NAME pointers\n\n");
2314 for (i = 1; i < num_ssa_names; i++)
2316 tree ptr = ssa_name (i);
2317 struct ptr_info_def *pi;
2319 if (ptr == NULL_TREE)
2320 continue;
2322 pi = SSA_NAME_PTR_INFO (ptr);
2323 if (!SSA_NAME_IN_FREE_LIST (ptr)
2324 && pi
2325 && pi->name_mem_tag)
2326 dump_points_to_info_for (file, ptr);
2329 fprintf (file, "\nName memory tags\n\n");
2330 for (i = 0; i < num_referenced_vars; i++)
2332 tree var = referenced_var (i);
2333 var_ann_t ann = var_ann (var);
2334 if (ann->mem_tag_kind == NAME_TAG)
2335 dump_variable (file, var);
2338 fprintf (file, "\n");
2342 /* Dump alias information on stderr. */
2344 void
2345 debug_alias_info (void)
2347 dump_alias_info (stderr);
2351 /* Return the alias information associated with pointer T. It creates a
2352 new instance if none existed. */
2354 struct ptr_info_def *
2355 get_ptr_info (tree t)
2357 struct ptr_info_def *pi;
2359 gcc_assert (POINTER_TYPE_P (TREE_TYPE (t)));
2361 pi = SSA_NAME_PTR_INFO (t);
2362 if (pi == NULL)
2364 pi = ggc_alloc (sizeof (*pi));
2365 memset ((void *)pi, 0, sizeof (*pi));
2366 SSA_NAME_PTR_INFO (t) = pi;
2369 return pi;
2373 /* Dump points-to information for SSA_NAME PTR into FILE. */
2375 void
2376 dump_points_to_info_for (FILE *file, tree ptr)
2378 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
2380 print_generic_expr (file, ptr, dump_flags);
2382 if (pi)
2384 if (pi->name_mem_tag)
2386 fprintf (file, ", name memory tag: ");
2387 print_generic_expr (file, pi->name_mem_tag, dump_flags);
2390 if (pi->is_dereferenced)
2391 fprintf (file, ", is dereferenced");
2393 if (pi->value_escapes_p)
2394 fprintf (file, ", its value escapes");
2396 if (pi->pt_anything)
2397 fprintf (file, ", points-to anything");
2399 if (pi->pt_malloc)
2400 fprintf (file, ", points-to malloc");
2402 if (pi->pt_null)
2403 fprintf (file, ", points-to NULL");
2405 if (pi->pt_vars)
2407 unsigned ix;
2408 bitmap_iterator bi;
2410 fprintf (file, ", points-to vars: { ");
2411 EXECUTE_IF_SET_IN_BITMAP (pi->pt_vars, 0, ix, bi)
2413 print_generic_expr (file, referenced_var (ix), dump_flags);
2414 fprintf (file, " ");
2416 fprintf (file, "}");
2420 fprintf (file, "\n");
2424 /* Dump points-to information for VAR into stderr. */
2426 void
2427 debug_points_to_info_for (tree var)
2429 dump_points_to_info_for (stderr, var);
2433 /* Dump points-to information into FILE. NOTE: This function is slow, as
2434 it needs to traverse the whole CFG looking for pointer SSA_NAMEs. */
2436 void
2437 dump_points_to_info (FILE *file)
2439 basic_block bb;
2440 block_stmt_iterator si;
2441 size_t i;
2442 ssa_op_iter iter;
2443 const char *fname =
2444 lang_hooks.decl_printable_name (current_function_decl, 2);
2446 fprintf (file, "\n\nPointed-to sets for pointers in %s\n\n", fname);
2448 /* First dump points-to information for the default definitions of
2449 pointer variables. This is necessary because default definitions are
2450 not part of the code. */
2451 for (i = 0; i < num_referenced_vars; i++)
2453 tree var = referenced_var (i);
2454 if (POINTER_TYPE_P (TREE_TYPE (var)))
2456 var_ann_t ann = var_ann (var);
2457 if (ann->default_def)
2458 dump_points_to_info_for (file, ann->default_def);
2462 /* Dump points-to information for every pointer defined in the program. */
2463 FOR_EACH_BB (bb)
2465 tree phi;
2467 for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
2469 tree ptr = PHI_RESULT (phi);
2470 if (POINTER_TYPE_P (TREE_TYPE (ptr)))
2471 dump_points_to_info_for (file, ptr);
2474 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
2476 tree stmt = bsi_stmt (si);
2477 tree def;
2478 FOR_EACH_SSA_TREE_OPERAND (def, stmt, iter, SSA_OP_DEF)
2479 if (POINTER_TYPE_P (TREE_TYPE (def)))
2480 dump_points_to_info_for (file, def);
2484 fprintf (file, "\n");
2488 /* Dump points-to info pointed by PTO into STDERR. */
2490 void
2491 debug_points_to_info (void)
2493 dump_points_to_info (stderr);
2496 /* Dump to FILE the list of variables that may be aliasing VAR. */
2498 void
2499 dump_may_aliases_for (FILE *file, tree var)
2501 varray_type aliases;
2503 if (TREE_CODE (var) == SSA_NAME)
2504 var = SSA_NAME_VAR (var);
2506 aliases = var_ann (var)->may_aliases;
2507 if (aliases)
2509 size_t i;
2510 fprintf (file, "{ ");
2511 for (i = 0; i < VARRAY_ACTIVE_SIZE (aliases); i++)
2513 print_generic_expr (file, VARRAY_TREE (aliases, i), dump_flags);
2514 fprintf (file, " ");
2516 fprintf (file, "}");
2521 /* Dump to stderr the list of variables that may be aliasing VAR. */
2523 void
2524 debug_may_aliases_for (tree var)
2526 dump_may_aliases_for (stderr, var);
2529 /* Return true if VAR may be aliased. */
2531 bool
2532 may_be_aliased (tree var)
2534 /* Obviously. */
2535 if (TREE_ADDRESSABLE (var))
2536 return true;
2538 /* Globally visible variables can have their addresses taken by other
2539 translation units. */
2540 if (DECL_EXTERNAL (var) || TREE_PUBLIC (var))
2541 return true;
2543 /* Automatic variables can't have their addresses escape any other way.
2544 This must be after the check for global variables, as extern declarations
2545 do not have TREE_STATIC set. */
2546 if (!TREE_STATIC (var))
2547 return false;
2549 /* If we're in unit-at-a-time mode, then we must have seen all occurrences
2550 of address-of operators, and so we can trust TREE_ADDRESSABLE. Otherwise
2551 we can only be sure the variable isn't addressable if it's local to the
2552 current function. */
2553 if (flag_unit_at_a_time)
2554 return false;
2555 if (decl_function_context (var) == current_function_decl)
2556 return false;
2558 return true;