1 /* SSA name expresssons routines
2    Copyright (C) 2013-2014 Free Software Foundation, Inc.
3 
4 This file is part of GCC.
5 
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
10 
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  for more details.
15 
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3.  If not see
18 <http://www.gnu.org/licenses/>.  */
19 
20 #ifndef GCC_TREE_SSANAMES_H
21 #define GCC_TREE_SSANAMES_H
22 
23 /* Aliasing information for SSA_NAMEs representing pointer variables.  */
24 
25 struct GTY(()) ptr_info_def
26 {
27   /* The points-to solution.  */
28   struct pt_solution pt;
29 
30   /* Alignment and misalignment of the pointer in bytes.  Together
31      align and misalign specify low known bits of the pointer.
32      ptr & (align - 1) == misalign.  */
33 
34   /* When known, this is the power-of-two byte alignment of the object this
35      pointer points into.  This is usually DECL_ALIGN_UNIT for decls and
36      MALLOC_ABI_ALIGNMENT for allocated storage.  When the alignment is not
37      known, it is zero.  Do not access directly but use functions
38      get_ptr_info_alignment, set_ptr_info_alignment,
39      mark_ptr_info_alignment_unknown and similar.  */
40   unsigned int align;
41 
42   /* When alignment is known, the byte offset this pointer differs from the
43      above alignment.  Access only through the same helper functions as align
44      above.  */
45   unsigned int misalign;
46 };
47 
48 /* Value range information for SSA_NAMEs representing non-pointer variables.  */
49 
50 struct GTY (()) range_info_def {
51   /* Minimum for value range.  */
52   double_int min;
53   /* Maximum for value range.  */
54   double_int max;
55   /* Non-zero bits - bits not set are guaranteed to be always zero.  */
56   double_int nonzero_bits;
57 };
58 
59 
60 #define SSANAMES(fun) (fun)->gimple_df->ssa_names
61 #define DEFAULT_DEFS(fun) (fun)->gimple_df->default_defs
62 
63 #define num_ssa_names (vec_safe_length (cfun->gimple_df->ssa_names))
64 #define ssa_name(i) ((*cfun->gimple_df->ssa_names)[(i)])
65 
66 
67 /* Type of value ranges.  See value_range_d In tree-vrp.c for a
68    description of these types.  */
69 enum value_range_type { VR_UNDEFINED, VR_RANGE, VR_ANTI_RANGE, VR_VARYING };
70 
71 /* Sets the value range to SSA.  */
72 extern void set_range_info (tree, enum value_range_type, double_int,
73 			    double_int);
74 /* Gets the value range from SSA.  */
75 extern enum value_range_type get_range_info (const_tree, double_int *,
76 					     double_int *);
77 extern void set_nonzero_bits (tree, double_int);
78 extern double_int get_nonzero_bits (const_tree);
79 extern void init_ssanames (struct function *, int);
80 extern void fini_ssanames (void);
81 extern void ssanames_print_statistics (void);
82 extern tree make_ssa_name_fn (struct function *, tree, gimple);
83 extern void release_ssa_name_fn (struct function *, tree);
84 extern bool get_ptr_info_alignment (struct ptr_info_def *, unsigned int *,
85 				    unsigned int *);
86 extern void mark_ptr_info_alignment_unknown (struct ptr_info_def *);
87 extern void set_ptr_info_alignment (struct ptr_info_def *, unsigned int,
88 				    unsigned int);
89 extern void adjust_ptr_info_misalignment (struct ptr_info_def *,
90 					  unsigned int);
91 extern struct ptr_info_def *get_ptr_info (tree);
92 
93 extern tree copy_ssa_name_fn (struct function *, tree, gimple);
94 extern void duplicate_ssa_name_ptr_info (tree, struct ptr_info_def *);
95 extern tree duplicate_ssa_name_fn (struct function *, tree, gimple);
96 extern void duplicate_ssa_name_range_info (tree, enum value_range_type,
97 					   struct range_info_def *);
98 extern void release_defs (gimple);
99 extern void replace_ssa_name_symbol (tree, tree);
100 
101 
102 /* Return an SSA_NAME node for variable VAR defined in statement STMT
103    in function cfun.  */
104 
105 static inline tree
make_ssa_name(tree var,gimple stmt)106 make_ssa_name (tree var, gimple stmt)
107 {
108   return make_ssa_name_fn (cfun, var, stmt);
109 }
110 
111 /* Return an SSA_NAME node using the template SSA name NAME defined in
112    statement STMT in function cfun.  */
113 
114 static inline tree
copy_ssa_name(tree var,gimple stmt)115 copy_ssa_name (tree var, gimple stmt)
116 {
117   return copy_ssa_name_fn (cfun, var, stmt);
118 }
119 
120 /*  Creates a duplicate of a SSA name NAME tobe defined by statement STMT
121     in function cfun.  */
122 
123 static inline tree
duplicate_ssa_name(tree var,gimple stmt)124 duplicate_ssa_name (tree var, gimple stmt)
125 {
126   return duplicate_ssa_name_fn (cfun, var, stmt);
127 }
128 
129 /* Release the SSA name NAME used in function cfun.  */
130 
131 static inline void
release_ssa_name(tree name)132 release_ssa_name (tree name)
133 {
134   release_ssa_name_fn (cfun, name);
135 }
136 
137 /* Return an anonymous SSA_NAME node for type TYPE defined in statement STMT
138    in function cfun.  Arrange so that it uses NAME in dumps.  */
139 
140 static inline tree
make_temp_ssa_name(tree type,gimple stmt,const char * name)141 make_temp_ssa_name (tree type, gimple stmt, const char *name)
142 {
143   tree ssa_name;
144   gcc_checking_assert (TYPE_P (type));
145   ssa_name = make_ssa_name_fn (cfun, type, stmt);
146   SET_SSA_NAME_VAR_OR_IDENTIFIER (ssa_name, get_identifier (name));
147   return ssa_name;
148 }
149 
150 
151 #endif /* GCC_TREE_SSANAMES_H */
152