1 /* SSA name expresssons routines
2 Copyright (C) 2013-2022 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 ((variable_size)) range_info_def {
51 /* Minimum, maximum and nonzero bits. */
52 TRAILING_WIDE_INT_ACCESSOR (min, ints, 0)
53 TRAILING_WIDE_INT_ACCESSOR (max, ints, 1)
54 TRAILING_WIDE_INT_ACCESSOR (nonzero_bits, ints, 2)
55 trailing_wide_ints <3> ints;
56 };
57
58
59 #define SSANAMES(fun) (fun)->gimple_df->ssa_names
60 #define DEFAULT_DEFS(fun) (fun)->gimple_df->default_defs
61
62 #define num_ssa_names (vec_safe_length (cfun->gimple_df->ssa_names))
63 #define ssa_name(i) ((*cfun->gimple_df->ssa_names)[(i)])
64
65 #define FOR_EACH_SSA_NAME(I, VAR, FN) \
66 for (I = 1; SSANAMES (FN)->iterate (I, &VAR); ++I) \
67 if (VAR)
68
69 /* Sets the value range to SSA. */
70 extern void set_range_info (tree, enum value_range_kind, const wide_int_ref &,
71 const wide_int_ref &);
72 extern void set_range_info (tree, const value_range &);
73 extern void set_nonzero_bits (tree, const wide_int_ref &);
74 extern wide_int get_nonzero_bits (const_tree);
75 extern bool ssa_name_has_boolean_range (tree);
76 extern void init_ssanames (struct function *, int);
77 extern void fini_ssanames (struct function *);
78 extern void ssanames_print_statistics (void);
79 extern tree make_ssa_name_fn (struct function *, tree, gimple *,
80 unsigned int version = 0);
81 extern void init_ssa_name_imm_use (tree);
82 extern void release_ssa_name_fn (struct function *, tree);
83 extern bool get_ptr_info_alignment (struct ptr_info_def *, unsigned int *,
84 unsigned int *);
85 extern void mark_ptr_info_alignment_unknown (struct ptr_info_def *);
86 extern void set_ptr_info_alignment (struct ptr_info_def *, unsigned int,
87 unsigned int);
88 extern void adjust_ptr_info_misalignment (struct ptr_info_def *, poly_uint64);
89 extern struct ptr_info_def *get_ptr_info (tree);
90 extern void set_ptr_nonnull (tree);
91
92 extern tree copy_ssa_name_fn (struct function *, tree, gimple *);
93 extern void duplicate_ssa_name_ptr_info (tree, struct ptr_info_def *);
94 extern tree duplicate_ssa_name_fn (struct function *, tree, gimple *);
95 extern void duplicate_ssa_name_range_info (tree, enum value_range_kind,
96 struct range_info_def *);
97 extern void reset_flow_sensitive_info (tree);
98 extern void reset_flow_sensitive_info_in_bb (basic_block);
99 extern void release_defs (gimple *);
100 extern void replace_ssa_name_symbol (tree, tree);
101 extern void flush_ssaname_freelist (void);
102
103
104 /* Return an SSA_NAME node for variable VAR defined in statement STMT
105 in function cfun. */
106
107 static inline tree
108 make_ssa_name (tree var, gimple *stmt = NULL)
109 {
110 return make_ssa_name_fn (cfun, var, stmt);
111 }
112
113 /* Return an SSA_NAME node using the template SSA name NAME defined in
114 statement STMT in function cfun. */
115
116 static inline tree
117 copy_ssa_name (tree var, gimple *stmt = NULL)
118 {
119 return copy_ssa_name_fn (cfun, var, stmt);
120 }
121
122 /* Creates a duplicate of a SSA name NAME tobe defined by statement STMT
123 in function cfun. */
124
125 static inline tree
duplicate_ssa_name(tree var,gimple * stmt)126 duplicate_ssa_name (tree var, gimple *stmt)
127 {
128 return duplicate_ssa_name_fn (cfun, var, stmt);
129 }
130
131 /* Release the SSA name NAME used in function cfun. */
132
133 static inline void
release_ssa_name(tree name)134 release_ssa_name (tree name)
135 {
136 release_ssa_name_fn (cfun, name);
137 }
138
139 /* Return an anonymous SSA_NAME node for type TYPE defined in statement STMT
140 in function cfun. Arrange so that it uses NAME in dumps. */
141
142 static inline tree
make_temp_ssa_name(tree type,gimple * stmt,const char * name)143 make_temp_ssa_name (tree type, gimple *stmt, const char *name)
144 {
145 tree ssa_name;
146 gcc_checking_assert (TYPE_P (type));
147 ssa_name = make_ssa_name_fn (cfun, type, stmt);
148 SET_SSA_NAME_VAR_OR_IDENTIFIER (ssa_name, get_identifier (name));
149 return ssa_name;
150 }
151
152
153 #endif /* GCC_TREE_SSANAMES_H */
154