1 /* Lower GIMPLE_SWITCH expressions to something more efficient than
3 Copyright (C) 2006, 2008, 2009, 2010, 2011, 2012
4 Free Software Foundation, Inc.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 3, or (at your option) any
13 GCC is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not, write to the Free
20 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
23 /* This file handles the lowering of GIMPLE_SWITCH to an indexed
24 load, or a series of bit-test-and-branch expressions. */
28 #include "coretypes.h"
34 #include "basic-block.h"
35 #include "tree-flow.h"
36 #include "tree-flow-inline.h"
37 #include "tree-ssa-operands.h"
38 #include "tree-pass.h"
39 #include "gimple-pretty-print.h"
41 /* ??? For lang_hooks.types.type_for_mode, but is there a word_mode
42 type in the GIMPLE type system that is language-independent? */
43 #include "langhooks.h"
45 /* Need to include expr.h and optabs.h for lshift_cheap_p. */
49 /* Maximum number of case bit tests.
50 FIXME: This should be derived from PARAM_CASE_VALUES_THRESHOLD and
51 targetm.case_values_threshold(), or be its own param. */
52 #define MAX_CASE_BIT_TESTS 3
54 /* Split the basic block at the statement pointed to by GSIP, and insert
55 a branch to the target basic block of E_TRUE conditional on tree
58 It is assumed that there is already an edge from the to-be-split
59 basic block to E_TRUE->dest block. This edge is removed, and the
60 profile information on the edge is re-used for the new conditional
63 The CFG is updated. The dominator tree will not be valid after
64 this transformation, but the immediate dominators are updated if
65 UPDATE_DOMINATORS is true.
67 Returns the newly created basic block. */
70 hoist_edge_and_branch_if_true (gimple_stmt_iterator
*gsip
,
71 tree cond
, edge e_true
,
72 bool update_dominators
)
77 basic_block new_bb
, split_bb
= gsi_bb (*gsip
);
78 bool dominated_e_true
= false;
80 gcc_assert (e_true
->src
== split_bb
);
83 && get_immediate_dominator (CDI_DOMINATORS
, e_true
->dest
) == split_bb
)
84 dominated_e_true
= true;
86 tmp
= force_gimple_operand_gsi (gsip
, cond
, /*simple=*/true, NULL
,
87 /*before=*/true, GSI_SAME_STMT
);
88 cond_stmt
= gimple_build_cond_from_tree (tmp
, NULL_TREE
, NULL_TREE
);
89 gsi_insert_before (gsip
, cond_stmt
, GSI_SAME_STMT
);
91 e_false
= split_block (split_bb
, cond_stmt
);
92 new_bb
= e_false
->dest
;
93 redirect_edge_pred (e_true
, split_bb
);
95 e_true
->flags
&= ~EDGE_FALLTHRU
;
96 e_true
->flags
|= EDGE_TRUE_VALUE
;
98 e_false
->flags
&= ~EDGE_FALLTHRU
;
99 e_false
->flags
|= EDGE_FALSE_VALUE
;
100 e_false
->probability
= REG_BR_PROB_BASE
- e_true
->probability
;
101 e_false
->count
= split_bb
->count
- e_true
->count
;
102 new_bb
->count
= e_false
->count
;
104 if (update_dominators
)
106 if (dominated_e_true
)
107 set_immediate_dominator (CDI_DOMINATORS
, e_true
->dest
, split_bb
);
108 set_immediate_dominator (CDI_DOMINATORS
, e_false
->dest
, split_bb
);
115 /* Determine whether "1 << x" is relatively cheap in word_mode. */
116 /* FIXME: This is the function that we need rtl.h and optabs.h for.
117 This function (and similar RTL-related cost code in e.g. IVOPTS) should
118 be moved to some kind of interface file for GIMPLE/RTL interactions. */
120 lshift_cheap_p (void)
122 /* FIXME: This should be made target dependent via this "this_target"
123 mechanism, similar to e.g. can_copy_init_p in gcse.c. */
124 static bool init
[2] = {false, false};
125 static bool cheap
[2] = {true, true};
128 /* If the targer has no lshift in word_mode, the operation will most
129 probably not be cheap. ??? Does GCC even work for such targets? */
130 if (optab_handler (ashl_optab
, word_mode
) == CODE_FOR_nothing
)
133 speed_p
= optimize_insn_for_speed_p ();
137 rtx reg
= gen_raw_REG (word_mode
, 10000);
138 int cost
= set_src_cost (gen_rtx_ASHIFT (word_mode
, const1_rtx
, reg
),
140 cheap
[speed_p
] = cost
< COSTS_N_INSNS (MAX_CASE_BIT_TESTS
);
141 init
[speed_p
] = true;
144 return cheap
[speed_p
];
147 /* Return true if a switch should be expanded as a bit test.
148 RANGE is the difference between highest and lowest case.
149 UNIQ is number of unique case node targets, not counting the default case.
150 COUNT is the number of comparisons needed, not counting the default case. */
153 expand_switch_using_bit_tests_p (tree range
,
157 return (((uniq
== 1 && count
>= 3)
158 || (uniq
== 2 && count
>= 5)
159 || (uniq
== 3 && count
>= 6))
161 && compare_tree_int (range
, GET_MODE_BITSIZE (word_mode
)) < 0
162 && compare_tree_int (range
, 0) > 0);
165 /* Implement switch statements with bit tests
167 A GIMPLE switch statement can be expanded to a short sequence of bit-wise
168 comparisons. "switch(x)" is converted into "if ((1 << (x-MINVAL)) & CST)"
169 where CST and MINVAL are integer constants. This is better than a series
170 of compare-and-banch insns in some cases, e.g. we can implement:
172 if ((x==4) || (x==6) || (x==9) || (x==11))
174 as a single bit test:
176 if ((1<<x) & ((1<<4)|(1<<6)|(1<<9)|(1<<11)))
178 This transformation is only applied if the number of case targets is small,
179 if CST constains at least 3 bits, and "1 << x" is cheap. The bit tests are
180 performed in "word_mode".
182 The following example shows the code the transformation generates:
188 case '0': case '1': case '2': case '3': case '4':
189 case '5': case '6': case '7': case '8': case '9':
190 case 'A': case 'B': case 'C': case 'D': case 'E':
202 if (tmp1 > (70 - 48)) goto L2;
204 tmp3 = 0b11111100000001111111111;
205 if ((tmp2 & tmp3) != 0) goto L1 ; else goto L2;
212 TODO: There are still some improvements to this transformation that could
215 * A narrower mode than word_mode could be used if that is cheaper, e.g.
216 for x86_64 where a narrower-mode shift may result in smaller code.
218 * The compounded constant could be shifted rather than the one. The
219 test would be either on the sign bit or on the least significant bit,
220 depending on the direction of the shift. On some machines, the test
221 for the branch would be free if the bit to test is already set by the
224 This transformation was contributed by Roger Sayle, see this e-mail:
225 http://gcc.gnu.org/ml/gcc-patches/2003-01/msg01950.html
228 /* A case_bit_test represents a set of case nodes that may be
229 selected from using a bit-wise comparison. HI and LO hold
230 the integer to be tested against, TARGET_EDGE contains the
231 edge to the basic block to jump to upon success and BITS
232 counts the number of case nodes handled by this test,
233 typically the number of bits set in HI:LO. The LABEL field
234 is used to quickly identify all cases in this set without
235 looking at label_to_block for every case label. */
246 /* Comparison function for qsort to order bit tests by decreasing
247 probability of execution. Our best guess comes from a measured
248 profile. If the profile counts are equal, break even on the
249 number of case nodes, i.e. the node with the most cases gets
252 TODO: Actually this currently runs before a profile is available.
253 Therefore the case-as-bit-tests transformation should be done
254 later in the pass pipeline, or something along the lines of
255 "Efficient and effective branch reordering using profile data"
256 (Yang et. al., 2002) should be implemented (although, how good
257 is a paper is called "Efficient and effective ..." when the
258 latter is implied by the former, but oh well...). */
261 case_bit_test_cmp (const void *p1
, const void *p2
)
263 const struct case_bit_test
*const d1
= (const struct case_bit_test
*) p1
;
264 const struct case_bit_test
*const d2
= (const struct case_bit_test
*) p2
;
266 if (d2
->target_edge
->count
!= d1
->target_edge
->count
)
267 return d2
->target_edge
->count
- d1
->target_edge
->count
;
268 if (d2
->bits
!= d1
->bits
)
269 return d2
->bits
- d1
->bits
;
271 /* Stabilize the sort. */
272 return LABEL_DECL_UID (d2
->label
) - LABEL_DECL_UID (d1
->label
);
275 /* Expand a switch statement by a short sequence of bit-wise
276 comparisons. "switch(x)" is effectively converted into
277 "if ((1 << (x-MINVAL)) & CST)" where CST and MINVAL are
280 INDEX_EXPR is the value being switched on.
282 MINVAL is the lowest case value of in the case nodes,
283 and RANGE is highest value minus MINVAL. MINVAL and RANGE
284 are not guaranteed to be of the same type as INDEX_EXPR
285 (the gimplifier doesn't change the type of case label values,
286 and MINVAL and RANGE are derived from those values).
288 There *MUST* be MAX_CASE_BIT_TESTS or less unique case
292 emit_case_bit_tests (gimple swtch
, tree index_expr
,
293 tree minval
, tree range
)
295 struct case_bit_test test
[MAX_CASE_BIT_TESTS
];
296 unsigned int i
, j
, k
;
299 basic_block switch_bb
= gimple_bb (swtch
);
300 basic_block default_bb
, new_default_bb
, new_bb
;
302 bool update_dom
= dom_info_available_p (CDI_DOMINATORS
);
304 VEC (basic_block
, heap
) *bbs_to_fix_dom
= NULL
;
306 tree index_type
= TREE_TYPE (index_expr
);
307 tree unsigned_index_type
= unsigned_type_for (index_type
);
308 unsigned int branch_num
= gimple_switch_num_labels (swtch
);
310 gimple_stmt_iterator gsi
;
314 tree word_type_node
= lang_hooks
.types
.type_for_mode (word_mode
, 1);
315 tree word_mode_zero
= fold_convert (word_type_node
, integer_zero_node
);
316 tree word_mode_one
= fold_convert (word_type_node
, integer_one_node
);
318 memset (&test
, 0, sizeof (test
));
320 /* Get the edge for the default case. */
321 tmp
= gimple_switch_label (swtch
, 0);
322 default_bb
= label_to_block (CASE_LABEL (tmp
));
323 default_edge
= find_edge (switch_bb
, default_bb
);
325 /* Go through all case labels, and collect the case labels, profile
326 counts, and other information we need to build the branch tests. */
328 for (i
= 1; i
< branch_num
; i
++)
331 tree cs
= gimple_switch_label (swtch
, i
);
332 tree label
= CASE_LABEL (cs
);
333 edge e
= find_edge (switch_bb
, label_to_block (label
));
334 for (k
= 0; k
< count
; k
++)
335 if (e
== test
[k
].target_edge
)
340 gcc_checking_assert (count
< MAX_CASE_BIT_TESTS
);
343 test
[k
].target_edge
= e
;
344 test
[k
].label
= label
;
351 lo
= tree_low_cst (int_const_binop (MINUS_EXPR
,
352 CASE_LOW (cs
), minval
),
354 if (CASE_HIGH (cs
) == NULL_TREE
)
357 hi
= tree_low_cst (int_const_binop (MINUS_EXPR
,
358 CASE_HIGH (cs
), minval
),
361 for (j
= lo
; j
<= hi
; j
++)
362 if (j
>= HOST_BITS_PER_WIDE_INT
)
363 test
[k
].hi
|= (HOST_WIDE_INT
) 1 << (j
- HOST_BITS_PER_INT
);
365 test
[k
].lo
|= (HOST_WIDE_INT
) 1 << j
;
368 qsort (test
, count
, sizeof(*test
), case_bit_test_cmp
);
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
373 new_default_bb
= split_edge (default_edge
);
377 bbs_to_fix_dom
= VEC_alloc (basic_block
, heap
, 10);
378 VEC_quick_push (basic_block
, bbs_to_fix_dom
, switch_bb
);
379 VEC_quick_push (basic_block
, bbs_to_fix_dom
, default_bb
);
380 VEC_quick_push (basic_block
, bbs_to_fix_dom
, 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
);
403 VEC_quick_push (basic_block
, bbs_to_fix_dom
, 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. */
411 VEC (basic_block
, heap
) *dom_bbs
;
414 dom_bbs
= get_dominated_by (CDI_DOMINATORS
, new_bb
);
415 FOR_EACH_VEC_ELT (basic_block
, dom_bbs
, i
, dom_son
)
417 edge e
= find_edge (new_bb
, dom_son
);
418 if (e
&& single_pred_p (e
->dest
))
420 set_immediate_dominator (CDI_DOMINATORS
, dom_son
, switch_bb
);
421 VEC_safe_push (basic_block
, heap
, bbs_to_fix_dom
, dom_son
);
423 VEC_free (basic_block
, heap
, dom_bbs
);
426 /* csui = (1 << (word_mode) idx) */
427 csui
= make_ssa_name (word_type_node
, NULL
);
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
= build_int_cst_wide (word_type_node
, test
[k
].lo
, test
[k
].hi
);
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
,
450 VEC_safe_push (basic_block
, heap
, bbs_to_fix_dom
, 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);
466 /* Fix up the dominator tree. */
467 iterate_fix_dominators (CDI_DOMINATORS
, bbs_to_fix_dom
, true);
468 VEC_free (basic_block
, heap
, bbs_to_fix_dom
);
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:
502 a_5 = PHI <a_1, a_2, a_3, a_4>
503 b_5 = PHI <b_1, b_2, b_3, b_4>
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,
512 if (((unsigned) argc) - 1 < 11)
514 a_6 = CSWTCH02[argc - 1];
515 b_6 = CSWTCH01[argc - 1];
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. */
538 /* The following integer constants store the minimum and maximum value
539 covered by the case labels. */
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. */
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. */
561 /* The count of the default edge in the replaced switch. */
562 gcov_type default_count
;
564 /* Combined count of all other (non-default) edges in the replaced switch. */
565 gcov_type other_count
;
567 /* Number of phi nodes in the final bb (that we'll be replacing). */
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
, gc
) **constructors
;
576 /* Array of ssa names that are initialized with a value from a new static
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 /* The first load statement that loads a temporary from a new static array.
586 gimple arr_ref_first
;
588 /* The last load statement that loads a temporary from a new static array. */
591 /* String reason why the case wasn't a good candidate that is written to the
592 dump file, if there is one. */
595 /* Parameters for expand_switch_using_bit_tests. Should be computed
596 the same way as in expand_case. */
601 /* Collect information about GIMPLE_SWITCH statement SWTCH into INFO. */
604 collect_switch_conv_info (gimple swtch
, struct switch_conv_info
*info
)
606 unsigned int branch_num
= gimple_switch_num_labels (swtch
);
607 tree min_case
, max_case
;
608 unsigned int count
, i
;
612 memset (info
, 0, sizeof (*info
));
614 /* The gimplifier has already sorted the cases by CASE_LOW and ensured there
615 is a default label which is the first in the vector. */
616 gcc_assert (CASE_LOW (gimple_switch_label (swtch
, 0)) == NULL_TREE
);
618 /* Collect the bits we can deduce from the CFG. */
619 info
->index_expr
= gimple_switch_index (swtch
);
620 info
->switch_bb
= gimple_bb (swtch
);
622 label_to_block (CASE_LABEL (gimple_switch_label (swtch
, 0)));
623 e_default
= find_edge (info
->switch_bb
, info
->default_bb
);
624 info
->default_prob
= e_default
->probability
;
625 info
->default_count
= e_default
->count
;
626 FOR_EACH_EDGE (e
, ei
, info
->switch_bb
->succs
)
628 info
->other_count
+= e
->count
;
630 /* See if there is one common successor block for all branch
631 targets. If it exists, record it in FINAL_BB. */
632 FOR_EACH_EDGE (e
, ei
, info
->switch_bb
->succs
)
634 if (! single_pred_p (e
->dest
))
636 info
->final_bb
= e
->dest
;
641 FOR_EACH_EDGE (e
, ei
, info
->switch_bb
->succs
)
643 if (e
->dest
== info
->final_bb
)
646 if (single_pred_p (e
->dest
)
647 && single_succ_p (e
->dest
)
648 && single_succ (e
->dest
) == info
->final_bb
)
651 info
->final_bb
= NULL
;
655 /* Get upper and lower bounds of case values, and the covered range. */
656 min_case
= gimple_switch_label (swtch
, 1);
657 max_case
= gimple_switch_label (swtch
, branch_num
- 1);
659 info
->range_min
= CASE_LOW (min_case
);
660 if (CASE_HIGH (max_case
) != NULL_TREE
)
661 info
->range_max
= CASE_HIGH (max_case
);
663 info
->range_max
= CASE_LOW (max_case
);
666 int_const_binop (MINUS_EXPR
, info
->range_max
, info
->range_min
);
668 /* Get a count of the number of case labels. Single-valued case labels
669 simply count as one, but a case range counts double, since it may
670 require two compares if it gets lowered as a branching tree. */
672 for (i
= 1; i
< branch_num
; i
++)
674 tree elt
= gimple_switch_label (swtch
, i
);
677 && ! tree_int_cst_equal (CASE_LOW (elt
), CASE_HIGH (elt
)))
682 /* Get the number of unique non-default targets out of the GIMPLE_SWITCH
683 block. Assume a CFG cleanup would have already removed degenerate
684 switch statements, this allows us to just use EDGE_COUNT. */
685 info
->uniq
= EDGE_COUNT (gimple_bb (swtch
)->succs
) - 1;
688 /* Checks whether the range given by individual case statements of the SWTCH
689 switch statement isn't too big and whether the number of branches actually
690 satisfies the size of the new array. */
693 check_range (struct switch_conv_info
*info
)
695 gcc_assert (info
->range_size
);
696 if (!host_integerp (info
->range_size
, 1))
698 info
->reason
= "index range way too large or otherwise unusable";
702 if ((unsigned HOST_WIDE_INT
) tree_low_cst (info
->range_size
, 1)
703 > ((unsigned) info
->count
* SWITCH_CONVERSION_BRANCH_RATIO
))
705 info
->reason
= "the maximum range-branch ratio exceeded";
712 /* Checks whether all but the FINAL_BB basic blocks are empty. */
715 check_all_empty_except_final (struct switch_conv_info
*info
)
720 FOR_EACH_EDGE (e
, ei
, info
->switch_bb
->succs
)
722 if (e
->dest
== info
->final_bb
)
725 if (!empty_block_p (e
->dest
))
727 info
->reason
= "bad case - a non-final BB not empty";
735 /* This function checks whether all required values in phi nodes in final_bb
736 are constants. Required values are those that correspond to a basic block
737 which is a part of the examined switch statement. It returns true if the
738 phi nodes are OK, otherwise false. */
741 check_final_bb (struct switch_conv_info
*info
)
743 gimple_stmt_iterator gsi
;
746 for (gsi
= gsi_start_phis (info
->final_bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
748 gimple phi
= gsi_stmt (gsi
);
753 for (i
= 0; i
< gimple_phi_num_args (phi
); i
++)
755 basic_block bb
= gimple_phi_arg_edge (phi
, i
)->src
;
757 if (bb
== info
->switch_bb
758 || (single_pred_p (bb
) && single_pred (bb
) == info
->switch_bb
))
762 val
= gimple_phi_arg_def (phi
, i
);
763 if (!is_gimple_ip_invariant (val
))
765 info
->reason
= "non-invariant value from a case";
766 return false; /* Non-invariant argument. */
768 reloc
= initializer_constant_valid_p (val
, TREE_TYPE (val
));
769 if ((flag_pic
&& reloc
!= null_pointer_node
)
770 || (!flag_pic
&& reloc
== NULL_TREE
))
774 = "value from a case would need runtime relocations";
777 = "value from a case is not a valid initializer";
787 /* The following function allocates default_values, target_{in,out}_names and
788 constructors arrays. The last one is also populated with pointers to
789 vectors that will become constructors of new arrays. */
792 create_temp_arrays (struct switch_conv_info
*info
)
796 info
->default_values
= XCNEWVEC (tree
, info
->phi_count
* 3);
797 info
->constructors
= XCNEWVEC (VEC (constructor_elt
, gc
) *, info
->phi_count
);
798 info
->target_inbound_names
= info
->default_values
+ info
->phi_count
;
799 info
->target_outbound_names
= info
->target_inbound_names
+ info
->phi_count
;
800 for (i
= 0; i
< info
->phi_count
; i
++)
801 info
->constructors
[i
]
802 = VEC_alloc (constructor_elt
, gc
, tree_low_cst (info
->range_size
, 1) + 1);
805 /* Free the arrays created by create_temp_arrays(). The vectors that are
806 created by that function are not freed here, however, because they have
807 already become constructors and must be preserved. */
810 free_temp_arrays (struct switch_conv_info
*info
)
812 XDELETEVEC (info
->constructors
);
813 XDELETEVEC (info
->default_values
);
816 /* Populate the array of default values in the order of phi nodes.
817 DEFAULT_CASE is the CASE_LABEL_EXPR for the default switch branch. */
820 gather_default_values (tree default_case
, struct switch_conv_info
*info
)
822 gimple_stmt_iterator gsi
;
823 basic_block bb
= label_to_block (CASE_LABEL (default_case
));
827 gcc_assert (CASE_LOW (default_case
) == NULL_TREE
);
829 if (bb
== info
->final_bb
)
830 e
= find_edge (info
->switch_bb
, bb
);
832 e
= single_succ_edge (bb
);
834 for (gsi
= gsi_start_phis (info
->final_bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
836 gimple phi
= gsi_stmt (gsi
);
837 tree val
= PHI_ARG_DEF_FROM_EDGE (phi
, e
);
839 info
->default_values
[i
++] = val
;
843 /* The following function populates the vectors in the constructors array with
844 future contents of the static arrays. The vectors are populated in the
845 order of phi nodes. SWTCH is the switch statement being converted. */
848 build_constructors (gimple swtch
, struct switch_conv_info
*info
)
850 unsigned i
, branch_num
= gimple_switch_num_labels (swtch
);
851 tree pos
= info
->range_min
;
853 for (i
= 1; i
< branch_num
; i
++)
855 tree cs
= gimple_switch_label (swtch
, i
);
856 basic_block bb
= label_to_block (CASE_LABEL (cs
));
859 gimple_stmt_iterator gsi
;
862 if (bb
== info
->final_bb
)
863 e
= find_edge (info
->switch_bb
, bb
);
865 e
= single_succ_edge (bb
);
868 while (tree_int_cst_lt (pos
, CASE_LOW (cs
)))
871 for (k
= 0; k
< info
->phi_count
; k
++)
873 constructor_elt
*elt
;
875 elt
= VEC_quick_push (constructor_elt
,
876 info
->constructors
[k
], NULL
);
877 elt
->index
= int_const_binop (MINUS_EXPR
, pos
,
879 elt
->value
= info
->default_values
[k
];
882 pos
= int_const_binop (PLUS_EXPR
, pos
, integer_one_node
);
884 gcc_assert (tree_int_cst_equal (pos
, CASE_LOW (cs
)));
888 high
= CASE_HIGH (cs
);
890 high
= CASE_LOW (cs
);
891 for (gsi
= gsi_start_phis (info
->final_bb
);
892 !gsi_end_p (gsi
); gsi_next (&gsi
))
894 gimple phi
= gsi_stmt (gsi
);
895 tree val
= PHI_ARG_DEF_FROM_EDGE (phi
, e
);
896 tree low
= CASE_LOW (cs
);
901 constructor_elt
*elt
;
903 elt
= VEC_quick_push (constructor_elt
,
904 info
->constructors
[j
], NULL
);
905 elt
->index
= int_const_binop (MINUS_EXPR
, pos
, info
->range_min
);
908 pos
= int_const_binop (PLUS_EXPR
, pos
, integer_one_node
);
909 } while (!tree_int_cst_lt (high
, pos
)
910 && tree_int_cst_lt (low
, pos
));
916 /* If all values in the constructor vector are the same, return the value.
917 Otherwise return NULL_TREE. Not supposed to be called for empty
921 constructor_contains_same_values_p (VEC (constructor_elt
, gc
) *vec
)
924 tree prev
= NULL_TREE
;
925 constructor_elt
*elt
;
927 FOR_EACH_VEC_ELT (constructor_elt
, vec
, i
, elt
)
931 else if (!operand_equal_p (elt
->value
, prev
, OEP_ONLY_CONST
))
937 /* Return type which should be used for array elements, either TYPE,
938 or for integral type some smaller integral type that can still hold
939 all the constants. */
942 array_value_type (gimple swtch
, tree type
, int num
,
943 struct switch_conv_info
*info
)
945 unsigned int i
, len
= VEC_length (constructor_elt
, info
->constructors
[num
]);
946 constructor_elt
*elt
;
947 enum machine_mode mode
;
951 if (!INTEGRAL_TYPE_P (type
))
954 mode
= GET_CLASS_NARROWEST_MODE (GET_MODE_CLASS (TYPE_MODE (type
)));
955 if (GET_MODE_SIZE (TYPE_MODE (type
)) <= GET_MODE_SIZE (mode
))
958 if (len
< (optimize_bb_for_size_p (gimple_bb (swtch
)) ? 2 : 32))
961 FOR_EACH_VEC_ELT (constructor_elt
, info
->constructors
[num
], i
, elt
)
965 if (TREE_CODE (elt
->value
) != INTEGER_CST
)
968 cst
= TREE_INT_CST (elt
->value
);
971 unsigned int prec
= GET_MODE_BITSIZE (mode
);
972 if (prec
> HOST_BITS_PER_WIDE_INT
)
976 && double_int_equal_p (cst
, double_int_zext (cst
, prec
)))
979 && double_int_equal_p (cst
, double_int_sext (cst
, prec
)))
985 && double_int_equal_p (cst
, double_int_sext (cst
, prec
)))
994 mode
= GET_MODE_WIDER_MODE (mode
);
996 || GET_MODE_SIZE (mode
) >= GET_MODE_SIZE (TYPE_MODE (type
)))
1002 sign
= TYPE_UNSIGNED (type
) ? 1 : -1;
1003 smaller_type
= lang_hooks
.types
.type_for_mode (mode
, sign
>= 0);
1004 if (GET_MODE_SIZE (TYPE_MODE (type
))
1005 <= GET_MODE_SIZE (TYPE_MODE (smaller_type
)))
1008 return smaller_type
;
1011 /* Create an appropriate array type and declaration and assemble a static array
1012 variable. Also create a load statement that initializes the variable in
1013 question with a value from the static array. SWTCH is the switch statement
1014 being converted, NUM is the index to arrays of constructors, default values
1015 and target SSA names for this particular array. ARR_INDEX_TYPE is the type
1016 of the index of the new array, PHI is the phi node of the final BB that
1017 corresponds to the value that will be loaded from the created array. TIDX
1018 is an ssa name of a temporary variable holding the index for loads from the
1022 build_one_array (gimple swtch
, int num
, tree arr_index_type
, gimple phi
,
1023 tree tidx
, struct switch_conv_info
*info
)
1027 gimple_stmt_iterator gsi
= gsi_for_stmt (swtch
);
1028 location_t loc
= gimple_location (swtch
);
1030 gcc_assert (info
->default_values
[num
]);
1032 name
= copy_ssa_name (PHI_RESULT (phi
), NULL
);
1033 info
->target_inbound_names
[num
] = name
;
1035 cst
= constructor_contains_same_values_p (info
->constructors
[num
]);
1037 load
= gimple_build_assign (name
, cst
);
1040 tree array_type
, ctor
, decl
, value_type
, fetch
, default_type
;
1042 default_type
= TREE_TYPE (info
->default_values
[num
]);
1043 value_type
= array_value_type (swtch
, default_type
, num
, info
);
1044 array_type
= build_array_type (value_type
, arr_index_type
);
1045 if (default_type
!= value_type
)
1048 constructor_elt
*elt
;
1050 FOR_EACH_VEC_ELT (constructor_elt
, info
->constructors
[num
], i
, elt
)
1051 elt
->value
= fold_convert (value_type
, elt
->value
);
1053 ctor
= build_constructor (array_type
, info
->constructors
[num
]);
1054 TREE_CONSTANT (ctor
) = true;
1055 TREE_STATIC (ctor
) = true;
1057 decl
= build_decl (loc
, VAR_DECL
, NULL_TREE
, array_type
);
1058 TREE_STATIC (decl
) = 1;
1059 DECL_INITIAL (decl
) = ctor
;
1061 DECL_NAME (decl
) = create_tmp_var_name ("CSWTCH");
1062 DECL_ARTIFICIAL (decl
) = 1;
1063 TREE_CONSTANT (decl
) = 1;
1064 TREE_READONLY (decl
) = 1;
1065 varpool_finalize_decl (decl
);
1067 fetch
= build4 (ARRAY_REF
, value_type
, decl
, tidx
, NULL_TREE
,
1069 if (default_type
!= value_type
)
1071 fetch
= fold_convert (default_type
, fetch
);
1072 fetch
= force_gimple_operand_gsi (&gsi
, fetch
, true, NULL_TREE
,
1073 true, GSI_SAME_STMT
);
1075 load
= gimple_build_assign (name
, fetch
);
1078 gsi_insert_before (&gsi
, load
, GSI_SAME_STMT
);
1080 info
->arr_ref_last
= load
;
1083 /* Builds and initializes static arrays initialized with values gathered from
1084 the SWTCH switch statement. Also creates statements that load values from
1088 build_arrays (gimple swtch
, struct switch_conv_info
*info
)
1090 tree arr_index_type
;
1091 tree tidx
, sub
, utype
;
1093 gimple_stmt_iterator gsi
;
1095 location_t loc
= gimple_location (swtch
);
1097 gsi
= gsi_for_stmt (swtch
);
1099 /* Make sure we do not generate arithmetics in a subrange. */
1100 utype
= TREE_TYPE (info
->index_expr
);
1101 if (TREE_TYPE (utype
))
1102 utype
= lang_hooks
.types
.type_for_mode (TYPE_MODE (TREE_TYPE (utype
)), 1);
1104 utype
= lang_hooks
.types
.type_for_mode (TYPE_MODE (utype
), 1);
1106 arr_index_type
= build_index_type (info
->range_size
);
1107 tidx
= make_ssa_name (utype
, NULL
);
1108 sub
= fold_build2_loc (loc
, MINUS_EXPR
, utype
,
1109 fold_convert_loc (loc
, utype
, info
->index_expr
),
1110 fold_convert_loc (loc
, utype
, info
->range_min
));
1111 sub
= force_gimple_operand_gsi (&gsi
, sub
,
1112 false, NULL
, true, GSI_SAME_STMT
);
1113 stmt
= gimple_build_assign (tidx
, sub
);
1115 gsi_insert_before (&gsi
, stmt
, GSI_SAME_STMT
);
1117 info
->arr_ref_first
= stmt
;
1119 for (gsi
= gsi_start_phis (info
->final_bb
), i
= 0;
1120 !gsi_end_p (gsi
); gsi_next (&gsi
), i
++)
1121 build_one_array (swtch
, i
, arr_index_type
, gsi_stmt (gsi
), tidx
, info
);
1124 /* Generates and appropriately inserts loads of default values at the position
1125 given by BSI. Returns the last inserted statement. */
1128 gen_def_assigns (gimple_stmt_iterator
*gsi
, struct switch_conv_info
*info
)
1131 gimple assign
= NULL
;
1133 for (i
= 0; i
< info
->phi_count
; i
++)
1135 tree name
= copy_ssa_name (info
->target_inbound_names
[i
], NULL
);
1136 info
->target_outbound_names
[i
] = name
;
1137 assign
= gimple_build_assign (name
, info
->default_values
[i
]);
1138 gsi_insert_before (gsi
, assign
, GSI_SAME_STMT
);
1139 update_stmt (assign
);
1144 /* Deletes the unused bbs and edges that now contain the switch statement and
1145 its empty branch bbs. BBD is the now dead BB containing the original switch
1146 statement, FINAL is the last BB of the converted switch statement (in terms
1150 prune_bbs (basic_block bbd
, basic_block final
)
1155 for (ei
= ei_start (bbd
->succs
); (e
= ei_safe_edge (ei
)); )
1161 delete_basic_block (bb
);
1163 delete_basic_block (bbd
);
1166 /* Add values to phi nodes in final_bb for the two new edges. E1F is the edge
1167 from the basic block loading values from an array and E2F from the basic
1168 block loading default values. BBF is the last switch basic block (see the
1169 bbf description in the comment below). */
1172 fix_phi_nodes (edge e1f
, edge e2f
, basic_block bbf
,
1173 struct switch_conv_info
*info
)
1175 gimple_stmt_iterator gsi
;
1178 for (gsi
= gsi_start_phis (bbf
), i
= 0;
1179 !gsi_end_p (gsi
); gsi_next (&gsi
), i
++)
1181 gimple phi
= gsi_stmt (gsi
);
1182 add_phi_arg (phi
, info
->target_inbound_names
[i
], e1f
, UNKNOWN_LOCATION
);
1183 add_phi_arg (phi
, info
->target_outbound_names
[i
], e2f
, UNKNOWN_LOCATION
);
1187 /* Creates a check whether the switch expression value actually falls into the
1188 range given by all the cases. If it does not, the temporaries are loaded
1189 with default values instead. SWTCH is the switch statement being converted.
1191 bb0 is the bb with the switch statement, however, we'll end it with a
1194 bb1 is the bb to be used when the range check went ok. It is derived from
1197 bb2 is the bb taken when the expression evaluated outside of the range
1198 covered by the created arrays. It is populated by loads of default
1201 bbF is a fall through for both bb1 and bb2 and contains exactly what
1202 originally followed the switch statement.
1204 bbD contains the switch statement (in the end). It is unreachable but we
1205 still need to strip off its edges.
1209 gen_inbound_check (gimple swtch
, struct switch_conv_info
*info
)
1211 tree label_decl1
= create_artificial_label (UNKNOWN_LOCATION
);
1212 tree label_decl2
= create_artificial_label (UNKNOWN_LOCATION
);
1213 tree label_decl3
= create_artificial_label (UNKNOWN_LOCATION
);
1214 gimple label1
, label2
, label3
;
1221 gimple_stmt_iterator gsi
;
1222 basic_block bb0
, bb1
, bb2
, bbf
, bbd
;
1223 edge e01
, e02
, e21
, e1d
, e1f
, e2f
;
1224 location_t loc
= gimple_location (swtch
);
1226 gcc_assert (info
->default_values
);
1228 bb0
= gimple_bb (swtch
);
1230 tidx
= gimple_assign_lhs (info
->arr_ref_first
);
1231 utype
= TREE_TYPE (tidx
);
1233 /* (end of) block 0 */
1234 gsi
= gsi_for_stmt (info
->arr_ref_first
);
1237 bound
= fold_convert_loc (loc
, utype
, info
->range_size
);
1238 cond_stmt
= gimple_build_cond (LE_EXPR
, tidx
, bound
, NULL_TREE
, NULL_TREE
);
1239 gsi_insert_before (&gsi
, cond_stmt
, GSI_SAME_STMT
);
1240 update_stmt (cond_stmt
);
1243 label2
= gimple_build_label (label_decl2
);
1244 gsi_insert_before (&gsi
, label2
, GSI_SAME_STMT
);
1245 last_assign
= gen_def_assigns (&gsi
, info
);
1248 label1
= gimple_build_label (label_decl1
);
1249 gsi_insert_before (&gsi
, label1
, GSI_SAME_STMT
);
1252 gsi
= gsi_start_bb (info
->final_bb
);
1253 label3
= gimple_build_label (label_decl3
);
1254 gsi_insert_before (&gsi
, label3
, GSI_SAME_STMT
);
1257 e02
= split_block (bb0
, cond_stmt
);
1260 e21
= split_block (bb2
, last_assign
);
1264 e1d
= split_block (bb1
, info
->arr_ref_last
);
1268 /* flags and profiles of the edge for in-range values */
1269 e01
= make_edge (bb0
, bb1
, EDGE_TRUE_VALUE
);
1270 e01
->probability
= REG_BR_PROB_BASE
- info
->default_prob
;
1271 e01
->count
= info
->other_count
;
1273 /* flags and profiles of the edge taking care of out-of-range values */
1274 e02
->flags
&= ~EDGE_FALLTHRU
;
1275 e02
->flags
|= EDGE_FALSE_VALUE
;
1276 e02
->probability
= info
->default_prob
;
1277 e02
->count
= info
->default_count
;
1279 bbf
= info
->final_bb
;
1281 e1f
= make_edge (bb1
, bbf
, EDGE_FALLTHRU
);
1282 e1f
->probability
= REG_BR_PROB_BASE
;
1283 e1f
->count
= info
->other_count
;
1285 e2f
= make_edge (bb2
, bbf
, EDGE_FALLTHRU
);
1286 e2f
->probability
= REG_BR_PROB_BASE
;
1287 e2f
->count
= info
->default_count
;
1289 /* frequencies of the new BBs */
1290 bb1
->frequency
= EDGE_FREQUENCY (e01
);
1291 bb2
->frequency
= EDGE_FREQUENCY (e02
);
1292 bbf
->frequency
= EDGE_FREQUENCY (e1f
) + EDGE_FREQUENCY (e2f
);
1294 /* Tidy blocks that have become unreachable. */
1295 prune_bbs (bbd
, info
->final_bb
);
1297 /* Fixup the PHI nodes in bbF. */
1298 fix_phi_nodes (e1f
, e2f
, bbf
, info
);
1300 /* Fix the dominator tree, if it is available. */
1301 if (dom_info_available_p (CDI_DOMINATORS
))
1303 VEC (basic_block
, heap
) *bbs_to_fix_dom
;
1305 set_immediate_dominator (CDI_DOMINATORS
, bb1
, bb0
);
1306 set_immediate_dominator (CDI_DOMINATORS
, bb2
, bb0
);
1307 if (! get_immediate_dominator (CDI_DOMINATORS
, bbf
))
1308 /* If bbD was the immediate dominator ... */
1309 set_immediate_dominator (CDI_DOMINATORS
, bbf
, bb0
);
1311 bbs_to_fix_dom
= VEC_alloc (basic_block
, heap
, 4);
1312 VEC_quick_push (basic_block
, bbs_to_fix_dom
, bb0
);
1313 VEC_quick_push (basic_block
, bbs_to_fix_dom
, bb1
);
1314 VEC_quick_push (basic_block
, bbs_to_fix_dom
, bb2
);
1315 VEC_quick_push (basic_block
, bbs_to_fix_dom
, bbf
);
1317 iterate_fix_dominators (CDI_DOMINATORS
, bbs_to_fix_dom
, true);
1318 VEC_free (basic_block
, heap
, bbs_to_fix_dom
);
1322 /* The following function is invoked on every switch statement (the current one
1323 is given in SWTCH) and runs the individual phases of switch conversion on it
1324 one after another until one fails or the conversion is completed.
1325 Returns NULL on success, or a pointer to a string with the reason why the
1326 conversion failed. */
1329 process_switch (gimple swtch
)
1331 struct switch_conv_info info
;
1333 /* Group case labels so that we get the right results from the heuristics
1334 that decide on the code generation approach for this switch. */
1335 group_case_labels_stmt (swtch
);
1337 /* If this switch is now a degenerate case with only a default label,
1338 there is nothing left for us to do. */
1339 if (gimple_switch_num_labels (swtch
) < 2)
1340 return "switch is a degenerate case";
1342 collect_switch_conv_info (swtch
, &info
);
1344 /* No error markers should reach here (they should be filtered out
1345 during gimplification). */
1346 gcc_checking_assert (TREE_TYPE (info
.index_expr
) != error_mark_node
);
1348 /* A switch on a constant should have been optimized in tree-cfg-cleanup. */
1349 gcc_checking_assert (! TREE_CONSTANT (info
.index_expr
));
1351 if (info
.uniq
<= MAX_CASE_BIT_TESTS
)
1353 if (expand_switch_using_bit_tests_p (info
.range_size
,
1354 info
.uniq
, info
.count
))
1357 fputs (" expanding as bit test is preferable\n", dump_file
);
1358 emit_case_bit_tests (swtch
, info
.index_expr
,
1359 info
.range_min
, info
.range_size
);
1364 /* This will be expanded as a decision tree in stmt.c:expand_case. */
1365 return " expanding as jumps is preferable";
1368 /* If there is no common successor, we cannot do the transformation. */
1369 if (! info
.final_bb
)
1370 return "no common successor to all case label target blocks found";
1372 /* Check the case label values are within reasonable range: */
1373 if (!check_range (&info
))
1375 gcc_assert (info
.reason
);
1379 /* For all the cases, see whether they are empty, the assignments they
1380 represent constant and so on... */
1381 if (! check_all_empty_except_final (&info
))
1383 gcc_assert (info
.reason
);
1386 if (!check_final_bb (&info
))
1388 gcc_assert (info
.reason
);
1392 /* At this point all checks have passed and we can proceed with the
1395 create_temp_arrays (&info
);
1396 gather_default_values (gimple_switch_label (swtch
, 0), &info
);
1397 build_constructors (swtch
, &info
);
1399 build_arrays (swtch
, &info
); /* Build the static arrays and assignments. */
1400 gen_inbound_check (swtch
, &info
); /* Build the bounds check. */
1403 free_temp_arrays (&info
);
1407 /* The main function of the pass scans statements for switches and invokes
1408 process_switch on them. */
1411 do_switchconv (void)
1417 const char *failure_reason
;
1418 gimple stmt
= last_stmt (bb
);
1419 if (stmt
&& gimple_code (stmt
) == GIMPLE_SWITCH
)
1423 expanded_location loc
= expand_location (gimple_location (stmt
));
1425 fprintf (dump_file
, "beginning to process the following "
1426 "SWITCH statement (%s:%d) : ------- \n",
1427 loc
.file
, loc
.line
);
1428 print_gimple_stmt (dump_file
, stmt
, 0, TDF_SLIM
);
1429 putc ('\n', dump_file
);
1432 failure_reason
= process_switch (stmt
);
1433 if (! failure_reason
)
1437 fputs ("Switch converted\n", dump_file
);
1438 fputs ("--------------------------------\n", dump_file
);
1441 /* Make no effort to update the post-dominator tree. It is actually not
1442 that hard for the transformations we have performed, but it is not
1443 supported by iterate_fix_dominators. */
1444 free_dominance_info (CDI_POST_DOMINATORS
);
1450 fputs ("Bailing out - ", dump_file
);
1451 fputs (failure_reason
, dump_file
);
1452 fputs ("\n--------------------------------\n", dump_file
);
1461 /* The pass gate. */
1464 switchconv_gate (void)
1466 return flag_tree_switch_conversion
!= 0;
1469 struct gimple_opt_pass pass_convert_switch
=
1473 "switchconv", /* name */
1474 switchconv_gate
, /* gate */
1475 do_switchconv
, /* execute */
1478 0, /* static_pass_number */
1479 TV_TREE_SWITCH_CONVERSION
, /* tv_id */
1480 PROP_cfg
| PROP_ssa
, /* properties_required */
1481 0, /* properties_provided */
1482 0, /* properties_destroyed */
1483 0, /* todo_flags_start */
1485 | TODO_ggc_collect
| TODO_verify_ssa
1487 | TODO_verify_flow
/* todo_flags_finish */