PR middle-end/13127
[official-gcc.git] / gcc / tree-ssa-alias.c
blob8df7b82c9919f9c5f948ac2addf6eb9f78bf92c5
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 bool ptr_is_dereferenced_by (tree, tree, bool *);
153 static void maybe_create_global_var (struct alias_info *ai);
154 static void group_aliases (struct alias_info *);
155 static void set_pt_anything (tree ptr);
156 static void set_pt_malloc (tree ptr);
158 /* Global declarations. */
160 /* Call clobbered variables in the function. If bit I is set, then
161 REFERENCED_VARS (I) is call-clobbered. */
162 bitmap call_clobbered_vars;
164 /* Addressable variables in the function. If bit I is set, then
165 REFERENCED_VARS (I) has had its address taken. Note that
166 CALL_CLOBBERED_VARS and ADDRESSABLE_VARS are not related. An
167 addressable variable is not necessarily call-clobbered (e.g., a
168 local addressable whose address does not escape) and not all
169 call-clobbered variables are addressable (e.g., a local static
170 variable). */
171 bitmap addressable_vars;
173 /* When the program has too many call-clobbered variables and call-sites,
174 this variable is used to represent the clobbering effects of function
175 calls. In these cases, all the call clobbered variables in the program
176 are forced to alias this variable. This reduces compile times by not
177 having to keep track of too many V_MAY_DEF expressions at call sites. */
178 tree global_var;
181 /* Compute may-alias information for every variable referenced in function
182 FNDECL.
184 Alias analysis proceeds in 3 main phases:
186 1- Points-to and escape analysis.
188 This phase walks the use-def chains in the SSA web looking for three
189 things:
191 * Assignments of the form P_i = &VAR
192 * Assignments of the form P_i = malloc()
193 * Pointers and ADDR_EXPR that escape the current function.
195 The concept of 'escaping' is the same one used in the Java world. When
196 a pointer or an ADDR_EXPR escapes, it means that it has been exposed
197 outside of the current function. So, assignment to global variables,
198 function arguments and returning a pointer are all escape sites, as are
199 conversions between pointers and integers.
201 This is where we are currently limited. Since not everything is renamed
202 into SSA, we lose track of escape properties when a pointer is stashed
203 inside a field in a structure, for instance. In those cases, we are
204 assuming that the pointer does escape.
206 We use escape analysis to determine whether a variable is
207 call-clobbered. Simply put, if an ADDR_EXPR escapes, then the variable
208 is call-clobbered. If a pointer P_i escapes, then all the variables
209 pointed-to by P_i (and its memory tag) also escape.
211 2- Compute flow-sensitive aliases
213 We have two classes of memory tags. Memory tags associated with the
214 pointed-to data type of the pointers in the program. These tags are
215 called "type memory tag" (TMT). The other class are those associated
216 with SSA_NAMEs, called "name memory tag" (NMT). The basic idea is that
217 when adding operands for an INDIRECT_REF *P_i, we will first check
218 whether P_i has a name tag, if it does we use it, because that will have
219 more precise aliasing information. Otherwise, we use the standard type
220 tag.
222 In this phase, we go through all the pointers we found in points-to
223 analysis and create alias sets for the name memory tags associated with
224 each pointer P_i. If P_i escapes, we mark call-clobbered the variables
225 it points to and its tag.
228 3- Compute flow-insensitive aliases
230 This pass will compare the alias set of every type memory tag and every
231 addressable variable found in the program. Given a type memory tag TMT
232 and an addressable variable V. If the alias sets of TMT and V conflict
233 (as computed by may_alias_p), then V is marked as an alias tag and added
234 to the alias set of TMT.
236 For instance, consider the following function:
238 foo (int i)
240 int *p, a, b;
242 if (i > 10)
243 p = &a;
244 else
245 p = &b;
247 *p = 3;
248 a = b + 2;
249 return *p;
252 After aliasing analysis has finished, the type memory tag for pointer
253 'p' will have two aliases, namely variables 'a' and 'b'. Every time
254 pointer 'p' is dereferenced, we want to mark the operation as a
255 potential reference to 'a' and 'b'.
257 foo (int i)
259 int *p, a, b;
261 if (i_2 > 10)
262 p_4 = &a;
263 else
264 p_6 = &b;
265 # p_1 = PHI <p_4(1), p_6(2)>;
267 # a_7 = V_MAY_DEF <a_3>;
268 # b_8 = V_MAY_DEF <b_5>;
269 *p_1 = 3;
271 # a_9 = V_MAY_DEF <a_7>
272 # VUSE <b_8>
273 a_9 = b_8 + 2;
275 # VUSE <a_9>;
276 # VUSE <b_8>;
277 return *p_1;
280 In certain cases, the list of may aliases for a pointer may grow too
281 large. This may cause an explosion in the number of virtual operands
282 inserted in the code. Resulting in increased memory consumption and
283 compilation time.
285 When the number of virtual operands needed to represent aliased
286 loads and stores grows too large (configurable with @option{--param
287 max-aliased-vops}), alias sets are grouped to avoid severe
288 compile-time slow downs and memory consumption. See group_aliases. */
290 static void
291 compute_may_aliases (void)
293 struct alias_info *ai;
295 memset (&alias_stats, 0, sizeof (alias_stats));
297 /* Initialize aliasing information. */
298 ai = init_alias_info ();
300 /* For each pointer P_i, determine the sets of variables that P_i may
301 point-to. For every addressable variable V, determine whether the
302 address of V escapes the current function, making V call-clobbered
303 (i.e., whether &V is stored in a global variable or if its passed as a
304 function call argument). */
305 compute_points_to_and_addr_escape (ai);
307 /* Collect all pointers and addressable variables, compute alias sets,
308 create memory tags for pointers and promote variables whose address is
309 not needed anymore. */
310 setup_pointers_and_addressables (ai);
312 /* Compute flow-sensitive, points-to based aliasing for all the name
313 memory tags. Note that this pass needs to be done before flow
314 insensitive analysis because it uses the points-to information
315 gathered before to mark call-clobbered type tags. */
316 compute_flow_sensitive_aliasing (ai);
318 /* Compute type-based flow-insensitive aliasing for all the type
319 memory tags. */
320 compute_flow_insensitive_aliasing (ai);
322 /* If the program has too many call-clobbered variables and/or function
323 calls, create .GLOBAL_VAR and use it to model call-clobbering
324 semantics at call sites. This reduces the number of virtual operands
325 considerably, improving compile times at the expense of lost
326 aliasing precision. */
327 maybe_create_global_var (ai);
329 /* Debugging dumps. */
330 if (dump_file)
332 dump_referenced_vars (dump_file);
333 if (dump_flags & TDF_STATS)
334 dump_alias_stats (dump_file);
335 dump_points_to_info (dump_file);
336 dump_alias_info (dump_file);
339 /* Deallocate memory used by aliasing data structures. */
340 delete_alias_info (ai);
343 struct tree_opt_pass pass_may_alias =
345 "alias", /* name */
346 NULL, /* gate */
347 compute_may_aliases, /* execute */
348 NULL, /* sub */
349 NULL, /* next */
350 0, /* static_pass_number */
351 TV_TREE_MAY_ALIAS, /* tv_id */
352 PROP_cfg | PROP_ssa, /* properties_required */
353 PROP_alias, /* properties_provided */
354 0, /* properties_destroyed */
355 0, /* todo_flags_start */
356 TODO_dump_func | TODO_rename_vars
357 | TODO_ggc_collect | TODO_verify_ssa
358 | TODO_verify_stmts, /* todo_flags_finish */
359 0 /* letter */
362 /* Count the number of calls in the function and conditionally
363 create GLOBAL_VAR. This is performed before translation
364 into SSA (and thus before alias analysis) to avoid compile time
365 and memory utilization explosions in functions with many
366 of calls and call clobbered variables. */
368 static void
369 count_calls_and_maybe_create_global_var (void)
371 struct alias_info ai;
372 basic_block bb;
373 bool temp;
375 memset (&ai, 0, sizeof (struct alias_info));
377 /* First count the number of calls in the IL. */
378 FOR_EACH_BB (bb)
380 block_stmt_iterator si;
382 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
384 tree stmt = bsi_stmt (si);
386 if (get_call_expr_in (stmt) != NULL_TREE)
387 ai.num_calls_found++;
391 /* If there are no call clobbered variables, then maybe_create_global_var
392 will always create a GLOBAL_VAR. At this point we do not want that
393 behavior. So we turn on one bit in CALL_CLOBBERED_VARs, call
394 maybe_create_global_var, then reset the bit to its original state. */
395 temp = bitmap_bit_p (call_clobbered_vars, 0);
396 bitmap_set_bit (call_clobbered_vars, 0);
397 maybe_create_global_var (&ai);
398 if (!temp)
399 bitmap_clear_bit (call_clobbered_vars, 0);
402 struct tree_opt_pass pass_maybe_create_global_var =
404 "maybe_create_global_var", /* name */
405 NULL, /* gate */
406 count_calls_and_maybe_create_global_var, /* execute */
407 NULL, /* sub */
408 NULL, /* next */
409 0, /* static_pass_number */
410 TV_TREE_MAY_ALIAS, /* tv_id */
411 PROP_cfg, /* properties_required */
412 0, /* properties_provided */
413 0, /* properties_destroyed */
414 0, /* todo_flags_start */
415 0, /* todo_flags_finish */
416 0 /* letter */
419 /* Initialize the data structures used for alias analysis. */
421 static struct alias_info *
422 init_alias_info (void)
424 struct alias_info *ai;
425 static bool aliases_computed_p = false;
427 ai = xcalloc (1, sizeof (struct alias_info));
428 ai->ssa_names_visited = sbitmap_alloc (num_ssa_names);
429 sbitmap_zero (ai->ssa_names_visited);
430 VARRAY_TREE_INIT (ai->processed_ptrs, 50, "processed_ptrs");
431 ai->addresses_needed = BITMAP_XMALLOC ();
432 VARRAY_UINT_INIT (ai->num_references, num_referenced_vars, "num_references");
433 ai->written_vars = BITMAP_XMALLOC ();
434 ai->dereferenced_ptrs_store = BITMAP_XMALLOC ();
435 ai->dereferenced_ptrs_load = BITMAP_XMALLOC ();
437 /* If aliases have been computed before, clear existing information. */
438 if (aliases_computed_p)
440 unsigned i;
441 basic_block bb;
443 /* Make sure that every statement has a valid set of operands.
444 If a statement needs to be scanned for operands while we
445 compute aliases, it may get erroneous operands because all
446 the alias relations are not built at that point.
447 FIXME: This code will become obsolete when operands are not
448 lazily updated. */
449 FOR_EACH_BB (bb)
451 block_stmt_iterator si;
452 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
453 get_stmt_operands (bsi_stmt (si));
456 /* Similarly, clear the set of addressable variables. In this
457 case, we can just clear the set because addressability is
458 only computed here. */
459 bitmap_clear (addressable_vars);
461 /* Clear flow-insensitive alias information from each symbol. */
462 for (i = 0; i < num_referenced_vars; i++)
464 tree var = referenced_var (i);
465 var_ann_t ann = var_ann (var);
467 ann->is_alias_tag = 0;
468 ann->may_aliases = NULL;
470 /* Since we are about to re-discover call-clobbered
471 variables, clear the call-clobbered flag. Variables that
472 are intrinsically call-clobbered (globals, local statics,
473 etc) will not be marked by the aliasing code, so we can't
474 remove them from CALL_CLOBBERED_VARS. */
475 if (ann->mem_tag_kind != NOT_A_TAG || !is_global_var (var))
476 clear_call_clobbered (var);
479 /* Clear flow-sensitive points-to information from each SSA name. */
480 for (i = 1; i < num_ssa_names; i++)
482 tree name = ssa_name (i);
484 if (!name || !POINTER_TYPE_P (TREE_TYPE (name)))
485 continue;
487 if (SSA_NAME_PTR_INFO (name))
489 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (name);
491 /* Clear all the flags but keep the name tag to
492 avoid creating new temporaries unnecessarily. If
493 this pointer is found to point to a subset or
494 superset of its former points-to set, then a new
495 tag will need to be created in create_name_tags. */
496 pi->pt_anything = 0;
497 pi->pt_malloc = 0;
498 pi->value_escapes_p = 0;
499 pi->is_dereferenced = 0;
500 if (pi->pt_vars)
501 bitmap_clear (pi->pt_vars);
506 /* Next time, we will need to reset alias information. */
507 aliases_computed_p = true;
509 return ai;
513 /* Deallocate memory used by alias analysis. */
515 static void
516 delete_alias_info (struct alias_info *ai)
518 size_t i;
520 sbitmap_free (ai->ssa_names_visited);
521 ai->processed_ptrs = NULL;
522 BITMAP_XFREE (ai->addresses_needed);
524 for (i = 0; i < ai->num_addressable_vars; i++)
526 sbitmap_free (ai->addressable_vars[i]->may_aliases);
527 free (ai->addressable_vars[i]);
529 free (ai->addressable_vars);
531 for (i = 0; i < ai->num_pointers; i++)
533 sbitmap_free (ai->pointers[i]->may_aliases);
534 free (ai->pointers[i]);
536 free (ai->pointers);
538 ai->num_references = NULL;
539 BITMAP_XFREE (ai->written_vars);
540 BITMAP_XFREE (ai->dereferenced_ptrs_store);
541 BITMAP_XFREE (ai->dereferenced_ptrs_load);
543 free (ai);
547 /* Walk use-def chains for pointer PTR to determine what variables is PTR
548 pointing to. */
550 static void
551 collect_points_to_info_for (struct alias_info *ai, tree ptr)
553 gcc_assert (POINTER_TYPE_P (TREE_TYPE (ptr)));
555 if (!TEST_BIT (ai->ssa_names_visited, SSA_NAME_VERSION (ptr)))
557 SET_BIT (ai->ssa_names_visited, SSA_NAME_VERSION (ptr));
558 walk_use_def_chains (ptr, collect_points_to_info_r, ai, true);
559 VARRAY_PUSH_TREE (ai->processed_ptrs, ptr);
564 /* Helper for ptr_is_dereferenced_by. Called by walk_tree to look for
565 (ALIGN/MISALIGNED_)INDIRECT_REF nodes for the pointer passed in DATA. */
567 static tree
568 find_ptr_dereference (tree *tp, int *walk_subtrees ATTRIBUTE_UNUSED, void *data)
570 tree ptr = (tree) data;
572 if (INDIRECT_REF_P (*tp)
573 && TREE_OPERAND (*tp, 0) == ptr)
574 return *tp;
576 return NULL_TREE;
580 /* Return true if STMT contains (ALIGN/MISALIGNED_)INDIRECT_REF <PTR>.
581 *IS_STORE is set to 'true' if the dereference is on the LHS of an
582 assignment. */
584 static bool
585 ptr_is_dereferenced_by (tree ptr, tree stmt, bool *is_store)
587 *is_store = false;
589 if (TREE_CODE (stmt) == MODIFY_EXPR
590 || (TREE_CODE (stmt) == RETURN_EXPR
591 && TREE_CODE (TREE_OPERAND (stmt, 0)) == MODIFY_EXPR))
593 tree e, lhs, rhs;
595 e = (TREE_CODE (stmt) == RETURN_EXPR) ? TREE_OPERAND (stmt, 0) : stmt;
596 lhs = TREE_OPERAND (e, 0);
597 rhs = TREE_OPERAND (e, 1);
599 if (EXPR_P (lhs)
600 && walk_tree (&lhs, find_ptr_dereference, ptr, NULL))
602 *is_store = true;
603 return true;
605 else if (EXPR_P (rhs)
606 && walk_tree (&rhs, find_ptr_dereference, ptr, NULL))
608 return true;
611 else if (TREE_CODE (stmt) == ASM_EXPR)
613 if (walk_tree (&ASM_OUTPUTS (stmt), find_ptr_dereference, ptr, NULL)
614 || walk_tree (&ASM_CLOBBERS (stmt), find_ptr_dereference, ptr, NULL))
616 *is_store = true;
617 return true;
619 else if (walk_tree (&ASM_INPUTS (stmt), find_ptr_dereference, ptr, NULL))
621 return true;
625 return false;
629 /* Traverse use-def links for all the pointers in the program to collect
630 address escape and points-to information.
632 This is loosely based on the same idea described in R. Hasti and S.
633 Horwitz, ``Using static single assignment form to improve
634 flow-insensitive pointer analysis,'' in SIGPLAN Conference on
635 Programming Language Design and Implementation, pp. 97-105, 1998. */
637 static void
638 compute_points_to_and_addr_escape (struct alias_info *ai)
640 basic_block bb;
641 unsigned i;
642 tree op;
643 ssa_op_iter iter;
645 timevar_push (TV_TREE_PTA);
647 FOR_EACH_BB (bb)
649 bb_ann_t block_ann = bb_ann (bb);
650 block_stmt_iterator si;
652 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
654 bitmap addr_taken;
655 tree stmt = bsi_stmt (si);
656 bool stmt_escapes_p = is_escape_site (stmt, &ai->num_calls_found);
657 bitmap_iterator bi;
659 /* Mark all the variables whose address are taken by the
660 statement. Note that this will miss all the addresses taken
661 in PHI nodes (those are discovered while following the use-def
662 chains). */
663 get_stmt_operands (stmt);
664 addr_taken = addresses_taken (stmt);
665 if (addr_taken)
666 EXECUTE_IF_SET_IN_BITMAP (addr_taken, 0, i, bi)
668 tree var = referenced_var (i);
669 bitmap_set_bit (ai->addresses_needed, var_ann (var)->uid);
670 if (stmt_escapes_p)
671 mark_call_clobbered (var);
674 if (stmt_escapes_p)
675 block_ann->has_escape_site = 1;
677 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_USE)
679 var_ann_t v_ann = var_ann (SSA_NAME_VAR (op));
680 struct ptr_info_def *pi;
681 bool is_store;
683 /* If the operand's variable may be aliased, keep track
684 of how many times we've referenced it. This is used
685 for alias grouping in compute_flow_sensitive_aliasing.
686 Note that we don't need to grow AI->NUM_REFERENCES
687 because we are processing regular variables, not
688 memory tags (the array's initial size is set to
689 NUM_REFERENCED_VARS). */
690 if (may_be_aliased (SSA_NAME_VAR (op)))
691 (VARRAY_UINT (ai->num_references, v_ann->uid))++;
693 if (!POINTER_TYPE_P (TREE_TYPE (op)))
694 continue;
696 collect_points_to_info_for (ai, op);
698 pi = SSA_NAME_PTR_INFO (op);
699 if (ptr_is_dereferenced_by (op, stmt, &is_store))
701 /* Mark OP as dereferenced. In a subsequent pass,
702 dereferenced pointers that point to a set of
703 variables will be assigned a name tag to alias
704 all the variables OP points to. */
705 pi->is_dereferenced = 1;
707 /* Keep track of how many time we've dereferenced each
708 pointer. Again, we don't need to grow
709 AI->NUM_REFERENCES because we're processing
710 existing program variables. */
711 (VARRAY_UINT (ai->num_references, v_ann->uid))++;
713 /* If this is a store operation, mark OP as being
714 dereferenced to store, otherwise mark it as being
715 dereferenced to load. */
716 if (is_store)
717 bitmap_set_bit (ai->dereferenced_ptrs_store, v_ann->uid);
718 else
719 bitmap_set_bit (ai->dereferenced_ptrs_load, v_ann->uid);
721 else if (stmt_escapes_p)
723 /* Note that even if STMT is an escape point, pointer OP
724 will not escape if it is being dereferenced. That's
725 why we only check for escape points if OP is not
726 dereferenced by STMT. */
727 pi->value_escapes_p = 1;
729 /* If the statement makes a function call, assume
730 that pointer OP will be dereferenced in a store
731 operation inside the called function. */
732 if (get_call_expr_in (stmt))
734 bitmap_set_bit (ai->dereferenced_ptrs_store, v_ann->uid);
735 pi->is_dereferenced = 1;
740 /* Update reference counter for definitions to any
741 potentially aliased variable. This is used in the alias
742 grouping heuristics. */
743 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_DEF)
745 tree var = SSA_NAME_VAR (op);
746 var_ann_t ann = var_ann (var);
747 bitmap_set_bit (ai->written_vars, ann->uid);
748 if (may_be_aliased (var))
749 (VARRAY_UINT (ai->num_references, ann->uid))++;
751 if (POINTER_TYPE_P (TREE_TYPE (op)))
752 collect_points_to_info_for (ai, op);
755 /* Mark variables in V_MAY_DEF operands as being written to. */
756 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_VIRTUAL_DEFS)
758 tree var = SSA_NAME_VAR (op);
759 var_ann_t ann = var_ann (var);
760 bitmap_set_bit (ai->written_vars, ann->uid);
763 /* After promoting variables and computing aliasing we will
764 need to re-scan most statements. FIXME: Try to minimize the
765 number of statements re-scanned. It's not really necessary to
766 re-scan *all* statements. */
767 modify_stmt (stmt);
771 timevar_pop (TV_TREE_PTA);
775 /* Create name tags for all the pointers that have been dereferenced.
776 We only create a name tag for a pointer P if P is found to point to
777 a set of variables (so that we can alias them to *P) or if it is
778 the result of a call to malloc (which means that P cannot point to
779 anything else nor alias any other variable).
781 If two pointers P and Q point to the same set of variables, they
782 are assigned the same name tag. */
784 static void
785 create_name_tags (struct alias_info *ai)
787 size_t i;
789 for (i = 0; i < VARRAY_ACTIVE_SIZE (ai->processed_ptrs); i++)
791 tree ptr = VARRAY_TREE (ai->processed_ptrs, i);
792 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
794 if (pi->pt_anything || !pi->is_dereferenced)
796 /* No name tags for pointers that have not been
797 dereferenced or point to an arbitrary location. */
798 pi->name_mem_tag = NULL_TREE;
799 continue;
802 if (pi->pt_vars && !bitmap_empty_p (pi->pt_vars))
804 size_t j;
805 tree old_name_tag = pi->name_mem_tag;
807 /* If PTR points to a set of variables, check if we don't
808 have another pointer Q with the same points-to set before
809 creating a tag. If so, use Q's tag instead of creating a
810 new one.
812 This is important for not creating unnecessary symbols
813 and also for copy propagation. If we ever need to
814 propagate PTR into Q or vice-versa, we would run into
815 problems if they both had different name tags because
816 they would have different SSA version numbers (which
817 would force us to take the name tags in and out of SSA). */
818 for (j = 0; j < i; j++)
820 tree q = VARRAY_TREE (ai->processed_ptrs, j);
821 struct ptr_info_def *qi = SSA_NAME_PTR_INFO (q);
823 if (qi
824 && qi->pt_vars
825 && qi->name_mem_tag
826 && bitmap_equal_p (pi->pt_vars, qi->pt_vars))
828 pi->name_mem_tag = qi->name_mem_tag;
829 break;
833 /* If we didn't find a pointer with the same points-to set
834 as PTR, create a new name tag if needed. */
835 if (pi->name_mem_tag == NULL_TREE)
836 pi->name_mem_tag = get_nmt_for (ptr);
838 /* If the new name tag computed for PTR is different than
839 the old name tag that it used to have, then the old tag
840 needs to be removed from the IL, so we mark it for
841 renaming. */
842 if (old_name_tag && old_name_tag != pi->name_mem_tag)
843 bitmap_set_bit (vars_to_rename, var_ann (old_name_tag)->uid);
845 else if (pi->pt_malloc)
847 /* Otherwise, create a unique name tag for this pointer. */
848 pi->name_mem_tag = get_nmt_for (ptr);
850 else
852 /* Only pointers that may point to malloc or other variables
853 may receive a name tag. If the pointer does not point to
854 a known spot, we should use type tags. */
855 set_pt_anything (ptr);
856 continue;
859 TREE_THIS_VOLATILE (pi->name_mem_tag)
860 |= TREE_THIS_VOLATILE (TREE_TYPE (TREE_TYPE (ptr)));
862 /* Mark the new name tag for renaming. */
863 bitmap_set_bit (vars_to_rename, var_ann (pi->name_mem_tag)->uid);
869 /* For every pointer P_i in AI->PROCESSED_PTRS, create may-alias sets for
870 the name memory tag (NMT) associated with P_i. If P_i escapes, then its
871 name tag and the variables it points-to are call-clobbered. Finally, if
872 P_i escapes and we could not determine where it points to, then all the
873 variables in the same alias set as *P_i are marked call-clobbered. This
874 is necessary because we must assume that P_i may take the address of any
875 variable in the same alias set. */
877 static void
878 compute_flow_sensitive_aliasing (struct alias_info *ai)
880 size_t i;
882 create_name_tags (ai);
884 for (i = 0; i < VARRAY_ACTIVE_SIZE (ai->processed_ptrs); i++)
886 unsigned j;
887 tree ptr = VARRAY_TREE (ai->processed_ptrs, i);
888 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
889 var_ann_t v_ann = var_ann (SSA_NAME_VAR (ptr));
890 bitmap_iterator bi;
892 if (pi->value_escapes_p || pi->pt_anything)
894 /* If PTR escapes or may point to anything, then its associated
895 memory tags and pointed-to variables are call-clobbered. */
896 if (pi->name_mem_tag)
897 mark_call_clobbered (pi->name_mem_tag);
899 if (v_ann->type_mem_tag)
900 mark_call_clobbered (v_ann->type_mem_tag);
902 if (pi->pt_vars)
903 EXECUTE_IF_SET_IN_BITMAP (pi->pt_vars, 0, j, bi)
905 mark_call_clobbered (referenced_var (j));
909 /* Set up aliasing information for PTR's name memory tag (if it has
910 one). Note that only pointers that have been dereferenced will
911 have a name memory tag. */
912 if (pi->name_mem_tag && pi->pt_vars)
913 EXECUTE_IF_SET_IN_BITMAP (pi->pt_vars, 0, j, bi)
915 add_may_alias (pi->name_mem_tag, referenced_var (j));
918 /* If the name tag is call clobbered, so is the type tag
919 associated with the base VAR_DECL. */
920 if (pi->name_mem_tag
921 && v_ann->type_mem_tag
922 && is_call_clobbered (pi->name_mem_tag))
923 mark_call_clobbered (v_ann->type_mem_tag);
928 /* Compute type-based alias sets. Traverse all the pointers and
929 addressable variables found in setup_pointers_and_addressables.
931 For every pointer P in AI->POINTERS and addressable variable V in
932 AI->ADDRESSABLE_VARS, add V to the may-alias sets of P's type
933 memory tag (TMT) if their alias sets conflict. V is then marked as
934 an alias tag so that the operand scanner knows that statements
935 containing V have aliased operands. */
937 static void
938 compute_flow_insensitive_aliasing (struct alias_info *ai)
940 size_t i;
942 /* Initialize counter for the total number of virtual operands that
943 aliasing will introduce. When AI->TOTAL_ALIAS_VOPS goes beyond the
944 threshold set by --params max-alias-vops, we enable alias
945 grouping. */
946 ai->total_alias_vops = 0;
948 /* For every pointer P, determine which addressable variables may alias
949 with P's type memory tag. */
950 for (i = 0; i < ai->num_pointers; i++)
952 size_t j;
953 struct alias_map_d *p_map = ai->pointers[i];
954 tree tag = var_ann (p_map->var)->type_mem_tag;
955 var_ann_t tag_ann = var_ann (tag);
957 p_map->total_alias_vops = 0;
958 p_map->may_aliases = sbitmap_alloc (num_referenced_vars);
959 sbitmap_zero (p_map->may_aliases);
961 for (j = 0; j < ai->num_addressable_vars; j++)
963 struct alias_map_d *v_map;
964 var_ann_t v_ann;
965 tree var;
966 bool tag_stored_p, var_stored_p;
968 v_map = ai->addressable_vars[j];
969 var = v_map->var;
970 v_ann = var_ann (var);
972 /* Skip memory tags and variables that have never been
973 written to. We also need to check if the variables are
974 call-clobbered because they may be overwritten by
975 function calls.
977 Note this is effectively random accessing elements in
978 the sparse bitset, which can be highly inefficient.
979 So we first check the call_clobbered status of the
980 tag and variable before querying the bitmap. */
981 tag_stored_p = is_call_clobbered (tag)
982 || bitmap_bit_p (ai->written_vars, tag_ann->uid);
983 var_stored_p = is_call_clobbered (var)
984 || bitmap_bit_p (ai->written_vars, v_ann->uid);
985 if (!tag_stored_p && !var_stored_p)
986 continue;
988 if (may_alias_p (p_map->var, p_map->set, var, v_map->set))
990 size_t num_tag_refs, num_var_refs;
992 num_tag_refs = VARRAY_UINT (ai->num_references, tag_ann->uid);
993 num_var_refs = VARRAY_UINT (ai->num_references, v_ann->uid);
995 /* Add VAR to TAG's may-aliases set. */
996 add_may_alias (tag, var);
998 /* Update the total number of virtual operands due to
999 aliasing. Since we are adding one more alias to TAG's
1000 may-aliases set, the total number of virtual operands due
1001 to aliasing will be increased by the number of references
1002 made to VAR and TAG (every reference to TAG will also
1003 count as a reference to VAR). */
1004 ai->total_alias_vops += (num_var_refs + num_tag_refs);
1005 p_map->total_alias_vops += (num_var_refs + num_tag_refs);
1007 /* Update the bitmap used to represent TAG's alias set
1008 in case we need to group aliases. */
1009 SET_BIT (p_map->may_aliases, var_ann (var)->uid);
1014 /* Since this analysis is based exclusively on symbols, it fails to
1015 handle cases where two pointers P and Q have different memory
1016 tags with conflicting alias set numbers but no aliased symbols in
1017 common.
1019 For example, suppose that we have two memory tags TMT.1 and TMT.2
1020 such that
1022 may-aliases (TMT.1) = { a }
1023 may-aliases (TMT.2) = { b }
1025 and the alias set number of TMT.1 conflicts with that of TMT.2.
1026 Since they don't have symbols in common, loads and stores from
1027 TMT.1 and TMT.2 will seem independent of each other, which will
1028 lead to the optimizers making invalid transformations (see
1029 testsuite/gcc.c-torture/execute/pr15262-[12].c).
1031 To avoid this problem, we do a final traversal of AI->POINTERS
1032 looking for pairs of pointers that have no aliased symbols in
1033 common and yet have conflicting alias set numbers. */
1034 for (i = 0; i < ai->num_pointers; i++)
1036 size_t j;
1037 struct alias_map_d *p_map1 = ai->pointers[i];
1038 tree tag1 = var_ann (p_map1->var)->type_mem_tag;
1039 sbitmap may_aliases1 = p_map1->may_aliases;
1041 for (j = i + 1; j < ai->num_pointers; j++)
1043 struct alias_map_d *p_map2 = ai->pointers[j];
1044 tree tag2 = var_ann (p_map2->var)->type_mem_tag;
1045 sbitmap may_aliases2 = p_map2->may_aliases;
1047 /* If the pointers may not point to each other, do nothing. */
1048 if (!may_alias_p (p_map1->var, p_map1->set, p_map2->var, p_map2->set))
1049 continue;
1051 /* The two pointers may alias each other. If they already have
1052 symbols in common, do nothing. */
1053 if (sbitmap_any_common_bits (may_aliases1, may_aliases2))
1054 continue;
1056 if (sbitmap_first_set_bit (may_aliases2) >= 0)
1058 size_t k;
1060 /* Add all the aliases for TAG2 into TAG1's alias set.
1061 FIXME, update grouping heuristic counters. */
1062 EXECUTE_IF_SET_IN_SBITMAP (may_aliases2, 0, k,
1063 add_may_alias (tag1, referenced_var (k)));
1064 sbitmap_a_or_b (may_aliases1, may_aliases1, may_aliases2);
1066 else
1068 /* Since TAG2 does not have any aliases of its own, add
1069 TAG2 itself to the alias set of TAG1. */
1070 add_may_alias (tag1, tag2);
1075 if (dump_file)
1076 fprintf (dump_file, "%s: Total number of aliased vops: %ld\n",
1077 get_name (current_function_decl),
1078 ai->total_alias_vops);
1080 /* Determine if we need to enable alias grouping. */
1081 if (ai->total_alias_vops >= MAX_ALIASED_VOPS)
1082 group_aliases (ai);
1086 /* Comparison function for qsort used in group_aliases. */
1088 static int
1089 total_alias_vops_cmp (const void *p, const void *q)
1091 const struct alias_map_d **p1 = (const struct alias_map_d **)p;
1092 const struct alias_map_d **p2 = (const struct alias_map_d **)q;
1093 long n1 = (*p1)->total_alias_vops;
1094 long n2 = (*p2)->total_alias_vops;
1096 /* We want to sort in descending order. */
1097 return (n1 > n2 ? -1 : (n1 == n2) ? 0 : 1);
1100 /* Group all the aliases for TAG to make TAG represent all the
1101 variables in its alias set. Update the total number
1102 of virtual operands due to aliasing (AI->TOTAL_ALIAS_VOPS). This
1103 function will make TAG be the unique alias tag for all the
1104 variables in its may-aliases. So, given:
1106 may-aliases(TAG) = { V1, V2, V3 }
1108 This function will group the variables into:
1110 may-aliases(V1) = { TAG }
1111 may-aliases(V2) = { TAG }
1112 may-aliases(V2) = { TAG } */
1114 static void
1115 group_aliases_into (tree tag, sbitmap tag_aliases, struct alias_info *ai)
1117 size_t i;
1118 var_ann_t tag_ann = var_ann (tag);
1119 size_t num_tag_refs = VARRAY_UINT (ai->num_references, tag_ann->uid);
1121 EXECUTE_IF_SET_IN_SBITMAP (tag_aliases, 0, i,
1123 tree var = referenced_var (i);
1124 var_ann_t ann = var_ann (var);
1126 /* Make TAG the unique alias of VAR. */
1127 ann->is_alias_tag = 0;
1128 ann->may_aliases = NULL;
1130 /* Note that VAR and TAG may be the same if the function has no
1131 addressable variables (see the discussion at the end of
1132 setup_pointers_and_addressables). */
1133 if (var != tag)
1134 add_may_alias (var, tag);
1136 /* Reduce total number of virtual operands contributed
1137 by TAG on behalf of VAR. Notice that the references to VAR
1138 itself won't be removed. We will merely replace them with
1139 references to TAG. */
1140 ai->total_alias_vops -= num_tag_refs;
1143 /* We have reduced the number of virtual operands that TAG makes on
1144 behalf of all the variables formerly aliased with it. However,
1145 we have also "removed" all the virtual operands for TAG itself,
1146 so we add them back. */
1147 ai->total_alias_vops += num_tag_refs;
1149 /* TAG no longer has any aliases. */
1150 tag_ann->may_aliases = NULL;
1154 /* Group may-aliases sets to reduce the number of virtual operands due
1155 to aliasing.
1157 1- Sort the list of pointers in decreasing number of contributed
1158 virtual operands.
1160 2- Take the first entry in AI->POINTERS and revert the role of
1161 the memory tag and its aliases. Usually, whenever an aliased
1162 variable Vi is found to alias with a memory tag T, we add Vi
1163 to the may-aliases set for T. Meaning that after alias
1164 analysis, we will have:
1166 may-aliases(T) = { V1, V2, V3, ..., Vn }
1168 This means that every statement that references T, will get 'n'
1169 virtual operands for each of the Vi tags. But, when alias
1170 grouping is enabled, we make T an alias tag and add it to the
1171 alias set of all the Vi variables:
1173 may-aliases(V1) = { T }
1174 may-aliases(V2) = { T }
1176 may-aliases(Vn) = { T }
1178 This has two effects: (a) statements referencing T will only get
1179 a single virtual operand, and, (b) all the variables Vi will now
1180 appear to alias each other. So, we lose alias precision to
1181 improve compile time. But, in theory, a program with such a high
1182 level of aliasing should not be very optimizable in the first
1183 place.
1185 3- Since variables may be in the alias set of more than one
1186 memory tag, the grouping done in step (2) needs to be extended
1187 to all the memory tags that have a non-empty intersection with
1188 the may-aliases set of tag T. For instance, if we originally
1189 had these may-aliases sets:
1191 may-aliases(T) = { V1, V2, V3 }
1192 may-aliases(R) = { V2, V4 }
1194 In step (2) we would have reverted the aliases for T as:
1196 may-aliases(V1) = { T }
1197 may-aliases(V2) = { T }
1198 may-aliases(V3) = { T }
1200 But note that now V2 is no longer aliased with R. We could
1201 add R to may-aliases(V2), but we are in the process of
1202 grouping aliases to reduce virtual operands so what we do is
1203 add V4 to the grouping to obtain:
1205 may-aliases(V1) = { T }
1206 may-aliases(V2) = { T }
1207 may-aliases(V3) = { T }
1208 may-aliases(V4) = { T }
1210 4- If the total number of virtual operands due to aliasing is
1211 still above the threshold set by max-alias-vops, go back to (2). */
1213 static void
1214 group_aliases (struct alias_info *ai)
1216 size_t i;
1218 /* Sort the POINTERS array in descending order of contributed
1219 virtual operands. */
1220 qsort (ai->pointers, ai->num_pointers, sizeof (struct alias_map_d *),
1221 total_alias_vops_cmp);
1223 /* For every pointer in AI->POINTERS, reverse the roles of its tag
1224 and the tag's may-aliases set. */
1225 for (i = 0; i < ai->num_pointers; i++)
1227 size_t j;
1228 tree tag1 = var_ann (ai->pointers[i]->var)->type_mem_tag;
1229 sbitmap tag1_aliases = ai->pointers[i]->may_aliases;
1231 /* Skip tags that have been grouped already. */
1232 if (ai->pointers[i]->grouped_p)
1233 continue;
1235 /* See if TAG1 had any aliases in common with other type tags.
1236 If we find a TAG2 with common aliases with TAG1, add TAG2's
1237 aliases into TAG1. */
1238 for (j = i + 1; j < ai->num_pointers; j++)
1240 sbitmap tag2_aliases = ai->pointers[j]->may_aliases;
1242 if (sbitmap_any_common_bits (tag1_aliases, tag2_aliases))
1244 tree tag2 = var_ann (ai->pointers[j]->var)->type_mem_tag;
1246 sbitmap_a_or_b (tag1_aliases, tag1_aliases, tag2_aliases);
1248 /* TAG2 does not need its aliases anymore. */
1249 sbitmap_zero (tag2_aliases);
1250 var_ann (tag2)->may_aliases = NULL;
1252 /* TAG1 is the unique alias of TAG2. */
1253 add_may_alias (tag2, tag1);
1255 ai->pointers[j]->grouped_p = true;
1259 /* Now group all the aliases we collected into TAG1. */
1260 group_aliases_into (tag1, tag1_aliases, ai);
1262 /* If we've reduced total number of virtual operands below the
1263 threshold, stop. */
1264 if (ai->total_alias_vops < MAX_ALIASED_VOPS)
1265 break;
1268 /* Finally, all the variables that have been grouped cannot be in
1269 the may-alias set of name memory tags. Suppose that we have
1270 grouped the aliases in this code so that may-aliases(a) = TMT.20
1272 p_5 = &a;
1274 # a_9 = V_MAY_DEF <a_8>
1275 p_5->field = 0
1276 ... Several modifications to TMT.20 ...
1277 # VUSE <a_9>
1278 x_30 = p_5->field
1280 Since p_5 points to 'a', the optimizers will try to propagate 0
1281 into p_5->field, but that is wrong because there have been
1282 modifications to 'TMT.20' in between. To prevent this we have to
1283 replace 'a' with 'TMT.20' in the name tag of p_5. */
1284 for (i = 0; i < VARRAY_ACTIVE_SIZE (ai->processed_ptrs); i++)
1286 size_t j;
1287 tree ptr = VARRAY_TREE (ai->processed_ptrs, i);
1288 tree name_tag = SSA_NAME_PTR_INFO (ptr)->name_mem_tag;
1289 varray_type aliases;
1291 if (name_tag == NULL_TREE)
1292 continue;
1294 aliases = var_ann (name_tag)->may_aliases;
1295 for (j = 0; aliases && j < VARRAY_ACTIVE_SIZE (aliases); j++)
1297 tree alias = VARRAY_TREE (aliases, j);
1298 var_ann_t ann = var_ann (alias);
1300 if (ann->mem_tag_kind == NOT_A_TAG && ann->may_aliases)
1302 tree new_alias;
1304 gcc_assert (VARRAY_ACTIVE_SIZE (ann->may_aliases) == 1);
1306 new_alias = VARRAY_TREE (ann->may_aliases, 0);
1307 replace_may_alias (name_tag, j, new_alias);
1312 if (dump_file)
1313 fprintf (dump_file,
1314 "%s: Total number of aliased vops after grouping: %ld%s\n",
1315 get_name (current_function_decl),
1316 ai->total_alias_vops,
1317 (ai->total_alias_vops < 0) ? " (negative values are OK)" : "");
1321 /* Create a new alias set entry for VAR in AI->ADDRESSABLE_VARS. */
1323 static void
1324 create_alias_map_for (tree var, struct alias_info *ai)
1326 struct alias_map_d *alias_map;
1327 alias_map = xcalloc (1, sizeof (*alias_map));
1328 alias_map->var = var;
1329 alias_map->set = get_alias_set (var);
1330 ai->addressable_vars[ai->num_addressable_vars++] = alias_map;
1334 /* Create memory tags for all the dereferenced pointers and build the
1335 ADDRESSABLE_VARS and POINTERS arrays used for building the may-alias
1336 sets. Based on the address escape and points-to information collected
1337 earlier, this pass will also clear the TREE_ADDRESSABLE flag from those
1338 variables whose address is not needed anymore. */
1340 static void
1341 setup_pointers_and_addressables (struct alias_info *ai)
1343 size_t i, n_vars, num_addressable_vars, num_pointers;
1345 /* Size up the arrays ADDRESSABLE_VARS and POINTERS. */
1346 num_addressable_vars = num_pointers = 0;
1347 for (i = 0; i < num_referenced_vars; i++)
1349 tree var = referenced_var (i);
1351 if (may_be_aliased (var))
1352 num_addressable_vars++;
1354 if (POINTER_TYPE_P (TREE_TYPE (var)))
1356 /* Since we don't keep track of volatile variables, assume that
1357 these pointers are used in indirect store operations. */
1358 if (TREE_THIS_VOLATILE (var))
1359 bitmap_set_bit (ai->dereferenced_ptrs_store, var_ann (var)->uid);
1361 num_pointers++;
1365 /* Create ADDRESSABLE_VARS and POINTERS. Note that these arrays are
1366 always going to be slightly bigger than we actually need them
1367 because some TREE_ADDRESSABLE variables will be marked
1368 non-addressable below and only pointers with unique type tags are
1369 going to be added to POINTERS. */
1370 ai->addressable_vars = xcalloc (num_addressable_vars,
1371 sizeof (struct alias_map_d *));
1372 ai->pointers = xcalloc (num_pointers, sizeof (struct alias_map_d *));
1373 ai->num_addressable_vars = 0;
1374 ai->num_pointers = 0;
1376 /* Since we will be creating type memory tags within this loop, cache the
1377 value of NUM_REFERENCED_VARS to avoid processing the additional tags
1378 unnecessarily. */
1379 n_vars = num_referenced_vars;
1381 for (i = 0; i < n_vars; i++)
1383 tree var = referenced_var (i);
1384 var_ann_t v_ann = var_ann (var);
1386 /* Name memory tags already have flow-sensitive aliasing
1387 information, so they need not be processed by
1388 compute_flow_insensitive_aliasing. Similarly, type memory
1389 tags are already accounted for when we process their
1390 associated pointer. */
1391 if (v_ann->mem_tag_kind != NOT_A_TAG)
1392 continue;
1394 /* Remove the ADDRESSABLE flag from every addressable variable whose
1395 address is not needed anymore. This is caused by the propagation
1396 of ADDR_EXPR constants into INDIRECT_REF expressions and the
1397 removal of dead pointer assignments done by the early scalar
1398 cleanup passes. */
1399 if (TREE_ADDRESSABLE (var))
1401 if (!bitmap_bit_p (ai->addresses_needed, v_ann->uid)
1402 && TREE_CODE (var) != RESULT_DECL
1403 && !is_global_var (var))
1405 /* The address of VAR is not needed, remove the
1406 addressable bit, so that it can be optimized as a
1407 regular variable. */
1408 mark_non_addressable (var);
1410 /* Since VAR is now a regular GIMPLE register, we will need
1411 to rename VAR into SSA afterwards. */
1412 bitmap_set_bit (vars_to_rename, v_ann->uid);
1414 else
1416 /* Add the variable to the set of addressables. Mostly
1417 used when scanning operands for ASM_EXPRs that
1418 clobber memory. In those cases, we need to clobber
1419 all call-clobbered variables and all addressables. */
1420 bitmap_set_bit (addressable_vars, v_ann->uid);
1424 /* Global variables and addressable locals may be aliased. Create an
1425 entry in ADDRESSABLE_VARS for VAR. */
1426 if (may_be_aliased (var))
1428 create_alias_map_for (var, ai);
1429 bitmap_set_bit (vars_to_rename, var_ann (var)->uid);
1432 /* Add pointer variables that have been dereferenced to the POINTERS
1433 array and create a type memory tag for them. */
1434 if (POINTER_TYPE_P (TREE_TYPE (var)))
1436 if ((bitmap_bit_p (ai->dereferenced_ptrs_store, v_ann->uid)
1437 || bitmap_bit_p (ai->dereferenced_ptrs_load, v_ann->uid)))
1439 tree tag;
1440 var_ann_t t_ann;
1442 /* If pointer VAR still doesn't have a memory tag
1443 associated with it, create it now or re-use an
1444 existing one. */
1445 tag = get_tmt_for (var, ai);
1446 t_ann = var_ann (tag);
1448 /* The type tag will need to be renamed into SSA
1449 afterwards. Note that we cannot do this inside
1450 get_tmt_for because aliasing may run multiple times
1451 and we only create type tags the first time. */
1452 bitmap_set_bit (vars_to_rename, t_ann->uid);
1454 /* Associate the tag with pointer VAR. */
1455 v_ann->type_mem_tag = tag;
1457 /* If pointer VAR has been used in a store operation,
1458 then its memory tag must be marked as written-to. */
1459 if (bitmap_bit_p (ai->dereferenced_ptrs_store, v_ann->uid))
1460 bitmap_set_bit (ai->written_vars, t_ann->uid);
1462 /* If pointer VAR is a global variable or a PARM_DECL,
1463 then its memory tag should be considered a global
1464 variable. */
1465 if (TREE_CODE (var) == PARM_DECL || is_global_var (var))
1466 mark_call_clobbered (tag);
1468 /* All the dereferences of pointer VAR count as
1469 references of TAG. Since TAG can be associated with
1470 several pointers, add the dereferences of VAR to the
1471 TAG. We may need to grow AI->NUM_REFERENCES because
1472 we have been adding name and type tags. */
1473 if (t_ann->uid >= VARRAY_SIZE (ai->num_references))
1474 VARRAY_GROW (ai->num_references, t_ann->uid + 10);
1476 VARRAY_UINT (ai->num_references, t_ann->uid)
1477 += VARRAY_UINT (ai->num_references, v_ann->uid);
1479 else
1481 /* The pointer has not been dereferenced. If it had a
1482 type memory tag, remove it and mark the old tag for
1483 renaming to remove it out of the IL. */
1484 var_ann_t ann = var_ann (var);
1485 tree tag = ann->type_mem_tag;
1486 if (tag)
1488 bitmap_set_bit (vars_to_rename, var_ann (tag)->uid);
1489 ann->type_mem_tag = NULL_TREE;
1497 /* Determine whether to use .GLOBAL_VAR to model call clobbering semantics. At
1498 every call site, we need to emit V_MAY_DEF expressions to represent the
1499 clobbering effects of the call for variables whose address escapes the
1500 current function.
1502 One approach is to group all call-clobbered variables into a single
1503 representative that is used as an alias of every call-clobbered variable
1504 (.GLOBAL_VAR). This works well, but it ties the optimizer hands because
1505 references to any call clobbered variable is a reference to .GLOBAL_VAR.
1507 The second approach is to emit a clobbering V_MAY_DEF for every
1508 call-clobbered variable at call sites. This is the preferred way in terms
1509 of optimization opportunities but it may create too many V_MAY_DEF operands
1510 if there are many call clobbered variables and function calls in the
1511 function.
1513 To decide whether or not to use .GLOBAL_VAR we multiply the number of
1514 function calls found by the number of call-clobbered variables. If that
1515 product is beyond a certain threshold, as determined by the parameterized
1516 values shown below, we use .GLOBAL_VAR.
1518 FIXME. This heuristic should be improved. One idea is to use several
1519 .GLOBAL_VARs of different types instead of a single one. The thresholds
1520 have been derived from a typical bootstrap cycle, including all target
1521 libraries. Compile times were found increase by ~1% compared to using
1522 .GLOBAL_VAR. */
1524 static void
1525 maybe_create_global_var (struct alias_info *ai)
1527 unsigned i, n_clobbered;
1528 bitmap_iterator bi;
1530 /* No need to create it, if we have one already. */
1531 if (global_var == NULL_TREE)
1533 /* Count all the call-clobbered variables. */
1534 n_clobbered = 0;
1535 EXECUTE_IF_SET_IN_BITMAP (call_clobbered_vars, 0, i, bi)
1537 n_clobbered++;
1540 /* Create .GLOBAL_VAR if we have too many call-clobbered
1541 variables. We also create .GLOBAL_VAR when there no
1542 call-clobbered variables to prevent code motion
1543 transformations from re-arranging function calls that may
1544 have side effects. For instance,
1546 foo ()
1548 int a = f ();
1549 g ();
1550 h (a);
1553 There are no call-clobbered variables in foo(), so it would
1554 be entirely possible for a pass to want to move the call to
1555 f() after the call to g(). If f() has side effects, that
1556 would be wrong. Creating .GLOBAL_VAR in this case will
1557 insert VDEFs for it and prevent such transformations. */
1558 if (n_clobbered == 0
1559 || ai->num_calls_found * n_clobbered >= (size_t) GLOBAL_VAR_THRESHOLD)
1560 create_global_var ();
1563 /* If the function has calls to clobbering functions and .GLOBAL_VAR has
1564 been created, make it an alias for all call-clobbered variables. */
1565 if (global_var)
1566 EXECUTE_IF_SET_IN_BITMAP (call_clobbered_vars, 0, i, bi)
1568 tree var = referenced_var (i);
1569 if (var != global_var)
1571 add_may_alias (var, global_var);
1572 bitmap_set_bit (vars_to_rename, var_ann (var)->uid);
1578 /* Return TRUE if pointer PTR may point to variable VAR.
1580 MEM_ALIAS_SET is the alias set for the memory location pointed-to by PTR
1581 This is needed because when checking for type conflicts we are
1582 interested in the alias set of the memory location pointed-to by
1583 PTR. The alias set of PTR itself is irrelevant.
1585 VAR_ALIAS_SET is the alias set for VAR. */
1587 static bool
1588 may_alias_p (tree ptr, HOST_WIDE_INT mem_alias_set,
1589 tree var, HOST_WIDE_INT var_alias_set)
1591 tree mem;
1592 var_ann_t v_ann, m_ann;
1594 alias_stats.alias_queries++;
1595 alias_stats.simple_queries++;
1597 /* By convention, a variable cannot alias itself. */
1598 mem = var_ann (ptr)->type_mem_tag;
1599 if (mem == var)
1601 alias_stats.alias_noalias++;
1602 alias_stats.simple_resolved++;
1603 return false;
1606 v_ann = var_ann (var);
1607 m_ann = var_ann (mem);
1609 gcc_assert (m_ann->mem_tag_kind == TYPE_TAG);
1611 alias_stats.tbaa_queries++;
1613 /* If VAR is a pointer with the same alias set as PTR, then dereferencing
1614 PTR can't possibly affect VAR. Note, that we are specifically testing
1615 for PTR's alias set here, not its pointed-to type. We also can't
1616 do this check with relaxed aliasing enabled. */
1617 if (POINTER_TYPE_P (TREE_TYPE (var))
1618 && var_alias_set != 0
1619 && mem_alias_set != 0)
1621 HOST_WIDE_INT ptr_alias_set = get_alias_set (ptr);
1622 if (ptr_alias_set == var_alias_set)
1624 alias_stats.alias_noalias++;
1625 alias_stats.tbaa_resolved++;
1626 return false;
1630 /* If the alias sets don't conflict then MEM cannot alias VAR. */
1631 if (!alias_sets_conflict_p (mem_alias_set, var_alias_set))
1633 alias_stats.alias_noalias++;
1634 alias_stats.tbaa_resolved++;
1635 return false;
1638 alias_stats.alias_mayalias++;
1639 return true;
1643 /* Add ALIAS to the set of variables that may alias VAR. */
1645 static void
1646 add_may_alias (tree var, tree alias)
1648 size_t i;
1649 var_ann_t v_ann = get_var_ann (var);
1650 var_ann_t a_ann = get_var_ann (alias);
1652 gcc_assert (var != alias);
1654 if (v_ann->may_aliases == NULL)
1655 VARRAY_TREE_INIT (v_ann->may_aliases, 2, "aliases");
1657 /* Avoid adding duplicates. */
1658 for (i = 0; i < VARRAY_ACTIVE_SIZE (v_ann->may_aliases); i++)
1659 if (alias == VARRAY_TREE (v_ann->may_aliases, i))
1660 return;
1662 /* If VAR is a call-clobbered variable, so is its new ALIAS.
1663 FIXME, call-clobbering should only depend on whether an address
1664 escapes. It should be independent of aliasing. */
1665 if (is_call_clobbered (var))
1666 mark_call_clobbered (alias);
1668 /* Likewise. If ALIAS is call-clobbered, so is VAR. */
1669 else if (is_call_clobbered (alias))
1670 mark_call_clobbered (var);
1672 VARRAY_PUSH_TREE (v_ann->may_aliases, alias);
1673 a_ann->is_alias_tag = 1;
1677 /* Replace alias I in the alias sets of VAR with NEW_ALIAS. */
1679 static void
1680 replace_may_alias (tree var, size_t i, tree new_alias)
1682 var_ann_t v_ann = var_ann (var);
1683 VARRAY_TREE (v_ann->may_aliases, i) = new_alias;
1685 /* If VAR is a call-clobbered variable, so is NEW_ALIAS.
1686 FIXME, call-clobbering should only depend on whether an address
1687 escapes. It should be independent of aliasing. */
1688 if (is_call_clobbered (var))
1689 mark_call_clobbered (new_alias);
1691 /* Likewise. If NEW_ALIAS is call-clobbered, so is VAR. */
1692 else if (is_call_clobbered (new_alias))
1693 mark_call_clobbered (var);
1697 /* Mark pointer PTR as pointing to an arbitrary memory location. */
1699 static void
1700 set_pt_anything (tree ptr)
1702 struct ptr_info_def *pi = get_ptr_info (ptr);
1704 pi->pt_anything = 1;
1705 pi->pt_malloc = 0;
1707 /* The pointer used to have a name tag, but we now found it pointing
1708 to an arbitrary location. The name tag needs to be renamed and
1709 disassociated from PTR. */
1710 if (pi->name_mem_tag)
1712 bitmap_set_bit (vars_to_rename, var_ann (pi->name_mem_tag)->uid);
1713 pi->name_mem_tag = NULL_TREE;
1718 /* Mark pointer PTR as pointing to a malloc'd memory area. */
1720 static void
1721 set_pt_malloc (tree ptr)
1723 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
1725 /* If the pointer has already been found to point to arbitrary
1726 memory locations, it is unsafe to mark it as pointing to malloc. */
1727 if (pi->pt_anything)
1728 return;
1730 pi->pt_malloc = 1;
1734 /* Given two different pointers DEST and ORIG. Merge the points-to
1735 information in ORIG into DEST. AI is as in
1736 collect_points_to_info. */
1738 static void
1739 merge_pointed_to_info (struct alias_info *ai, tree dest, tree orig)
1741 struct ptr_info_def *dest_pi, *orig_pi;
1743 gcc_assert (dest != orig);
1745 /* Make sure we have points-to information for ORIG. */
1746 collect_points_to_info_for (ai, orig);
1748 dest_pi = get_ptr_info (dest);
1749 orig_pi = SSA_NAME_PTR_INFO (orig);
1751 if (orig_pi)
1753 /* Notice that we never merge PT_MALLOC. This attribute is only
1754 true if the pointer is the result of a malloc() call.
1755 Otherwise, we can end up in this situation:
1757 P_i = malloc ();
1759 P_j = P_i + X;
1761 P_j would be marked as PT_MALLOC, however we currently do not
1762 handle cases of more than one pointer pointing to the same
1763 malloc'd area.
1765 FIXME: If the merging comes from an expression that preserves
1766 the PT_MALLOC attribute (copy assignment, address
1767 arithmetic), we ought to merge PT_MALLOC, but then both
1768 pointers would end up getting different name tags because
1769 create_name_tags is not smart enough to determine that the
1770 two come from the same malloc call. Copy propagation before
1771 aliasing should cure this. */
1772 gcc_assert (orig_pi != dest_pi);
1774 dest_pi->pt_malloc = 0;
1776 if (orig_pi->pt_malloc || orig_pi->pt_anything)
1777 set_pt_anything (dest);
1779 if (!dest_pi->pt_anything
1780 && orig_pi->pt_vars
1781 && !bitmap_empty_p (orig_pi->pt_vars))
1783 if (dest_pi->pt_vars == NULL)
1785 dest_pi->pt_vars = BITMAP_GGC_ALLOC ();
1786 bitmap_copy (dest_pi->pt_vars, orig_pi->pt_vars);
1788 else
1789 bitmap_ior_into (dest_pi->pt_vars, orig_pi->pt_vars);
1792 else
1793 set_pt_anything (dest);
1797 /* Add EXPR to the list of expressions pointed-to by PTR. */
1799 static void
1800 add_pointed_to_expr (struct alias_info *ai, tree ptr, tree expr)
1802 if (TREE_CODE (expr) == WITH_SIZE_EXPR)
1803 expr = TREE_OPERAND (expr, 0);
1805 get_ptr_info (ptr);
1807 if (TREE_CODE (expr) == CALL_EXPR
1808 && (call_expr_flags (expr) & (ECF_MALLOC | ECF_MAY_BE_ALLOCA)))
1810 /* If EXPR is a malloc-like call, then the area pointed to PTR
1811 is guaranteed to not alias with anything else. */
1812 set_pt_malloc (ptr);
1814 else if (TREE_CODE (expr) == ADDR_EXPR)
1816 /* Found P_i = ADDR_EXPR */
1817 add_pointed_to_var (ai, ptr, expr);
1819 else if (TREE_CODE (expr) == SSA_NAME && POINTER_TYPE_P (TREE_TYPE (expr)))
1821 /* Found P_i = Q_j. */
1822 merge_pointed_to_info (ai, ptr, expr);
1824 else if (TREE_CODE (expr) == PLUS_EXPR || TREE_CODE (expr) == MINUS_EXPR)
1826 /* Found P_i = PLUS_EXPR or P_i = MINUS_EXPR */
1827 tree op0 = TREE_OPERAND (expr, 0);
1828 tree op1 = TREE_OPERAND (expr, 1);
1830 /* Both operands may be of pointer type. FIXME: Shouldn't
1831 we just expect PTR + OFFSET always? */
1832 if (POINTER_TYPE_P (TREE_TYPE (op0))
1833 && TREE_CODE (op0) != INTEGER_CST)
1835 if (TREE_CODE (op0) == SSA_NAME)
1836 merge_pointed_to_info (ai, ptr, op0);
1837 else if (TREE_CODE (op0) == ADDR_EXPR)
1838 add_pointed_to_var (ai, ptr, op0);
1839 else
1840 set_pt_anything (ptr);
1843 if (POINTER_TYPE_P (TREE_TYPE (op1))
1844 && TREE_CODE (op1) != INTEGER_CST)
1846 if (TREE_CODE (op1) == SSA_NAME)
1847 merge_pointed_to_info (ai, ptr, op1);
1848 else if (TREE_CODE (op1) == ADDR_EXPR)
1849 add_pointed_to_var (ai, ptr, op1);
1850 else
1851 set_pt_anything (ptr);
1854 /* Neither operand is a pointer? VAR can be pointing anywhere.
1855 FIXME: Shouldn't we abort here? If we get here, we found
1856 PTR = INT_CST + INT_CST, which should not be a valid pointer
1857 expression. */
1858 if (!(POINTER_TYPE_P (TREE_TYPE (op0))
1859 && TREE_CODE (op0) != INTEGER_CST)
1860 && !(POINTER_TYPE_P (TREE_TYPE (op1))
1861 && TREE_CODE (op1) != INTEGER_CST))
1862 set_pt_anything (ptr);
1864 else
1866 /* If we can't recognize the expression, assume that PTR may
1867 point anywhere. */
1868 set_pt_anything (ptr);
1873 /* If VALUE is of the form &DECL, add DECL to the set of variables
1874 pointed-to by PTR. Otherwise, add VALUE as a pointed-to expression by
1875 PTR. AI is as in collect_points_to_info. */
1877 static void
1878 add_pointed_to_var (struct alias_info *ai, tree ptr, tree value)
1880 struct ptr_info_def *pi = get_ptr_info (ptr);
1881 tree pt_var;
1882 size_t uid;
1884 gcc_assert (TREE_CODE (value) == ADDR_EXPR);
1886 pt_var = TREE_OPERAND (value, 0);
1887 if (REFERENCE_CLASS_P (pt_var))
1888 pt_var = get_base_address (pt_var);
1890 if (pt_var && SSA_VAR_P (pt_var))
1892 uid = var_ann (pt_var)->uid;
1893 bitmap_set_bit (ai->addresses_needed, uid);
1895 if (pi->pt_vars == NULL)
1896 pi->pt_vars = BITMAP_GGC_ALLOC ();
1897 bitmap_set_bit (pi->pt_vars, uid);
1899 /* If the variable is a global, mark the pointer as pointing to
1900 global memory (which will make its tag a global variable). */
1901 if (is_global_var (pt_var))
1902 pi->pt_global_mem = 1;
1907 /* Callback for walk_use_def_chains to gather points-to information from the
1908 SSA web.
1910 VAR is an SSA variable or a GIMPLE expression.
1912 STMT is the statement that generates the SSA variable or, if STMT is a
1913 PHI_NODE, VAR is one of the PHI arguments.
1915 DATA is a pointer to a structure of type ALIAS_INFO. */
1917 static bool
1918 collect_points_to_info_r (tree var, tree stmt, void *data)
1920 struct alias_info *ai = (struct alias_info *) data;
1922 if (dump_file && (dump_flags & TDF_DETAILS))
1924 fprintf (dump_file, "Visiting use-def links for ");
1925 print_generic_expr (dump_file, var, dump_flags);
1926 fprintf (dump_file, "\n");
1929 switch (TREE_CODE (stmt))
1931 case RETURN_EXPR:
1932 if (TREE_CODE (TREE_OPERAND (stmt, 0)) != MODIFY_EXPR)
1933 abort ();
1934 stmt = TREE_OPERAND (stmt, 0);
1935 /* FALLTHRU */
1937 case MODIFY_EXPR:
1939 tree rhs = TREE_OPERAND (stmt, 1);
1940 STRIP_NOPS (rhs);
1941 add_pointed_to_expr (ai, var, rhs);
1942 break;
1945 case ASM_EXPR:
1946 /* Pointers defined by __asm__ statements can point anywhere. */
1947 set_pt_anything (var);
1948 break;
1950 case NOP_EXPR:
1951 if (IS_EMPTY_STMT (stmt))
1953 tree decl = SSA_NAME_VAR (var);
1955 if (TREE_CODE (decl) == PARM_DECL)
1956 add_pointed_to_expr (ai, var, decl);
1957 else if (DECL_INITIAL (decl))
1958 add_pointed_to_expr (ai, var, DECL_INITIAL (decl));
1959 else
1960 add_pointed_to_expr (ai, var, decl);
1962 break;
1964 case PHI_NODE:
1966 /* It STMT is a PHI node, then VAR is one of its arguments. The
1967 variable that we are analyzing is the LHS of the PHI node. */
1968 tree lhs = PHI_RESULT (stmt);
1970 switch (TREE_CODE (var))
1972 case ADDR_EXPR:
1973 add_pointed_to_var (ai, lhs, var);
1974 break;
1976 case SSA_NAME:
1977 /* Avoid unnecessary merges. */
1978 if (lhs != var)
1979 merge_pointed_to_info (ai, lhs, var);
1980 break;
1982 default:
1983 gcc_assert (is_gimple_min_invariant (var));
1984 add_pointed_to_expr (ai, lhs, var);
1985 break;
1987 break;
1990 default:
1991 gcc_unreachable ();
1994 return false;
1998 /* Return true if STMT is an "escape" site from the current function. Escape
1999 sites those statements which might expose the address of a variable
2000 outside the current function. STMT is an escape site iff:
2002 1- STMT is a function call, or
2003 2- STMT is an __asm__ expression, or
2004 3- STMT is an assignment to a non-local variable, or
2005 4- STMT is a return statement.
2007 If NUM_CALLS_P is not NULL, the counter is incremented if STMT contains
2008 a function call. */
2010 static bool
2011 is_escape_site (tree stmt, size_t *num_calls_p)
2013 if (get_call_expr_in (stmt) != NULL_TREE)
2015 if (num_calls_p)
2016 (*num_calls_p)++;
2018 return true;
2020 else if (TREE_CODE (stmt) == ASM_EXPR)
2021 return true;
2022 else if (TREE_CODE (stmt) == MODIFY_EXPR)
2024 tree lhs = TREE_OPERAND (stmt, 0);
2026 /* Get to the base of _REF nodes. */
2027 if (TREE_CODE (lhs) != SSA_NAME)
2028 lhs = get_base_address (lhs);
2030 /* If we couldn't recognize the LHS of the assignment, assume that it
2031 is a non-local store. */
2032 if (lhs == NULL_TREE)
2033 return true;
2035 /* If the RHS is a conversion between a pointer and an integer, the
2036 pointer escapes since we can't track the integer. */
2037 if ((TREE_CODE (TREE_OPERAND (stmt, 1)) == NOP_EXPR
2038 || TREE_CODE (TREE_OPERAND (stmt, 1)) == CONVERT_EXPR
2039 || TREE_CODE (TREE_OPERAND (stmt, 1)) == VIEW_CONVERT_EXPR)
2040 && POINTER_TYPE_P (TREE_TYPE (TREE_OPERAND
2041 (TREE_OPERAND (stmt, 1), 0)))
2042 && !POINTER_TYPE_P (TREE_TYPE (TREE_OPERAND (stmt, 1))))
2043 return true;
2045 /* If the LHS is an SSA name, it can't possibly represent a non-local
2046 memory store. */
2047 if (TREE_CODE (lhs) == SSA_NAME)
2048 return false;
2050 /* FIXME: LHS is not an SSA_NAME. Even if it's an assignment to a
2051 local variables we cannot be sure if it will escape, because we
2052 don't have information about objects not in SSA form. Need to
2053 implement something along the lines of
2055 J.-D. Choi, M. Gupta, M. J. Serrano, V. C. Sreedhar, and S. P.
2056 Midkiff, ``Escape analysis for java,'' in Proceedings of the
2057 Conference on Object-Oriented Programming Systems, Languages, and
2058 Applications (OOPSLA), pp. 1-19, 1999. */
2059 return true;
2061 else if (TREE_CODE (stmt) == RETURN_EXPR)
2062 return true;
2064 return false;
2068 /* Create a new memory tag of type TYPE. If IS_TYPE_TAG is true, the tag
2069 is considered to represent all the pointers whose pointed-to types are
2070 in the same alias set class. Otherwise, the tag represents a single
2071 SSA_NAME pointer variable. */
2073 static tree
2074 create_memory_tag (tree type, bool is_type_tag)
2076 var_ann_t ann;
2077 tree tag = create_tmp_var_raw (type, (is_type_tag) ? "TMT" : "NMT");
2079 /* By default, memory tags are local variables. Alias analysis will
2080 determine whether they should be considered globals. */
2081 DECL_CONTEXT (tag) = current_function_decl;
2083 /* Memory tags are by definition addressable. This also prevents
2084 is_gimple_ref frome confusing memory tags with optimizable
2085 variables. */
2086 TREE_ADDRESSABLE (tag) = 1;
2088 ann = get_var_ann (tag);
2089 ann->mem_tag_kind = (is_type_tag) ? TYPE_TAG : NAME_TAG;
2090 ann->type_mem_tag = NULL_TREE;
2092 /* Add the tag to the symbol table. */
2093 add_referenced_tmp_var (tag);
2095 return tag;
2099 /* Create a name memory tag to represent a specific SSA_NAME pointer P_i.
2100 This is used if P_i has been found to point to a specific set of
2101 variables or to a non-aliased memory location like the address returned
2102 by malloc functions. */
2104 static tree
2105 get_nmt_for (tree ptr)
2107 struct ptr_info_def *pi = get_ptr_info (ptr);
2108 tree tag = pi->name_mem_tag;
2110 if (tag == NULL_TREE)
2111 tag = create_memory_tag (TREE_TYPE (TREE_TYPE (ptr)), false);
2113 /* If PTR is a PARM_DECL, it points to a global variable or malloc,
2114 then its name tag should be considered a global variable. */
2115 if (TREE_CODE (SSA_NAME_VAR (ptr)) == PARM_DECL
2116 || pi->pt_malloc
2117 || pi->pt_global_mem)
2118 mark_call_clobbered (tag);
2120 return tag;
2124 /* Return the type memory tag associated to pointer PTR. A memory tag is an
2125 artificial variable that represents the memory location pointed-to by
2126 PTR. It is used to model the effects of pointer de-references on
2127 addressable variables.
2129 AI points to the data gathered during alias analysis. This function
2130 populates the array AI->POINTERS. */
2132 static tree
2133 get_tmt_for (tree ptr, struct alias_info *ai)
2135 size_t i;
2136 tree tag;
2137 tree tag_type = TREE_TYPE (TREE_TYPE (ptr));
2138 HOST_WIDE_INT tag_set = get_alias_set (tag_type);
2140 /* To avoid creating unnecessary memory tags, only create one memory tag
2141 per alias set class. Note that it may be tempting to group
2142 memory tags based on conflicting alias sets instead of
2143 equivalence. That would be wrong because alias sets are not
2144 necessarily transitive (as demonstrated by the libstdc++ test
2145 23_containers/vector/cons/4.cc). Given three alias sets A, B, C
2146 such that conflicts (A, B) == true and conflicts (A, C) == true,
2147 it does not necessarily follow that conflicts (B, C) == true. */
2148 for (i = 0, tag = NULL_TREE; i < ai->num_pointers; i++)
2150 struct alias_map_d *curr = ai->pointers[i];
2151 if (tag_set == curr->set)
2153 tag = var_ann (curr->var)->type_mem_tag;
2154 break;
2158 /* If VAR cannot alias with any of the existing memory tags, create a new
2159 tag for PTR and add it to the POINTERS array. */
2160 if (tag == NULL_TREE)
2162 struct alias_map_d *alias_map;
2164 /* If PTR did not have a type tag already, create a new TMT.*
2165 artificial variable representing the memory location
2166 pointed-to by PTR. */
2167 if (var_ann (ptr)->type_mem_tag == NULL_TREE)
2168 tag = create_memory_tag (tag_type, true);
2169 else
2170 tag = var_ann (ptr)->type_mem_tag;
2172 /* Add PTR to the POINTERS array. Note that we are not interested in
2173 PTR's alias set. Instead, we cache the alias set for the memory that
2174 PTR points to. */
2175 alias_map = xcalloc (1, sizeof (*alias_map));
2176 alias_map->var = ptr;
2177 alias_map->set = tag_set;
2178 ai->pointers[ai->num_pointers++] = alias_map;
2181 /* If the pointed-to type is volatile, so is the tag. */
2182 TREE_THIS_VOLATILE (tag) |= TREE_THIS_VOLATILE (tag_type);
2184 /* Make sure that the type tag has the same alias set as the
2185 pointed-to type. */
2186 gcc_assert (tag_set == get_alias_set (tag));
2188 return tag;
2192 /* Create GLOBAL_VAR, an artificial global variable to act as a
2193 representative of all the variables that may be clobbered by function
2194 calls. */
2196 static void
2197 create_global_var (void)
2199 global_var = build_decl (VAR_DECL, get_identifier (".GLOBAL_VAR"),
2200 void_type_node);
2201 DECL_ARTIFICIAL (global_var) = 1;
2202 TREE_READONLY (global_var) = 0;
2203 DECL_EXTERNAL (global_var) = 1;
2204 TREE_STATIC (global_var) = 1;
2205 TREE_USED (global_var) = 1;
2206 DECL_CONTEXT (global_var) = NULL_TREE;
2207 TREE_THIS_VOLATILE (global_var) = 0;
2208 TREE_ADDRESSABLE (global_var) = 0;
2210 add_referenced_tmp_var (global_var);
2211 bitmap_set_bit (vars_to_rename, var_ann (global_var)->uid);
2215 /* Dump alias statistics on FILE. */
2217 static void
2218 dump_alias_stats (FILE *file)
2220 const char *funcname
2221 = lang_hooks.decl_printable_name (current_function_decl, 2);
2222 fprintf (file, "\nAlias statistics for %s\n\n", funcname);
2223 fprintf (file, "Total alias queries:\t%u\n", alias_stats.alias_queries);
2224 fprintf (file, "Total alias mayalias results:\t%u\n",
2225 alias_stats.alias_mayalias);
2226 fprintf (file, "Total alias noalias results:\t%u\n",
2227 alias_stats.alias_noalias);
2228 fprintf (file, "Total simple queries:\t%u\n",
2229 alias_stats.simple_queries);
2230 fprintf (file, "Total simple resolved:\t%u\n",
2231 alias_stats.simple_resolved);
2232 fprintf (file, "Total TBAA queries:\t%u\n",
2233 alias_stats.tbaa_queries);
2234 fprintf (file, "Total TBAA resolved:\t%u\n",
2235 alias_stats.tbaa_resolved);
2239 /* Dump alias information on FILE. */
2241 void
2242 dump_alias_info (FILE *file)
2244 size_t i;
2245 const char *funcname
2246 = lang_hooks.decl_printable_name (current_function_decl, 2);
2248 fprintf (file, "\nFlow-insensitive alias information for %s\n\n", funcname);
2250 fprintf (file, "Aliased symbols\n\n");
2251 for (i = 0; i < num_referenced_vars; i++)
2253 tree var = referenced_var (i);
2254 if (may_be_aliased (var))
2255 dump_variable (file, var);
2258 fprintf (file, "\nDereferenced pointers\n\n");
2259 for (i = 0; i < num_referenced_vars; i++)
2261 tree var = referenced_var (i);
2262 var_ann_t ann = var_ann (var);
2263 if (ann->type_mem_tag)
2264 dump_variable (file, var);
2267 fprintf (file, "\nType memory tags\n\n");
2268 for (i = 0; i < num_referenced_vars; i++)
2270 tree var = referenced_var (i);
2271 var_ann_t ann = var_ann (var);
2272 if (ann->mem_tag_kind == TYPE_TAG)
2273 dump_variable (file, var);
2276 fprintf (file, "\n\nFlow-sensitive alias information for %s\n\n", funcname);
2278 fprintf (file, "SSA_NAME pointers\n\n");
2279 for (i = 1; i < num_ssa_names; i++)
2281 tree ptr = ssa_name (i);
2282 struct ptr_info_def *pi;
2284 if (ptr == NULL_TREE)
2285 continue;
2287 pi = SSA_NAME_PTR_INFO (ptr);
2288 if (!SSA_NAME_IN_FREE_LIST (ptr)
2289 && pi
2290 && pi->name_mem_tag)
2291 dump_points_to_info_for (file, ptr);
2294 fprintf (file, "\nName memory tags\n\n");
2295 for (i = 0; i < num_referenced_vars; i++)
2297 tree var = referenced_var (i);
2298 var_ann_t ann = var_ann (var);
2299 if (ann->mem_tag_kind == NAME_TAG)
2300 dump_variable (file, var);
2303 fprintf (file, "\n");
2307 /* Dump alias information on stderr. */
2309 void
2310 debug_alias_info (void)
2312 dump_alias_info (stderr);
2316 /* Return the alias information associated with pointer T. It creates a
2317 new instance if none existed. */
2319 struct ptr_info_def *
2320 get_ptr_info (tree t)
2322 struct ptr_info_def *pi;
2324 gcc_assert (POINTER_TYPE_P (TREE_TYPE (t)));
2326 pi = SSA_NAME_PTR_INFO (t);
2327 if (pi == NULL)
2329 pi = ggc_alloc (sizeof (*pi));
2330 memset ((void *)pi, 0, sizeof (*pi));
2331 SSA_NAME_PTR_INFO (t) = pi;
2334 return pi;
2338 /* Dump points-to information for SSA_NAME PTR into FILE. */
2340 void
2341 dump_points_to_info_for (FILE *file, tree ptr)
2343 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
2345 print_generic_expr (file, ptr, dump_flags);
2347 if (pi)
2349 if (pi->name_mem_tag)
2351 fprintf (file, ", name memory tag: ");
2352 print_generic_expr (file, pi->name_mem_tag, dump_flags);
2355 if (pi->is_dereferenced)
2356 fprintf (file, ", is dereferenced");
2358 if (pi->value_escapes_p)
2359 fprintf (file, ", its value escapes");
2361 if (pi->pt_anything)
2362 fprintf (file, ", points-to anything");
2364 if (pi->pt_malloc)
2365 fprintf (file, ", points-to malloc");
2367 if (pi->pt_vars)
2369 unsigned ix;
2370 bitmap_iterator bi;
2372 fprintf (file, ", points-to vars: { ");
2373 EXECUTE_IF_SET_IN_BITMAP (pi->pt_vars, 0, ix, bi)
2375 print_generic_expr (file, referenced_var (ix), dump_flags);
2376 fprintf (file, " ");
2378 fprintf (file, "}");
2382 fprintf (file, "\n");
2386 /* Dump points-to information for VAR into stderr. */
2388 void
2389 debug_points_to_info_for (tree var)
2391 dump_points_to_info_for (stderr, var);
2395 /* Dump points-to information into FILE. NOTE: This function is slow, as
2396 it needs to traverse the whole CFG looking for pointer SSA_NAMEs. */
2398 void
2399 dump_points_to_info (FILE *file)
2401 basic_block bb;
2402 block_stmt_iterator si;
2403 size_t i;
2404 ssa_op_iter iter;
2405 const char *fname =
2406 lang_hooks.decl_printable_name (current_function_decl, 2);
2408 fprintf (file, "\n\nPointed-to sets for pointers in %s\n\n", fname);
2410 /* First dump points-to information for the default definitions of
2411 pointer variables. This is necessary because default definitions are
2412 not part of the code. */
2413 for (i = 0; i < num_referenced_vars; i++)
2415 tree var = referenced_var (i);
2416 if (POINTER_TYPE_P (TREE_TYPE (var)))
2418 var_ann_t ann = var_ann (var);
2419 if (ann->default_def)
2420 dump_points_to_info_for (file, ann->default_def);
2424 /* Dump points-to information for every pointer defined in the program. */
2425 FOR_EACH_BB (bb)
2427 tree phi;
2429 for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
2431 tree ptr = PHI_RESULT (phi);
2432 if (POINTER_TYPE_P (TREE_TYPE (ptr)))
2433 dump_points_to_info_for (file, ptr);
2436 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
2438 tree stmt = bsi_stmt (si);
2439 tree def;
2440 FOR_EACH_SSA_TREE_OPERAND (def, stmt, iter, SSA_OP_DEF)
2441 if (POINTER_TYPE_P (TREE_TYPE (def)))
2442 dump_points_to_info_for (file, def);
2446 fprintf (file, "\n");
2450 /* Dump points-to info pointed by PTO into STDERR. */
2452 void
2453 debug_points_to_info (void)
2455 dump_points_to_info (stderr);
2458 /* Dump to FILE the list of variables that may be aliasing VAR. */
2460 void
2461 dump_may_aliases_for (FILE *file, tree var)
2463 varray_type aliases;
2465 if (TREE_CODE (var) == SSA_NAME)
2466 var = SSA_NAME_VAR (var);
2468 aliases = var_ann (var)->may_aliases;
2469 if (aliases)
2471 size_t i;
2472 fprintf (file, "{ ");
2473 for (i = 0; i < VARRAY_ACTIVE_SIZE (aliases); i++)
2475 print_generic_expr (file, VARRAY_TREE (aliases, i), dump_flags);
2476 fprintf (file, " ");
2478 fprintf (file, "}");
2483 /* Dump to stderr the list of variables that may be aliasing VAR. */
2485 void
2486 debug_may_aliases_for (tree var)
2488 dump_may_aliases_for (stderr, var);
2491 /* Return true if VAR may be aliased. */
2493 bool
2494 may_be_aliased (tree var)
2496 /* Obviously. */
2497 if (TREE_ADDRESSABLE (var))
2498 return true;
2500 /* Globally visible variables can have their addresses taken by other
2501 translation units. */
2502 if (DECL_EXTERNAL (var) || TREE_PUBLIC (var))
2503 return true;
2505 /* Automatic variables can't have their addresses escape any other way.
2506 This must be after the check for global variables, as extern declarations
2507 do not have TREE_STATIC set. */
2508 if (!TREE_STATIC (var))
2509 return false;
2511 /* If we're in unit-at-a-time mode, then we must have seen all occurrences
2512 of address-of operators, and so we can trust TREE_ADDRESSABLE. Otherwise
2513 we can only be sure the variable isn't addressable if it's local to the
2514 current function. */
2515 if (flag_unit_at_a_time)
2516 return false;
2517 if (decl_function_context (var) == current_function_decl)
2518 return false;
2520 return true;