2005-06-30 J. D. Johnston <jjohnst@us.ibm.com>
[official-gcc.git] / gcc / tree-ssa-alias.c
blob2e74b58e10390c2c7d7d82e95a88c3935458b844
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, 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, 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"
45 #include "vec.h"
47 /* 'true' after aliases have been computed (see compute_may_aliases). */
48 bool aliases_computed_p;
50 /* Structure to map a variable to its alias set and keep track of the
51 virtual operands that will be needed to represent it. */
52 struct alias_map_d
54 /* Variable and its alias set. */
55 tree var;
56 HOST_WIDE_INT set;
58 /* Total number of virtual operands that will be needed to represent
59 all the aliases of VAR. */
60 long total_alias_vops;
62 /* Nonzero if the aliases for this memory tag have been grouped
63 already. Used in group_aliases. */
64 unsigned int grouped_p : 1;
66 /* Set of variables aliased with VAR. This is the exact same
67 information contained in VAR_ANN (VAR)->MAY_ALIASES, but in
68 bitmap form to speed up alias grouping. */
69 sbitmap may_aliases;
73 /* Alias information used by compute_may_aliases and its helpers. */
74 struct alias_info
76 /* SSA names visited while collecting points-to information. If bit I
77 is set, it means that SSA variable with version I has already been
78 visited. */
79 sbitmap ssa_names_visited;
81 /* Array of SSA_NAME pointers processed by the points-to collector. */
82 varray_type processed_ptrs;
84 /* Variables whose address is still needed. */
85 bitmap addresses_needed;
87 /* ADDRESSABLE_VARS contains all the global variables and locals that
88 have had their address taken. */
89 struct alias_map_d **addressable_vars;
90 size_t num_addressable_vars;
92 /* POINTERS contains all the _DECL pointers with unique memory tags
93 that have been referenced in the program. */
94 struct alias_map_d **pointers;
95 size_t num_pointers;
97 /* Number of function calls found in the program. */
98 size_t num_calls_found;
100 /* Number of const/pure function calls found in the program. */
101 size_t num_pure_const_calls_found;
103 /* Array of counters to keep track of how many times each pointer has
104 been dereferenced in the program. This is used by the alias grouping
105 heuristic in compute_flow_insensitive_aliasing. */
106 varray_type num_references;
108 /* Total number of virtual operands that will be needed to represent
109 all the aliases of all the pointers found in the program. */
110 long total_alias_vops;
112 /* Variables that have been written to. */
113 bitmap written_vars;
115 /* Pointers that have been used in an indirect store operation. */
116 bitmap dereferenced_ptrs_store;
118 /* Pointers that have been used in an indirect load operation. */
119 bitmap dereferenced_ptrs_load;
123 /* Counters used to display statistics on alias analysis. */
124 struct alias_stats_d
126 unsigned int alias_queries;
127 unsigned int alias_mayalias;
128 unsigned int alias_noalias;
129 unsigned int simple_queries;
130 unsigned int simple_resolved;
131 unsigned int tbaa_queries;
132 unsigned int tbaa_resolved;
136 /* Local variables. */
137 static struct alias_stats_d alias_stats;
139 /* Local functions. */
140 static void compute_flow_insensitive_aliasing (struct alias_info *);
141 static void dump_alias_stats (FILE *);
142 static bool may_alias_p (tree, HOST_WIDE_INT, tree, HOST_WIDE_INT);
143 static tree create_memory_tag (tree type, bool is_type_tag);
144 static tree get_tmt_for (tree, struct alias_info *);
145 static tree get_nmt_for (tree);
146 static void add_may_alias (tree, tree);
147 static void replace_may_alias (tree, size_t, tree);
148 static struct alias_info *init_alias_info (void);
149 static void delete_alias_info (struct alias_info *);
150 static void compute_points_to_and_addr_escape (struct alias_info *);
151 static void compute_flow_sensitive_aliasing (struct alias_info *);
152 static void setup_pointers_and_addressables (struct alias_info *);
153 static bool collect_points_to_info_r (tree, tree, void *);
154 static bool is_escape_site (tree, struct alias_info *);
155 static void add_pointed_to_var (struct alias_info *, tree, tree);
156 static void create_global_var (void);
157 static void collect_points_to_info_for (struct alias_info *, tree);
158 static void maybe_create_global_var (struct alias_info *ai);
159 static void group_aliases (struct alias_info *);
160 static void set_pt_anything (tree ptr);
161 static void set_pt_malloc (tree ptr);
163 /* Global declarations. */
165 /* Call clobbered variables in the function. If bit I is set, then
166 REFERENCED_VARS (I) is call-clobbered. */
167 bitmap call_clobbered_vars;
169 /* Addressable variables in the function. If bit I is set, then
170 REFERENCED_VARS (I) has had its address taken. Note that
171 CALL_CLOBBERED_VARS and ADDRESSABLE_VARS are not related. An
172 addressable variable is not necessarily call-clobbered (e.g., a
173 local addressable whose address does not escape) and not all
174 call-clobbered variables are addressable (e.g., a local static
175 variable). */
176 bitmap addressable_vars;
178 /* When the program has too many call-clobbered variables and call-sites,
179 this variable is used to represent the clobbering effects of function
180 calls. In these cases, all the call clobbered variables in the program
181 are forced to alias this variable. This reduces compile times by not
182 having to keep track of too many V_MAY_DEF expressions at call sites. */
183 tree global_var;
186 /* Compute may-alias information for every variable referenced in function
187 FNDECL.
189 Alias analysis proceeds in 3 main phases:
191 1- Points-to and escape analysis.
193 This phase walks the use-def chains in the SSA web looking for three
194 things:
196 * Assignments of the form P_i = &VAR
197 * Assignments of the form P_i = malloc()
198 * Pointers and ADDR_EXPR that escape the current function.
200 The concept of 'escaping' is the same one used in the Java world. When
201 a pointer or an ADDR_EXPR escapes, it means that it has been exposed
202 outside of the current function. So, assignment to global variables,
203 function arguments and returning a pointer are all escape sites, as are
204 conversions between pointers and integers.
206 This is where we are currently limited. Since not everything is renamed
207 into SSA, we lose track of escape properties when a pointer is stashed
208 inside a field in a structure, for instance. In those cases, we are
209 assuming that the pointer does escape.
211 We use escape analysis to determine whether a variable is
212 call-clobbered. Simply put, if an ADDR_EXPR escapes, then the variable
213 is call-clobbered. If a pointer P_i escapes, then all the variables
214 pointed-to by P_i (and its memory tag) also escape.
216 2- Compute flow-sensitive aliases
218 We have two classes of memory tags. Memory tags associated with the
219 pointed-to data type of the pointers in the program. These tags are
220 called "type memory tag" (TMT). The other class are those associated
221 with SSA_NAMEs, called "name memory tag" (NMT). The basic idea is that
222 when adding operands for an INDIRECT_REF *P_i, we will first check
223 whether P_i has a name tag, if it does we use it, because that will have
224 more precise aliasing information. Otherwise, we use the standard type
225 tag.
227 In this phase, we go through all the pointers we found in points-to
228 analysis and create alias sets for the name memory tags associated with
229 each pointer P_i. If P_i escapes, we mark call-clobbered the variables
230 it points to and its tag.
233 3- Compute flow-insensitive aliases
235 This pass will compare the alias set of every type memory tag and every
236 addressable variable found in the program. Given a type memory tag TMT
237 and an addressable variable V. If the alias sets of TMT and V conflict
238 (as computed by may_alias_p), then V is marked as an alias tag and added
239 to the alias set of TMT.
241 For instance, consider the following function:
243 foo (int i)
245 int *p, a, b;
247 if (i > 10)
248 p = &a;
249 else
250 p = &b;
252 *p = 3;
253 a = b + 2;
254 return *p;
257 After aliasing analysis has finished, the type memory tag for pointer
258 'p' will have two aliases, namely variables 'a' and 'b'. Every time
259 pointer 'p' is dereferenced, we want to mark the operation as a
260 potential reference to 'a' and 'b'.
262 foo (int i)
264 int *p, a, b;
266 if (i_2 > 10)
267 p_4 = &a;
268 else
269 p_6 = &b;
270 # p_1 = PHI <p_4(1), p_6(2)>;
272 # a_7 = V_MAY_DEF <a_3>;
273 # b_8 = V_MAY_DEF <b_5>;
274 *p_1 = 3;
276 # a_9 = V_MAY_DEF <a_7>
277 # VUSE <b_8>
278 a_9 = b_8 + 2;
280 # VUSE <a_9>;
281 # VUSE <b_8>;
282 return *p_1;
285 In certain cases, the list of may aliases for a pointer may grow too
286 large. This may cause an explosion in the number of virtual operands
287 inserted in the code. Resulting in increased memory consumption and
288 compilation time.
290 When the number of virtual operands needed to represent aliased
291 loads and stores grows too large (configurable with @option{--param
292 max-aliased-vops}), alias sets are grouped to avoid severe
293 compile-time slow downs and memory consumption. See group_aliases. */
295 static void
296 compute_may_aliases (void)
298 struct alias_info *ai;
300 memset (&alias_stats, 0, sizeof (alias_stats));
302 /* Initialize aliasing information. */
303 ai = init_alias_info ();
305 /* For each pointer P_i, determine the sets of variables that P_i may
306 point-to. For every addressable variable V, determine whether the
307 address of V escapes the current function, making V call-clobbered
308 (i.e., whether &V is stored in a global variable or if its passed as a
309 function call argument). */
310 compute_points_to_and_addr_escape (ai);
312 /* Collect all pointers and addressable variables, compute alias sets,
313 create memory tags for pointers and promote variables whose address is
314 not needed anymore. */
315 setup_pointers_and_addressables (ai);
317 /* Compute flow-sensitive, points-to based aliasing for all the name
318 memory tags. Note that this pass needs to be done before flow
319 insensitive analysis because it uses the points-to information
320 gathered before to mark call-clobbered type tags. */
321 compute_flow_sensitive_aliasing (ai);
323 /* Compute type-based flow-insensitive aliasing for all the type
324 memory tags. */
325 compute_flow_insensitive_aliasing (ai);
327 /* If the program has too many call-clobbered variables and/or function
328 calls, create .GLOBAL_VAR and use it to model call-clobbering
329 semantics at call sites. This reduces the number of virtual operands
330 considerably, improving compile times at the expense of lost
331 aliasing precision. */
332 maybe_create_global_var (ai);
334 /* Debugging dumps. */
335 if (dump_file)
337 dump_referenced_vars (dump_file);
338 if (dump_flags & TDF_STATS)
339 dump_alias_stats (dump_file);
340 dump_points_to_info (dump_file);
341 dump_alias_info (dump_file);
344 /* Deallocate memory used by aliasing data structures. */
345 delete_alias_info (ai);
348 block_stmt_iterator bsi;
349 basic_block bb;
350 FOR_EACH_BB (bb)
352 for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
354 update_stmt_if_modified (bsi_stmt (bsi));
361 struct tree_opt_pass pass_may_alias =
363 "alias", /* name */
364 NULL, /* gate */
365 compute_may_aliases, /* execute */
366 NULL, /* sub */
367 NULL, /* next */
368 0, /* static_pass_number */
369 TV_TREE_MAY_ALIAS, /* tv_id */
370 PROP_cfg | PROP_ssa, /* properties_required */
371 PROP_alias, /* properties_provided */
372 0, /* properties_destroyed */
373 0, /* todo_flags_start */
374 TODO_dump_func | TODO_update_ssa
375 | TODO_ggc_collect | TODO_verify_ssa
376 | TODO_verify_stmts, /* todo_flags_finish */
377 0 /* letter */
381 /* Data structure used to count the number of dereferences to PTR
382 inside an expression. */
383 struct count_ptr_d
385 tree ptr;
386 unsigned count;
390 /* Helper for count_uses_and_derefs. Called by walk_tree to look for
391 (ALIGN/MISALIGNED_)INDIRECT_REF nodes for the pointer passed in DATA. */
393 static tree
394 count_ptr_derefs (tree *tp, int *walk_subtrees ATTRIBUTE_UNUSED, void *data)
396 struct count_ptr_d *count_p = (struct count_ptr_d *) data;
398 if (INDIRECT_REF_P (*tp) && TREE_OPERAND (*tp, 0) == count_p->ptr)
399 count_p->count++;
401 return NULL_TREE;
405 /* Count the number of direct and indirect uses for pointer PTR in
406 statement STMT. The two counts are stored in *NUM_USES_P and
407 *NUM_DEREFS_P respectively. *IS_STORE_P is set to 'true' if at
408 least one of those dereferences is a store operation. */
410 void
411 count_uses_and_derefs (tree ptr, tree stmt, unsigned *num_uses_p,
412 unsigned *num_derefs_p, bool *is_store)
414 ssa_op_iter i;
415 tree use;
417 *num_uses_p = 0;
418 *num_derefs_p = 0;
419 *is_store = false;
421 /* Find out the total number of uses of PTR in STMT. */
422 FOR_EACH_SSA_TREE_OPERAND (use, stmt, i, SSA_OP_USE)
423 if (use == ptr)
424 (*num_uses_p)++;
426 /* Now count the number of indirect references to PTR. This is
427 truly awful, but we don't have much choice. There are no parent
428 pointers inside INDIRECT_REFs, so an expression like
429 '*x_1 = foo (x_1, *x_1)' needs to be traversed piece by piece to
430 find all the indirect and direct uses of x_1 inside. The only
431 shortcut we can take is the fact that GIMPLE only allows
432 INDIRECT_REFs inside the expressions below. */
433 if (TREE_CODE (stmt) == MODIFY_EXPR
434 || (TREE_CODE (stmt) == RETURN_EXPR
435 && TREE_CODE (TREE_OPERAND (stmt, 0)) == MODIFY_EXPR)
436 || TREE_CODE (stmt) == ASM_EXPR
437 || TREE_CODE (stmt) == CALL_EXPR)
439 tree lhs, rhs;
441 if (TREE_CODE (stmt) == MODIFY_EXPR)
443 lhs = TREE_OPERAND (stmt, 0);
444 rhs = TREE_OPERAND (stmt, 1);
446 else if (TREE_CODE (stmt) == RETURN_EXPR)
448 tree e = TREE_OPERAND (stmt, 0);
449 lhs = TREE_OPERAND (e, 0);
450 rhs = TREE_OPERAND (e, 1);
452 else if (TREE_CODE (stmt) == ASM_EXPR)
454 lhs = ASM_OUTPUTS (stmt);
455 rhs = ASM_INPUTS (stmt);
457 else
459 lhs = NULL_TREE;
460 rhs = stmt;
463 if (lhs && (TREE_CODE (lhs) == TREE_LIST || EXPR_P (lhs)))
465 struct count_ptr_d count;
466 count.ptr = ptr;
467 count.count = 0;
468 walk_tree (&lhs, count_ptr_derefs, &count, NULL);
469 *is_store = true;
470 *num_derefs_p = count.count;
473 if (rhs && (TREE_CODE (rhs) == TREE_LIST || EXPR_P (rhs)))
475 struct count_ptr_d count;
476 count.ptr = ptr;
477 count.count = 0;
478 walk_tree (&rhs, count_ptr_derefs, &count, NULL);
479 *num_derefs_p += count.count;
483 gcc_assert (*num_uses_p >= *num_derefs_p);
487 /* Initialize the data structures used for alias analysis. */
489 static struct alias_info *
490 init_alias_info (void)
492 struct alias_info *ai;
494 ai = xcalloc (1, sizeof (struct alias_info));
495 ai->ssa_names_visited = sbitmap_alloc (num_ssa_names);
496 sbitmap_zero (ai->ssa_names_visited);
497 VARRAY_TREE_INIT (ai->processed_ptrs, 50, "processed_ptrs");
498 ai->addresses_needed = BITMAP_ALLOC (NULL);
499 VARRAY_UINT_INIT (ai->num_references, num_referenced_vars, "num_references");
500 ai->written_vars = BITMAP_ALLOC (NULL);
501 ai->dereferenced_ptrs_store = BITMAP_ALLOC (NULL);
502 ai->dereferenced_ptrs_load = BITMAP_ALLOC (NULL);
504 /* If aliases have been computed before, clear existing information. */
505 if (aliases_computed_p)
507 unsigned i;
509 /* Similarly, clear the set of addressable variables. In this
510 case, we can just clear the set because addressability is
511 only computed here. */
512 bitmap_clear (addressable_vars);
514 /* Clear flow-insensitive alias information from each symbol. */
515 for (i = 0; i < num_referenced_vars; i++)
517 tree var = referenced_var (i);
518 var_ann_t ann = var_ann (var);
520 ann->is_alias_tag = 0;
521 ann->may_aliases = NULL;
523 /* Since we are about to re-discover call-clobbered
524 variables, clear the call-clobbered flag. Variables that
525 are intrinsically call-clobbered (globals, local statics,
526 etc) will not be marked by the aliasing code, so we can't
527 remove them from CALL_CLOBBERED_VARS.
529 NB: STRUCT_FIELDS are still call clobbered if they are for
530 a global variable, so we *don't* clear their call clobberedness
531 just because they are tags, though we will clear it if they
532 aren't for global variables. */
533 if (ann->mem_tag_kind == NAME_TAG
534 || ann->mem_tag_kind == TYPE_TAG
535 || !is_global_var (var))
536 clear_call_clobbered (var);
539 /* Clear flow-sensitive points-to information from each SSA name. */
540 for (i = 1; i < num_ssa_names; i++)
542 tree name = ssa_name (i);
544 if (!name || !POINTER_TYPE_P (TREE_TYPE (name)))
545 continue;
547 if (SSA_NAME_PTR_INFO (name))
549 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (name);
551 /* Clear all the flags but keep the name tag to
552 avoid creating new temporaries unnecessarily. If
553 this pointer is found to point to a subset or
554 superset of its former points-to set, then a new
555 tag will need to be created in create_name_tags. */
556 pi->pt_anything = 0;
557 pi->pt_malloc = 0;
558 pi->pt_null = 0;
559 pi->value_escapes_p = 0;
560 pi->is_dereferenced = 0;
561 if (pi->pt_vars)
562 bitmap_clear (pi->pt_vars);
567 /* Next time, we will need to reset alias information. */
568 aliases_computed_p = true;
570 return ai;
574 /* Deallocate memory used by alias analysis. */
576 static void
577 delete_alias_info (struct alias_info *ai)
579 size_t i;
581 sbitmap_free (ai->ssa_names_visited);
582 ai->processed_ptrs = NULL;
583 BITMAP_FREE (ai->addresses_needed);
585 for (i = 0; i < ai->num_addressable_vars; i++)
587 sbitmap_free (ai->addressable_vars[i]->may_aliases);
588 free (ai->addressable_vars[i]);
590 free (ai->addressable_vars);
592 for (i = 0; i < ai->num_pointers; i++)
594 sbitmap_free (ai->pointers[i]->may_aliases);
595 free (ai->pointers[i]);
597 free (ai->pointers);
599 ai->num_references = NULL;
600 BITMAP_FREE (ai->written_vars);
601 BITMAP_FREE (ai->dereferenced_ptrs_store);
602 BITMAP_FREE (ai->dereferenced_ptrs_load);
604 free (ai);
608 /* Walk use-def chains for pointer PTR to determine what variables is PTR
609 pointing to. */
611 static void
612 collect_points_to_info_for (struct alias_info *ai, tree ptr)
614 gcc_assert (POINTER_TYPE_P (TREE_TYPE (ptr)));
616 if (!TEST_BIT (ai->ssa_names_visited, SSA_NAME_VERSION (ptr)))
618 SET_BIT (ai->ssa_names_visited, SSA_NAME_VERSION (ptr));
619 walk_use_def_chains (ptr, collect_points_to_info_r, ai, true);
620 VARRAY_PUSH_TREE (ai->processed_ptrs, ptr);
625 /* Traverse use-def links for all the pointers in the program to collect
626 address escape and points-to information.
628 This is loosely based on the same idea described in R. Hasti and S.
629 Horwitz, ``Using static single assignment form to improve
630 flow-insensitive pointer analysis,'' in SIGPLAN Conference on
631 Programming Language Design and Implementation, pp. 97-105, 1998. */
633 static void
634 compute_points_to_and_addr_escape (struct alias_info *ai)
636 basic_block bb;
637 unsigned i;
638 tree op;
639 ssa_op_iter iter;
641 timevar_push (TV_TREE_PTA);
643 FOR_EACH_BB (bb)
645 block_stmt_iterator si;
647 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
649 bitmap addr_taken;
650 tree stmt = bsi_stmt (si);
651 bool stmt_escapes_p = is_escape_site (stmt, ai);
652 bitmap_iterator bi;
654 /* Mark all the variables whose address are taken by the
655 statement. Note that this will miss all the addresses taken
656 in PHI nodes (those are discovered while following the use-def
657 chains). */
658 addr_taken = addresses_taken (stmt);
659 if (addr_taken)
660 EXECUTE_IF_SET_IN_BITMAP (addr_taken, 0, i, bi)
662 tree var = referenced_var (i);
663 bitmap_set_bit (ai->addresses_needed, var_ann (var)->uid);
664 if (stmt_escapes_p)
665 mark_call_clobbered (var);
668 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_USE)
670 var_ann_t v_ann = var_ann (SSA_NAME_VAR (op));
671 struct ptr_info_def *pi;
672 bool is_store;
673 unsigned num_uses, num_derefs;
675 /* If the operand's variable may be aliased, keep track
676 of how many times we've referenced it. This is used
677 for alias grouping in compute_flow_sensitive_aliasing.
678 Note that we don't need to grow AI->NUM_REFERENCES
679 because we are processing regular variables, not
680 memory tags (the array's initial size is set to
681 NUM_REFERENCED_VARS). */
682 if (may_be_aliased (SSA_NAME_VAR (op)))
683 (VARRAY_UINT (ai->num_references, v_ann->uid))++;
685 if (!POINTER_TYPE_P (TREE_TYPE (op)))
686 continue;
688 collect_points_to_info_for (ai, op);
690 pi = SSA_NAME_PTR_INFO (op);
691 count_uses_and_derefs (op, stmt, &num_uses, &num_derefs,
692 &is_store);
694 if (num_derefs > 0)
696 /* Mark OP as dereferenced. In a subsequent pass,
697 dereferenced pointers that point to a set of
698 variables will be assigned a name tag to alias
699 all the variables OP points to. */
700 pi->is_dereferenced = 1;
702 /* Keep track of how many time we've dereferenced each
703 pointer. Again, we don't need to grow
704 AI->NUM_REFERENCES because we're processing
705 existing program variables. */
706 (VARRAY_UINT (ai->num_references, v_ann->uid))++;
708 /* If this is a store operation, mark OP as being
709 dereferenced to store, otherwise mark it as being
710 dereferenced to load. */
711 if (is_store)
712 bitmap_set_bit (ai->dereferenced_ptrs_store, v_ann->uid);
713 else
714 bitmap_set_bit (ai->dereferenced_ptrs_load, v_ann->uid);
717 if (stmt_escapes_p && num_derefs < num_uses)
719 /* If STMT is an escape point and STMT contains at
720 least one direct use of OP, then the value of OP
721 escapes and so the pointed-to variables need to
722 be marked call-clobbered. */
723 pi->value_escapes_p = 1;
725 /* If the statement makes a function call, assume
726 that pointer OP will be dereferenced in a store
727 operation inside the called function. */
728 if (get_call_expr_in (stmt))
730 bitmap_set_bit (ai->dereferenced_ptrs_store, v_ann->uid);
731 pi->is_dereferenced = 1;
736 /* Update reference counter for definitions to any
737 potentially aliased variable. This is used in the alias
738 grouping heuristics. */
739 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_DEF)
741 tree var = SSA_NAME_VAR (op);
742 var_ann_t ann = var_ann (var);
743 bitmap_set_bit (ai->written_vars, ann->uid);
744 if (may_be_aliased (var))
745 (VARRAY_UINT (ai->num_references, ann->uid))++;
747 if (POINTER_TYPE_P (TREE_TYPE (op)))
748 collect_points_to_info_for (ai, op);
751 /* Mark variables in V_MAY_DEF operands as being written to. */
752 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_VIRTUAL_DEFS)
754 tree var = DECL_P (op) ? op : SSA_NAME_VAR (op);
755 var_ann_t ann = var_ann (var);
756 bitmap_set_bit (ai->written_vars, ann->uid);
759 /* After promoting variables and computing aliasing we will
760 need to re-scan most statements. FIXME: Try to minimize the
761 number of statements re-scanned. It's not really necessary to
762 re-scan *all* statements. */
763 mark_stmt_modified (stmt);
767 timevar_pop (TV_TREE_PTA);
771 /* Create name tags for all the pointers that have been dereferenced.
772 We only create a name tag for a pointer P if P is found to point to
773 a set of variables (so that we can alias them to *P) or if it is
774 the result of a call to malloc (which means that P cannot point to
775 anything else nor alias any other variable).
777 If two pointers P and Q point to the same set of variables, they
778 are assigned the same name tag. */
780 static void
781 create_name_tags (struct alias_info *ai)
783 size_t i;
785 for (i = 0; i < VARRAY_ACTIVE_SIZE (ai->processed_ptrs); i++)
787 tree ptr = VARRAY_TREE (ai->processed_ptrs, i);
788 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
790 if (pi->pt_anything || !pi->is_dereferenced)
792 /* No name tags for pointers that have not been
793 dereferenced or point to an arbitrary location. */
794 pi->name_mem_tag = NULL_TREE;
795 continue;
798 if (pi->pt_vars && !bitmap_empty_p (pi->pt_vars))
800 size_t j;
801 tree old_name_tag = pi->name_mem_tag;
803 /* If PTR points to a set of variables, check if we don't
804 have another pointer Q with the same points-to set before
805 creating a tag. If so, use Q's tag instead of creating a
806 new one.
808 This is important for not creating unnecessary symbols
809 and also for copy propagation. If we ever need to
810 propagate PTR into Q or vice-versa, we would run into
811 problems if they both had different name tags because
812 they would have different SSA version numbers (which
813 would force us to take the name tags in and out of SSA). */
814 for (j = 0; j < i; j++)
816 tree q = VARRAY_TREE (ai->processed_ptrs, j);
817 struct ptr_info_def *qi = SSA_NAME_PTR_INFO (q);
819 if (qi
820 && qi->pt_vars
821 && qi->name_mem_tag
822 && bitmap_equal_p (pi->pt_vars, qi->pt_vars))
824 pi->name_mem_tag = qi->name_mem_tag;
825 break;
829 /* If we didn't find a pointer with the same points-to set
830 as PTR, create a new name tag if needed. */
831 if (pi->name_mem_tag == NULL_TREE)
832 pi->name_mem_tag = get_nmt_for (ptr);
834 /* If the new name tag computed for PTR is different than
835 the old name tag that it used to have, then the old tag
836 needs to be removed from the IL, so we mark it for
837 renaming. */
838 if (old_name_tag && old_name_tag != pi->name_mem_tag)
839 mark_sym_for_renaming (old_name_tag);
841 else if (pi->pt_malloc)
843 /* Otherwise, create a unique name tag for this pointer. */
844 pi->name_mem_tag = get_nmt_for (ptr);
846 else
848 /* Only pointers that may point to malloc or other variables
849 may receive a name tag. If the pointer does not point to
850 a known spot, we should use type tags. */
851 set_pt_anything (ptr);
852 continue;
855 TREE_THIS_VOLATILE (pi->name_mem_tag)
856 |= TREE_THIS_VOLATILE (TREE_TYPE (TREE_TYPE (ptr)));
858 /* Mark the new name tag for renaming. */
859 mark_sym_for_renaming (pi->name_mem_tag);
865 /* For every pointer P_i in AI->PROCESSED_PTRS, create may-alias sets for
866 the name memory tag (NMT) associated with P_i. If P_i escapes, then its
867 name tag and the variables it points-to are call-clobbered. Finally, if
868 P_i escapes and we could not determine where it points to, then all the
869 variables in the same alias set as *P_i are marked call-clobbered. This
870 is necessary because we must assume that P_i may take the address of any
871 variable in the same alias set. */
873 static void
874 compute_flow_sensitive_aliasing (struct alias_info *ai)
876 size_t i;
878 for (i = 0; i < VARRAY_ACTIVE_SIZE (ai->processed_ptrs); i++)
880 tree ptr = VARRAY_TREE (ai->processed_ptrs, i);
881 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
882 if (pi->pt_anything || pi->pt_vars == NULL)
884 find_what_p_points_to (ptr);
887 create_name_tags (ai);
889 for (i = 0; i < VARRAY_ACTIVE_SIZE (ai->processed_ptrs); i++)
891 unsigned j;
892 tree ptr = VARRAY_TREE (ai->processed_ptrs, i);
893 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
894 var_ann_t v_ann = var_ann (SSA_NAME_VAR (ptr));
895 bitmap_iterator bi;
897 if (pi->value_escapes_p || pi->pt_anything)
899 /* If PTR escapes or may point to anything, then its associated
900 memory tags and pointed-to variables are call-clobbered. */
901 if (pi->name_mem_tag)
902 mark_call_clobbered (pi->name_mem_tag);
904 if (v_ann->type_mem_tag)
905 mark_call_clobbered (v_ann->type_mem_tag);
907 if (pi->pt_vars)
908 EXECUTE_IF_SET_IN_BITMAP (pi->pt_vars, 0, j, bi)
910 mark_call_clobbered (referenced_var (j));
914 /* Set up aliasing information for PTR's name memory tag (if it has
915 one). Note that only pointers that have been dereferenced will
916 have a name memory tag. */
917 if (pi->name_mem_tag && pi->pt_vars)
918 EXECUTE_IF_SET_IN_BITMAP (pi->pt_vars, 0, j, bi)
920 add_may_alias (pi->name_mem_tag, referenced_var (j));
921 add_may_alias (v_ann->type_mem_tag, referenced_var (j));
924 /* If the name tag is call clobbered, so is the type tag
925 associated with the base VAR_DECL. */
926 if (pi->name_mem_tag
927 && v_ann->type_mem_tag
928 && is_call_clobbered (pi->name_mem_tag))
929 mark_call_clobbered (v_ann->type_mem_tag);
934 /* Compute type-based alias sets. Traverse all the pointers and
935 addressable variables found in setup_pointers_and_addressables.
937 For every pointer P in AI->POINTERS and addressable variable V in
938 AI->ADDRESSABLE_VARS, add V to the may-alias sets of P's type
939 memory tag (TMT) if their alias sets conflict. V is then marked as
940 an alias tag so that the operand scanner knows that statements
941 containing V have aliased operands. */
943 static void
944 compute_flow_insensitive_aliasing (struct alias_info *ai)
946 size_t i;
948 /* Initialize counter for the total number of virtual operands that
949 aliasing will introduce. When AI->TOTAL_ALIAS_VOPS goes beyond the
950 threshold set by --params max-alias-vops, we enable alias
951 grouping. */
952 ai->total_alias_vops = 0;
954 /* For every pointer P, determine which addressable variables may alias
955 with P's type memory tag. */
956 for (i = 0; i < ai->num_pointers; i++)
958 size_t j;
959 struct alias_map_d *p_map = ai->pointers[i];
960 tree tag = var_ann (p_map->var)->type_mem_tag;
961 var_ann_t tag_ann = var_ann (tag);
963 p_map->total_alias_vops = 0;
964 p_map->may_aliases = sbitmap_alloc (num_referenced_vars);
965 sbitmap_zero (p_map->may_aliases);
967 for (j = 0; j < ai->num_addressable_vars; j++)
969 struct alias_map_d *v_map;
970 var_ann_t v_ann;
971 tree var;
972 bool tag_stored_p, var_stored_p;
974 v_map = ai->addressable_vars[j];
975 var = v_map->var;
976 v_ann = var_ann (var);
978 /* Skip memory tags and variables that have never been
979 written to. We also need to check if the variables are
980 call-clobbered because they may be overwritten by
981 function calls.
983 Note this is effectively random accessing elements in
984 the sparse bitset, which can be highly inefficient.
985 So we first check the call_clobbered status of the
986 tag and variable before querying the bitmap. */
987 tag_stored_p = is_call_clobbered (tag)
988 || bitmap_bit_p (ai->written_vars, tag_ann->uid);
989 var_stored_p = is_call_clobbered (var)
990 || bitmap_bit_p (ai->written_vars, v_ann->uid);
991 if (!tag_stored_p && !var_stored_p)
992 continue;
994 if (may_alias_p (p_map->var, p_map->set, var, v_map->set))
996 subvar_t svars;
997 size_t num_tag_refs, num_var_refs;
999 num_tag_refs = VARRAY_UINT (ai->num_references, tag_ann->uid);
1000 num_var_refs = VARRAY_UINT (ai->num_references, v_ann->uid);
1002 /* Add VAR to TAG's may-aliases set. */
1004 /* If this is an aggregate, we may have subvariables for it
1005 that need to be pointed to. */
1006 if (var_can_have_subvars (var)
1007 && (svars = get_subvars_for_var (var)))
1009 subvar_t sv;
1011 for (sv = svars; sv; sv = sv->next)
1013 add_may_alias (tag, sv->var);
1014 /* Update the bitmap used to represent TAG's alias set
1015 in case we need to group aliases. */
1016 SET_BIT (p_map->may_aliases, var_ann (sv->var)->uid);
1019 else
1021 add_may_alias (tag, var);
1022 /* Update the bitmap used to represent TAG's alias set
1023 in case we need to group aliases. */
1024 SET_BIT (p_map->may_aliases, var_ann (var)->uid);
1027 /* Update the total number of virtual operands due to
1028 aliasing. Since we are adding one more alias to TAG's
1029 may-aliases set, the total number of virtual operands due
1030 to aliasing will be increased by the number of references
1031 made to VAR and TAG (every reference to TAG will also
1032 count as a reference to VAR). */
1033 ai->total_alias_vops += (num_var_refs + num_tag_refs);
1034 p_map->total_alias_vops += (num_var_refs + num_tag_refs);
1041 /* Since this analysis is based exclusively on symbols, it fails to
1042 handle cases where two pointers P and Q have different memory
1043 tags with conflicting alias set numbers but no aliased symbols in
1044 common.
1046 For example, suppose that we have two memory tags TMT.1 and TMT.2
1047 such that
1049 may-aliases (TMT.1) = { a }
1050 may-aliases (TMT.2) = { b }
1052 and the alias set number of TMT.1 conflicts with that of TMT.2.
1053 Since they don't have symbols in common, loads and stores from
1054 TMT.1 and TMT.2 will seem independent of each other, which will
1055 lead to the optimizers making invalid transformations (see
1056 testsuite/gcc.c-torture/execute/pr15262-[12].c).
1058 To avoid this problem, we do a final traversal of AI->POINTERS
1059 looking for pairs of pointers that have no aliased symbols in
1060 common and yet have conflicting alias set numbers. */
1061 for (i = 0; i < ai->num_pointers; i++)
1063 size_t j;
1064 struct alias_map_d *p_map1 = ai->pointers[i];
1065 tree tag1 = var_ann (p_map1->var)->type_mem_tag;
1066 sbitmap may_aliases1 = p_map1->may_aliases;
1068 for (j = i + 1; j < ai->num_pointers; j++)
1070 struct alias_map_d *p_map2 = ai->pointers[j];
1071 tree tag2 = var_ann (p_map2->var)->type_mem_tag;
1072 sbitmap may_aliases2 = p_map2->may_aliases;
1074 /* If the pointers may not point to each other, do nothing. */
1075 if (!may_alias_p (p_map1->var, p_map1->set, tag2, p_map2->set))
1076 continue;
1078 /* The two pointers may alias each other. If they already have
1079 symbols in common, do nothing. */
1080 if (sbitmap_any_common_bits (may_aliases1, may_aliases2))
1081 continue;
1083 if (sbitmap_first_set_bit (may_aliases2) >= 0)
1085 unsigned int k;
1086 sbitmap_iterator sbi;
1088 /* Add all the aliases for TAG2 into TAG1's alias set.
1089 FIXME, update grouping heuristic counters. */
1090 EXECUTE_IF_SET_IN_SBITMAP (may_aliases2, 0, k, sbi)
1091 add_may_alias (tag1, referenced_var (k));
1092 sbitmap_a_or_b (may_aliases1, may_aliases1, may_aliases2);
1094 else
1096 /* Since TAG2 does not have any aliases of its own, add
1097 TAG2 itself to the alias set of TAG1. */
1098 add_may_alias (tag1, tag2);
1099 SET_BIT (may_aliases1, var_ann (tag2)->uid);
1104 if (dump_file)
1105 fprintf (dump_file, "%s: Total number of aliased vops: %ld\n",
1106 get_name (current_function_decl),
1107 ai->total_alias_vops);
1109 /* Determine if we need to enable alias grouping. */
1110 if (ai->total_alias_vops >= MAX_ALIASED_VOPS)
1111 group_aliases (ai);
1115 /* Comparison function for qsort used in group_aliases. */
1117 static int
1118 total_alias_vops_cmp (const void *p, const void *q)
1120 const struct alias_map_d **p1 = (const struct alias_map_d **)p;
1121 const struct alias_map_d **p2 = (const struct alias_map_d **)q;
1122 long n1 = (*p1)->total_alias_vops;
1123 long n2 = (*p2)->total_alias_vops;
1125 /* We want to sort in descending order. */
1126 return (n1 > n2 ? -1 : (n1 == n2) ? 0 : 1);
1129 /* Group all the aliases for TAG to make TAG represent all the
1130 variables in its alias set. Update the total number
1131 of virtual operands due to aliasing (AI->TOTAL_ALIAS_VOPS). This
1132 function will make TAG be the unique alias tag for all the
1133 variables in its may-aliases. So, given:
1135 may-aliases(TAG) = { V1, V2, V3 }
1137 This function will group the variables into:
1139 may-aliases(V1) = { TAG }
1140 may-aliases(V2) = { TAG }
1141 may-aliases(V2) = { TAG } */
1143 static void
1144 group_aliases_into (tree tag, sbitmap tag_aliases, struct alias_info *ai)
1146 unsigned int i;
1147 var_ann_t tag_ann = var_ann (tag);
1148 size_t num_tag_refs = VARRAY_UINT (ai->num_references, tag_ann->uid);
1149 sbitmap_iterator sbi;
1151 EXECUTE_IF_SET_IN_SBITMAP (tag_aliases, 0, i, sbi)
1153 tree var = referenced_var (i);
1154 var_ann_t ann = var_ann (var);
1156 /* Make TAG the unique alias of VAR. */
1157 ann->is_alias_tag = 0;
1158 ann->may_aliases = NULL;
1160 /* Note that VAR and TAG may be the same if the function has no
1161 addressable variables (see the discussion at the end of
1162 setup_pointers_and_addressables). */
1163 if (var != tag)
1164 add_may_alias (var, tag);
1166 /* Reduce total number of virtual operands contributed
1167 by TAG on behalf of VAR. Notice that the references to VAR
1168 itself won't be removed. We will merely replace them with
1169 references to TAG. */
1170 ai->total_alias_vops -= num_tag_refs;
1173 /* We have reduced the number of virtual operands that TAG makes on
1174 behalf of all the variables formerly aliased with it. However,
1175 we have also "removed" all the virtual operands for TAG itself,
1176 so we add them back. */
1177 ai->total_alias_vops += num_tag_refs;
1179 /* TAG no longer has any aliases. */
1180 tag_ann->may_aliases = NULL;
1184 /* Group may-aliases sets to reduce the number of virtual operands due
1185 to aliasing.
1187 1- Sort the list of pointers in decreasing number of contributed
1188 virtual operands.
1190 2- Take the first entry in AI->POINTERS and revert the role of
1191 the memory tag and its aliases. Usually, whenever an aliased
1192 variable Vi is found to alias with a memory tag T, we add Vi
1193 to the may-aliases set for T. Meaning that after alias
1194 analysis, we will have:
1196 may-aliases(T) = { V1, V2, V3, ..., Vn }
1198 This means that every statement that references T, will get 'n'
1199 virtual operands for each of the Vi tags. But, when alias
1200 grouping is enabled, we make T an alias tag and add it to the
1201 alias set of all the Vi variables:
1203 may-aliases(V1) = { T }
1204 may-aliases(V2) = { T }
1206 may-aliases(Vn) = { T }
1208 This has two effects: (a) statements referencing T will only get
1209 a single virtual operand, and, (b) all the variables Vi will now
1210 appear to alias each other. So, we lose alias precision to
1211 improve compile time. But, in theory, a program with such a high
1212 level of aliasing should not be very optimizable in the first
1213 place.
1215 3- Since variables may be in the alias set of more than one
1216 memory tag, the grouping done in step (2) needs to be extended
1217 to all the memory tags that have a non-empty intersection with
1218 the may-aliases set of tag T. For instance, if we originally
1219 had these may-aliases sets:
1221 may-aliases(T) = { V1, V2, V3 }
1222 may-aliases(R) = { V2, V4 }
1224 In step (2) we would have reverted the aliases for T as:
1226 may-aliases(V1) = { T }
1227 may-aliases(V2) = { T }
1228 may-aliases(V3) = { T }
1230 But note that now V2 is no longer aliased with R. We could
1231 add R to may-aliases(V2), but we are in the process of
1232 grouping aliases to reduce virtual operands so what we do is
1233 add V4 to the grouping to obtain:
1235 may-aliases(V1) = { T }
1236 may-aliases(V2) = { T }
1237 may-aliases(V3) = { T }
1238 may-aliases(V4) = { T }
1240 4- If the total number of virtual operands due to aliasing is
1241 still above the threshold set by max-alias-vops, go back to (2). */
1243 static void
1244 group_aliases (struct alias_info *ai)
1246 size_t i;
1248 /* Sort the POINTERS array in descending order of contributed
1249 virtual operands. */
1250 qsort (ai->pointers, ai->num_pointers, sizeof (struct alias_map_d *),
1251 total_alias_vops_cmp);
1253 /* For every pointer in AI->POINTERS, reverse the roles of its tag
1254 and the tag's may-aliases set. */
1255 for (i = 0; i < ai->num_pointers; i++)
1257 size_t j;
1258 tree tag1 = var_ann (ai->pointers[i]->var)->type_mem_tag;
1259 sbitmap tag1_aliases = ai->pointers[i]->may_aliases;
1261 /* Skip tags that have been grouped already. */
1262 if (ai->pointers[i]->grouped_p)
1263 continue;
1265 /* See if TAG1 had any aliases in common with other type tags.
1266 If we find a TAG2 with common aliases with TAG1, add TAG2's
1267 aliases into TAG1. */
1268 for (j = i + 1; j < ai->num_pointers; j++)
1270 sbitmap tag2_aliases = ai->pointers[j]->may_aliases;
1272 if (sbitmap_any_common_bits (tag1_aliases, tag2_aliases))
1274 tree tag2 = var_ann (ai->pointers[j]->var)->type_mem_tag;
1276 sbitmap_a_or_b (tag1_aliases, tag1_aliases, tag2_aliases);
1278 /* TAG2 does not need its aliases anymore. */
1279 sbitmap_zero (tag2_aliases);
1280 var_ann (tag2)->may_aliases = NULL;
1282 /* TAG1 is the unique alias of TAG2. */
1283 add_may_alias (tag2, tag1);
1285 ai->pointers[j]->grouped_p = true;
1289 /* Now group all the aliases we collected into TAG1. */
1290 group_aliases_into (tag1, tag1_aliases, ai);
1292 /* If we've reduced total number of virtual operands below the
1293 threshold, stop. */
1294 if (ai->total_alias_vops < MAX_ALIASED_VOPS)
1295 break;
1298 /* Finally, all the variables that have been grouped cannot be in
1299 the may-alias set of name memory tags. Suppose that we have
1300 grouped the aliases in this code so that may-aliases(a) = TMT.20
1302 p_5 = &a;
1304 # a_9 = V_MAY_DEF <a_8>
1305 p_5->field = 0
1306 ... Several modifications to TMT.20 ...
1307 # VUSE <a_9>
1308 x_30 = p_5->field
1310 Since p_5 points to 'a', the optimizers will try to propagate 0
1311 into p_5->field, but that is wrong because there have been
1312 modifications to 'TMT.20' in between. To prevent this we have to
1313 replace 'a' with 'TMT.20' in the name tag of p_5. */
1314 for (i = 0; i < VARRAY_ACTIVE_SIZE (ai->processed_ptrs); i++)
1316 size_t j;
1317 tree ptr = VARRAY_TREE (ai->processed_ptrs, i);
1318 tree name_tag = SSA_NAME_PTR_INFO (ptr)->name_mem_tag;
1319 varray_type aliases;
1321 if (name_tag == NULL_TREE)
1322 continue;
1324 aliases = var_ann (name_tag)->may_aliases;
1325 for (j = 0; aliases && j < VARRAY_ACTIVE_SIZE (aliases); j++)
1327 tree alias = VARRAY_TREE (aliases, j);
1328 var_ann_t ann = var_ann (alias);
1330 if ((ann->mem_tag_kind == NOT_A_TAG
1331 || ann->mem_tag_kind == STRUCT_FIELD)
1332 && ann->may_aliases)
1334 tree new_alias;
1336 gcc_assert (VARRAY_ACTIVE_SIZE (ann->may_aliases) == 1);
1338 new_alias = VARRAY_TREE (ann->may_aliases, 0);
1339 replace_may_alias (name_tag, j, new_alias);
1344 if (dump_file)
1345 fprintf (dump_file,
1346 "%s: Total number of aliased vops after grouping: %ld%s\n",
1347 get_name (current_function_decl),
1348 ai->total_alias_vops,
1349 (ai->total_alias_vops < 0) ? " (negative values are OK)" : "");
1353 /* Create a new alias set entry for VAR in AI->ADDRESSABLE_VARS. */
1355 static void
1356 create_alias_map_for (tree var, struct alias_info *ai)
1358 struct alias_map_d *alias_map;
1359 alias_map = xcalloc (1, sizeof (*alias_map));
1360 alias_map->var = var;
1361 alias_map->set = get_alias_set (var);
1362 ai->addressable_vars[ai->num_addressable_vars++] = alias_map;
1366 /* Create memory tags for all the dereferenced pointers and build the
1367 ADDRESSABLE_VARS and POINTERS arrays used for building the may-alias
1368 sets. Based on the address escape and points-to information collected
1369 earlier, this pass will also clear the TREE_ADDRESSABLE flag from those
1370 variables whose address is not needed anymore. */
1372 static void
1373 setup_pointers_and_addressables (struct alias_info *ai)
1375 size_t i, n_vars, num_addressable_vars, num_pointers;
1377 /* Size up the arrays ADDRESSABLE_VARS and POINTERS. */
1378 num_addressable_vars = num_pointers = 0;
1379 for (i = 0; i < num_referenced_vars; i++)
1381 tree var = referenced_var (i);
1383 if (may_be_aliased (var))
1384 num_addressable_vars++;
1386 if (POINTER_TYPE_P (TREE_TYPE (var)))
1388 /* Since we don't keep track of volatile variables, assume that
1389 these pointers are used in indirect store operations. */
1390 if (TREE_THIS_VOLATILE (var))
1391 bitmap_set_bit (ai->dereferenced_ptrs_store, var_ann (var)->uid);
1393 num_pointers++;
1397 /* Create ADDRESSABLE_VARS and POINTERS. Note that these arrays are
1398 always going to be slightly bigger than we actually need them
1399 because some TREE_ADDRESSABLE variables will be marked
1400 non-addressable below and only pointers with unique type tags are
1401 going to be added to POINTERS. */
1402 ai->addressable_vars = xcalloc (num_addressable_vars,
1403 sizeof (struct alias_map_d *));
1404 ai->pointers = xcalloc (num_pointers, sizeof (struct alias_map_d *));
1405 ai->num_addressable_vars = 0;
1406 ai->num_pointers = 0;
1408 /* Since we will be creating type memory tags within this loop, cache the
1409 value of NUM_REFERENCED_VARS to avoid processing the additional tags
1410 unnecessarily. */
1411 n_vars = num_referenced_vars;
1413 for (i = 0; i < n_vars; i++)
1415 tree var = referenced_var (i);
1416 var_ann_t v_ann = var_ann (var);
1417 subvar_t svars;
1419 /* Name memory tags already have flow-sensitive aliasing
1420 information, so they need not be processed by
1421 compute_flow_insensitive_aliasing. Similarly, type memory
1422 tags are already accounted for when we process their
1423 associated pointer.
1425 Structure fields, on the other hand, have to have some of this
1426 information processed for them, but it's pointless to mark them
1427 non-addressable (since they are fake variables anyway). */
1428 if (v_ann->mem_tag_kind != NOT_A_TAG
1429 && v_ann->mem_tag_kind != STRUCT_FIELD)
1430 continue;
1432 /* Remove the ADDRESSABLE flag from every addressable variable whose
1433 address is not needed anymore. This is caused by the propagation
1434 of ADDR_EXPR constants into INDIRECT_REF expressions and the
1435 removal of dead pointer assignments done by the early scalar
1436 cleanup passes. */
1437 if (TREE_ADDRESSABLE (var) && v_ann->mem_tag_kind != STRUCT_FIELD)
1439 if (!bitmap_bit_p (ai->addresses_needed, v_ann->uid)
1440 && TREE_CODE (var) != RESULT_DECL
1441 && !is_global_var (var))
1443 bool okay_to_mark = true;
1445 /* Since VAR is now a regular GIMPLE register, we will need
1446 to rename VAR into SSA afterwards. */
1447 mark_sym_for_renaming (var);
1449 if (var_can_have_subvars (var)
1450 && (svars = get_subvars_for_var (var)))
1452 subvar_t sv;
1454 for (sv = svars; sv; sv = sv->next)
1456 var_ann_t svann = var_ann (sv->var);
1457 if (bitmap_bit_p (ai->addresses_needed, svann->uid))
1458 okay_to_mark = false;
1459 mark_sym_for_renaming (sv->var);
1463 /* The address of VAR is not needed, remove the
1464 addressable bit, so that it can be optimized as a
1465 regular variable. */
1466 if (okay_to_mark)
1467 mark_non_addressable (var);
1469 else
1471 /* Add the variable to the set of addressables. Mostly
1472 used when scanning operands for ASM_EXPRs that
1473 clobber memory. In those cases, we need to clobber
1474 all call-clobbered variables and all addressables. */
1475 bitmap_set_bit (addressable_vars, v_ann->uid);
1476 if (var_can_have_subvars (var)
1477 && (svars = get_subvars_for_var (var)))
1479 subvar_t sv;
1480 for (sv = svars; sv; sv = sv->next)
1481 bitmap_set_bit (addressable_vars, var_ann (sv->var)->uid);
1487 /* Global variables and addressable locals may be aliased. Create an
1488 entry in ADDRESSABLE_VARS for VAR. */
1489 if (may_be_aliased (var))
1491 create_alias_map_for (var, ai);
1492 mark_sym_for_renaming (var);
1495 /* Add pointer variables that have been dereferenced to the POINTERS
1496 array and create a type memory tag for them. */
1497 if (POINTER_TYPE_P (TREE_TYPE (var)))
1499 if ((bitmap_bit_p (ai->dereferenced_ptrs_store, v_ann->uid)
1500 || bitmap_bit_p (ai->dereferenced_ptrs_load, v_ann->uid)))
1502 tree tag;
1503 var_ann_t t_ann;
1505 /* If pointer VAR still doesn't have a memory tag
1506 associated with it, create it now or re-use an
1507 existing one. */
1508 tag = get_tmt_for (var, ai);
1509 t_ann = var_ann (tag);
1511 /* The type tag will need to be renamed into SSA
1512 afterwards. Note that we cannot do this inside
1513 get_tmt_for because aliasing may run multiple times
1514 and we only create type tags the first time. */
1515 mark_sym_for_renaming (tag);
1517 /* Similarly, if pointer VAR used to have another type
1518 tag, we will need to process it in the renamer to
1519 remove the stale virtual operands. */
1520 if (v_ann->type_mem_tag)
1521 mark_sym_for_renaming (v_ann->type_mem_tag);
1523 /* Associate the tag with pointer VAR. */
1524 v_ann->type_mem_tag = tag;
1526 /* If pointer VAR has been used in a store operation,
1527 then its memory tag must be marked as written-to. */
1528 if (bitmap_bit_p (ai->dereferenced_ptrs_store, v_ann->uid))
1529 bitmap_set_bit (ai->written_vars, t_ann->uid);
1531 /* If pointer VAR is a global variable or a PARM_DECL,
1532 then its memory tag should be considered a global
1533 variable. */
1534 if (TREE_CODE (var) == PARM_DECL || is_global_var (var))
1535 mark_call_clobbered (tag);
1537 /* All the dereferences of pointer VAR count as
1538 references of TAG. Since TAG can be associated with
1539 several pointers, add the dereferences of VAR to the
1540 TAG. We may need to grow AI->NUM_REFERENCES because
1541 we have been adding name and type tags. */
1542 if (t_ann->uid >= VARRAY_SIZE (ai->num_references))
1543 VARRAY_GROW (ai->num_references, t_ann->uid + 10);
1545 VARRAY_UINT (ai->num_references, t_ann->uid)
1546 += VARRAY_UINT (ai->num_references, v_ann->uid);
1548 else
1550 /* The pointer has not been dereferenced. If it had a
1551 type memory tag, remove it and mark the old tag for
1552 renaming to remove it out of the IL. */
1553 var_ann_t ann = var_ann (var);
1554 tree tag = ann->type_mem_tag;
1555 if (tag)
1557 mark_sym_for_renaming (tag);
1558 ann->type_mem_tag = NULL_TREE;
1566 /* Determine whether to use .GLOBAL_VAR to model call clobbering semantics. At
1567 every call site, we need to emit V_MAY_DEF expressions to represent the
1568 clobbering effects of the call for variables whose address escapes the
1569 current function.
1571 One approach is to group all call-clobbered variables into a single
1572 representative that is used as an alias of every call-clobbered variable
1573 (.GLOBAL_VAR). This works well, but it ties the optimizer hands because
1574 references to any call clobbered variable is a reference to .GLOBAL_VAR.
1576 The second approach is to emit a clobbering V_MAY_DEF for every
1577 call-clobbered variable at call sites. This is the preferred way in terms
1578 of optimization opportunities but it may create too many V_MAY_DEF operands
1579 if there are many call clobbered variables and function calls in the
1580 function.
1582 To decide whether or not to use .GLOBAL_VAR we multiply the number of
1583 function calls found by the number of call-clobbered variables. If that
1584 product is beyond a certain threshold, as determined by the parameterized
1585 values shown below, we use .GLOBAL_VAR.
1587 FIXME. This heuristic should be improved. One idea is to use several
1588 .GLOBAL_VARs of different types instead of a single one. The thresholds
1589 have been derived from a typical bootstrap cycle, including all target
1590 libraries. Compile times were found increase by ~1% compared to using
1591 .GLOBAL_VAR. */
1593 static void
1594 maybe_create_global_var (struct alias_info *ai)
1596 unsigned i, n_clobbered;
1597 bitmap_iterator bi;
1599 /* No need to create it, if we have one already. */
1600 if (global_var == NULL_TREE)
1602 /* Count all the call-clobbered variables. */
1603 n_clobbered = 0;
1604 EXECUTE_IF_SET_IN_BITMAP (call_clobbered_vars, 0, i, bi)
1606 n_clobbered++;
1609 /* If the number of virtual operands that would be needed to
1610 model all the call-clobbered variables is larger than
1611 GLOBAL_VAR_THRESHOLD, create .GLOBAL_VAR.
1613 Also create .GLOBAL_VAR if there are no call-clobbered
1614 variables and the program contains a mixture of pure/const
1615 and regular function calls. This is to avoid the problem
1616 described in PR 20115:
1618 int X;
1619 int func_pure (void) { return X; }
1620 int func_non_pure (int a) { X += a; }
1621 int foo ()
1623 int a = func_pure ();
1624 func_non_pure (a);
1625 a = func_pure ();
1626 return a;
1629 Since foo() has no call-clobbered variables, there is
1630 no relationship between the calls to func_pure and
1631 func_non_pure. Since func_pure has no side-effects, value
1632 numbering optimizations elide the second call to func_pure.
1633 So, if we have some pure/const and some regular calls in the
1634 program we create .GLOBAL_VAR to avoid missing these
1635 relations. */
1636 if (ai->num_calls_found * n_clobbered >= (size_t) GLOBAL_VAR_THRESHOLD
1637 || (n_clobbered == 0
1638 && ai->num_calls_found > 0
1639 && ai->num_pure_const_calls_found > 0
1640 && ai->num_calls_found > ai->num_pure_const_calls_found))
1641 create_global_var ();
1644 /* Mark all call-clobbered symbols for renaming. Since the initial
1645 rewrite into SSA ignored all call sites, we may need to rename
1646 .GLOBAL_VAR and the call-clobbered variables. */
1647 EXECUTE_IF_SET_IN_BITMAP (call_clobbered_vars, 0, i, bi)
1649 tree var = referenced_var (i);
1651 /* If the function has calls to clobbering functions and
1652 .GLOBAL_VAR has been created, make it an alias for all
1653 call-clobbered variables. */
1654 if (global_var && var != global_var)
1656 subvar_t svars;
1657 add_may_alias (var, global_var);
1658 if (var_can_have_subvars (var)
1659 && (svars = get_subvars_for_var (var)))
1661 subvar_t sv;
1662 for (sv = svars; sv; sv = sv->next)
1663 mark_sym_for_renaming (sv->var);
1667 mark_sym_for_renaming (var);
1672 /* Return TRUE if pointer PTR may point to variable VAR.
1674 MEM_ALIAS_SET is the alias set for the memory location pointed-to by PTR
1675 This is needed because when checking for type conflicts we are
1676 interested in the alias set of the memory location pointed-to by
1677 PTR. The alias set of PTR itself is irrelevant.
1679 VAR_ALIAS_SET is the alias set for VAR. */
1681 static bool
1682 may_alias_p (tree ptr, HOST_WIDE_INT mem_alias_set,
1683 tree var, HOST_WIDE_INT var_alias_set)
1685 tree mem;
1686 var_ann_t m_ann;
1688 alias_stats.alias_queries++;
1689 alias_stats.simple_queries++;
1691 /* By convention, a variable cannot alias itself. */
1692 mem = var_ann (ptr)->type_mem_tag;
1693 if (mem == var)
1695 alias_stats.alias_noalias++;
1696 alias_stats.simple_resolved++;
1697 return false;
1700 /* If -fargument-noalias-global is >1, pointer arguments may
1701 not point to global variables. */
1702 if (flag_argument_noalias > 1 && is_global_var (var)
1703 && TREE_CODE (ptr) == PARM_DECL)
1705 alias_stats.alias_noalias++;
1706 alias_stats.simple_resolved++;
1707 return false;
1710 /* If either MEM or VAR is a read-only global and the other one
1711 isn't, then PTR cannot point to VAR. */
1712 if ((unmodifiable_var_p (mem) && !unmodifiable_var_p (var))
1713 || (unmodifiable_var_p (var) && !unmodifiable_var_p (mem)))
1715 alias_stats.alias_noalias++;
1716 alias_stats.simple_resolved++;
1717 return false;
1720 m_ann = var_ann (mem);
1722 gcc_assert (m_ann->mem_tag_kind == TYPE_TAG);
1724 alias_stats.tbaa_queries++;
1726 /* If VAR is a pointer with the same alias set as PTR, then dereferencing
1727 PTR can't possibly affect VAR. Note, that we are specifically testing
1728 for PTR's alias set here, not its pointed-to type. We also can't
1729 do this check with relaxed aliasing enabled. */
1730 if (POINTER_TYPE_P (TREE_TYPE (var))
1731 && var_alias_set != 0
1732 && mem_alias_set != 0)
1734 HOST_WIDE_INT ptr_alias_set = get_alias_set (ptr);
1735 if (ptr_alias_set == var_alias_set)
1737 alias_stats.alias_noalias++;
1738 alias_stats.tbaa_resolved++;
1739 return false;
1743 /* If the alias sets don't conflict then MEM cannot alias VAR. */
1744 if (!alias_sets_conflict_p (mem_alias_set, var_alias_set))
1746 alias_stats.alias_noalias++;
1747 alias_stats.tbaa_resolved++;
1748 return false;
1750 alias_stats.alias_mayalias++;
1751 return true;
1755 /* Add ALIAS to the set of variables that may alias VAR. */
1757 static void
1758 add_may_alias (tree var, tree alias)
1760 size_t i;
1761 var_ann_t v_ann = get_var_ann (var);
1762 var_ann_t a_ann = get_var_ann (alias);
1764 gcc_assert (var != alias);
1766 if (v_ann->may_aliases == NULL)
1767 VARRAY_TREE_INIT (v_ann->may_aliases, 2, "aliases");
1769 /* Avoid adding duplicates. */
1770 for (i = 0; i < VARRAY_ACTIVE_SIZE (v_ann->may_aliases); i++)
1771 if (alias == VARRAY_TREE (v_ann->may_aliases, i))
1772 return;
1774 /* If VAR is a call-clobbered variable, so is its new ALIAS.
1775 FIXME, call-clobbering should only depend on whether an address
1776 escapes. It should be independent of aliasing. */
1777 if (is_call_clobbered (var))
1778 mark_call_clobbered (alias);
1780 /* Likewise. If ALIAS is call-clobbered, so is VAR. */
1781 else if (is_call_clobbered (alias))
1782 mark_call_clobbered (var);
1784 VARRAY_PUSH_TREE (v_ann->may_aliases, alias);
1785 a_ann->is_alias_tag = 1;
1789 /* Replace alias I in the alias sets of VAR with NEW_ALIAS. */
1791 static void
1792 replace_may_alias (tree var, size_t i, tree new_alias)
1794 var_ann_t v_ann = var_ann (var);
1795 VARRAY_TREE (v_ann->may_aliases, i) = new_alias;
1797 /* If VAR is a call-clobbered variable, so is NEW_ALIAS.
1798 FIXME, call-clobbering should only depend on whether an address
1799 escapes. It should be independent of aliasing. */
1800 if (is_call_clobbered (var))
1801 mark_call_clobbered (new_alias);
1803 /* Likewise. If NEW_ALIAS is call-clobbered, so is VAR. */
1804 else if (is_call_clobbered (new_alias))
1805 mark_call_clobbered (var);
1809 /* Mark pointer PTR as pointing to an arbitrary memory location. */
1811 static void
1812 set_pt_anything (tree ptr)
1814 struct ptr_info_def *pi = get_ptr_info (ptr);
1816 pi->pt_anything = 1;
1817 pi->pt_malloc = 0;
1819 /* The pointer used to have a name tag, but we now found it pointing
1820 to an arbitrary location. The name tag needs to be renamed and
1821 disassociated from PTR. */
1822 if (pi->name_mem_tag)
1824 mark_sym_for_renaming (pi->name_mem_tag);
1825 pi->name_mem_tag = NULL_TREE;
1830 /* Mark pointer PTR as pointing to a malloc'd memory area. */
1832 static void
1833 set_pt_malloc (tree ptr)
1835 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
1837 /* If the pointer has already been found to point to arbitrary
1838 memory locations, it is unsafe to mark it as pointing to malloc. */
1839 if (pi->pt_anything)
1840 return;
1842 pi->pt_malloc = 1;
1846 /* Given two different pointers DEST and ORIG. Merge the points-to
1847 information in ORIG into DEST. AI contains all the alias
1848 information collected up to this point. */
1850 static void
1851 merge_pointed_to_info (struct alias_info *ai, tree dest, tree orig)
1853 struct ptr_info_def *dest_pi, *orig_pi;
1855 gcc_assert (dest != orig);
1857 /* Make sure we have points-to information for ORIG. */
1858 collect_points_to_info_for (ai, orig);
1860 dest_pi = get_ptr_info (dest);
1861 orig_pi = SSA_NAME_PTR_INFO (orig);
1863 if (orig_pi)
1865 gcc_assert (orig_pi != dest_pi);
1867 /* Notice that we never merge PT_MALLOC. This attribute is only
1868 true if the pointer is the result of a malloc() call.
1869 Otherwise, we can end up in this situation:
1871 P_i = malloc ();
1873 P_j = P_i + X;
1875 P_j would be marked as PT_MALLOC, however we currently do not
1876 handle cases of more than one pointer pointing to the same
1877 malloc'd area.
1879 FIXME: If the merging comes from an expression that preserves
1880 the PT_MALLOC attribute (copy assignment, address
1881 arithmetic), we ought to merge PT_MALLOC, but then both
1882 pointers would end up getting different name tags because
1883 create_name_tags is not smart enough to determine that the
1884 two come from the same malloc call. Copy propagation before
1885 aliasing should cure this. */
1886 dest_pi->pt_malloc = 0;
1887 if (orig_pi->pt_malloc || orig_pi->pt_anything)
1888 set_pt_anything (dest);
1890 dest_pi->pt_null |= orig_pi->pt_null;
1892 if (!dest_pi->pt_anything
1893 && orig_pi->pt_vars
1894 && !bitmap_empty_p (orig_pi->pt_vars))
1896 if (dest_pi->pt_vars == NULL)
1898 dest_pi->pt_vars = BITMAP_GGC_ALLOC ();
1899 bitmap_copy (dest_pi->pt_vars, orig_pi->pt_vars);
1901 else
1902 bitmap_ior_into (dest_pi->pt_vars, orig_pi->pt_vars);
1905 else
1906 set_pt_anything (dest);
1910 /* Add EXPR to the list of expressions pointed-to by PTR. */
1912 static void
1913 add_pointed_to_expr (struct alias_info *ai, tree ptr, tree expr)
1915 if (TREE_CODE (expr) == WITH_SIZE_EXPR)
1916 expr = TREE_OPERAND (expr, 0);
1918 get_ptr_info (ptr);
1920 if (TREE_CODE (expr) == CALL_EXPR
1921 && (call_expr_flags (expr) & (ECF_MALLOC | ECF_MAY_BE_ALLOCA)))
1923 /* If EXPR is a malloc-like call, then the area pointed to PTR
1924 is guaranteed to not alias with anything else. */
1925 set_pt_malloc (ptr);
1927 else if (TREE_CODE (expr) == ADDR_EXPR)
1929 /* Found P_i = ADDR_EXPR */
1930 add_pointed_to_var (ai, ptr, expr);
1932 else if (TREE_CODE (expr) == SSA_NAME && POINTER_TYPE_P (TREE_TYPE (expr)))
1934 /* Found P_i = Q_j. */
1935 merge_pointed_to_info (ai, ptr, expr);
1937 else if (TREE_CODE (expr) == PLUS_EXPR || TREE_CODE (expr) == MINUS_EXPR)
1939 /* Found P_i = PLUS_EXPR or P_i = MINUS_EXPR */
1940 tree op0 = TREE_OPERAND (expr, 0);
1941 tree op1 = TREE_OPERAND (expr, 1);
1943 /* Both operands may be of pointer type. FIXME: Shouldn't
1944 we just expect PTR + OFFSET always? */
1945 if (POINTER_TYPE_P (TREE_TYPE (op0))
1946 && TREE_CODE (op0) != INTEGER_CST)
1948 if (TREE_CODE (op0) == SSA_NAME)
1949 merge_pointed_to_info (ai, ptr, op0);
1950 else if (TREE_CODE (op0) == ADDR_EXPR)
1951 add_pointed_to_var (ai, ptr, op0);
1952 else
1953 set_pt_anything (ptr);
1956 if (POINTER_TYPE_P (TREE_TYPE (op1))
1957 && TREE_CODE (op1) != INTEGER_CST)
1959 if (TREE_CODE (op1) == SSA_NAME)
1960 merge_pointed_to_info (ai, ptr, op1);
1961 else if (TREE_CODE (op1) == ADDR_EXPR)
1962 add_pointed_to_var (ai, ptr, op1);
1963 else
1964 set_pt_anything (ptr);
1967 /* Neither operand is a pointer? VAR can be pointing anywhere.
1968 FIXME: Shouldn't we asserting here? If we get here, we found
1969 PTR = INT_CST + INT_CST, which should not be a valid pointer
1970 expression. */
1971 if (!(POINTER_TYPE_P (TREE_TYPE (op0))
1972 && TREE_CODE (op0) != INTEGER_CST)
1973 && !(POINTER_TYPE_P (TREE_TYPE (op1))
1974 && TREE_CODE (op1) != INTEGER_CST))
1975 set_pt_anything (ptr);
1977 else if (integer_zerop (expr))
1979 /* EXPR is the NULL pointer. Mark PTR as pointing to NULL. */
1980 SSA_NAME_PTR_INFO (ptr)->pt_null = 1;
1982 else
1984 /* If we can't recognize the expression, assume that PTR may
1985 point anywhere. */
1986 set_pt_anything (ptr);
1991 /* If VALUE is of the form &DECL, add DECL to the set of variables
1992 pointed-to by PTR. Otherwise, add VALUE as a pointed-to expression by
1993 PTR. AI points to the collected alias information. */
1995 static void
1996 add_pointed_to_var (struct alias_info *ai, tree ptr, tree value)
1998 struct ptr_info_def *pi = get_ptr_info (ptr);
1999 tree pt_var = NULL_TREE;
2000 HOST_WIDE_INT offset, size;
2001 tree addrop;
2002 size_t uid;
2003 tree ref;
2004 subvar_t svars;
2006 gcc_assert (TREE_CODE (value) == ADDR_EXPR);
2008 addrop = TREE_OPERAND (value, 0);
2009 if (REFERENCE_CLASS_P (addrop))
2010 pt_var = get_base_address (addrop);
2011 else
2012 pt_var = addrop;
2014 /* If this is a component_ref, see if we can get a smaller number of
2015 variables to take the address of. */
2016 if (TREE_CODE (addrop) == COMPONENT_REF
2017 && (ref = okay_component_ref_for_subvars (addrop, &offset ,&size)))
2019 subvar_t sv;
2020 svars = get_subvars_for_var (ref);
2022 uid = var_ann (pt_var)->uid;
2024 if (pi->pt_vars == NULL)
2025 pi->pt_vars = BITMAP_GGC_ALLOC ();
2026 /* If the variable is a global, mark the pointer as pointing to
2027 global memory (which will make its tag a global variable). */
2028 if (is_global_var (pt_var))
2029 pi->pt_global_mem = 1;
2031 for (sv = svars; sv; sv = sv->next)
2033 if (overlap_subvar (offset, size, sv, NULL))
2035 bitmap_set_bit (pi->pt_vars, var_ann (sv->var)->uid);
2036 bitmap_set_bit (ai->addresses_needed, var_ann (sv->var)->uid);
2040 else if (pt_var && SSA_VAR_P (pt_var))
2043 uid = var_ann (pt_var)->uid;
2045 if (pi->pt_vars == NULL)
2046 pi->pt_vars = BITMAP_GGC_ALLOC ();
2048 /* If this is an aggregate, we may have subvariables for it that need
2049 to be pointed to. */
2050 if (var_can_have_subvars (pt_var)
2051 && (svars = get_subvars_for_var (pt_var)))
2053 subvar_t sv;
2054 for (sv = svars; sv; sv = sv->next)
2056 uid = var_ann (sv->var)->uid;
2057 bitmap_set_bit (ai->addresses_needed, uid);
2058 bitmap_set_bit (pi->pt_vars, uid);
2061 else
2063 bitmap_set_bit (ai->addresses_needed, uid);
2064 bitmap_set_bit (pi->pt_vars, uid);
2067 /* If the variable is a global, mark the pointer as pointing to
2068 global memory (which will make its tag a global variable). */
2069 if (is_global_var (pt_var))
2070 pi->pt_global_mem = 1;
2075 /* Callback for walk_use_def_chains to gather points-to information from the
2076 SSA web.
2078 VAR is an SSA variable or a GIMPLE expression.
2080 STMT is the statement that generates the SSA variable or, if STMT is a
2081 PHI_NODE, VAR is one of the PHI arguments.
2083 DATA is a pointer to a structure of type ALIAS_INFO. */
2085 static bool
2086 collect_points_to_info_r (tree var, tree stmt, void *data)
2088 struct alias_info *ai = (struct alias_info *) data;
2090 if (dump_file && (dump_flags & TDF_DETAILS))
2092 fprintf (dump_file, "Visiting use-def links for ");
2093 print_generic_expr (dump_file, var, dump_flags);
2094 fprintf (dump_file, "\n");
2097 switch (TREE_CODE (stmt))
2099 case RETURN_EXPR:
2100 gcc_assert (TREE_CODE (TREE_OPERAND (stmt, 0)) == MODIFY_EXPR);
2101 stmt = TREE_OPERAND (stmt, 0);
2102 /* FALLTHRU */
2104 case MODIFY_EXPR:
2106 tree rhs = TREE_OPERAND (stmt, 1);
2107 STRIP_NOPS (rhs);
2108 add_pointed_to_expr (ai, var, rhs);
2109 break;
2112 case ASM_EXPR:
2113 /* Pointers defined by __asm__ statements can point anywhere. */
2114 set_pt_anything (var);
2115 break;
2117 case NOP_EXPR:
2118 if (IS_EMPTY_STMT (stmt))
2120 tree decl = SSA_NAME_VAR (var);
2122 if (TREE_CODE (decl) == PARM_DECL)
2123 add_pointed_to_expr (ai, var, decl);
2124 else if (DECL_INITIAL (decl))
2125 add_pointed_to_expr (ai, var, DECL_INITIAL (decl));
2126 else
2127 add_pointed_to_expr (ai, var, decl);
2129 break;
2131 case PHI_NODE:
2133 /* It STMT is a PHI node, then VAR is one of its arguments. The
2134 variable that we are analyzing is the LHS of the PHI node. */
2135 tree lhs = PHI_RESULT (stmt);
2137 switch (TREE_CODE (var))
2139 case ADDR_EXPR:
2140 add_pointed_to_var (ai, lhs, var);
2141 break;
2143 case SSA_NAME:
2144 /* Avoid unnecessary merges. */
2145 if (lhs != var)
2146 merge_pointed_to_info (ai, lhs, var);
2147 break;
2149 default:
2150 gcc_assert (is_gimple_min_invariant (var));
2151 add_pointed_to_expr (ai, lhs, var);
2152 break;
2154 break;
2157 default:
2158 gcc_unreachable ();
2161 return false;
2165 /* Return true if STMT is an "escape" site from the current function. Escape
2166 sites those statements which might expose the address of a variable
2167 outside the current function. STMT is an escape site iff:
2169 1- STMT is a function call, or
2170 2- STMT is an __asm__ expression, or
2171 3- STMT is an assignment to a non-local variable, or
2172 4- STMT is a return statement.
2174 AI points to the alias information collected so far. */
2176 static bool
2177 is_escape_site (tree stmt, struct alias_info *ai)
2179 tree call = get_call_expr_in (stmt);
2180 if (call != NULL_TREE)
2182 ai->num_calls_found++;
2184 if (!TREE_SIDE_EFFECTS (call))
2185 ai->num_pure_const_calls_found++;
2187 return true;
2189 else if (TREE_CODE (stmt) == ASM_EXPR)
2190 return true;
2191 else if (TREE_CODE (stmt) == MODIFY_EXPR)
2193 tree lhs = TREE_OPERAND (stmt, 0);
2195 /* Get to the base of _REF nodes. */
2196 if (TREE_CODE (lhs) != SSA_NAME)
2197 lhs = get_base_address (lhs);
2199 /* If we couldn't recognize the LHS of the assignment, assume that it
2200 is a non-local store. */
2201 if (lhs == NULL_TREE)
2202 return true;
2204 /* If the RHS is a conversion between a pointer and an integer, the
2205 pointer escapes since we can't track the integer. */
2206 if ((TREE_CODE (TREE_OPERAND (stmt, 1)) == NOP_EXPR
2207 || TREE_CODE (TREE_OPERAND (stmt, 1)) == CONVERT_EXPR
2208 || TREE_CODE (TREE_OPERAND (stmt, 1)) == VIEW_CONVERT_EXPR)
2209 && POINTER_TYPE_P (TREE_TYPE (TREE_OPERAND
2210 (TREE_OPERAND (stmt, 1), 0)))
2211 && !POINTER_TYPE_P (TREE_TYPE (TREE_OPERAND (stmt, 1))))
2212 return true;
2214 /* If the LHS is an SSA name, it can't possibly represent a non-local
2215 memory store. */
2216 if (TREE_CODE (lhs) == SSA_NAME)
2217 return false;
2219 /* FIXME: LHS is not an SSA_NAME. Even if it's an assignment to a
2220 local variables we cannot be sure if it will escape, because we
2221 don't have information about objects not in SSA form. Need to
2222 implement something along the lines of
2224 J.-D. Choi, M. Gupta, M. J. Serrano, V. C. Sreedhar, and S. P.
2225 Midkiff, ``Escape analysis for java,'' in Proceedings of the
2226 Conference on Object-Oriented Programming Systems, Languages, and
2227 Applications (OOPSLA), pp. 1-19, 1999. */
2228 return true;
2230 else if (TREE_CODE (stmt) == RETURN_EXPR)
2231 return true;
2233 return false;
2237 /* Create a new memory tag of type TYPE. If IS_TYPE_TAG is true, the tag
2238 is considered to represent all the pointers whose pointed-to types are
2239 in the same alias set class. Otherwise, the tag represents a single
2240 SSA_NAME pointer variable. */
2242 static tree
2243 create_memory_tag (tree type, bool is_type_tag)
2245 var_ann_t ann;
2246 tree tag = create_tmp_var_raw (type, (is_type_tag) ? "TMT" : "NMT");
2248 /* By default, memory tags are local variables. Alias analysis will
2249 determine whether they should be considered globals. */
2250 DECL_CONTEXT (tag) = current_function_decl;
2252 /* Memory tags are by definition addressable. This also prevents
2253 is_gimple_ref frome confusing memory tags with optimizable
2254 variables. */
2255 TREE_ADDRESSABLE (tag) = 1;
2257 ann = get_var_ann (tag);
2258 ann->mem_tag_kind = (is_type_tag) ? TYPE_TAG : NAME_TAG;
2259 ann->type_mem_tag = NULL_TREE;
2261 /* Add the tag to the symbol table. */
2262 add_referenced_tmp_var (tag);
2264 return tag;
2268 /* Create a name memory tag to represent a specific SSA_NAME pointer P_i.
2269 This is used if P_i has been found to point to a specific set of
2270 variables or to a non-aliased memory location like the address returned
2271 by malloc functions. */
2273 static tree
2274 get_nmt_for (tree ptr)
2276 struct ptr_info_def *pi = get_ptr_info (ptr);
2277 tree tag = pi->name_mem_tag;
2279 if (tag == NULL_TREE)
2280 tag = create_memory_tag (TREE_TYPE (TREE_TYPE (ptr)), false);
2282 /* If PTR is a PARM_DECL, it points to a global variable or malloc,
2283 then its name tag should be considered a global variable. */
2284 if (TREE_CODE (SSA_NAME_VAR (ptr)) == PARM_DECL
2285 || pi->pt_malloc
2286 || pi->pt_global_mem)
2287 mark_call_clobbered (tag);
2289 return tag;
2293 /* Return the type memory tag associated to pointer PTR. A memory tag is an
2294 artificial variable that represents the memory location pointed-to by
2295 PTR. It is used to model the effects of pointer de-references on
2296 addressable variables.
2298 AI points to the data gathered during alias analysis. This function
2299 populates the array AI->POINTERS. */
2301 static tree
2302 get_tmt_for (tree ptr, struct alias_info *ai)
2304 size_t i;
2305 tree tag;
2306 tree tag_type = TREE_TYPE (TREE_TYPE (ptr));
2307 HOST_WIDE_INT tag_set = get_alias_set (tag_type);
2309 /* To avoid creating unnecessary memory tags, only create one memory tag
2310 per alias set class. Note that it may be tempting to group
2311 memory tags based on conflicting alias sets instead of
2312 equivalence. That would be wrong because alias sets are not
2313 necessarily transitive (as demonstrated by the libstdc++ test
2314 23_containers/vector/cons/4.cc). Given three alias sets A, B, C
2315 such that conflicts (A, B) == true and conflicts (A, C) == true,
2316 it does not necessarily follow that conflicts (B, C) == true. */
2317 for (i = 0, tag = NULL_TREE; i < ai->num_pointers; i++)
2319 struct alias_map_d *curr = ai->pointers[i];
2320 tree curr_tag = var_ann (curr->var)->type_mem_tag;
2321 if (tag_set == curr->set
2322 && TYPE_READONLY (tag_type) == TYPE_READONLY (TREE_TYPE (curr_tag)))
2324 tag = curr_tag;
2325 break;
2329 /* If VAR cannot alias with any of the existing memory tags, create a new
2330 tag for PTR and add it to the POINTERS array. */
2331 if (tag == NULL_TREE)
2333 struct alias_map_d *alias_map;
2335 /* If PTR did not have a type tag already, create a new TMT.*
2336 artificial variable representing the memory location
2337 pointed-to by PTR. */
2338 if (var_ann (ptr)->type_mem_tag == NULL_TREE)
2339 tag = create_memory_tag (tag_type, true);
2340 else
2341 tag = var_ann (ptr)->type_mem_tag;
2343 /* Add PTR to the POINTERS array. Note that we are not interested in
2344 PTR's alias set. Instead, we cache the alias set for the memory that
2345 PTR points to. */
2346 alias_map = xcalloc (1, sizeof (*alias_map));
2347 alias_map->var = ptr;
2348 alias_map->set = tag_set;
2349 ai->pointers[ai->num_pointers++] = alias_map;
2352 /* If the pointed-to type is volatile, so is the tag. */
2353 TREE_THIS_VOLATILE (tag) |= TREE_THIS_VOLATILE (tag_type);
2355 /* Make sure that the type tag has the same alias set as the
2356 pointed-to type. */
2357 gcc_assert (tag_set == get_alias_set (tag));
2359 /* If PTR's pointed-to type is read-only, then TAG's type must also
2360 be read-only. */
2361 gcc_assert (TYPE_READONLY (tag_type) == TYPE_READONLY (TREE_TYPE (tag)));
2363 return tag;
2367 /* Create GLOBAL_VAR, an artificial global variable to act as a
2368 representative of all the variables that may be clobbered by function
2369 calls. */
2371 static void
2372 create_global_var (void)
2374 global_var = build_decl (VAR_DECL, get_identifier (".GLOBAL_VAR"),
2375 void_type_node);
2376 DECL_ARTIFICIAL (global_var) = 1;
2377 TREE_READONLY (global_var) = 0;
2378 DECL_EXTERNAL (global_var) = 1;
2379 TREE_STATIC (global_var) = 1;
2380 TREE_USED (global_var) = 1;
2381 DECL_CONTEXT (global_var) = NULL_TREE;
2382 TREE_THIS_VOLATILE (global_var) = 0;
2383 TREE_ADDRESSABLE (global_var) = 0;
2385 add_referenced_tmp_var (global_var);
2386 mark_sym_for_renaming (global_var);
2390 /* Dump alias statistics on FILE. */
2392 static void
2393 dump_alias_stats (FILE *file)
2395 const char *funcname
2396 = lang_hooks.decl_printable_name (current_function_decl, 2);
2397 fprintf (file, "\nAlias statistics for %s\n\n", funcname);
2398 fprintf (file, "Total alias queries:\t%u\n", alias_stats.alias_queries);
2399 fprintf (file, "Total alias mayalias results:\t%u\n",
2400 alias_stats.alias_mayalias);
2401 fprintf (file, "Total alias noalias results:\t%u\n",
2402 alias_stats.alias_noalias);
2403 fprintf (file, "Total simple queries:\t%u\n",
2404 alias_stats.simple_queries);
2405 fprintf (file, "Total simple resolved:\t%u\n",
2406 alias_stats.simple_resolved);
2407 fprintf (file, "Total TBAA queries:\t%u\n",
2408 alias_stats.tbaa_queries);
2409 fprintf (file, "Total TBAA resolved:\t%u\n",
2410 alias_stats.tbaa_resolved);
2414 /* Dump alias information on FILE. */
2416 void
2417 dump_alias_info (FILE *file)
2419 size_t i;
2420 const char *funcname
2421 = lang_hooks.decl_printable_name (current_function_decl, 2);
2423 fprintf (file, "\nFlow-insensitive alias information for %s\n\n", funcname);
2425 fprintf (file, "Aliased symbols\n\n");
2426 for (i = 0; i < num_referenced_vars; i++)
2428 tree var = referenced_var (i);
2429 if (may_be_aliased (var))
2430 dump_variable (file, var);
2433 fprintf (file, "\nDereferenced pointers\n\n");
2434 for (i = 0; i < num_referenced_vars; i++)
2436 tree var = referenced_var (i);
2437 var_ann_t ann = var_ann (var);
2438 if (ann->type_mem_tag)
2439 dump_variable (file, var);
2442 fprintf (file, "\nType memory tags\n\n");
2443 for (i = 0; i < num_referenced_vars; i++)
2445 tree var = referenced_var (i);
2446 var_ann_t ann = var_ann (var);
2447 if (ann->mem_tag_kind == TYPE_TAG)
2448 dump_variable (file, var);
2451 fprintf (file, "\n\nFlow-sensitive alias information for %s\n\n", funcname);
2453 fprintf (file, "SSA_NAME pointers\n\n");
2454 for (i = 1; i < num_ssa_names; i++)
2456 tree ptr = ssa_name (i);
2457 struct ptr_info_def *pi;
2459 if (ptr == NULL_TREE)
2460 continue;
2462 pi = SSA_NAME_PTR_INFO (ptr);
2463 if (!SSA_NAME_IN_FREE_LIST (ptr)
2464 && pi
2465 && pi->name_mem_tag)
2466 dump_points_to_info_for (file, ptr);
2469 fprintf (file, "\nName memory tags\n\n");
2470 for (i = 0; i < num_referenced_vars; i++)
2472 tree var = referenced_var (i);
2473 var_ann_t ann = var_ann (var);
2474 if (ann->mem_tag_kind == NAME_TAG)
2475 dump_variable (file, var);
2478 fprintf (file, "\n");
2482 /* Dump alias information on stderr. */
2484 void
2485 debug_alias_info (void)
2487 dump_alias_info (stderr);
2491 /* Return the alias information associated with pointer T. It creates a
2492 new instance if none existed. */
2494 struct ptr_info_def *
2495 get_ptr_info (tree t)
2497 struct ptr_info_def *pi;
2499 gcc_assert (POINTER_TYPE_P (TREE_TYPE (t)));
2501 pi = SSA_NAME_PTR_INFO (t);
2502 if (pi == NULL)
2504 pi = ggc_alloc (sizeof (*pi));
2505 memset ((void *)pi, 0, sizeof (*pi));
2506 SSA_NAME_PTR_INFO (t) = pi;
2509 return pi;
2513 /* Dump points-to information for SSA_NAME PTR into FILE. */
2515 void
2516 dump_points_to_info_for (FILE *file, tree ptr)
2518 struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
2520 print_generic_expr (file, ptr, dump_flags);
2522 if (pi)
2524 if (pi->name_mem_tag)
2526 fprintf (file, ", name memory tag: ");
2527 print_generic_expr (file, pi->name_mem_tag, dump_flags);
2530 if (pi->is_dereferenced)
2531 fprintf (file, ", is dereferenced");
2533 if (pi->value_escapes_p)
2534 fprintf (file, ", its value escapes");
2536 if (pi->pt_anything)
2537 fprintf (file, ", points-to anything");
2539 if (pi->pt_malloc)
2540 fprintf (file, ", points-to malloc");
2542 if (pi->pt_null)
2543 fprintf (file, ", points-to NULL");
2545 if (pi->pt_vars)
2547 unsigned ix;
2548 bitmap_iterator bi;
2550 fprintf (file, ", points-to vars: { ");
2551 EXECUTE_IF_SET_IN_BITMAP (pi->pt_vars, 0, ix, bi)
2553 print_generic_expr (file, referenced_var (ix), dump_flags);
2554 fprintf (file, " ");
2556 fprintf (file, "}");
2560 fprintf (file, "\n");
2564 /* Dump points-to information for VAR into stderr. */
2566 void
2567 debug_points_to_info_for (tree var)
2569 dump_points_to_info_for (stderr, var);
2573 /* Dump points-to information into FILE. NOTE: This function is slow, as
2574 it needs to traverse the whole CFG looking for pointer SSA_NAMEs. */
2576 void
2577 dump_points_to_info (FILE *file)
2579 basic_block bb;
2580 block_stmt_iterator si;
2581 size_t i;
2582 ssa_op_iter iter;
2583 const char *fname =
2584 lang_hooks.decl_printable_name (current_function_decl, 2);
2586 fprintf (file, "\n\nPointed-to sets for pointers in %s\n\n", fname);
2588 /* First dump points-to information for the default definitions of
2589 pointer variables. This is necessary because default definitions are
2590 not part of the code. */
2591 for (i = 0; i < num_referenced_vars; i++)
2593 tree var = referenced_var (i);
2594 if (POINTER_TYPE_P (TREE_TYPE (var)))
2596 var_ann_t ann = var_ann (var);
2597 if (ann->default_def)
2598 dump_points_to_info_for (file, ann->default_def);
2602 /* Dump points-to information for every pointer defined in the program. */
2603 FOR_EACH_BB (bb)
2605 tree phi;
2607 for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
2609 tree ptr = PHI_RESULT (phi);
2610 if (POINTER_TYPE_P (TREE_TYPE (ptr)))
2611 dump_points_to_info_for (file, ptr);
2614 for (si = bsi_start (bb); !bsi_end_p (si); bsi_next (&si))
2616 tree stmt = bsi_stmt (si);
2617 tree def;
2618 FOR_EACH_SSA_TREE_OPERAND (def, stmt, iter, SSA_OP_DEF)
2619 if (POINTER_TYPE_P (TREE_TYPE (def)))
2620 dump_points_to_info_for (file, def);
2624 fprintf (file, "\n");
2628 /* Dump points-to info pointed by PTO into STDERR. */
2630 void
2631 debug_points_to_info (void)
2633 dump_points_to_info (stderr);
2636 /* Dump to FILE the list of variables that may be aliasing VAR. */
2638 void
2639 dump_may_aliases_for (FILE *file, tree var)
2641 varray_type aliases;
2643 if (TREE_CODE (var) == SSA_NAME)
2644 var = SSA_NAME_VAR (var);
2646 aliases = var_ann (var)->may_aliases;
2647 if (aliases)
2649 size_t i;
2650 fprintf (file, "{ ");
2651 for (i = 0; i < VARRAY_ACTIVE_SIZE (aliases); i++)
2653 print_generic_expr (file, VARRAY_TREE (aliases, i), dump_flags);
2654 fprintf (file, " ");
2656 fprintf (file, "}");
2661 /* Dump to stderr the list of variables that may be aliasing VAR. */
2663 void
2664 debug_may_aliases_for (tree var)
2666 dump_may_aliases_for (stderr, var);
2669 /* Return true if VAR may be aliased. */
2671 bool
2672 may_be_aliased (tree var)
2674 /* Obviously. */
2675 if (TREE_ADDRESSABLE (var))
2676 return true;
2678 /* Globally visible variables can have their addresses taken by other
2679 translation units. */
2680 if (DECL_EXTERNAL (var) || TREE_PUBLIC (var))
2681 return true;
2683 /* Automatic variables can't have their addresses escape any other way.
2684 This must be after the check for global variables, as extern declarations
2685 do not have TREE_STATIC set. */
2686 if (!TREE_STATIC (var))
2687 return false;
2689 /* If we're in unit-at-a-time mode, then we must have seen all occurrences
2690 of address-of operators, and so we can trust TREE_ADDRESSABLE. Otherwise
2691 we can only be sure the variable isn't addressable if it's local to the
2692 current function. */
2693 if (flag_unit_at_a_time)
2694 return false;
2695 if (decl_function_context (var) == current_function_decl)
2696 return false;
2698 return true;
2702 /* Add VAR to the list of may-aliases of PTR's type tag. If PTR
2703 doesn't already have a type tag, create one. */
2705 void
2706 add_type_alias (tree ptr, tree var)
2708 varray_type aliases;
2709 tree tag;
2710 var_ann_t ann = var_ann (ptr);
2711 subvar_t svars;
2713 if (ann->type_mem_tag == NULL_TREE)
2715 size_t i;
2716 tree q = NULL_TREE;
2717 tree tag_type = TREE_TYPE (TREE_TYPE (ptr));
2718 HOST_WIDE_INT tag_set = get_alias_set (tag_type);
2720 /* PTR doesn't have a type tag, create a new one and add VAR to
2721 the new tag's alias set.
2723 FIXME, This is slower than necessary. We need to determine
2724 whether there is another pointer Q with the same alias set as
2725 PTR. This could be sped up by having type tags associated
2726 with types. */
2727 for (i = 0; i < num_referenced_vars; i++)
2729 q = referenced_var (i);
2731 if (POINTER_TYPE_P (TREE_TYPE (q))
2732 && tag_set == get_alias_set (TREE_TYPE (TREE_TYPE (q))))
2734 /* Found another pointer Q with the same alias set as
2735 the PTR's pointed-to type. If Q has a type tag, use
2736 it. Otherwise, create a new memory tag for PTR. */
2737 var_ann_t ann1 = var_ann (q);
2738 if (ann1->type_mem_tag)
2739 ann->type_mem_tag = ann1->type_mem_tag;
2740 else
2741 ann->type_mem_tag = create_memory_tag (tag_type, true);
2742 goto found_tag;
2746 /* Couldn't find any other pointer with a type tag we could use.
2747 Create a new memory tag for PTR. */
2748 ann->type_mem_tag = create_memory_tag (tag_type, true);
2751 found_tag:
2752 /* If VAR is not already PTR's type tag, add it to the may-alias set
2753 for PTR's type tag. */
2754 gcc_assert (var_ann (var)->type_mem_tag == NOT_A_TAG);
2755 tag = ann->type_mem_tag;
2757 /* If VAR has subvars, add the subvars to the tag instead of the
2758 actual var. */
2759 if (var_can_have_subvars (var)
2760 && (svars = get_subvars_for_var (var)))
2762 subvar_t sv;
2763 for (sv = svars; sv; sv = sv->next)
2764 add_may_alias (tag, sv->var);
2766 else
2767 add_may_alias (tag, var);
2769 /* TAG and its set of aliases need to be marked for renaming. */
2770 mark_sym_for_renaming (tag);
2771 if ((aliases = var_ann (tag)->may_aliases) != NULL)
2773 size_t i;
2774 for (i = 0; i < VARRAY_ACTIVE_SIZE (aliases); i++)
2775 mark_sym_for_renaming (VARRAY_TREE (aliases, i));
2778 /* If we had grouped aliases, VAR may have aliases of its own. Mark
2779 them for renaming as well. Other statements referencing the
2780 aliases of VAR will need to be updated. */
2781 if ((aliases = var_ann (var)->may_aliases) != NULL)
2783 size_t i;
2784 for (i = 0; i < VARRAY_ACTIVE_SIZE (aliases); i++)
2785 mark_sym_for_renaming (VARRAY_TREE (aliases, i));
2790 /* Create a new type tag for PTR. Construct the may-alias list of this type
2791 tag so that it has the aliasing of VAR.
2793 Note, the set of aliases represented by the new type tag are not marked
2794 for renaming. */
2796 void
2797 new_type_alias (tree ptr, tree var)
2799 var_ann_t p_ann = var_ann (ptr);
2800 tree tag_type = TREE_TYPE (TREE_TYPE (ptr));
2801 var_ann_t v_ann = var_ann (var);
2802 tree tag;
2803 subvar_t svars;
2805 gcc_assert (p_ann->type_mem_tag == NULL_TREE);
2806 gcc_assert (v_ann->mem_tag_kind == NOT_A_TAG);
2808 /* Add VAR to the may-alias set of PTR's new type tag. If VAR has
2809 subvars, add the subvars to the tag instead of the actual var. */
2810 if (var_can_have_subvars (var)
2811 && (svars = get_subvars_for_var (var)))
2813 subvar_t sv;
2815 tag = create_memory_tag (tag_type, true);
2816 p_ann->type_mem_tag = tag;
2818 for (sv = svars; sv; sv = sv->next)
2819 add_may_alias (tag, sv->var);
2821 else
2823 /* The following is based on code in add_stmt_operand to ensure that the
2824 same defs/uses/vdefs/vuses will be found after replacing a reference
2825 to var (or ARRAY_REF to var) with an INDIRECT_REF to ptr whose value
2826 is the address of var. */
2827 varray_type aliases = v_ann->may_aliases;
2829 if ((aliases != NULL)
2830 && (VARRAY_ACTIVE_SIZE (aliases) == 1))
2832 tree ali = VARRAY_TREE (aliases, 0);
2834 if (get_var_ann (ali)->mem_tag_kind == TYPE_TAG)
2836 p_ann->type_mem_tag = ali;
2837 return;
2841 tag = create_memory_tag (tag_type, true);
2842 p_ann->type_mem_tag = tag;
2844 if (aliases == NULL)
2845 add_may_alias (tag, var);
2846 else
2848 size_t i;
2850 for (i = 0; i < VARRAY_ACTIVE_SIZE (aliases); i++)
2851 add_may_alias (tag, VARRAY_TREE (aliases, i));
2856 /* This represents the used range of a variable. */
2858 typedef struct used_part
2860 HOST_WIDE_INT minused;
2861 HOST_WIDE_INT maxused;
2862 /* True if we have an explicit use/def of some portion of this variable,
2863 even if it is all of it. i.e. a.b = 5 or temp = a.b. */
2864 bool explicit_uses;
2865 /* True if we have an implicit use/def of some portion of this
2866 variable. Implicit uses occur when we can't tell what part we
2867 are referencing, and have to make conservative assumptions. */
2868 bool implicit_uses;
2869 } *used_part_t;
2871 /* An array of used_part structures, indexed by variable uid. */
2873 static used_part_t *used_portions;
2875 /* Given a variable uid, UID, get or create the entry in the used portions
2876 table for the variable. */
2878 static used_part_t
2879 get_or_create_used_part_for (size_t uid)
2881 used_part_t up;
2882 if (used_portions[uid] == NULL)
2884 up = xcalloc (1, sizeof (struct used_part));
2885 up->minused = INT_MAX;
2886 up->maxused = 0;
2887 up->explicit_uses = false;
2888 up->implicit_uses = false;
2890 else
2891 up = used_portions[uid];
2892 return up;
2896 /* Given an aggregate VAR, create the subvariables that represent its
2897 fields. */
2899 static void
2900 create_overlap_variables_for (tree var)
2902 VEC(fieldoff_s,heap) *fieldstack = NULL;
2903 used_part_t up;
2904 size_t uid = var_ann (var)->uid;
2906 if (used_portions[uid] == NULL)
2907 return;
2909 up = used_portions[uid];
2910 push_fields_onto_fieldstack (TREE_TYPE (var), &fieldstack, 0, NULL);
2911 if (VEC_length (fieldoff_s, fieldstack) != 0)
2913 subvar_t *subvars;
2914 fieldoff_s *fo;
2915 bool notokay = false;
2916 int fieldcount = 0;
2917 int i;
2918 HOST_WIDE_INT lastfooffset = -1;
2919 HOST_WIDE_INT lastfosize = -1;
2920 tree lastfotype = NULL_TREE;
2922 /* Not all fields have DECL_SIZE set, and those that don't, we don't
2923 know their size, and thus, can't handle.
2924 The same is true of fields with DECL_SIZE that is not an integer
2925 constant (such as variable sized fields).
2926 Fields with offsets which are not constant will have an offset < 0
2927 We *could* handle fields that are constant sized arrays, but
2928 currently don't. Doing so would require some extra changes to
2929 tree-ssa-operands.c. */
2931 for (i = 0; VEC_iterate (fieldoff_s, fieldstack, i, fo); i++)
2933 if (!DECL_SIZE (fo->field)
2934 || TREE_CODE (DECL_SIZE (fo->field)) != INTEGER_CST
2935 || TREE_CODE (TREE_TYPE (fo->field)) == ARRAY_TYPE
2936 || fo->offset < 0)
2938 notokay = true;
2939 break;
2941 fieldcount++;
2944 /* The current heuristic we use is as follows:
2945 If the variable has no used portions in this function, no
2946 structure vars are created for it.
2947 Otherwise,
2948 If the variable has less than SALIAS_MAX_IMPLICIT_FIELDS,
2949 we always create structure vars for them.
2950 If the variable has more than SALIAS_MAX_IMPLICIT_FIELDS, and
2951 some explicit uses, we create structure vars for them.
2952 If the variable has more than SALIAS_MAX_IMPLICIT_FIELDS, and
2953 no explicit uses, we do not create structure vars for them.
2956 if (fieldcount >= SALIAS_MAX_IMPLICIT_FIELDS
2957 && !up->explicit_uses)
2959 if (dump_file && (dump_flags & TDF_DETAILS))
2961 fprintf (dump_file, "Variable ");
2962 print_generic_expr (dump_file, var, 0);
2963 fprintf (dump_file, " has no explicit uses in this function, and is > SALIAS_MAX_IMPLICIT_FIELDS, so skipping\n");
2965 notokay = true;
2968 /* Bail out, if we can't create overlap variables. */
2969 if (notokay)
2971 VEC_free (fieldoff_s, heap, fieldstack);
2972 return;
2975 /* Otherwise, create the variables. */
2976 subvars = lookup_subvars_for_var (var);
2978 sort_fieldstack (fieldstack);
2980 for (i = VEC_length (fieldoff_s, fieldstack);
2981 VEC_iterate (fieldoff_s, fieldstack, --i, fo);)
2983 subvar_t sv;
2984 HOST_WIDE_INT fosize;
2985 var_ann_t ann;
2986 tree currfotype;
2988 fosize = TREE_INT_CST_LOW (DECL_SIZE (fo->field));
2989 currfotype = TREE_TYPE (fo->field);
2991 /* If this field isn't in the used portion,
2992 or it has the exact same offset and size as the last
2993 field, skip it. */
2995 if (((fo->offset <= up->minused
2996 && fo->offset + fosize <= up->minused)
2997 || fo->offset >= up->maxused)
2998 || (fo->offset == lastfooffset
2999 && fosize == lastfosize
3000 && currfotype == lastfotype))
3001 continue;
3002 sv = ggc_alloc (sizeof (struct subvar));
3003 sv->offset = fo->offset;
3004 sv->size = fosize;
3005 sv->next = *subvars;
3006 sv->var = create_tmp_var_raw (TREE_TYPE (fo->field), "SFT");
3007 if (dump_file)
3009 fprintf (dump_file, "structure field tag %s created for var %s",
3010 get_name (sv->var), get_name (var));
3011 fprintf (dump_file, " offset " HOST_WIDE_INT_PRINT_DEC,
3012 sv->offset);
3013 fprintf (dump_file, " size " HOST_WIDE_INT_PRINT_DEC,
3014 sv->size);
3015 fprintf (dump_file, "\n");
3018 /* We need to copy the various flags from var to sv->var, so that
3019 they are is_global_var iff the original variable was. */
3021 DECL_EXTERNAL (sv->var) = DECL_EXTERNAL (var);
3022 TREE_PUBLIC (sv->var) = TREE_PUBLIC (var);
3023 TREE_STATIC (sv->var) = TREE_STATIC (var);
3024 TREE_READONLY (sv->var) = TREE_READONLY (var);
3026 /* Like other memory tags, these need to be marked addressable to
3027 keep is_gimple_reg from thinking they are real. */
3028 TREE_ADDRESSABLE (sv->var) = 1;
3030 DECL_CONTEXT (sv->var) = DECL_CONTEXT (var);
3032 ann = get_var_ann (sv->var);
3033 ann->mem_tag_kind = STRUCT_FIELD;
3034 ann->type_mem_tag = NULL;
3035 add_referenced_tmp_var (sv->var);
3037 lastfotype = currfotype;
3038 lastfooffset = fo->offset;
3039 lastfosize = fosize;
3040 *subvars = sv;
3043 /* Once we have created subvars, the original is no longer call
3044 clobbered on its own. Its call clobbered status depends
3045 completely on the call clobbered status of the subvars.
3047 add_referenced_var in the above loop will take care of
3048 marking subvars of global variables as call clobbered for us
3049 to start, since they are global as well. */
3050 clear_call_clobbered (var);
3053 VEC_free (fieldoff_s, heap, fieldstack);
3057 /* Find the conservative answer to the question of what portions of what
3058 structures are used by this statement. We assume that if we have a
3059 component ref with a known size + offset, that we only need that part
3060 of the structure. For unknown cases, or cases where we do something
3061 to the whole structure, we assume we need to create fields for the
3062 entire structure. */
3064 static tree
3065 find_used_portions (tree *tp, int *walk_subtrees, void *data ATTRIBUTE_UNUSED)
3067 switch (TREE_CODE (*tp))
3069 case COMPONENT_REF:
3071 HOST_WIDE_INT bitsize;
3072 HOST_WIDE_INT bitpos;
3073 tree offset;
3074 enum machine_mode mode;
3075 int unsignedp;
3076 int volatilep;
3077 tree ref;
3078 ref = get_inner_reference (*tp, &bitsize, &bitpos, &offset, &mode,
3079 &unsignedp, &volatilep, false);
3080 if (DECL_P (ref) && offset == NULL && bitsize != -1)
3082 size_t uid = var_ann (ref)->uid;
3083 used_part_t up;
3085 up = get_or_create_used_part_for (uid);
3087 if (bitpos <= up->minused)
3088 up->minused = bitpos;
3089 if ((bitpos + bitsize >= up->maxused))
3090 up->maxused = bitpos + bitsize;
3092 up->explicit_uses = true;
3093 used_portions[uid] = up;
3095 *walk_subtrees = 0;
3096 return NULL_TREE;
3098 else if (DECL_P (ref))
3100 if (DECL_SIZE (ref)
3101 && var_can_have_subvars (ref)
3102 && TREE_CODE (DECL_SIZE (ref)) == INTEGER_CST)
3104 used_part_t up;
3105 size_t uid = var_ann (ref)->uid;
3107 up = get_or_create_used_part_for (uid);
3109 up->minused = 0;
3110 up->maxused = TREE_INT_CST_LOW (DECL_SIZE (ref));
3112 up->implicit_uses = true;
3114 used_portions[uid] = up;
3116 *walk_subtrees = 0;
3117 return NULL_TREE;
3121 break;
3122 /* This is here to make sure we mark the entire base variable as used
3123 when you take its address. Because our used portion analysis is
3124 simple, we aren't looking at casts or pointer arithmetic to see what
3125 happens when you take the address. */
3126 case ADDR_EXPR:
3128 tree var = get_base_address (TREE_OPERAND (*tp, 0));
3130 if (var
3131 && DECL_P (var)
3132 && DECL_SIZE (var)
3133 && var_can_have_subvars (var)
3134 && TREE_CODE (DECL_SIZE (var)) == INTEGER_CST)
3136 used_part_t up;
3137 size_t uid = var_ann (var)->uid;
3139 up = get_or_create_used_part_for (uid);
3141 up->minused = 0;
3142 up->maxused = TREE_INT_CST_LOW (DECL_SIZE (var));
3143 up->implicit_uses = true;
3145 used_portions[uid] = up;
3146 *walk_subtrees = 0;
3147 return NULL_TREE;
3150 break;
3151 case VAR_DECL:
3152 case PARM_DECL:
3154 tree var = *tp;
3155 if (DECL_SIZE (var)
3156 && var_can_have_subvars (var)
3157 && TREE_CODE (DECL_SIZE (var)) == INTEGER_CST)
3159 used_part_t up;
3160 size_t uid = var_ann (var)->uid;
3162 up = get_or_create_used_part_for (uid);
3164 up->minused = 0;
3165 up->maxused = TREE_INT_CST_LOW (DECL_SIZE (var));
3166 up->implicit_uses = true;
3168 used_portions[uid] = up;
3169 *walk_subtrees = 0;
3170 return NULL_TREE;
3173 break;
3175 default:
3176 break;
3179 return NULL_TREE;
3182 /* We are about to create some new referenced variables, and we need the
3183 before size. */
3185 static size_t old_referenced_vars;
3188 /* Create structure field variables for structures used in this function. */
3190 static void
3191 create_structure_vars (void)
3193 basic_block bb;
3194 size_t i;
3196 old_referenced_vars = num_referenced_vars;
3197 used_portions = xcalloc (num_referenced_vars, sizeof (used_part_t));
3199 FOR_EACH_BB (bb)
3201 block_stmt_iterator bsi;
3202 for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
3204 walk_tree_without_duplicates (bsi_stmt_ptr (bsi),
3205 find_used_portions,
3206 NULL);
3209 for (i = 0; i < old_referenced_vars; i++)
3211 tree var = referenced_var (i);
3212 /* The C++ FE creates vars without DECL_SIZE set, for some reason. */
3213 if (var
3214 && DECL_SIZE (var)
3215 && var_can_have_subvars (var)
3216 && var_ann (var)->mem_tag_kind == NOT_A_TAG
3217 && TREE_CODE (DECL_SIZE (var)) == INTEGER_CST)
3218 create_overlap_variables_for (var);
3220 for (i = 0; i < old_referenced_vars; i++)
3221 free (used_portions[i]);
3223 free (used_portions);
3226 static bool
3227 gate_structure_vars (void)
3229 return flag_tree_salias != 0;
3232 struct tree_opt_pass pass_create_structure_vars =
3234 "salias", /* name */
3235 gate_structure_vars, /* gate */
3236 create_structure_vars, /* execute */
3237 NULL, /* sub */
3238 NULL, /* next */
3239 0, /* static_pass_number */
3240 0, /* tv_id */
3241 PROP_cfg, /* properties_required */
3242 0, /* properties_provided */
3243 0, /* properties_destroyed */
3244 0, /* todo_flags_start */
3245 TODO_dump_func, /* todo_flags_finish */
3246 0 /* letter */