1/* SSA name expresssons routines
2   Copyright (C) 2013-2015 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
66/* Type of value ranges.  See value_range_d In tree-vrp.c for a
67   description of these types.  */
68enum value_range_type { VR_UNDEFINED, VR_RANGE, VR_ANTI_RANGE, VR_VARYING };
69
70/* Sets the value range to SSA.  */
71extern void set_range_info (tree, enum value_range_type, const wide_int_ref &,
72			    const wide_int_ref &);
73/* Gets the value range from SSA.  */
74extern enum value_range_type get_range_info (const_tree, wide_int *,
75					     wide_int *);
76extern void set_nonzero_bits (tree, const wide_int_ref &);
77extern wide_int get_nonzero_bits (const_tree);
78extern void init_ssanames (struct function *, int);
79extern void fini_ssanames (void);
80extern void ssanames_print_statistics (void);
81extern tree make_ssa_name_fn (struct function *, tree, gimple);
82extern void release_ssa_name_fn (struct function *, tree);
83extern bool get_ptr_info_alignment (struct ptr_info_def *, unsigned int *,
84				    unsigned int *);
85extern void mark_ptr_info_alignment_unknown (struct ptr_info_def *);
86extern void set_ptr_info_alignment (struct ptr_info_def *, unsigned int,
87				    unsigned int);
88extern void adjust_ptr_info_misalignment (struct ptr_info_def *,
89					  unsigned int);
90extern struct ptr_info_def *get_ptr_info (tree);
91
92extern tree copy_ssa_name_fn (struct function *, tree, gimple);
93extern void duplicate_ssa_name_ptr_info (tree, struct ptr_info_def *);
94extern tree duplicate_ssa_name_fn (struct function *, tree, gimple);
95extern void duplicate_ssa_name_range_info (tree, enum value_range_type,
96					   struct range_info_def *);
97extern void reset_flow_sensitive_info (tree);
98extern void reset_flow_sensitive_info_in_bb (basic_block);
99extern void release_defs (gimple);
100extern void replace_ssa_name_symbol (tree, tree);
101
102
103/* Return an SSA_NAME node for variable VAR defined in statement STMT
104   in function cfun.  */
105
106static inline tree
107make_ssa_name (tree var, gimple stmt = NULL)
108{
109  return make_ssa_name_fn (cfun, var, stmt);
110}
111
112/* Return an SSA_NAME node using the template SSA name NAME defined in
113   statement STMT in function cfun.  */
114
115static inline tree
116copy_ssa_name (tree var, gimple stmt = NULL)
117{
118  return copy_ssa_name_fn (cfun, var, stmt);
119}
120
121/*  Creates a duplicate of a SSA name NAME tobe defined by statement STMT
122    in function cfun.  */
123
124static inline tree
125duplicate_ssa_name (tree var, gimple stmt)
126{
127  return duplicate_ssa_name_fn (cfun, var, stmt);
128}
129
130/* Release the SSA name NAME used in function cfun.  */
131
132static inline void
133release_ssa_name (tree name)
134{
135  release_ssa_name_fn (cfun, name);
136}
137
138/* Return an anonymous SSA_NAME node for type TYPE defined in statement STMT
139   in function cfun.  Arrange so that it uses NAME in dumps.  */
140
141static inline tree
142make_temp_ssa_name (tree type, gimple stmt, const char *name)
143{
144  tree ssa_name;
145  gcc_checking_assert (TYPE_P (type));
146  ssa_name = make_ssa_name_fn (cfun, type, stmt);
147  SET_SSA_NAME_VAR_OR_IDENTIFIER (ssa_name, get_identifier (name));
148  return ssa_name;
149}
150
151
152#endif /* GCC_TREE_SSANAMES_H */
153