* tree-loop-distribution.c (params.h): Include header file.
[official-gcc.git] / gcc / tree-switch-conversion.c
blobe5b5cb9a0be6c598e7fe08646dd45068b121a049
1 /* Lower GIMPLE_SWITCH expressions to something more efficient than
2 a jump table.
3 Copyright (C) 2006-2017 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3, or (at your option) any
10 later version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not, write to the Free
19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
20 02110-1301, USA. */
22 /* This file handles the lowering of GIMPLE_SWITCH to an indexed
23 load, or a series of bit-test-and-branch expressions. */
25 #include "config.h"
26 #include "system.h"
27 #include "coretypes.h"
28 #include "backend.h"
29 #include "insn-codes.h"
30 #include "rtl.h"
31 #include "tree.h"
32 #include "gimple.h"
33 #include "cfghooks.h"
34 #include "tree-pass.h"
35 #include "ssa.h"
36 #include "optabs-tree.h"
37 #include "cgraph.h"
38 #include "gimple-pretty-print.h"
39 #include "params.h"
40 #include "fold-const.h"
41 #include "varasm.h"
42 #include "stor-layout.h"
43 #include "cfganal.h"
44 #include "gimplify.h"
45 #include "gimple-iterator.h"
46 #include "gimplify-me.h"
47 #include "tree-cfg.h"
48 #include "cfgloop.h"
50 /* ??? For lang_hooks.types.type_for_mode, but is there a word_mode
51 type in the GIMPLE type system that is language-independent? */
52 #include "langhooks.h"
55 /* Maximum number of case bit tests.
56 FIXME: This should be derived from PARAM_CASE_VALUES_THRESHOLD and
57 targetm.case_values_threshold(), or be its own param. */
58 #define MAX_CASE_BIT_TESTS 3
60 /* Split the basic block at the statement pointed to by GSIP, and insert
61 a branch to the target basic block of E_TRUE conditional on tree
62 expression COND.
64 It is assumed that there is already an edge from the to-be-split
65 basic block to E_TRUE->dest block. This edge is removed, and the
66 profile information on the edge is re-used for the new conditional
67 jump.
69 The CFG is updated. The dominator tree will not be valid after
70 this transformation, but the immediate dominators are updated if
71 UPDATE_DOMINATORS is true.
73 Returns the newly created basic block. */
75 static basic_block
76 hoist_edge_and_branch_if_true (gimple_stmt_iterator *gsip,
77 tree cond, edge e_true,
78 bool update_dominators)
80 tree tmp;
81 gcond *cond_stmt;
82 edge e_false;
83 basic_block new_bb, split_bb = gsi_bb (*gsip);
84 bool dominated_e_true = false;
86 gcc_assert (e_true->src == split_bb);
88 if (update_dominators
89 && get_immediate_dominator (CDI_DOMINATORS, e_true->dest) == split_bb)
90 dominated_e_true = true;
92 tmp = force_gimple_operand_gsi (gsip, cond, /*simple=*/true, NULL,
93 /*before=*/true, GSI_SAME_STMT);
94 cond_stmt = gimple_build_cond_from_tree (tmp, NULL_TREE, NULL_TREE);
95 gsi_insert_before (gsip, cond_stmt, GSI_SAME_STMT);
97 e_false = split_block (split_bb, cond_stmt);
98 new_bb = e_false->dest;
99 redirect_edge_pred (e_true, split_bb);
101 e_true->flags &= ~EDGE_FALLTHRU;
102 e_true->flags |= EDGE_TRUE_VALUE;
104 e_false->flags &= ~EDGE_FALLTHRU;
105 e_false->flags |= EDGE_FALSE_VALUE;
106 e_false->probability = e_true->probability.invert ();
107 e_false->count = split_bb->count - e_true->count;
108 new_bb->count = e_false->count;
110 if (update_dominators)
112 if (dominated_e_true)
113 set_immediate_dominator (CDI_DOMINATORS, e_true->dest, split_bb);
114 set_immediate_dominator (CDI_DOMINATORS, e_false->dest, split_bb);
117 return new_bb;
121 /* Return true if a switch should be expanded as a bit test.
122 RANGE is the difference between highest and lowest case.
123 UNIQ is number of unique case node targets, not counting the default case.
124 COUNT is the number of comparisons needed, not counting the default case. */
126 static bool
127 expand_switch_using_bit_tests_p (tree range,
128 unsigned int uniq,
129 unsigned int count, bool speed_p)
131 return (((uniq == 1 && count >= 3)
132 || (uniq == 2 && count >= 5)
133 || (uniq == 3 && count >= 6))
134 && lshift_cheap_p (speed_p)
135 && compare_tree_int (range, GET_MODE_BITSIZE (word_mode)) < 0
136 && compare_tree_int (range, 0) > 0);
139 /* Implement switch statements with bit tests
141 A GIMPLE switch statement can be expanded to a short sequence of bit-wise
142 comparisons. "switch(x)" is converted into "if ((1 << (x-MINVAL)) & CST)"
143 where CST and MINVAL are integer constants. This is better than a series
144 of compare-and-banch insns in some cases, e.g. we can implement:
146 if ((x==4) || (x==6) || (x==9) || (x==11))
148 as a single bit test:
150 if ((1<<x) & ((1<<4)|(1<<6)|(1<<9)|(1<<11)))
152 This transformation is only applied if the number of case targets is small,
153 if CST constains at least 3 bits, and "1 << x" is cheap. The bit tests are
154 performed in "word_mode".
156 The following example shows the code the transformation generates:
158 int bar(int x)
160 switch (x)
162 case '0': case '1': case '2': case '3': case '4':
163 case '5': case '6': case '7': case '8': case '9':
164 case 'A': case 'B': case 'C': case 'D': case 'E':
165 case 'F':
166 return 1;
168 return 0;
173 bar (int x)
175 tmp1 = x - 48;
176 if (tmp1 > (70 - 48)) goto L2;
177 tmp2 = 1 << tmp1;
178 tmp3 = 0b11111100000001111111111;
179 if ((tmp2 & tmp3) != 0) goto L1 ; else goto L2;
181 return 1;
183 return 0;
186 TODO: There are still some improvements to this transformation that could
187 be implemented:
189 * A narrower mode than word_mode could be used if that is cheaper, e.g.
190 for x86_64 where a narrower-mode shift may result in smaller code.
192 * The compounded constant could be shifted rather than the one. The
193 test would be either on the sign bit or on the least significant bit,
194 depending on the direction of the shift. On some machines, the test
195 for the branch would be free if the bit to test is already set by the
196 shift operation.
198 This transformation was contributed by Roger Sayle, see this e-mail:
199 http://gcc.gnu.org/ml/gcc-patches/2003-01/msg01950.html
202 /* A case_bit_test represents a set of case nodes that may be
203 selected from using a bit-wise comparison. HI and LO hold
204 the integer to be tested against, TARGET_EDGE contains the
205 edge to the basic block to jump to upon success and BITS
206 counts the number of case nodes handled by this test,
207 typically the number of bits set in HI:LO. The LABEL field
208 is used to quickly identify all cases in this set without
209 looking at label_to_block for every case label. */
211 struct case_bit_test
213 wide_int mask;
214 edge target_edge;
215 tree label;
216 int bits;
219 /* Comparison function for qsort to order bit tests by decreasing
220 probability of execution. Our best guess comes from a measured
221 profile. If the profile counts are equal, break even on the
222 number of case nodes, i.e. the node with the most cases gets
223 tested first.
225 TODO: Actually this currently runs before a profile is available.
226 Therefore the case-as-bit-tests transformation should be done
227 later in the pass pipeline, or something along the lines of
228 "Efficient and effective branch reordering using profile data"
229 (Yang et. al., 2002) should be implemented (although, how good
230 is a paper is called "Efficient and effective ..." when the
231 latter is implied by the former, but oh well...). */
233 static int
234 case_bit_test_cmp (const void *p1, const void *p2)
236 const struct case_bit_test *const d1 = (const struct case_bit_test *) p1;
237 const struct case_bit_test *const d2 = (const struct case_bit_test *) p2;
239 if (d2->target_edge->count < d1->target_edge->count)
240 return -1;
241 if (d2->target_edge->count > d1->target_edge->count)
242 return 1;
243 if (d2->bits != d1->bits)
244 return d2->bits - d1->bits;
246 /* Stabilize the sort. */
247 return LABEL_DECL_UID (d2->label) - LABEL_DECL_UID (d1->label);
250 /* Expand a switch statement by a short sequence of bit-wise
251 comparisons. "switch(x)" is effectively converted into
252 "if ((1 << (x-MINVAL)) & CST)" where CST and MINVAL are
253 integer constants.
255 INDEX_EXPR is the value being switched on.
257 MINVAL is the lowest case value of in the case nodes,
258 and RANGE is highest value minus MINVAL. MINVAL and RANGE
259 are not guaranteed to be of the same type as INDEX_EXPR
260 (the gimplifier doesn't change the type of case label values,
261 and MINVAL and RANGE are derived from those values).
262 MAXVAL is MINVAL + RANGE.
264 There *MUST* be MAX_CASE_BIT_TESTS or less unique case
265 node targets. */
267 static void
268 emit_case_bit_tests (gswitch *swtch, tree index_expr,
269 tree minval, tree range, tree maxval)
271 struct case_bit_test test[MAX_CASE_BIT_TESTS] = { {} };
272 unsigned int i, j, k;
273 unsigned int count;
275 basic_block switch_bb = gimple_bb (swtch);
276 basic_block default_bb, new_default_bb, new_bb;
277 edge default_edge;
278 bool update_dom = dom_info_available_p (CDI_DOMINATORS);
280 vec<basic_block> bbs_to_fix_dom = vNULL;
282 tree index_type = TREE_TYPE (index_expr);
283 tree unsigned_index_type = unsigned_type_for (index_type);
284 unsigned int branch_num = gimple_switch_num_labels (swtch);
286 gimple_stmt_iterator gsi;
287 gassign *shift_stmt;
289 tree idx, tmp, csui;
290 tree word_type_node = lang_hooks.types.type_for_mode (word_mode, 1);
291 tree word_mode_zero = fold_convert (word_type_node, integer_zero_node);
292 tree word_mode_one = fold_convert (word_type_node, integer_one_node);
293 int prec = TYPE_PRECISION (word_type_node);
294 wide_int wone = wi::one (prec);
296 /* Get the edge for the default case. */
297 tmp = gimple_switch_default_label (swtch);
298 default_bb = label_to_block (CASE_LABEL (tmp));
299 default_edge = find_edge (switch_bb, default_bb);
301 /* Go through all case labels, and collect the case labels, profile
302 counts, and other information we need to build the branch tests. */
303 count = 0;
304 for (i = 1; i < branch_num; i++)
306 unsigned int lo, hi;
307 tree cs = gimple_switch_label (swtch, i);
308 tree label = CASE_LABEL (cs);
309 edge e = find_edge (switch_bb, label_to_block (label));
310 for (k = 0; k < count; k++)
311 if (e == test[k].target_edge)
312 break;
314 if (k == count)
316 gcc_checking_assert (count < MAX_CASE_BIT_TESTS);
317 test[k].mask = wi::zero (prec);
318 test[k].target_edge = e;
319 test[k].label = label;
320 test[k].bits = 1;
321 count++;
323 else
324 test[k].bits++;
326 lo = tree_to_uhwi (int_const_binop (MINUS_EXPR,
327 CASE_LOW (cs), minval));
328 if (CASE_HIGH (cs) == NULL_TREE)
329 hi = lo;
330 else
331 hi = tree_to_uhwi (int_const_binop (MINUS_EXPR,
332 CASE_HIGH (cs), minval));
334 for (j = lo; j <= hi; j++)
335 test[k].mask |= wi::lshift (wone, j);
338 qsort (test, count, sizeof (*test), case_bit_test_cmp);
340 /* If all values are in the 0 .. BITS_PER_WORD-1 range, we can get rid of
341 the minval subtractions, but it might make the mask constants more
342 expensive. So, compare the costs. */
343 if (compare_tree_int (minval, 0) > 0
344 && compare_tree_int (maxval, GET_MODE_BITSIZE (word_mode)) < 0)
346 int cost_diff;
347 HOST_WIDE_INT m = tree_to_uhwi (minval);
348 rtx reg = gen_raw_REG (word_mode, 10000);
349 bool speed_p = optimize_bb_for_speed_p (gimple_bb (swtch));
350 cost_diff = set_rtx_cost (gen_rtx_PLUS (word_mode, reg,
351 GEN_INT (-m)), speed_p);
352 for (i = 0; i < count; i++)
354 rtx r = immed_wide_int_const (test[i].mask, word_mode);
355 cost_diff += set_src_cost (gen_rtx_AND (word_mode, reg, r),
356 word_mode, speed_p);
357 r = immed_wide_int_const (wi::lshift (test[i].mask, m), word_mode);
358 cost_diff -= set_src_cost (gen_rtx_AND (word_mode, reg, r),
359 word_mode, speed_p);
361 if (cost_diff > 0)
363 for (i = 0; i < count; i++)
364 test[i].mask = wi::lshift (test[i].mask, m);
365 minval = build_zero_cst (TREE_TYPE (minval));
366 range = maxval;
370 /* We generate two jumps to the default case label.
371 Split the default edge, so that we don't have to do any PHI node
372 updating. */
373 new_default_bb = split_edge (default_edge);
375 if (update_dom)
377 bbs_to_fix_dom.create (10);
378 bbs_to_fix_dom.quick_push (switch_bb);
379 bbs_to_fix_dom.quick_push (default_bb);
380 bbs_to_fix_dom.quick_push (new_default_bb);
383 /* Now build the test-and-branch code. */
385 gsi = gsi_last_bb (switch_bb);
387 /* idx = (unsigned)x - minval. */
388 idx = fold_convert (unsigned_index_type, index_expr);
389 idx = fold_build2 (MINUS_EXPR, unsigned_index_type, idx,
390 fold_convert (unsigned_index_type, minval));
391 idx = force_gimple_operand_gsi (&gsi, idx,
392 /*simple=*/true, NULL_TREE,
393 /*before=*/true, GSI_SAME_STMT);
395 /* if (idx > range) goto default */
396 range = force_gimple_operand_gsi (&gsi,
397 fold_convert (unsigned_index_type, range),
398 /*simple=*/true, NULL_TREE,
399 /*before=*/true, GSI_SAME_STMT);
400 tmp = fold_build2 (GT_EXPR, boolean_type_node, idx, range);
401 new_bb = hoist_edge_and_branch_if_true (&gsi, tmp, default_edge, update_dom);
402 if (update_dom)
403 bbs_to_fix_dom.quick_push (new_bb);
404 gcc_assert (gimple_bb (swtch) == new_bb);
405 gsi = gsi_last_bb (new_bb);
407 /* Any blocks dominated by the GIMPLE_SWITCH, but that are not successors
408 of NEW_BB, are still immediately dominated by SWITCH_BB. Make it so. */
409 if (update_dom)
411 vec<basic_block> dom_bbs;
412 basic_block dom_son;
414 dom_bbs = get_dominated_by (CDI_DOMINATORS, new_bb);
415 FOR_EACH_VEC_ELT (dom_bbs, i, dom_son)
417 edge e = find_edge (new_bb, dom_son);
418 if (e && single_pred_p (e->dest))
419 continue;
420 set_immediate_dominator (CDI_DOMINATORS, dom_son, switch_bb);
421 bbs_to_fix_dom.safe_push (dom_son);
423 dom_bbs.release ();
426 /* csui = (1 << (word_mode) idx) */
427 csui = make_ssa_name (word_type_node);
428 tmp = fold_build2 (LSHIFT_EXPR, word_type_node, word_mode_one,
429 fold_convert (word_type_node, idx));
430 tmp = force_gimple_operand_gsi (&gsi, tmp,
431 /*simple=*/false, NULL_TREE,
432 /*before=*/true, GSI_SAME_STMT);
433 shift_stmt = gimple_build_assign (csui, tmp);
434 gsi_insert_before (&gsi, shift_stmt, GSI_SAME_STMT);
435 update_stmt (shift_stmt);
437 /* for each unique set of cases:
438 if (const & csui) goto target */
439 for (k = 0; k < count; k++)
441 tmp = wide_int_to_tree (word_type_node, test[k].mask);
442 tmp = fold_build2 (BIT_AND_EXPR, word_type_node, csui, tmp);
443 tmp = force_gimple_operand_gsi (&gsi, tmp,
444 /*simple=*/true, NULL_TREE,
445 /*before=*/true, GSI_SAME_STMT);
446 tmp = fold_build2 (NE_EXPR, boolean_type_node, tmp, word_mode_zero);
447 new_bb = hoist_edge_and_branch_if_true (&gsi, tmp, test[k].target_edge,
448 update_dom);
449 if (update_dom)
450 bbs_to_fix_dom.safe_push (new_bb);
451 gcc_assert (gimple_bb (swtch) == new_bb);
452 gsi = gsi_last_bb (new_bb);
455 /* We should have removed all edges now. */
456 gcc_assert (EDGE_COUNT (gsi_bb (gsi)->succs) == 0);
458 /* If nothing matched, go to the default label. */
459 make_edge (gsi_bb (gsi), new_default_bb, EDGE_FALLTHRU);
461 /* The GIMPLE_SWITCH is now redundant. */
462 gsi_remove (&gsi, true);
464 if (update_dom)
466 /* Fix up the dominator tree. */
467 iterate_fix_dominators (CDI_DOMINATORS, bbs_to_fix_dom, true);
468 bbs_to_fix_dom.release ();
473 Switch initialization conversion
475 The following pass changes simple initializations of scalars in a switch
476 statement into initializations from a static array. Obviously, the values
477 must be constant and known at compile time and a default branch must be
478 provided. For example, the following code:
480 int a,b;
482 switch (argc)
484 case 1:
485 case 2:
486 a_1 = 8;
487 b_1 = 6;
488 break;
489 case 3:
490 a_2 = 9;
491 b_2 = 5;
492 break;
493 case 12:
494 a_3 = 10;
495 b_3 = 4;
496 break;
497 default:
498 a_4 = 16;
499 b_4 = 1;
500 break;
502 a_5 = PHI <a_1, a_2, a_3, a_4>
503 b_5 = PHI <b_1, b_2, b_3, b_4>
506 is changed into:
508 static const int = CSWTCH01[] = {6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 4};
509 static const int = CSWTCH02[] = {8, 8, 9, 16, 16, 16, 16, 16, 16, 16,
510 16, 16, 10};
512 if (((unsigned) argc) - 1 < 11)
514 a_6 = CSWTCH02[argc - 1];
515 b_6 = CSWTCH01[argc - 1];
517 else
519 a_7 = 16;
520 b_7 = 1;
522 a_5 = PHI <a_6, a_7>
523 b_b = PHI <b_6, b_7>
525 There are further constraints. Specifically, the range of values across all
526 case labels must not be bigger than SWITCH_CONVERSION_BRANCH_RATIO (default
527 eight) times the number of the actual switch branches.
529 This transformation was contributed by Martin Jambor, see this e-mail:
530 http://gcc.gnu.org/ml/gcc-patches/2008-07/msg00011.html */
532 /* The main structure of the pass. */
533 struct switch_conv_info
535 /* The expression used to decide the switch branch. */
536 tree index_expr;
538 /* The following integer constants store the minimum and maximum value
539 covered by the case labels. */
540 tree range_min;
541 tree range_max;
543 /* The difference between the above two numbers. Stored here because it
544 is used in all the conversion heuristics, as well as for some of the
545 transformation, and it is expensive to re-compute it all the time. */
546 tree range_size;
548 /* Basic block that contains the actual GIMPLE_SWITCH. */
549 basic_block switch_bb;
551 /* Basic block that is the target of the default case. */
552 basic_block default_bb;
554 /* The single successor block of all branches out of the GIMPLE_SWITCH,
555 if such a block exists. Otherwise NULL. */
556 basic_block final_bb;
558 /* The probability of the default edge in the replaced switch. */
559 profile_probability default_prob;
561 /* The count of the default edge in the replaced switch. */
562 profile_count default_count;
564 /* Combined count of all other (non-default) edges in the replaced switch. */
565 profile_count other_count;
567 /* Number of phi nodes in the final bb (that we'll be replacing). */
568 int phi_count;
570 /* Array of default values, in the same order as phi nodes. */
571 tree *default_values;
573 /* Constructors of new static arrays. */
574 vec<constructor_elt, va_gc> **constructors;
576 /* Array of ssa names that are initialized with a value from a new static
577 array. */
578 tree *target_inbound_names;
580 /* Array of ssa names that are initialized with the default value if the
581 switch expression is out of range. */
582 tree *target_outbound_names;
584 /* VOP SSA_NAME. */
585 tree target_vop;
587 /* The first load statement that loads a temporary from a new static array.
589 gimple *arr_ref_first;
591 /* The last load statement that loads a temporary from a new static array. */
592 gimple *arr_ref_last;
594 /* String reason why the case wasn't a good candidate that is written to the
595 dump file, if there is one. */
596 const char *reason;
598 /* True if default case is not used for any value between range_min and
599 range_max inclusive. */
600 bool contiguous_range;
602 /* True if default case does not have the required shape for other case
603 labels. */
604 bool default_case_nonstandard;
606 /* Parameters for expand_switch_using_bit_tests. Should be computed
607 the same way as in expand_case. */
608 unsigned int uniq;
609 unsigned int count;
612 /* Collect information about GIMPLE_SWITCH statement SWTCH into INFO. */
614 static void
615 collect_switch_conv_info (gswitch *swtch, struct switch_conv_info *info)
617 unsigned int branch_num = gimple_switch_num_labels (swtch);
618 tree min_case, max_case;
619 unsigned int count, i;
620 edge e, e_default, e_first;
621 edge_iterator ei;
622 basic_block first;
624 memset (info, 0, sizeof (*info));
626 /* The gimplifier has already sorted the cases by CASE_LOW and ensured there
627 is a default label which is the first in the vector.
628 Collect the bits we can deduce from the CFG. */
629 info->index_expr = gimple_switch_index (swtch);
630 info->switch_bb = gimple_bb (swtch);
631 info->default_bb
632 = label_to_block (CASE_LABEL (gimple_switch_default_label (swtch)));
633 e_default = find_edge (info->switch_bb, info->default_bb);
634 info->default_prob = e_default->probability;
635 info->default_count = e_default->count;
636 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
637 if (e != e_default)
638 info->other_count += e->count;
640 /* Get upper and lower bounds of case values, and the covered range. */
641 min_case = gimple_switch_label (swtch, 1);
642 max_case = gimple_switch_label (swtch, branch_num - 1);
644 info->range_min = CASE_LOW (min_case);
645 if (CASE_HIGH (max_case) != NULL_TREE)
646 info->range_max = CASE_HIGH (max_case);
647 else
648 info->range_max = CASE_LOW (max_case);
650 info->contiguous_range = true;
651 tree last = CASE_HIGH (min_case) ? CASE_HIGH (min_case) : info->range_min;
652 for (i = 2; i < branch_num; i++)
654 tree elt = gimple_switch_label (swtch, i);
655 wide_int w = last;
656 if (w + 1 != CASE_LOW (elt))
658 info->contiguous_range = false;
659 break;
661 last = CASE_HIGH (elt) ? CASE_HIGH (elt) : CASE_LOW (elt);
664 if (info->contiguous_range)
666 first = label_to_block (CASE_LABEL (gimple_switch_label (swtch, 1)));
667 e_first = find_edge (info->switch_bb, first);
669 else
671 first = info->default_bb;
672 e_first = e_default;
675 /* See if there is one common successor block for all branch
676 targets. If it exists, record it in FINAL_BB.
677 Start with the destination of the first non-default case
678 if the range is contiguous and default case otherwise as
679 guess or its destination in case it is a forwarder block. */
680 if (! single_pred_p (e_first->dest))
681 info->final_bb = e_first->dest;
682 else if (single_succ_p (e_first->dest)
683 && ! single_pred_p (single_succ (e_first->dest)))
684 info->final_bb = single_succ (e_first->dest);
685 /* Require that all switch destinations are either that common
686 FINAL_BB or a forwarder to it, except for the default
687 case if contiguous range. */
688 if (info->final_bb)
689 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
691 if (e->dest == info->final_bb)
692 continue;
694 if (single_pred_p (e->dest)
695 && single_succ_p (e->dest)
696 && single_succ (e->dest) == info->final_bb)
697 continue;
699 if (e == e_default && info->contiguous_range)
701 info->default_case_nonstandard = true;
702 continue;
705 info->final_bb = NULL;
706 break;
709 info->range_size
710 = int_const_binop (MINUS_EXPR, info->range_max, info->range_min);
712 /* Get a count of the number of case labels. Single-valued case labels
713 simply count as one, but a case range counts double, since it may
714 require two compares if it gets lowered as a branching tree. */
715 count = 0;
716 for (i = 1; i < branch_num; i++)
718 tree elt = gimple_switch_label (swtch, i);
719 count++;
720 if (CASE_HIGH (elt)
721 && ! tree_int_cst_equal (CASE_LOW (elt), CASE_HIGH (elt)))
722 count++;
724 info->count = count;
726 /* Get the number of unique non-default targets out of the GIMPLE_SWITCH
727 block. Assume a CFG cleanup would have already removed degenerate
728 switch statements, this allows us to just use EDGE_COUNT. */
729 info->uniq = EDGE_COUNT (gimple_bb (swtch)->succs) - 1;
732 /* Checks whether the range given by individual case statements of the SWTCH
733 switch statement isn't too big and whether the number of branches actually
734 satisfies the size of the new array. */
736 static bool
737 check_range (struct switch_conv_info *info)
739 gcc_assert (info->range_size);
740 if (!tree_fits_uhwi_p (info->range_size))
742 info->reason = "index range way too large or otherwise unusable";
743 return false;
746 if (tree_to_uhwi (info->range_size)
747 > ((unsigned) info->count * SWITCH_CONVERSION_BRANCH_RATIO))
749 info->reason = "the maximum range-branch ratio exceeded";
750 return false;
753 return true;
756 /* Checks whether all but the FINAL_BB basic blocks are empty. */
758 static bool
759 check_all_empty_except_final (struct switch_conv_info *info)
761 edge e, e_default = find_edge (info->switch_bb, info->default_bb);
762 edge_iterator ei;
764 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
766 if (e->dest == info->final_bb)
767 continue;
769 if (!empty_block_p (e->dest))
771 if (info->contiguous_range && e == e_default)
773 info->default_case_nonstandard = true;
774 continue;
777 info->reason = "bad case - a non-final BB not empty";
778 return false;
782 return true;
785 /* This function checks whether all required values in phi nodes in final_bb
786 are constants. Required values are those that correspond to a basic block
787 which is a part of the examined switch statement. It returns true if the
788 phi nodes are OK, otherwise false. */
790 static bool
791 check_final_bb (gswitch *swtch, struct switch_conv_info *info)
793 gphi_iterator gsi;
795 info->phi_count = 0;
796 for (gsi = gsi_start_phis (info->final_bb); !gsi_end_p (gsi); gsi_next (&gsi))
798 gphi *phi = gsi.phi ();
799 unsigned int i;
801 if (virtual_operand_p (gimple_phi_result (phi)))
802 continue;
804 info->phi_count++;
806 for (i = 0; i < gimple_phi_num_args (phi); i++)
808 basic_block bb = gimple_phi_arg_edge (phi, i)->src;
810 if (bb == info->switch_bb
811 || (single_pred_p (bb)
812 && single_pred (bb) == info->switch_bb
813 && (!info->default_case_nonstandard
814 || empty_block_p (bb))))
816 tree reloc, val;
817 const char *reason = NULL;
819 val = gimple_phi_arg_def (phi, i);
820 if (!is_gimple_ip_invariant (val))
821 reason = "non-invariant value from a case";
822 else
824 reloc = initializer_constant_valid_p (val, TREE_TYPE (val));
825 if ((flag_pic && reloc != null_pointer_node)
826 || (!flag_pic && reloc == NULL_TREE))
828 if (reloc)
829 reason
830 = "value from a case would need runtime relocations";
831 else
832 reason
833 = "value from a case is not a valid initializer";
836 if (reason)
838 /* For contiguous range, we can allow non-constant
839 or one that needs relocation, as long as it is
840 only reachable from the default case. */
841 if (bb == info->switch_bb)
842 bb = info->final_bb;
843 if (!info->contiguous_range || bb != info->default_bb)
845 info->reason = reason;
846 return false;
849 unsigned int branch_num = gimple_switch_num_labels (swtch);
850 for (unsigned int i = 1; i < branch_num; i++)
852 tree lab = CASE_LABEL (gimple_switch_label (swtch, i));
853 if (label_to_block (lab) == bb)
855 info->reason = reason;
856 return false;
859 info->default_case_nonstandard = true;
865 return true;
868 /* The following function allocates default_values, target_{in,out}_names and
869 constructors arrays. The last one is also populated with pointers to
870 vectors that will become constructors of new arrays. */
872 static void
873 create_temp_arrays (struct switch_conv_info *info)
875 int i;
877 info->default_values = XCNEWVEC (tree, info->phi_count * 3);
878 /* ??? Macros do not support multi argument templates in their
879 argument list. We create a typedef to work around that problem. */
880 typedef vec<constructor_elt, va_gc> *vec_constructor_elt_gc;
881 info->constructors = XCNEWVEC (vec_constructor_elt_gc, info->phi_count);
882 info->target_inbound_names = info->default_values + info->phi_count;
883 info->target_outbound_names = info->target_inbound_names + info->phi_count;
884 for (i = 0; i < info->phi_count; i++)
885 vec_alloc (info->constructors[i], tree_to_uhwi (info->range_size) + 1);
888 /* Free the arrays created by create_temp_arrays(). The vectors that are
889 created by that function are not freed here, however, because they have
890 already become constructors and must be preserved. */
892 static void
893 free_temp_arrays (struct switch_conv_info *info)
895 XDELETEVEC (info->constructors);
896 XDELETEVEC (info->default_values);
899 /* Populate the array of default values in the order of phi nodes.
900 DEFAULT_CASE is the CASE_LABEL_EXPR for the default switch branch
901 if the range is non-contiguous or the default case has standard
902 structure, otherwise it is the first non-default case instead. */
904 static void
905 gather_default_values (tree default_case, struct switch_conv_info *info)
907 gphi_iterator gsi;
908 basic_block bb = label_to_block (CASE_LABEL (default_case));
909 edge e;
910 int i = 0;
912 gcc_assert (CASE_LOW (default_case) == NULL_TREE
913 || info->default_case_nonstandard);
915 if (bb == info->final_bb)
916 e = find_edge (info->switch_bb, bb);
917 else
918 e = single_succ_edge (bb);
920 for (gsi = gsi_start_phis (info->final_bb); !gsi_end_p (gsi); gsi_next (&gsi))
922 gphi *phi = gsi.phi ();
923 if (virtual_operand_p (gimple_phi_result (phi)))
924 continue;
925 tree val = PHI_ARG_DEF_FROM_EDGE (phi, e);
926 gcc_assert (val);
927 info->default_values[i++] = val;
931 /* The following function populates the vectors in the constructors array with
932 future contents of the static arrays. The vectors are populated in the
933 order of phi nodes. SWTCH is the switch statement being converted. */
935 static void
936 build_constructors (gswitch *swtch, struct switch_conv_info *info)
938 unsigned i, branch_num = gimple_switch_num_labels (swtch);
939 tree pos = info->range_min;
940 tree pos_one = build_int_cst (TREE_TYPE (pos), 1);
942 for (i = 1; i < branch_num; i++)
944 tree cs = gimple_switch_label (swtch, i);
945 basic_block bb = label_to_block (CASE_LABEL (cs));
946 edge e;
947 tree high;
948 gphi_iterator gsi;
949 int j;
951 if (bb == info->final_bb)
952 e = find_edge (info->switch_bb, bb);
953 else
954 e = single_succ_edge (bb);
955 gcc_assert (e);
957 while (tree_int_cst_lt (pos, CASE_LOW (cs)))
959 int k;
960 gcc_assert (!info->contiguous_range);
961 for (k = 0; k < info->phi_count; k++)
963 constructor_elt elt;
965 elt.index = int_const_binop (MINUS_EXPR, pos, info->range_min);
966 elt.value
967 = unshare_expr_without_location (info->default_values[k]);
968 info->constructors[k]->quick_push (elt);
971 pos = int_const_binop (PLUS_EXPR, pos, pos_one);
973 gcc_assert (tree_int_cst_equal (pos, CASE_LOW (cs)));
975 j = 0;
976 if (CASE_HIGH (cs))
977 high = CASE_HIGH (cs);
978 else
979 high = CASE_LOW (cs);
980 for (gsi = gsi_start_phis (info->final_bb);
981 !gsi_end_p (gsi); gsi_next (&gsi))
983 gphi *phi = gsi.phi ();
984 if (virtual_operand_p (gimple_phi_result (phi)))
985 continue;
986 tree val = PHI_ARG_DEF_FROM_EDGE (phi, e);
987 tree low = CASE_LOW (cs);
988 pos = CASE_LOW (cs);
992 constructor_elt elt;
994 elt.index = int_const_binop (MINUS_EXPR, pos, info->range_min);
995 elt.value = unshare_expr_without_location (val);
996 info->constructors[j]->quick_push (elt);
998 pos = int_const_binop (PLUS_EXPR, pos, pos_one);
999 } while (!tree_int_cst_lt (high, pos)
1000 && tree_int_cst_lt (low, pos));
1001 j++;
1006 /* If all values in the constructor vector are the same, return the value.
1007 Otherwise return NULL_TREE. Not supposed to be called for empty
1008 vectors. */
1010 static tree
1011 constructor_contains_same_values_p (vec<constructor_elt, va_gc> *vec)
1013 unsigned int i;
1014 tree prev = NULL_TREE;
1015 constructor_elt *elt;
1017 FOR_EACH_VEC_SAFE_ELT (vec, i, elt)
1019 if (!prev)
1020 prev = elt->value;
1021 else if (!operand_equal_p (elt->value, prev, OEP_ONLY_CONST))
1022 return NULL_TREE;
1024 return prev;
1027 /* Return type which should be used for array elements, either TYPE's
1028 main variant or, for integral types, some smaller integral type
1029 that can still hold all the constants. */
1031 static tree
1032 array_value_type (gswitch *swtch, tree type, int num,
1033 struct switch_conv_info *info)
1035 unsigned int i, len = vec_safe_length (info->constructors[num]);
1036 constructor_elt *elt;
1037 machine_mode mode;
1038 int sign = 0;
1039 tree smaller_type;
1041 /* Types with alignments greater than their size can reach here, e.g. out of
1042 SRA. We couldn't use these as an array component type so get back to the
1043 main variant first, which, for our purposes, is fine for other types as
1044 well. */
1046 type = TYPE_MAIN_VARIANT (type);
1048 if (!INTEGRAL_TYPE_P (type))
1049 return type;
1051 mode = GET_CLASS_NARROWEST_MODE (GET_MODE_CLASS (TYPE_MODE (type)));
1052 if (GET_MODE_SIZE (TYPE_MODE (type)) <= GET_MODE_SIZE (mode))
1053 return type;
1055 if (len < (optimize_bb_for_size_p (gimple_bb (swtch)) ? 2 : 32))
1056 return type;
1058 FOR_EACH_VEC_SAFE_ELT (info->constructors[num], i, elt)
1060 wide_int cst;
1062 if (TREE_CODE (elt->value) != INTEGER_CST)
1063 return type;
1065 cst = elt->value;
1066 while (1)
1068 unsigned int prec = GET_MODE_BITSIZE (mode);
1069 if (prec > HOST_BITS_PER_WIDE_INT)
1070 return type;
1072 if (sign >= 0 && cst == wi::zext (cst, prec))
1074 if (sign == 0 && cst == wi::sext (cst, prec))
1075 break;
1076 sign = 1;
1077 break;
1079 if (sign <= 0 && cst == wi::sext (cst, prec))
1081 sign = -1;
1082 break;
1085 if (sign == 1)
1086 sign = 0;
1088 mode = GET_MODE_WIDER_MODE (mode);
1089 if (mode == VOIDmode
1090 || GET_MODE_SIZE (mode) >= GET_MODE_SIZE (TYPE_MODE (type)))
1091 return type;
1095 if (sign == 0)
1096 sign = TYPE_UNSIGNED (type) ? 1 : -1;
1097 smaller_type = lang_hooks.types.type_for_mode (mode, sign >= 0);
1098 if (GET_MODE_SIZE (TYPE_MODE (type))
1099 <= GET_MODE_SIZE (TYPE_MODE (smaller_type)))
1100 return type;
1102 return smaller_type;
1105 /* Create an appropriate array type and declaration and assemble a static array
1106 variable. Also create a load statement that initializes the variable in
1107 question with a value from the static array. SWTCH is the switch statement
1108 being converted, NUM is the index to arrays of constructors, default values
1109 and target SSA names for this particular array. ARR_INDEX_TYPE is the type
1110 of the index of the new array, PHI is the phi node of the final BB that
1111 corresponds to the value that will be loaded from the created array. TIDX
1112 is an ssa name of a temporary variable holding the index for loads from the
1113 new array. */
1115 static void
1116 build_one_array (gswitch *swtch, int num, tree arr_index_type,
1117 gphi *phi, tree tidx, struct switch_conv_info *info)
1119 tree name, cst;
1120 gimple *load;
1121 gimple_stmt_iterator gsi = gsi_for_stmt (swtch);
1122 location_t loc = gimple_location (swtch);
1124 gcc_assert (info->default_values[num]);
1126 name = copy_ssa_name (PHI_RESULT (phi));
1127 info->target_inbound_names[num] = name;
1129 cst = constructor_contains_same_values_p (info->constructors[num]);
1130 if (cst)
1131 load = gimple_build_assign (name, cst);
1132 else
1134 tree array_type, ctor, decl, value_type, fetch, default_type;
1136 default_type = TREE_TYPE (info->default_values[num]);
1137 value_type = array_value_type (swtch, default_type, num, info);
1138 array_type = build_array_type (value_type, arr_index_type);
1139 if (default_type != value_type)
1141 unsigned int i;
1142 constructor_elt *elt;
1144 FOR_EACH_VEC_SAFE_ELT (info->constructors[num], i, elt)
1145 elt->value = fold_convert (value_type, elt->value);
1147 ctor = build_constructor (array_type, info->constructors[num]);
1148 TREE_CONSTANT (ctor) = true;
1149 TREE_STATIC (ctor) = true;
1151 decl = build_decl (loc, VAR_DECL, NULL_TREE, array_type);
1152 TREE_STATIC (decl) = 1;
1153 DECL_INITIAL (decl) = ctor;
1155 DECL_NAME (decl) = create_tmp_var_name ("CSWTCH");
1156 DECL_ARTIFICIAL (decl) = 1;
1157 DECL_IGNORED_P (decl) = 1;
1158 TREE_CONSTANT (decl) = 1;
1159 TREE_READONLY (decl) = 1;
1160 DECL_IGNORED_P (decl) = 1;
1161 varpool_node::finalize_decl (decl);
1163 fetch = build4 (ARRAY_REF, value_type, decl, tidx, NULL_TREE,
1164 NULL_TREE);
1165 if (default_type != value_type)
1167 fetch = fold_convert (default_type, fetch);
1168 fetch = force_gimple_operand_gsi (&gsi, fetch, true, NULL_TREE,
1169 true, GSI_SAME_STMT);
1171 load = gimple_build_assign (name, fetch);
1174 gsi_insert_before (&gsi, load, GSI_SAME_STMT);
1175 update_stmt (load);
1176 info->arr_ref_last = load;
1179 /* Builds and initializes static arrays initialized with values gathered from
1180 the SWTCH switch statement. Also creates statements that load values from
1181 them. */
1183 static void
1184 build_arrays (gswitch *swtch, struct switch_conv_info *info)
1186 tree arr_index_type;
1187 tree tidx, sub, utype;
1188 gimple *stmt;
1189 gimple_stmt_iterator gsi;
1190 gphi_iterator gpi;
1191 int i;
1192 location_t loc = gimple_location (swtch);
1194 gsi = gsi_for_stmt (swtch);
1196 /* Make sure we do not generate arithmetics in a subrange. */
1197 utype = TREE_TYPE (info->index_expr);
1198 if (TREE_TYPE (utype))
1199 utype = lang_hooks.types.type_for_mode (TYPE_MODE (TREE_TYPE (utype)), 1);
1200 else
1201 utype = lang_hooks.types.type_for_mode (TYPE_MODE (utype), 1);
1203 arr_index_type = build_index_type (info->range_size);
1204 tidx = make_ssa_name (utype);
1205 sub = fold_build2_loc (loc, MINUS_EXPR, utype,
1206 fold_convert_loc (loc, utype, info->index_expr),
1207 fold_convert_loc (loc, utype, info->range_min));
1208 sub = force_gimple_operand_gsi (&gsi, sub,
1209 false, NULL, true, GSI_SAME_STMT);
1210 stmt = gimple_build_assign (tidx, sub);
1212 gsi_insert_before (&gsi, stmt, GSI_SAME_STMT);
1213 update_stmt (stmt);
1214 info->arr_ref_first = stmt;
1216 for (gpi = gsi_start_phis (info->final_bb), i = 0;
1217 !gsi_end_p (gpi); gsi_next (&gpi))
1219 gphi *phi = gpi.phi ();
1220 if (!virtual_operand_p (gimple_phi_result (phi)))
1221 build_one_array (swtch, i++, arr_index_type, phi, tidx, info);
1222 else
1224 edge e;
1225 edge_iterator ei;
1226 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
1228 if (e->dest == info->final_bb)
1229 break;
1230 if (!info->default_case_nonstandard
1231 || e->dest != info->default_bb)
1233 e = single_succ_edge (e->dest);
1234 break;
1237 gcc_assert (e && e->dest == info->final_bb);
1238 info->target_vop = PHI_ARG_DEF_FROM_EDGE (phi, e);
1243 /* Generates and appropriately inserts loads of default values at the position
1244 given by BSI. Returns the last inserted statement. */
1246 static gassign *
1247 gen_def_assigns (gimple_stmt_iterator *gsi, struct switch_conv_info *info)
1249 int i;
1250 gassign *assign = NULL;
1252 for (i = 0; i < info->phi_count; i++)
1254 tree name = copy_ssa_name (info->target_inbound_names[i]);
1255 info->target_outbound_names[i] = name;
1256 assign = gimple_build_assign (name, info->default_values[i]);
1257 gsi_insert_before (gsi, assign, GSI_SAME_STMT);
1258 update_stmt (assign);
1260 return assign;
1263 /* Deletes the unused bbs and edges that now contain the switch statement and
1264 its empty branch bbs. BBD is the now dead BB containing the original switch
1265 statement, FINAL is the last BB of the converted switch statement (in terms
1266 of succession). */
1268 static void
1269 prune_bbs (basic_block bbd, basic_block final, basic_block default_bb)
1271 edge_iterator ei;
1272 edge e;
1274 for (ei = ei_start (bbd->succs); (e = ei_safe_edge (ei)); )
1276 basic_block bb;
1277 bb = e->dest;
1278 remove_edge (e);
1279 if (bb != final && bb != default_bb)
1280 delete_basic_block (bb);
1282 delete_basic_block (bbd);
1285 /* Add values to phi nodes in final_bb for the two new edges. E1F is the edge
1286 from the basic block loading values from an array and E2F from the basic
1287 block loading default values. BBF is the last switch basic block (see the
1288 bbf description in the comment below). */
1290 static void
1291 fix_phi_nodes (edge e1f, edge e2f, basic_block bbf,
1292 struct switch_conv_info *info)
1294 gphi_iterator gsi;
1295 int i;
1297 for (gsi = gsi_start_phis (bbf), i = 0;
1298 !gsi_end_p (gsi); gsi_next (&gsi))
1300 gphi *phi = gsi.phi ();
1301 tree inbound, outbound;
1302 if (virtual_operand_p (gimple_phi_result (phi)))
1303 inbound = outbound = info->target_vop;
1304 else
1306 inbound = info->target_inbound_names[i];
1307 outbound = info->target_outbound_names[i++];
1309 add_phi_arg (phi, inbound, e1f, UNKNOWN_LOCATION);
1310 if (!info->default_case_nonstandard)
1311 add_phi_arg (phi, outbound, e2f, UNKNOWN_LOCATION);
1315 /* Creates a check whether the switch expression value actually falls into the
1316 range given by all the cases. If it does not, the temporaries are loaded
1317 with default values instead. SWTCH is the switch statement being converted.
1319 bb0 is the bb with the switch statement, however, we'll end it with a
1320 condition instead.
1322 bb1 is the bb to be used when the range check went ok. It is derived from
1323 the switch BB
1325 bb2 is the bb taken when the expression evaluated outside of the range
1326 covered by the created arrays. It is populated by loads of default
1327 values.
1329 bbF is a fall through for both bb1 and bb2 and contains exactly what
1330 originally followed the switch statement.
1332 bbD contains the switch statement (in the end). It is unreachable but we
1333 still need to strip off its edges.
1336 static void
1337 gen_inbound_check (gswitch *swtch, struct switch_conv_info *info)
1339 tree label_decl1 = create_artificial_label (UNKNOWN_LOCATION);
1340 tree label_decl2 = create_artificial_label (UNKNOWN_LOCATION);
1341 tree label_decl3 = create_artificial_label (UNKNOWN_LOCATION);
1342 glabel *label1, *label2, *label3;
1343 tree utype, tidx;
1344 tree bound;
1346 gcond *cond_stmt;
1348 gassign *last_assign = NULL;
1349 gimple_stmt_iterator gsi;
1350 basic_block bb0, bb1, bb2, bbf, bbd;
1351 edge e01 = NULL, e02, e21, e1d, e1f, e2f;
1352 location_t loc = gimple_location (swtch);
1354 gcc_assert (info->default_values);
1356 bb0 = gimple_bb (swtch);
1358 tidx = gimple_assign_lhs (info->arr_ref_first);
1359 utype = TREE_TYPE (tidx);
1361 /* (end of) block 0 */
1362 gsi = gsi_for_stmt (info->arr_ref_first);
1363 gsi_next (&gsi);
1365 bound = fold_convert_loc (loc, utype, info->range_size);
1366 cond_stmt = gimple_build_cond (LE_EXPR, tidx, bound, NULL_TREE, NULL_TREE);
1367 gsi_insert_before (&gsi, cond_stmt, GSI_SAME_STMT);
1368 update_stmt (cond_stmt);
1370 /* block 2 */
1371 if (!info->default_case_nonstandard)
1373 label2 = gimple_build_label (label_decl2);
1374 gsi_insert_before (&gsi, label2, GSI_SAME_STMT);
1375 last_assign = gen_def_assigns (&gsi, info);
1378 /* block 1 */
1379 label1 = gimple_build_label (label_decl1);
1380 gsi_insert_before (&gsi, label1, GSI_SAME_STMT);
1382 /* block F */
1383 gsi = gsi_start_bb (info->final_bb);
1384 label3 = gimple_build_label (label_decl3);
1385 gsi_insert_before (&gsi, label3, GSI_SAME_STMT);
1387 /* cfg fix */
1388 e02 = split_block (bb0, cond_stmt);
1389 bb2 = e02->dest;
1391 if (info->default_case_nonstandard)
1393 bb1 = bb2;
1394 bb2 = info->default_bb;
1395 e01 = e02;
1396 e01->flags = EDGE_TRUE_VALUE;
1397 e02 = make_edge (bb0, bb2, EDGE_FALSE_VALUE);
1398 edge e_default = find_edge (bb1, bb2);
1399 for (gphi_iterator gsi = gsi_start_phis (bb2);
1400 !gsi_end_p (gsi); gsi_next (&gsi))
1402 gphi *phi = gsi.phi ();
1403 tree arg = PHI_ARG_DEF_FROM_EDGE (phi, e_default);
1404 add_phi_arg (phi, arg, e02,
1405 gimple_phi_arg_location_from_edge (phi, e_default));
1407 /* Partially fix the dominator tree, if it is available. */
1408 if (dom_info_available_p (CDI_DOMINATORS))
1409 redirect_immediate_dominators (CDI_DOMINATORS, bb1, bb0);
1411 else
1413 e21 = split_block (bb2, last_assign);
1414 bb1 = e21->dest;
1415 remove_edge (e21);
1418 e1d = split_block (bb1, info->arr_ref_last);
1419 bbd = e1d->dest;
1420 remove_edge (e1d);
1422 /* flags and profiles of the edge for in-range values */
1423 if (!info->default_case_nonstandard)
1424 e01 = make_edge (bb0, bb1, EDGE_TRUE_VALUE);
1425 e01->probability = info->default_prob.invert ();
1426 e01->count = info->other_count;
1428 /* flags and profiles of the edge taking care of out-of-range values */
1429 e02->flags &= ~EDGE_FALLTHRU;
1430 e02->flags |= EDGE_FALSE_VALUE;
1431 e02->probability = info->default_prob;
1432 e02->count = info->default_count;
1434 bbf = info->final_bb;
1436 e1f = make_edge (bb1, bbf, EDGE_FALLTHRU);
1437 e1f->probability = profile_probability::always ();
1438 e1f->count = info->other_count;
1440 if (info->default_case_nonstandard)
1441 e2f = NULL;
1442 else
1444 e2f = make_edge (bb2, bbf, EDGE_FALLTHRU);
1445 e2f->probability = profile_probability::always ();
1446 e2f->count = info->default_count;
1449 /* frequencies of the new BBs */
1450 bb1->frequency = EDGE_FREQUENCY (e01);
1451 bb2->frequency = EDGE_FREQUENCY (e02);
1452 if (!info->default_case_nonstandard)
1453 bbf->frequency = EDGE_FREQUENCY (e1f) + EDGE_FREQUENCY (e2f);
1455 /* Tidy blocks that have become unreachable. */
1456 prune_bbs (bbd, info->final_bb,
1457 info->default_case_nonstandard ? info->default_bb : NULL);
1459 /* Fixup the PHI nodes in bbF. */
1460 fix_phi_nodes (e1f, e2f, bbf, info);
1462 /* Fix the dominator tree, if it is available. */
1463 if (dom_info_available_p (CDI_DOMINATORS))
1465 vec<basic_block> bbs_to_fix_dom;
1467 set_immediate_dominator (CDI_DOMINATORS, bb1, bb0);
1468 if (!info->default_case_nonstandard)
1469 set_immediate_dominator (CDI_DOMINATORS, bb2, bb0);
1470 if (! get_immediate_dominator (CDI_DOMINATORS, bbf))
1471 /* If bbD was the immediate dominator ... */
1472 set_immediate_dominator (CDI_DOMINATORS, bbf, bb0);
1474 bbs_to_fix_dom.create (3 + (bb2 != bbf));
1475 bbs_to_fix_dom.quick_push (bb0);
1476 bbs_to_fix_dom.quick_push (bb1);
1477 if (bb2 != bbf)
1478 bbs_to_fix_dom.quick_push (bb2);
1479 bbs_to_fix_dom.quick_push (bbf);
1481 iterate_fix_dominators (CDI_DOMINATORS, bbs_to_fix_dom, true);
1482 bbs_to_fix_dom.release ();
1486 /* The following function is invoked on every switch statement (the current one
1487 is given in SWTCH) and runs the individual phases of switch conversion on it
1488 one after another until one fails or the conversion is completed.
1489 Returns NULL on success, or a pointer to a string with the reason why the
1490 conversion failed. */
1492 static const char *
1493 process_switch (gswitch *swtch)
1495 struct switch_conv_info info;
1497 /* Group case labels so that we get the right results from the heuristics
1498 that decide on the code generation approach for this switch. */
1499 group_case_labels_stmt (swtch);
1501 /* If this switch is now a degenerate case with only a default label,
1502 there is nothing left for us to do. */
1503 if (gimple_switch_num_labels (swtch) < 2)
1504 return "switch is a degenerate case";
1506 collect_switch_conv_info (swtch, &info);
1508 /* No error markers should reach here (they should be filtered out
1509 during gimplification). */
1510 gcc_checking_assert (TREE_TYPE (info.index_expr) != error_mark_node);
1512 /* A switch on a constant should have been optimized in tree-cfg-cleanup. */
1513 gcc_checking_assert (! TREE_CONSTANT (info.index_expr));
1515 if (info.uniq <= MAX_CASE_BIT_TESTS)
1517 if (expand_switch_using_bit_tests_p (info.range_size,
1518 info.uniq, info.count,
1519 optimize_bb_for_speed_p
1520 (gimple_bb (swtch))))
1522 if (dump_file)
1523 fputs (" expanding as bit test is preferable\n", dump_file);
1524 emit_case_bit_tests (swtch, info.index_expr, info.range_min,
1525 info.range_size, info.range_max);
1526 loops_state_set (LOOPS_NEED_FIXUP);
1527 return NULL;
1530 if (info.uniq <= 2)
1531 /* This will be expanded as a decision tree in stmt.c:expand_case. */
1532 return " expanding as jumps is preferable";
1535 /* If there is no common successor, we cannot do the transformation. */
1536 if (! info.final_bb)
1537 return "no common successor to all case label target blocks found";
1539 /* Check the case label values are within reasonable range: */
1540 if (!check_range (&info))
1542 gcc_assert (info.reason);
1543 return info.reason;
1546 /* For all the cases, see whether they are empty, the assignments they
1547 represent constant and so on... */
1548 if (! check_all_empty_except_final (&info))
1550 gcc_assert (info.reason);
1551 return info.reason;
1553 if (!check_final_bb (swtch, &info))
1555 gcc_assert (info.reason);
1556 return info.reason;
1559 /* At this point all checks have passed and we can proceed with the
1560 transformation. */
1562 create_temp_arrays (&info);
1563 gather_default_values (info.default_case_nonstandard
1564 ? gimple_switch_label (swtch, 1)
1565 : gimple_switch_default_label (swtch), &info);
1566 build_constructors (swtch, &info);
1568 build_arrays (swtch, &info); /* Build the static arrays and assignments. */
1569 gen_inbound_check (swtch, &info); /* Build the bounds check. */
1571 /* Cleanup: */
1572 free_temp_arrays (&info);
1573 return NULL;
1576 /* The main function of the pass scans statements for switches and invokes
1577 process_switch on them. */
1579 namespace {
1581 const pass_data pass_data_convert_switch =
1583 GIMPLE_PASS, /* type */
1584 "switchconv", /* name */
1585 OPTGROUP_NONE, /* optinfo_flags */
1586 TV_TREE_SWITCH_CONVERSION, /* tv_id */
1587 ( PROP_cfg | PROP_ssa ), /* properties_required */
1588 0, /* properties_provided */
1589 0, /* properties_destroyed */
1590 0, /* todo_flags_start */
1591 TODO_update_ssa, /* todo_flags_finish */
1594 class pass_convert_switch : public gimple_opt_pass
1596 public:
1597 pass_convert_switch (gcc::context *ctxt)
1598 : gimple_opt_pass (pass_data_convert_switch, ctxt)
1601 /* opt_pass methods: */
1602 virtual bool gate (function *) { return flag_tree_switch_conversion != 0; }
1603 virtual unsigned int execute (function *);
1605 }; // class pass_convert_switch
1607 unsigned int
1608 pass_convert_switch::execute (function *fun)
1610 basic_block bb;
1612 FOR_EACH_BB_FN (bb, fun)
1614 const char *failure_reason;
1615 gimple *stmt = last_stmt (bb);
1616 if (stmt && gimple_code (stmt) == GIMPLE_SWITCH)
1618 if (dump_file)
1620 expanded_location loc = expand_location (gimple_location (stmt));
1622 fprintf (dump_file, "beginning to process the following "
1623 "SWITCH statement (%s:%d) : ------- \n",
1624 loc.file, loc.line);
1625 print_gimple_stmt (dump_file, stmt, 0, TDF_SLIM);
1626 putc ('\n', dump_file);
1629 failure_reason = process_switch (as_a <gswitch *> (stmt));
1630 if (! failure_reason)
1632 if (dump_file)
1634 fputs ("Switch converted\n", dump_file);
1635 fputs ("--------------------------------\n", dump_file);
1638 /* Make no effort to update the post-dominator tree. It is actually not
1639 that hard for the transformations we have performed, but it is not
1640 supported by iterate_fix_dominators. */
1641 free_dominance_info (CDI_POST_DOMINATORS);
1643 else
1645 if (dump_file)
1647 fputs ("Bailing out - ", dump_file);
1648 fputs (failure_reason, dump_file);
1649 fputs ("\n--------------------------------\n", dump_file);
1655 return 0;
1658 } // anon namespace
1660 gimple_opt_pass *
1661 make_pass_convert_switch (gcc::context *ctxt)
1663 return new pass_convert_switch (ctxt);