1/* SSA name expresssons routines
2   Copyright (C) 2013-2020 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15
16You should have received a copy of the GNU General Public License
17along 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
25struct 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
50struct 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.  */
70extern void set_range_info (tree, enum value_range_kind, const wide_int_ref &,
71			    const wide_int_ref &);
72extern void set_range_info (tree, const value_range &);
73/* Gets the value range from SSA.  */
74extern enum value_range_kind get_range_info (const_tree, wide_int *,
75					     wide_int *);
76extern enum value_range_kind get_range_info (const_tree, value_range &);
77extern void set_nonzero_bits (tree, const wide_int_ref &);
78extern wide_int get_nonzero_bits (const_tree);
79extern bool ssa_name_has_boolean_range (tree);
80extern void init_ssanames (struct function *, int);
81extern void fini_ssanames (struct function *);
82extern void ssanames_print_statistics (void);
83extern tree make_ssa_name_fn (struct function *, tree, gimple *,
84			      unsigned int version = 0);
85extern void init_ssa_name_imm_use (tree);
86extern void release_ssa_name_fn (struct function *, tree);
87extern bool get_ptr_info_alignment (struct ptr_info_def *, unsigned int *,
88				    unsigned int *);
89extern void mark_ptr_info_alignment_unknown (struct ptr_info_def *);
90extern void set_ptr_info_alignment (struct ptr_info_def *, unsigned int,
91				    unsigned int);
92extern void adjust_ptr_info_misalignment (struct ptr_info_def *, poly_uint64);
93extern struct ptr_info_def *get_ptr_info (tree);
94extern void set_ptr_nonnull (tree);
95extern bool get_ptr_nonnull (const_tree);
96
97extern tree copy_ssa_name_fn (struct function *, tree, gimple *);
98extern void duplicate_ssa_name_ptr_info (tree, struct ptr_info_def *);
99extern tree duplicate_ssa_name_fn (struct function *, tree, gimple *);
100extern void duplicate_ssa_name_range_info (tree, enum value_range_kind,
101					   struct range_info_def *);
102extern void reset_flow_sensitive_info (tree);
103extern void reset_flow_sensitive_info_in_bb (basic_block);
104extern void release_defs (gimple *);
105extern void replace_ssa_name_symbol (tree, tree);
106extern void flush_ssaname_freelist (void);
107
108
109/* Return an SSA_NAME node for variable VAR defined in statement STMT
110   in function cfun.  */
111
112static inline tree
113make_ssa_name (tree var, gimple *stmt = NULL)
114{
115  return make_ssa_name_fn (cfun, var, stmt);
116}
117
118/* Return an SSA_NAME node using the template SSA name NAME defined in
119   statement STMT in function cfun.  */
120
121static inline tree
122copy_ssa_name (tree var, gimple *stmt = NULL)
123{
124  return copy_ssa_name_fn (cfun, var, stmt);
125}
126
127/*  Creates a duplicate of a SSA name NAME tobe defined by statement STMT
128    in function cfun.  */
129
130static inline tree
131duplicate_ssa_name (tree var, gimple *stmt)
132{
133  return duplicate_ssa_name_fn (cfun, var, stmt);
134}
135
136/* Release the SSA name NAME used in function cfun.  */
137
138static inline void
139release_ssa_name (tree name)
140{
141  release_ssa_name_fn (cfun, name);
142}
143
144/* Return an anonymous SSA_NAME node for type TYPE defined in statement STMT
145   in function cfun.  Arrange so that it uses NAME in dumps.  */
146
147static inline tree
148make_temp_ssa_name (tree type, gimple *stmt, const char *name)
149{
150  tree ssa_name;
151  gcc_checking_assert (TYPE_P (type));
152  ssa_name = make_ssa_name_fn (cfun, type, stmt);
153  SET_SSA_NAME_VAR_OR_IDENTIFIER (ssa_name, get_identifier (name));
154  return ssa_name;
155}
156
157
158#endif /* GCC_TREE_SSANAMES_H */
159