c++: ICE on anon struct with base [PR96636]
[official-gcc.git] / gcc / gimple-range-gori.cc
blobc124b3c1ce495d491df55ca5cbea7aae12953732
1 /* Gimple range GORI functions.
2 Copyright (C) 2017-2021 Free Software Foundation, Inc.
3 Contributed by Andrew MacLeod <amacleod@redhat.com>
4 and Aldy Hernandez <aldyh@redhat.com>.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 any later version.
13 GCC is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
22 #include "config.h"
23 #include "system.h"
24 #include "coretypes.h"
25 #include "backend.h"
26 #include "tree.h"
27 #include "gimple.h"
28 #include "ssa.h"
29 #include "gimple-pretty-print.h"
30 #include "gimple-range.h"
32 // Calculate what we can determine of the range of this unary
33 // statement's operand if the lhs of the expression has the range
34 // LHS_RANGE. Return false if nothing can be determined.
36 bool
37 gimple_range_calc_op1 (irange &r, const gimple *stmt, const irange &lhs_range)
39 gcc_checking_assert (gimple_num_ops (stmt) < 3);
41 // An empty range is viral.
42 tree type = TREE_TYPE (gimple_range_operand1 (stmt));
43 if (lhs_range.undefined_p ())
45 r.set_undefined ();
46 return true;
48 // Unary operations require the type of the first operand in the
49 // second range position.
50 int_range<2> type_range (type);
51 return gimple_range_handler (stmt)->op1_range (r, type, lhs_range,
52 type_range);
55 // Calculate what we can determine of the range of this statement's
56 // first operand if the lhs of the expression has the range LHS_RANGE
57 // and the second operand has the range OP2_RANGE. Return false if
58 // nothing can be determined.
60 bool
61 gimple_range_calc_op1 (irange &r, const gimple *stmt,
62 const irange &lhs_range, const irange &op2_range)
64 // Unary operation are allowed to pass a range in for second operand
65 // as there are often additional restrictions beyond the type which
66 // can be imposed. See operator_cast::op1_range().
67 tree type = TREE_TYPE (gimple_range_operand1 (stmt));
68 // An empty range is viral.
69 if (op2_range.undefined_p () || lhs_range.undefined_p ())
71 r.set_undefined ();
72 return true;
74 return gimple_range_handler (stmt)->op1_range (r, type, lhs_range,
75 op2_range);
78 // Calculate what we can determine of the range of this statement's
79 // second operand if the lhs of the expression has the range LHS_RANGE
80 // and the first operand has the range OP1_RANGE. Return false if
81 // nothing can be determined.
83 bool
84 gimple_range_calc_op2 (irange &r, const gimple *stmt,
85 const irange &lhs_range, const irange &op1_range)
87 tree type = TREE_TYPE (gimple_range_operand2 (stmt));
88 // An empty range is viral.
89 if (op1_range.undefined_p () || lhs_range.undefined_p ())
91 r.set_undefined ();
92 return true;
94 return gimple_range_handler (stmt)->op2_range (r, type, lhs_range,
95 op1_range);
98 // Return TRUE if GS is a logical && or || expression.
100 static inline bool
101 is_gimple_logical_p (const gimple *gs)
103 // Look for boolean and/or condition.
104 if (is_gimple_assign (gs))
105 switch (gimple_expr_code (gs))
107 case TRUTH_AND_EXPR:
108 case TRUTH_OR_EXPR:
109 return true;
111 case BIT_AND_EXPR:
112 case BIT_IOR_EXPR:
113 // Bitwise operations on single bits are logical too.
114 if (types_compatible_p (TREE_TYPE (gimple_assign_rhs1 (gs)),
115 boolean_type_node))
116 return true;
117 break;
119 default:
120 break;
122 return false;
125 /* RANGE_DEF_CHAIN is used to determine which SSA names in a block can
126 have range information calculated for them, and what the
127 dependencies on each other are.
129 Information for a basic block is calculated once and stored. It is
130 only calculated the first time a query is made, so if no queries
131 are made, there is little overhead.
133 The def_chain bitmap is indexed by SSA_NAME_VERSION. Bits are set
134 within this bitmap to indicate SSA names that are defined in the
135 SAME block and used to calculate this SSA name.
138 <bb 2> :
139 _1 = x_4(D) + -2;
140 _2 = _1 * 4;
141 j_7 = foo ();
142 q_5 = _2 + 3;
143 if (q_5 <= 13)
145 _1 : x_4(D)
146 _2 : 1 x_4(D)
147 q_5 : _1 _2 x_4(D)
149 This dump indicates the bits set in the def_chain vector.
150 as well as demonstrates the def_chain bits for the related ssa_names.
152 Checking the chain for _2 indicates that _1 and x_4 are used in
153 its evaluation.
155 Def chains also only include statements which are valid gimple
156 so a def chain will only span statements for which the range
157 engine implements operations for. */
160 // Construct a range_def_chain.
162 range_def_chain::range_def_chain ()
164 bitmap_obstack_initialize (&m_bitmaps);
165 m_def_chain.create (0);
166 m_def_chain.safe_grow_cleared (num_ssa_names);
167 m_logical_depth = 0;
170 // Destruct a range_def_chain.
172 range_def_chain::~range_def_chain ()
174 m_def_chain.release ();
175 bitmap_obstack_release (&m_bitmaps);
178 // Return true if NAME is in the def chain of DEF. If BB is provided,
179 // only return true if the defining statement of DEF is in BB.
181 bool
182 range_def_chain::in_chain_p (tree name, tree def)
184 gcc_checking_assert (gimple_range_ssa_p (def));
185 gcc_checking_assert (gimple_range_ssa_p (name));
187 // Get the defintion chain for DEF.
188 bitmap chain = get_def_chain (def);
190 if (chain == NULL)
191 return false;
192 return bitmap_bit_p (chain, SSA_NAME_VERSION (name));
195 // Add either IMP or the import list B to the import set of DATA.
197 void
198 range_def_chain::set_import (struct rdc &data, tree imp, bitmap b)
200 // If there are no imports, just return
201 if (imp == NULL_TREE && !b)
202 return;
203 if (!data.m_import)
204 data.m_import = BITMAP_ALLOC (&m_bitmaps);
205 if (imp != NULL_TREE)
206 bitmap_set_bit (data.m_import, SSA_NAME_VERSION (imp));
207 else
208 bitmap_ior_into (data.m_import, b);
211 // Return the import list for NAME.
213 bitmap
214 range_def_chain::get_imports (tree name)
216 if (!has_def_chain (name))
217 get_def_chain (name);
218 bitmap i = m_def_chain[SSA_NAME_VERSION (name)].m_import;
219 // Either this is a default def, OR imports must be a subset of exports.
220 gcc_checking_assert (!get_def_chain (name) || !i
221 || !bitmap_intersect_compl_p (i, get_def_chain (name)));
222 return i;
225 // Return true if IMPORT is an import to NAMEs def chain.
227 bool
228 range_def_chain::chain_import_p (tree name, tree import)
230 bitmap b = get_imports (name);
231 if (b)
232 return bitmap_bit_p (b, SSA_NAME_VERSION (import));
233 return false;
236 // Build def_chains for NAME if it is in BB. Copy the def chain into RESULT.
238 void
239 range_def_chain::register_dependency (tree name, tree dep, basic_block bb)
241 if (!gimple_range_ssa_p (dep))
242 return;
244 unsigned v = SSA_NAME_VERSION (name);
245 if (v >= m_def_chain.length ())
246 m_def_chain.safe_grow_cleared (num_ssa_names + 1);
247 struct rdc &src = m_def_chain[v];
248 gimple *def_stmt = SSA_NAME_DEF_STMT (dep);
249 unsigned dep_v = SSA_NAME_VERSION (dep);
250 bitmap b;
252 // Set the direct dependency cache entries.
253 if (!src.ssa1)
254 src.ssa1 = dep;
255 else if (!src.ssa2 && src.ssa1 != dep)
256 src.ssa2 = dep;
258 // Don't calculate imports or export/dep chains if BB is not provided.
259 // This is usually the case for when the temporal cache wants the direct
260 // dependencies of a stmt.
261 if (!bb)
262 return;
264 if (!src.bm)
265 src.bm = BITMAP_ALLOC (&m_bitmaps);
267 // Add this operand into the result.
268 bitmap_set_bit (src.bm, dep_v);
270 if (gimple_bb (def_stmt) == bb && !is_a<gphi *>(def_stmt))
272 // Get the def chain for the operand.
273 b = get_def_chain (dep);
274 // If there was one, copy it into result.
275 if (b)
276 bitmap_ior_into (src.bm, b);
277 // And copy the import list.
278 set_import (src, NULL_TREE, get_imports (dep));
280 else
281 // Originated outside the block, so it is an import.
282 set_import (src, dep, NULL);
285 bool
286 range_def_chain::def_chain_in_bitmap_p (tree name, bitmap b)
288 bitmap a = get_def_chain (name);
289 if (a && b)
290 return bitmap_intersect_p (a, b);
291 return false;
294 void
295 range_def_chain::add_def_chain_to_bitmap (bitmap b, tree name)
297 bitmap r = get_def_chain (name);
298 if (r)
299 bitmap_ior_into (b, r);
303 // Return TRUE if NAME has been processed for a def_chain.
305 inline bool
306 range_def_chain::has_def_chain (tree name)
308 // Ensure there is an entry in the internal vector.
309 unsigned v = SSA_NAME_VERSION (name);
310 if (v >= m_def_chain.length ())
311 m_def_chain.safe_grow_cleared (num_ssa_names + 1);
312 return (m_def_chain[v].ssa1 != 0);
317 // Calculate the def chain for NAME and all of its dependent
318 // operands. Only using names in the same BB. Return the bitmap of
319 // all names in the m_def_chain. This only works for supported range
320 // statements.
322 bitmap
323 range_def_chain::get_def_chain (tree name)
325 tree ssa1, ssa2, ssa3;
326 unsigned v = SSA_NAME_VERSION (name);
327 bool is_logical = false;
329 // If it has already been processed, just return the cached value.
330 if (has_def_chain (name))
331 return m_def_chain[v].bm;
333 // No definition chain for default defs.
334 if (SSA_NAME_IS_DEFAULT_DEF (name))
336 // A Default def is always an import.
337 set_import (m_def_chain[v], name, NULL);
338 return NULL;
341 gimple *stmt = SSA_NAME_DEF_STMT (name);
342 if (gimple_range_handler (stmt))
344 is_logical = is_gimple_logical_p (stmt);
345 // Terminate the def chains if we see too many cascading logical stmts.
346 if (is_logical)
348 if (m_logical_depth == param_ranger_logical_depth)
349 return NULL;
350 m_logical_depth++;
353 ssa1 = gimple_range_ssa_p (gimple_range_operand1 (stmt));
354 ssa2 = gimple_range_ssa_p (gimple_range_operand2 (stmt));
355 ssa3 = NULL_TREE;
357 else if (is_a<gassign *> (stmt)
358 && gimple_assign_rhs_code (stmt) == COND_EXPR)
360 gassign *st = as_a<gassign *> (stmt);
361 ssa1 = gimple_range_ssa_p (gimple_assign_rhs1 (st));
362 ssa2 = gimple_range_ssa_p (gimple_assign_rhs2 (st));
363 ssa3 = gimple_range_ssa_p (gimple_assign_rhs3 (st));
365 else
367 // Stmts not understood are always imports.
368 set_import (m_def_chain[v], name, NULL);
369 return NULL;
372 register_dependency (name, ssa1, gimple_bb (stmt));
373 register_dependency (name, ssa2, gimple_bb (stmt));
374 register_dependency (name, ssa3, gimple_bb (stmt));
375 // Stmts with no understandable operands are also imports.
376 if (!ssa1 && !ssa2 & !ssa3)
377 set_import (m_def_chain[v], name, NULL);
379 if (is_logical)
380 m_logical_depth--;
382 return m_def_chain[v].bm;
385 // Dump what we know for basic block BB to file F.
387 void
388 range_def_chain::dump (FILE *f, basic_block bb, const char *prefix)
390 unsigned x, y;
391 bitmap_iterator bi;
393 // Dump the def chain for each SSA_NAME defined in BB.
394 for (x = 1; x < num_ssa_names; x++)
396 tree name = ssa_name (x);
397 if (!name)
398 continue;
399 gimple *stmt = SSA_NAME_DEF_STMT (name);
400 if (!stmt || (bb && gimple_bb (stmt) != bb))
401 continue;
402 bitmap chain = (has_def_chain (name) ? get_def_chain (name) : NULL);
403 if (chain && !bitmap_empty_p (chain))
405 fprintf (f, prefix);
406 print_generic_expr (f, name, TDF_SLIM);
407 fprintf (f, " : ");
409 bitmap imports = get_imports (name);
410 EXECUTE_IF_SET_IN_BITMAP (chain, 0, y, bi)
412 print_generic_expr (f, ssa_name (y), TDF_SLIM);
413 if (imports && bitmap_bit_p (imports, y))
414 fprintf (f, "(I)");
415 fprintf (f, " ");
417 fprintf (f, "\n");
423 // -------------------------------------------------------------------
425 /* GORI_MAP is used to accumulate what SSA names in a block can
426 generate range information, and provides tools for the block ranger
427 to enable it to efficiently calculate these ranges.
429 GORI stands for "Generates Outgoing Range Information."
431 It utilizes the range_def_chain class to contruct def_chains.
432 Information for a basic block is calculated once and stored. It is
433 only calculated the first time a query is made. If no queries are
434 made, there is little overhead.
436 one bitmap is maintained for each basic block:
437 m_outgoing : a set bit indicates a range can be generated for a name.
439 Generally speaking, the m_outgoing vector is the union of the
440 entire def_chain of all SSA names used in the last statement of the
441 block which generate ranges. */
444 // Initialize a gori-map structure.
446 gori_map::gori_map ()
448 m_outgoing.create (0);
449 m_outgoing.safe_grow_cleared (last_basic_block_for_fn (cfun));
450 m_incoming.create (0);
451 m_incoming.safe_grow_cleared (last_basic_block_for_fn (cfun));
452 m_maybe_variant = BITMAP_ALLOC (&m_bitmaps);
455 // Free any memory the GORI map allocated.
457 gori_map::~gori_map ()
459 m_incoming.release ();
460 m_outgoing.release ();
463 // Return the bitmap vector of all export from BB. Calculate if necessary.
465 bitmap
466 gori_map::exports (basic_block bb)
468 if (bb->index >= (signed int)m_outgoing.length () || !m_outgoing[bb->index])
469 calculate_gori (bb);
470 return m_outgoing[bb->index];
473 // Return the bitmap vector of all imports to BB. Calculate if necessary.
475 bitmap
476 gori_map::imports (basic_block bb)
478 if (bb->index >= (signed int)m_outgoing.length () || !m_outgoing[bb->index])
479 calculate_gori (bb);
480 return m_incoming[bb->index];
483 // Return true if NAME is can have ranges generated for it from basic
484 // block BB.
486 bool
487 gori_map::is_export_p (tree name, basic_block bb)
489 // If no BB is specified, test if it is exported anywhere in the IL.
490 if (!bb)
491 return bitmap_bit_p (m_maybe_variant, SSA_NAME_VERSION (name));
492 return bitmap_bit_p (exports (bb), SSA_NAME_VERSION (name));
495 // Clear the m_maybe_variant bit so ranges will not be tracked for NAME.
497 void
498 gori_map::set_range_invariant (tree name)
500 bitmap_clear_bit (m_maybe_variant, SSA_NAME_VERSION (name));
503 // Return true if NAME is an import to block BB.
505 bool
506 gori_map::is_import_p (tree name, basic_block bb)
508 // If no BB is specified, test if it is exported anywhere in the IL.
509 return bitmap_bit_p (imports (bb), SSA_NAME_VERSION (name));
512 // If NAME is non-NULL and defined in block BB, calculate the def
513 // chain and add it to m_outgoing.
515 void
516 gori_map::maybe_add_gori (tree name, basic_block bb)
518 if (name)
520 // Check if there is a def chain, regardless of the block.
521 add_def_chain_to_bitmap (m_outgoing[bb->index], name);
522 // Check for any imports.
523 bitmap imp = get_imports (name);
524 // If there were imports, add them so we can recompute
525 if (imp)
526 bitmap_ior_into (m_incoming[bb->index], imp);
527 // This name is always an import.
528 if (gimple_bb (SSA_NAME_DEF_STMT (name)) != bb)
529 bitmap_set_bit (m_incoming[bb->index], SSA_NAME_VERSION (name));
531 // Def chain doesn't include itself, and even if there isn't a
532 // def chain, this name should be added to exports.
533 bitmap_set_bit (m_outgoing[bb->index], SSA_NAME_VERSION (name));
537 // Calculate all the required information for BB.
539 void
540 gori_map::calculate_gori (basic_block bb)
542 tree name;
543 if (bb->index >= (signed int)m_outgoing.length ())
545 m_outgoing.safe_grow_cleared (last_basic_block_for_fn (cfun));
546 m_incoming.safe_grow_cleared (last_basic_block_for_fn (cfun));
548 gcc_checking_assert (m_outgoing[bb->index] == NULL);
549 m_outgoing[bb->index] = BITMAP_ALLOC (&m_bitmaps);
550 m_incoming[bb->index] = BITMAP_ALLOC (&m_bitmaps);
552 // If this block's last statement may generate range informaiton, go
553 // calculate it.
554 gimple *stmt = gimple_outgoing_range_stmt_p (bb);
555 if (!stmt)
556 return;
557 if (is_a<gcond *> (stmt))
559 gcond *gc = as_a<gcond *>(stmt);
560 name = gimple_range_ssa_p (gimple_cond_lhs (gc));
561 maybe_add_gori (name, gimple_bb (stmt));
563 name = gimple_range_ssa_p (gimple_cond_rhs (gc));
564 maybe_add_gori (name, gimple_bb (stmt));
566 else
568 gswitch *gs = as_a<gswitch *>(stmt);
569 name = gimple_range_ssa_p (gimple_switch_index (gs));
570 maybe_add_gori (name, gimple_bb (stmt));
572 // Add this bitmap to the aggregate list of all outgoing names.
573 bitmap_ior_into (m_maybe_variant, m_outgoing[bb->index]);
576 // Dump the table information for BB to file F.
578 void
579 gori_map::dump (FILE *f, basic_block bb, bool verbose)
581 // BB was not processed.
582 if (!m_outgoing[bb->index] || bitmap_empty_p (m_outgoing[bb->index]))
583 return;
585 tree name;
587 bitmap imp = imports (bb);
588 if (!bitmap_empty_p (imp))
590 if (verbose)
591 fprintf (f, "bb<%u> Imports: ",bb->index);
592 else
593 fprintf (f, "Imports: ");
594 FOR_EACH_GORI_IMPORT_NAME (*this, bb, name)
596 print_generic_expr (f, name, TDF_SLIM);
597 fprintf (f, " ");
599 fputc ('\n', f);
602 if (verbose)
603 fprintf (f, "bb<%u> Exports: ",bb->index);
604 else
605 fprintf (f, "Exports: ");
606 // Dump the export vector.
607 FOR_EACH_GORI_EXPORT_NAME (*this, bb, name)
609 print_generic_expr (f, name, TDF_SLIM);
610 fprintf (f, " ");
612 fputc ('\n', f);
614 range_def_chain::dump (f, bb, " ");
617 // Dump the entire GORI map structure to file F.
619 void
620 gori_map::dump (FILE *f)
622 basic_block bb;
623 FOR_EACH_BB_FN (bb, cfun)
624 dump (f, bb);
627 DEBUG_FUNCTION void
628 debug (gori_map &g)
630 g.dump (stderr);
633 // -------------------------------------------------------------------
635 // Construct a gori_compute object.
637 gori_compute::gori_compute ()
639 // Create a boolean_type true and false range.
640 m_bool_zero = int_range<2> (boolean_false_node, boolean_false_node);
641 m_bool_one = int_range<2> (boolean_true_node, boolean_true_node);
644 // Given the switch S, return an evaluation in R for NAME when the lhs
645 // evaluates to LHS. Returning false means the name being looked for
646 // was not resolvable.
648 bool
649 gori_compute::compute_operand_range_switch (irange &r, gswitch *s,
650 const irange &lhs,
651 tree name, fur_source &src)
653 tree op1 = gimple_switch_index (s);
655 // If name matches, the range is simply the range from the edge.
656 // Empty ranges are viral as they are on a path which isn't
657 // executable.
658 if (op1 == name || lhs.undefined_p ())
660 r = lhs;
661 return true;
664 // If op1 is in the defintion chain, pass lhs back.
665 if (gimple_range_ssa_p (op1) && in_chain_p (name, op1))
666 return compute_operand_range (r, SSA_NAME_DEF_STMT (op1), lhs, name, src);
668 return false;
672 // Return an evaluation for NAME as it would appear in STMT when the
673 // statement's lhs evaluates to LHS. If successful, return TRUE and
674 // store the evaluation in R, otherwise return FALSE.
676 bool
677 gori_compute::compute_operand_range (irange &r, gimple *stmt,
678 const irange &lhs, tree name,
679 fur_source &src)
681 // If the lhs doesn't tell us anything, neither will unwinding further.
682 if (lhs.varying_p ())
683 return false;
685 // Empty ranges are viral as they are on an unexecutable path.
686 if (lhs.undefined_p ())
688 r.set_undefined ();
689 return true;
691 if (is_a<gswitch *> (stmt))
692 return compute_operand_range_switch (r, as_a<gswitch *> (stmt), lhs, name,
693 src);
694 if (!gimple_range_handler (stmt))
695 return false;
697 tree op1 = gimple_range_ssa_p (gimple_range_operand1 (stmt));
698 tree op2 = gimple_range_ssa_p (gimple_range_operand2 (stmt));
700 // Handle end of lookup first.
701 if (op1 == name)
702 return compute_operand1_range (r, stmt, lhs, name, src);
703 if (op2 == name)
704 return compute_operand2_range (r, stmt, lhs, name, src);
706 // NAME is not in this stmt, but one of the names in it ought to be
707 // derived from it.
708 bool op1_in_chain = op1 && in_chain_p (name, op1);
709 bool op2_in_chain = op2 && in_chain_p (name, op2);
711 // If neither operand is derived, then this stmt tells us nothing.
712 if (!op1_in_chain && !op2_in_chain)
713 return false;
715 // Process logicals as they have special handling.
716 if (is_gimple_logical_p (stmt))
718 int_range_max op1_trange, op1_frange;
719 int_range_max op2_trange, op2_frange;
720 compute_logical_operands (op1_trange, op1_frange, stmt, lhs,
721 name, src, op1, op1_in_chain);
722 compute_logical_operands (op2_trange, op2_frange, stmt, lhs,
723 name, src, op2, op2_in_chain);
724 return logical_combine (r, gimple_expr_code (stmt), lhs,
725 op1_trange, op1_frange, op2_trange, op2_frange);
728 // Follow the appropriate operands now.
729 if (op1_in_chain && op2_in_chain)
730 return compute_operand1_and_operand2_range (r, stmt, lhs, name, src);
731 if (op1_in_chain)
732 return compute_operand1_range (r, stmt, lhs, name, src);
733 if (op2_in_chain)
734 return compute_operand2_range (r, stmt, lhs, name, src);
736 // If neither operand is derived, this statement tells us nothing.
737 return false;
741 // Return TRUE if range R is either a true or false compatible range.
743 static bool
744 range_is_either_true_or_false (const irange &r)
746 if (r.undefined_p ())
747 return false;
749 // This is complicated by the fact that Ada has multi-bit booleans,
750 // so true can be ~[0, 0] (i.e. [1,MAX]).
751 tree type = r.type ();
752 gcc_checking_assert (range_compatible_p (type, boolean_type_node));
753 return (r.singleton_p () || !r.contains_p (build_zero_cst (type)));
756 // Evaluate a binary logical expression by combining the true and
757 // false ranges for each of the operands based on the result value in
758 // the LHS.
760 bool
761 gori_compute::logical_combine (irange &r, enum tree_code code,
762 const irange &lhs,
763 const irange &op1_true, const irange &op1_false,
764 const irange &op2_true, const irange &op2_false)
766 if (op1_true.varying_p () && op1_false.varying_p ()
767 && op2_true.varying_p () && op2_false.varying_p ())
768 return false;
770 // This is not a simple fold of a logical expression, rather it
771 // determines ranges which flow through the logical expression.
773 // Assuming x_8 is an unsigned char, and relational statements:
774 // b_1 = x_8 < 20
775 // b_2 = x_8 > 5
776 // consider the logical expression and branch:
777 // c_2 = b_1 && b_2
778 // if (c_2)
780 // To determine the range of x_8 on either edge of the branch, one
781 // must first determine what the range of x_8 is when the boolean
782 // values of b_1 and b_2 are both true and false.
783 // b_1 TRUE x_8 = [0, 19]
784 // b_1 FALSE x_8 = [20, 255]
785 // b_2 TRUE x_8 = [6, 255]
786 // b_2 FALSE x_8 = [0,5].
788 // These ranges are then combined based on the expected outcome of
789 // the branch. The range on the TRUE side of the branch must satisfy
790 // b_1 == true && b_2 == true
792 // In terms of x_8, that means both x_8 == [0, 19] and x_8 = [6, 255]
793 // must be true. The range of x_8 on the true side must be the
794 // intersection of both ranges since both must be true. Thus the
795 // range of x_8 on the true side is [6, 19].
797 // To determine the ranges on the FALSE side, all 3 combinations of
798 // failing ranges must be considered, and combined as any of them
799 // can cause the false result.
801 // If the LHS can be TRUE or FALSE, then evaluate both a TRUE and
802 // FALSE results and combine them. If we fell back to VARYING any
803 // range restrictions that have been discovered up to this point
804 // would be lost.
805 if (!range_is_either_true_or_false (lhs))
807 int_range_max r1;
808 if (logical_combine (r1, code, m_bool_zero, op1_true, op1_false,
809 op2_true, op2_false)
810 && logical_combine (r, code, m_bool_one, op1_true, op1_false,
811 op2_true, op2_false))
813 r.union_ (r1);
814 return true;
816 return false;
819 switch (code)
821 // A logical AND combines ranges from 2 boolean conditions.
822 // c_2 = b_1 && b_2
823 case TRUTH_AND_EXPR:
824 case BIT_AND_EXPR:
825 if (!lhs.zero_p ())
827 // The TRUE side is the intersection of the the 2 true ranges.
828 r = op1_true;
829 r.intersect (op2_true);
831 else
833 // The FALSE side is the union of the other 3 cases.
834 int_range_max ff (op1_false);
835 ff.intersect (op2_false);
836 int_range_max tf (op1_true);
837 tf.intersect (op2_false);
838 int_range_max ft (op1_false);
839 ft.intersect (op2_true);
840 r = ff;
841 r.union_ (tf);
842 r.union_ (ft);
844 break;
845 // A logical OR combines ranges from 2 boolean conditons.
846 // c_2 = b_1 || b_2
847 case TRUTH_OR_EXPR:
848 case BIT_IOR_EXPR:
849 if (lhs.zero_p ())
851 // An OR operation will only take the FALSE path if both
852 // operands are false simlulateously, which means they should
853 // be intersected. !(x || y) == !x && !y
854 r = op1_false;
855 r.intersect (op2_false);
857 else
859 // The TRUE side of an OR operation will be the union of
860 // the other three combinations.
861 int_range_max tt (op1_true);
862 tt.intersect (op2_true);
863 int_range_max tf (op1_true);
864 tf.intersect (op2_false);
865 int_range_max ft (op1_false);
866 ft.intersect (op2_true);
867 r = tt;
868 r.union_ (tf);
869 r.union_ (ft);
871 break;
872 default:
873 gcc_unreachable ();
876 return true;
880 // Given a logical STMT, calculate true and false ranges for each
881 // potential path of NAME, assuming NAME came through the OP chain if
882 // OP_IN_CHAIN is true.
884 void
885 gori_compute::compute_logical_operands (irange &true_range, irange &false_range,
886 gimple *stmt,
887 const irange &lhs,
888 tree name, fur_source &src,
889 tree op, bool op_in_chain)
891 gimple *src_stmt = gimple_range_ssa_p (op) ? SSA_NAME_DEF_STMT (op) : NULL;
892 if (!op_in_chain || !src_stmt || chain_import_p (gimple_get_lhs (stmt), op))
894 // If op is not in the def chain, or defined in this block,
895 // use its known value on entry to the block.
896 src.get_operand (true_range, name);
897 false_range = true_range;
898 return;
901 enum tree_code code = gimple_expr_code (stmt);
902 // Optimize [0 = x | y], since neither operand can ever be non-zero.
903 if ((code == BIT_IOR_EXPR || code == TRUTH_OR_EXPR) && lhs.zero_p ())
905 if (!compute_operand_range (false_range, src_stmt, m_bool_zero, name,
906 src))
907 src.get_operand (false_range, name);
908 true_range = false_range;
909 return;
912 // Optimize [1 = x & y], since neither operand can ever be zero.
913 if ((code == BIT_AND_EXPR || code == TRUTH_AND_EXPR) && lhs == m_bool_one)
915 if (!compute_operand_range (true_range, src_stmt, m_bool_one, name, src))
916 src.get_operand (true_range, name);
917 false_range = true_range;
918 return;
921 // Calculate ranges for true and false on both sides, since the false
922 // path is not always a simple inversion of the true side.
923 if (!compute_operand_range (true_range, src_stmt, m_bool_one, name, src))
924 src.get_operand (true_range, name);
925 if (!compute_operand_range (false_range, src_stmt, m_bool_zero, name, src))
926 src.get_operand (false_range, name);
929 // Calculate a range for NAME from the operand 1 position of STMT
930 // assuming the result of the statement is LHS. Return the range in
931 // R, or false if no range could be calculated.
933 bool
934 gori_compute::compute_operand1_range (irange &r, gimple *stmt,
935 const irange &lhs, tree name,
936 fur_source &src)
938 int_range_max op1_range, op2_range;
939 tree op1 = gimple_range_operand1 (stmt);
940 tree op2 = gimple_range_operand2 (stmt);
942 // Fetch the known range for op1 in this block.
943 src.get_operand (op1_range, op1);
945 // Now range-op calcuate and put that result in r.
946 if (op2)
948 src.get_operand (op2_range, op2);
949 if (!gimple_range_calc_op1 (r, stmt, lhs, op2_range))
950 return false;
952 else
954 // We pass op1_range to the unary operation. Nomally it's a
955 // hidden range_for_type parameter, but sometimes having the
956 // actual range can result in better information.
957 if (!gimple_range_calc_op1 (r, stmt, lhs, op1_range))
958 return false;
961 // Intersect the calculated result with the known result and return if done.
962 if (op1 == name)
964 r.intersect (op1_range);
965 return true;
967 // If the calculation continues, we're using op1_range as the new LHS.
968 op1_range.intersect (r);
970 gimple *src_stmt = SSA_NAME_DEF_STMT (op1);
971 gcc_checking_assert (src_stmt);
973 // Then feed this range back as the LHS of the defining statement.
974 return compute_operand_range (r, src_stmt, op1_range, name, src);
978 // Calculate a range for NAME from the operand 2 position of S
979 // assuming the result of the statement is LHS. Return the range in
980 // R, or false if no range could be calculated.
982 bool
983 gori_compute::compute_operand2_range (irange &r, gimple *stmt,
984 const irange &lhs, tree name,
985 fur_source &src)
987 int_range_max op1_range, op2_range;
988 tree op1 = gimple_range_operand1 (stmt);
989 tree op2 = gimple_range_operand2 (stmt);
991 src.get_operand (op1_range, op1);
992 src.get_operand (op2_range, op2);
994 // Intersect with range for op2 based on lhs and op1.
995 if (!gimple_range_calc_op2 (r, stmt, lhs, op1_range))
996 return false;
998 // Intersect the calculated result with the known result and return if done.
999 if (op2 == name)
1001 r.intersect (op2_range);
1002 return true;
1004 // If the calculation continues, we're using op2_range as the new LHS.
1005 op2_range.intersect (r);
1007 gimple *src_stmt = SSA_NAME_DEF_STMT (op2);
1008 gcc_checking_assert (src_stmt);
1009 // gcc_checking_assert (!is_import_p (op2, find.bb));
1011 // Then feed this range back as the LHS of the defining statement.
1012 return compute_operand_range (r, src_stmt, op2_range, name, src);
1015 // Calculate a range for NAME from both operand positions of S
1016 // assuming the result of the statement is LHS. Return the range in
1017 // R, or false if no range could be calculated.
1019 bool
1020 gori_compute::compute_operand1_and_operand2_range (irange &r,
1021 gimple *stmt,
1022 const irange &lhs,
1023 tree name,
1024 fur_source &src)
1026 int_range_max op_range;
1028 // Calculate a good a range for op2. Since op1 == op2, this will
1029 // have already included whatever the actual range of name is.
1030 if (!compute_operand2_range (op_range, stmt, lhs, name, src))
1031 return false;
1033 // Now get the range thru op1.
1034 if (!compute_operand1_range (r, stmt, lhs, name, src))
1035 return false;
1037 // Both operands have to be simultaneously true, so perform an intersection.
1038 r.intersect (op_range);
1039 return true;
1041 // Return TRUE if a range can be calculated or recomputed for NAME on edge E.
1043 bool
1044 gori_compute::has_edge_range_p (tree name, edge e)
1046 // Check if NAME is an export or can be recomputed.
1047 if (e)
1048 return is_export_p (name, e->src) || may_recompute_p (name, e);
1050 // If no edge is specified, check if NAME can have a range calculated
1051 // on any edge.
1052 return is_export_p (name) || may_recompute_p (name);
1055 // Dump what is known to GORI computes to listing file F.
1057 void
1058 gori_compute::dump (FILE *f)
1060 gori_map::dump (f);
1063 // Return TRUE if NAME can be recomputed on edge E. If any direct dependant
1064 // is exported on edge E, it may change the computed value of NAME.
1066 bool
1067 gori_compute::may_recompute_p (tree name, edge e)
1069 tree dep1 = depend1 (name);
1070 tree dep2 = depend2 (name);
1072 // If the first dependency is not set, there is no recompuation.
1073 if (!dep1)
1074 return false;
1076 // Don't recalculate PHIs or statements with side_effects.
1077 gimple *s = SSA_NAME_DEF_STMT (name);
1078 if (is_a<gphi *> (s) || gimple_has_side_effects (s))
1079 return false;
1081 // If edge is specified, check if NAME can be recalculated on that edge.
1082 if (e)
1083 return ((is_export_p (dep1, e->src))
1084 || (dep2 && is_export_p (dep2, e->src)));
1086 return (is_export_p (dep1)) || (dep2 && is_export_p (dep2));
1089 // Calculate a range on edge E and return it in R. Try to evaluate a
1090 // range for NAME on this edge. Return FALSE if this is either not a
1091 // control edge or NAME is not defined by this edge.
1093 bool
1094 gori_compute::outgoing_edge_range_p (irange &r, edge e, tree name,
1095 range_query &q)
1097 int_range_max lhs;
1099 gcc_checking_assert (gimple_range_ssa_p (name));
1100 // Determine if there is an outgoing edge.
1101 gimple *stmt = outgoing.edge_range_p (lhs, e);
1102 if (!stmt)
1103 return false;
1105 fur_stmt src (stmt, &q);
1107 // If this edge is never taken, return undefined.
1108 gcond *gc = dyn_cast<gcond *> (stmt);
1109 if (gc)
1111 if (((e->flags & EDGE_TRUE_VALUE) && gimple_cond_false_p (gc))
1112 || ((e->flags & EDGE_FALSE_VALUE) && gimple_cond_true_p (gc)))
1114 r.set_undefined ();
1115 if (dump_file && (dump_flags & TDF_DETAILS))
1116 fprintf (dump_file, "Outgoing edge %d->%d unexecutable.\n",
1117 e->src->index, e->dest->index);
1118 return true;
1122 // If NAME can be calculated on the edge, use that.
1123 if (is_export_p (name, e->src))
1125 if (compute_operand_range (r, stmt, lhs, name, src))
1127 // Sometimes compatible types get interchanged. See PR97360.
1128 // Make sure we are returning the type of the thing we asked for.
1129 if (!r.undefined_p () && r.type () != TREE_TYPE (name))
1131 gcc_checking_assert (range_compatible_p (r.type (),
1132 TREE_TYPE (name)));
1133 range_cast (r, TREE_TYPE (name));
1135 return true;
1138 // If NAME isn't exported, check if it can be recomputed.
1139 else if (may_recompute_p (name, e))
1141 gimple *def_stmt = SSA_NAME_DEF_STMT (name);
1143 if (dump_file && (dump_flags & TDF_DETAILS))
1145 fprintf (dump_file, "recomputation attempt on edge %d->%d for ",
1146 e->src->index, e->dest->index);
1147 print_generic_expr (dump_file, name, TDF_SLIM);
1149 // Simply calculate DEF_STMT on edge E using the range query Q.
1150 fold_range (r, def_stmt, e, &q);
1151 if (dump_file && (dump_flags & TDF_DETAILS))
1153 fprintf (dump_file, " : Calculated :");
1154 r.dump (dump_file);
1155 fputc ('\n', dump_file);
1157 return true;
1159 return false;
1163 // ------------------------------------------------------------------------
1164 // GORI iterator. Although we have bitmap iterators, don't expose that it
1165 // is currently a bitmap. Use an export iterator to hide future changes.
1167 // Construct a basic iterator over an export bitmap.
1169 gori_export_iterator::gori_export_iterator (bitmap b)
1171 bm = b;
1172 if (b)
1173 bmp_iter_set_init (&bi, b, 1, &y);
1177 // Move to the next export bitmap spot.
1179 void
1180 gori_export_iterator::next ()
1182 bmp_iter_next (&bi, &y);
1186 // Fetch the name of the next export in the export list. Return NULL if
1187 // iteration is done.
1189 tree
1190 gori_export_iterator::get_name ()
1192 if (!bm)
1193 return NULL_TREE;
1195 while (bmp_iter_set (&bi, &y))
1197 tree t = ssa_name (y);
1198 if (t)
1199 return t;
1200 next ();
1202 return NULL_TREE;