blob: 4fe8d064a477d4aef3741c69d0a419cb844a91a7 [file] [log] [blame]
/* Header file for the GIMPLE fold_using_range interface.
Copyright (C) 2019-2022 Free Software Foundation, Inc.
Contributed by Andrew MacLeod <>
and Aldy Hernandez <>.
This file is part of GCC.
GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
for more details.
You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3. If not see
<>. */
// This file is the main include point for gimple range folding.
// These routines will fold stmt S into the result irange R.
// Any ssa_names on the stmt will be calculated using the range_query
// parameter via a call to range_of_expr.
// If no range_query is provided, current global range info will be used.
// The second variation specifies an edge, and stmt S is recalculated as if
// it appeared on that edge.
// Fold stmt S into range R using range query Q.
bool fold_range (irange &r, gimple *s, range_query *q = NULL);
// Recalculate stmt S into R using range query Q as if it were on edge ON_EDGE.
bool fold_range (irange &r, gimple *s, edge on_edge, range_query *q = NULL);
// These routines the operands to be specified when manually folding.
// Any excess queries will be drawn from the current range_query.
bool fold_range (irange &r, gimple *s, irange &r1);
bool fold_range (irange &r, gimple *s, irange &r1, irange &r2);
bool fold_range (irange &r, gimple *s, unsigned num_elements, irange *vector);
// Return the range_operator pointer for this statement. This routine
// can also be used to gate whether a routine is range-ops enabled.
static inline range_operator *
gimple_range_handler (const gimple *s)
if (const gassign *ass = dyn_cast<const gassign *> (s))
return range_op_handler (gimple_assign_rhs_code (ass),
TREE_TYPE (gimple_assign_lhs (ass)));
if (const gcond *cond = dyn_cast<const gcond *> (s))
return range_op_handler (gimple_cond_code (cond),
TREE_TYPE (gimple_cond_lhs (cond)));
return NULL;
// Return the type of range which statement S calculates. If the type is
// unsupported or no type can be determined, return NULL_TREE.
static inline tree
gimple_range_type (const gimple *s)
tree lhs = gimple_get_lhs (s);
tree type = NULL_TREE;
if (lhs)
type = TREE_TYPE (lhs);
enum gimple_code code = gimple_code (s);
if (code == GIMPLE_COND)
type = boolean_type_node;
else if (code == GIMPLE_PHI)
type = TREE_TYPE (gimple_phi_result (s));
else if (code == GIMPLE_CALL)
type = gimple_call_fntype (s);
// If it has a type, get the return type.
if (type)
type = TREE_TYPE (type);
if (irange::supports_type_p (type))
return type;
return NULL_TREE;
// Return EXP if it is an SSA_NAME with a type supported by gimple ranges.
static inline tree
gimple_range_ssa_p (tree exp)
if (exp && TREE_CODE (exp) == SSA_NAME &&
irange::supports_type_p (TREE_TYPE (exp)))
return exp;
return NULL_TREE;
// Return true if TYPE1 and TYPE2 are compatible range types.
static inline bool
range_compatible_p (tree type1, tree type2)
// types_compatible_p requires conversion in both directions to be useless.
// GIMPLE only requires a cast one way in order to be compatible.
// Ranges really only need the sign and precision to be the same.
return (TYPE_PRECISION (type1) == TYPE_PRECISION (type2)
&& TYPE_SIGN (type1) == TYPE_SIGN (type2));
// Source of all operands for fold_using_range and gori_compute.
// It abstracts out the source of an operand so it can come from a stmt or
// and edge or anywhere a derived class of fur_source wants.
// The default simply picks up ranges from the current range_query.
class fur_source
fur_source (range_query *q = NULL);
inline range_query *query () { return m_query; }
inline class gori_compute *gori () { return m_gori; };
virtual bool get_operand (irange &r, tree expr);
virtual bool get_phi_operand (irange &r, tree expr, edge e);
virtual relation_kind query_relation (tree op1, tree op2);
virtual void register_relation (gimple *stmt, relation_kind k, tree op1,
tree op2);
virtual void register_relation (edge e, relation_kind k, tree op1,
tree op2);
void register_outgoing_edges (gcond *, irange &lhs_range, edge e0, edge e1);
range_query *m_query;
gori_compute *m_gori;
// fur_stmt is the specification for drawing an operand from range_query Q
// via a range_of_Expr call on stmt S.
class fur_stmt : public fur_source
fur_stmt (gimple *s, range_query *q = NULL);
virtual bool get_operand (irange &r, tree expr) OVERRIDE;
virtual bool get_phi_operand (irange &r, tree expr, edge e) OVERRIDE;
virtual relation_kind query_relation (tree op1, tree op2) OVERRIDE;
gimple *m_stmt;
// This version of fur_source will pick a range from a stmt, and also register
// dependencies via a gori_compute object. This is mostly an internal API.
class fur_depend : public fur_stmt
fur_depend (gimple *s, gori_compute *gori, range_query *q = NULL);
virtual void register_relation (gimple *stmt, relation_kind k, tree op1,
tree op2) OVERRIDE;
virtual void register_relation (edge e, relation_kind k, tree op1,
tree op2) OVERRIDE;
relation_oracle *m_oracle;
extern tree gimple_range_operand1 (const gimple *s);
extern tree gimple_range_operand2 (const gimple *s);
// This class uses ranges to fold a gimple statement producinf a range for
// the LHS. The source of all operands is supplied via the fur_source class
// which provides a range_query as well as a source location and any other
// required information.
class fold_using_range
bool fold_stmt (irange &r, gimple *s, class fur_source &src,
tree name = NULL_TREE);
bool range_of_range_op (irange &r, gimple *s, fur_source &src);
bool range_of_call (irange &r, gcall *call, fur_source &src);
bool range_of_cond_expr (irange &r, gassign* cond, fur_source &src);
bool range_of_address (irange &r, gimple *s, fur_source &src);
bool range_of_builtin_call (irange &r, gcall *call, fur_source &src);
void range_of_builtin_ubsan_call (irange &r, gcall *call, tree_code code,
fur_source &src);
bool range_of_phi (irange &r, gphi *phi, fur_source &src);
void range_of_ssa_name_with_loop_info (irange &, tree, class loop *, gphi *,
fur_source &src);
void relation_fold_and_or (irange& lhs_range, gimple *s, fur_source &src);