GCC Middle and Back End API Reference
value-query.h
Go to the documentation of this file.
1/* Support routines for value queries.
2 Copyright (C) 2020-2024 Free Software Foundation, Inc.
3 Contributed by Aldy Hernandez <aldyh@redhat.com> and
4 Andrew Macleod <amacleod@redhat.com>.
5
6This file is part of GCC.
7
8GCC is free software; you can redistribute it and/or modify
9it under the terms of the GNU General Public License as published by
10the Free Software Foundation; either version 3, or (at your option)
11any later version.
12
13GCC is distributed in the hope that it will be useful,
14but WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License
19along with GCC; see the file COPYING3. If not see
20<http://www.gnu.org/licenses/>. */
21
22#ifndef GCC_QUERY_H
23#define GCC_QUERY_H
24
25#include "value-relation.h"
26
27// The value_query class is used by optimization passes that require
28// valueizing SSA names in terms of a tree value, but have no need
29// for ranges.
30//
31// value_of_expr must be provided. The default for value_on_edge and
32// value_of_stmt is to call value_of_expr.
33//
34// This implies the valuation is global in nature. If a pass can make
35// use of more specific information, it can override the other queries.
36//
37// Proper usage of the correct query in passes will enable other
38// valuation mechanisms to produce more precise results.
39
40// The range_query class is used by optimization passes which are
41// range aware.
42//
43// range_of_expr must be provided. The default for range_on_edge and
44// range_of_stmt is to call range_of_expr. If a pass can make use of
45// more specific information, then it can override the other queries.
46//
47// The default for the value_* routines is to call the equivalent
48// range_* routines, check if the range is a singleton, and return it
49// if so.
50//
51// The get_value_range method is currently provided for compatibility
52// with vr-values. It will be deprecated when possible.
53
55{
56public:
57 range_query ();
58 virtual ~range_query ();
59
60 virtual tree value_of_expr (tree expr, gimple * = NULL);
61 virtual tree value_on_edge (edge, tree expr);
62 virtual tree value_of_stmt (gimple *, tree name = NULL);
65
66 // These are the range equivalents of the value_* methods. Instead
67 // of returning a singleton, they calculate a range and return it in
68 // R. TRUE is returned on success or FALSE if no range was found.
69 //
70 // Note that range_of_expr must always return TRUE unless ranges are
71 // unsupported for EXPR's type (supports_type_p is false).
72 virtual bool range_of_expr (vrange &r, tree expr, gimple * = NULL) = 0;
73 virtual bool range_on_edge (vrange &r, edge, tree expr);
74 virtual bool range_of_stmt (vrange &r, gimple *, tree name = NULL);
75 virtual bool range_on_entry (vrange &r, basic_block bb, tree expr);
76 virtual bool range_on_exit (vrange &r, basic_block bb, tree expr);
77
78 inline class relation_oracle &relation () const { return *m_relation; }
79 void create_relation_oracle (bool do_trans_p = true);
81
82 inline class infer_range_oracle &infer_oracle () const { return *m_infer; }
83 void create_infer_oracle (bool do_search = TRUE);
85
86 inline class gimple_outgoing_range &gori () const { return *m_gori; }
87 inline class gori_map *gori_ssa () const { return m_map; }
88 void create_gori (int not_executable_flag = 0, int sw_max_edges = INT_MAX);
89 void destroy_gori ();
90
91 virtual void dump (FILE *);
92
93protected:
94 bool get_tree_range (vrange &v, tree expr, gimple *stmt,
95 basic_block bbentry = NULL, basic_block bbexit = NULL);
97 basic_block bbentry, basic_block bbexit);
103 // When multiple related range queries wish to share oracles.
104 // This is an internal interface
105 void share_query (range_query &q);
107
108};
109
110// Global ranges for SSA names using SSA_NAME_RANGE_INFO.
111
113{
114public:
115 bool range_of_expr (vrange &r, tree expr, gimple * = NULL) override;
116};
117
119
120inline range_query *
122{
123 return &global_ranges;
124}
125
126/* Returns the currently active range access class. When there is no active
127 range class, global ranges are used. Never returns null. */
128
129ATTRIBUTE_RETURNS_NONNULL inline range_query *
130get_range_query (const struct function *fun)
131{
132 return (fun && fun->x_range_query) ? fun->x_range_query : &global_ranges;
133}
134
135// Query the global range of NAME in function F. Default to cfun.
136extern void gimple_range_global (vrange &v, tree name,
137 struct function *f = cfun);
138#endif // GCC_QUERY_H
Definition genmatch.cc:845
Definition gimple-range-edge.h:48
Definition value-query.h:113
bool range_of_expr(vrange &r, tree expr, gimple *=NULL) override
Definition value-query.cc:525
Definition gimple-range-gori.h:94
Definition gimple-range-infer.h:56
Definition value-query.h:55
class infer_range_oracle & infer_oracle() const
Definition value-query.h:82
virtual tree value_of_expr(tree expr, gimple *=NULL)
Definition value-query.cc:73
virtual bool range_on_edge(vrange &r, edge, tree expr)
Definition value-query.cc:39
class relation_oracle & relation() const
Definition value-query.h:78
virtual bool range_on_entry(vrange &r, basic_block bb, tree expr)
Definition value-query.cc:45
gimple_outgoing_range * m_gori
Definition value-query.h:101
class gori_map * gori_ssa() const
Definition value-query.h:87
virtual ~range_query()
Definition value-query.cc:274
infer_range_oracle * m_infer
Definition value-query.h:100
void destroy_infer_oracle()
Definition value-query.cc:218
void create_gori(int not_executable_flag=0, int sw_max_edges=INT_MAX)
Definition value-query.cc:188
bool get_arith_expr_range(vrange &r, tree expr, gimple *stmt)
relation_oracle * m_relation
Definition value-query.h:99
virtual bool range_of_expr(vrange &r, tree expr, gimple *=NULL)=0
range_query()
Definition value-query.cc:265
void create_relation_oracle(bool do_trans_p=true)
Definition value-query.cc:230
virtual bool range_of_stmt(vrange &r, gimple *, tree name=NULL)
Definition value-query.cc:57
void share_query(range_query &q)
Definition value-query.cc:256
virtual tree value_on_edge(edge, tree expr)
Definition value-query.cc:98
bool m_shared_copy_p
Definition value-query.h:106
virtual tree value_on_entry(basic_block, tree expr)
Definition value-query.cc:142
gori_map * m_map
Definition value-query.h:102
virtual bool range_on_exit(vrange &r, basic_block bb, tree expr)
Definition value-query.cc:51
virtual tree value_on_exit(basic_block, tree expr)
Definition value-query.cc:161
bool invoke_range_of_expr(vrange &v, tree expr, gimple *stmt, basic_block bbentry, basic_block bbexit)
Definition value-query.cc:290
void destroy_relation_oracle()
Definition value-query.cc:244
virtual void dump(FILE *)
Definition value-query.cc:177
void destroy_gori()
Definition value-query.cc:199
void create_infer_oracle(bool do_search=TRUE)
Definition value-query.cc:210
bool get_tree_range(vrange &v, tree expr, gimple *stmt, basic_block bbentry=NULL, basic_block bbexit=NULL)
Definition value-query.cc:312
virtual tree value_of_stmt(gimple *, tree name=NULL)
Definition value-query.cc:121
class gimple_outgoing_range & gori() const
Definition value-query.h:86
Definition value-relation.h:98
Definition value-range.h:78
class edge_def * edge
Definition coretypes.h:343
union tree_node * tree
Definition coretypes.h:97
#define cfun
Definition function.h:475
#define INT_MAX
Definition glimits.h:85
poly_int< N, C > r
Definition poly-int.h:770
Definition basic-block.h:117
Definition function.h:249
range_query * x_range_query
Definition function.h:314
Definition gimple.h:225
#define NULL
Definition system.h:50
#define TRUE
Definition system.h:898
void gimple_range_global(vrange &v, tree name, struct function *f=cfun)
Definition value-query.cc:468
range_query * get_global_range_query()
Definition value-query.h:121
ATTRIBUTE_RETURNS_NONNULL range_query * get_range_query(const struct function *fun)
Definition value-query.h:130
global_range_query global_ranges
Definition value-query.cc:522