1/* Tree based points-to analysis
2   Copyright (C) 2002, 2003 Free Software Foundation, Inc.
3   Contributed by Daniel Berlin <dberlin@dberlin.org>
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify
8under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2 of the License, or
10(at your option) any later version.
11
12GCC is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; if not, write to the Free Software
19Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
20*/
21
22#ifndef TREE_SSA_STRUCTALIAS_H
23#define TREE_SSA_STRUCTALIAS_H
24
25struct constraint;
26typedef struct constraint *constraint_t;
27
28/* Alias information used by compute_may_aliases and its helpers.  */
29struct alias_info
30{
31  /* SSA names visited while collecting points-to information.  If bit I
32     is set, it means that SSA variable with version I has already been
33     visited.  */
34  sbitmap ssa_names_visited;
35
36  /* Array of SSA_NAME pointers processed by the points-to collector.  */
37  varray_type processed_ptrs;
38
39  /* ADDRESSABLE_VARS contains all the global variables and locals that
40     have had their address taken.  */
41  struct alias_map_d **addressable_vars;
42  size_t num_addressable_vars;
43
44  /* POINTERS contains all the _DECL pointers with unique memory tags
45     that have been referenced in the program.  */
46  struct alias_map_d **pointers;
47  size_t num_pointers;
48
49  /* Number of function calls found in the program.  */
50  size_t num_calls_found;
51
52  /* Number of const/pure function calls found in the program.  */
53  size_t num_pure_const_calls_found;
54
55  /* Array of counters to keep track of how many times each pointer has
56     been dereferenced in the program.  This is used by the alias grouping
57     heuristic in compute_flow_insensitive_aliasing.  */
58  varray_type num_references;
59
60  /* Total number of virtual operands that will be needed to represent
61     all the aliases of all the pointers found in the program.  */
62  long total_alias_vops;
63
64  /* Variables that have been written to.  */
65  bitmap written_vars;
66
67  /* Pointers that have been used in an indirect store operation.  */
68  bitmap dereferenced_ptrs_store;
69
70  /* Pointers that have been used in an indirect load operation.  */
71  bitmap dereferenced_ptrs_load;
72};
73
74/* Keep track of how many times each pointer has been dereferenced in
75   the program using the aux variable.  This is used by the alias
76   grouping heuristic in compute_flow_insensitive_aliasing.  */
77#define NUM_REFERENCES(ANN) ((size_t)((ANN)->common.aux))
78#define NUM_REFERENCES_CLEAR(ANN) ((ANN)->common.aux) = 0
79#define NUM_REFERENCES_INC(ANN) (ANN)->common.aux = (void*) (((size_t)((ANN)->common.aux)) + 1)
80#define NUM_REFERENCES_SET(ANN, VAL) (ANN)->common.aux = (void*) ((void *)(VAL))
81
82/* In tree-ssa-alias.c.  */
83bool is_escape_site (tree, struct alias_info *);
84
85/* In tree-ssa-structalias.c.  */
86extern void compute_points_to_sets (struct alias_info *);
87extern void delete_points_to_sets (void);
88extern void dump_constraint (FILE *, constraint_t);
89extern void dump_constraints (FILE *);
90extern void debug_constraint (constraint_t);
91extern void debug_constraints (void);
92extern void dump_solution_for_var (FILE *, unsigned int);
93extern void debug_solution_for_var (unsigned int);
94extern void dump_sa_points_to_info (FILE *);
95extern void debug_sa_points_to_info (void);
96
97#endif /* TREE_SSA_STRUCTALIAS_H  */
98