1 /* Lower GIMPLE_SWITCH expressions to something more efficient than
3 Copyright (C) 2006-2014 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
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
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
22 /* This file handles the lowering of GIMPLE_SWITCH to an indexed
23 load, or a series of bit-test-and-branch expressions. */
27 #include "coretypes.h"
34 #include "stor-layout.h"
35 #include "basic-block.h"
36 #include "tree-ssa-alias.h"
37 #include "internal-fn.h"
38 #include "gimple-expr.h"
42 #include "gimple-iterator.h"
43 #include "gimplify-me.h"
44 #include "gimple-ssa.h"
47 #include "tree-phinodes.h"
48 #include "stringpool.h"
49 #include "tree-ssanames.h"
50 #include "tree-pass.h"
51 #include "gimple-pretty-print.h"
54 /* ??? For lang_hooks.types.type_for_mode, but is there a word_mode
55 type in the GIMPLE type system that is language-independent? */
56 #include "langhooks.h"
58 /* Need to include expr.h and optabs.h for lshift_cheap_p. */
62 /* Maximum number of case bit tests.
63 FIXME: This should be derived from PARAM_CASE_VALUES_THRESHOLD and
64 targetm.case_values_threshold(), or be its own param. */
65 #define MAX_CASE_BIT_TESTS 3
67 /* Split the basic block at the statement pointed to by GSIP, and insert
68 a branch to the target basic block of E_TRUE conditional on tree
71 It is assumed that there is already an edge from the to-be-split
72 basic block to E_TRUE->dest block. This edge is removed, and the
73 profile information on the edge is re-used for the new conditional
76 The CFG is updated. The dominator tree will not be valid after
77 this transformation, but the immediate dominators are updated if
78 UPDATE_DOMINATORS is true.
80 Returns the newly created basic block. */
83 hoist_edge_and_branch_if_true (gimple_stmt_iterator
*gsip
,
84 tree cond
, edge e_true
,
85 bool update_dominators
)
90 basic_block new_bb
, split_bb
= gsi_bb (*gsip
);
91 bool dominated_e_true
= false;
93 gcc_assert (e_true
->src
== split_bb
);
96 && get_immediate_dominator (CDI_DOMINATORS
, e_true
->dest
) == split_bb
)
97 dominated_e_true
= true;
99 tmp
= force_gimple_operand_gsi (gsip
, cond
, /*simple=*/true, NULL
,
100 /*before=*/true, GSI_SAME_STMT
);
101 cond_stmt
= gimple_build_cond_from_tree (tmp
, NULL_TREE
, NULL_TREE
);
102 gsi_insert_before (gsip
, cond_stmt
, GSI_SAME_STMT
);
104 e_false
= split_block (split_bb
, cond_stmt
);
105 new_bb
= e_false
->dest
;
106 redirect_edge_pred (e_true
, split_bb
);
108 e_true
->flags
&= ~EDGE_FALLTHRU
;
109 e_true
->flags
|= EDGE_TRUE_VALUE
;
111 e_false
->flags
&= ~EDGE_FALLTHRU
;
112 e_false
->flags
|= EDGE_FALSE_VALUE
;
113 e_false
->probability
= REG_BR_PROB_BASE
- e_true
->probability
;
114 e_false
->count
= split_bb
->count
- e_true
->count
;
115 new_bb
->count
= e_false
->count
;
117 if (update_dominators
)
119 if (dominated_e_true
)
120 set_immediate_dominator (CDI_DOMINATORS
, e_true
->dest
, split_bb
);
121 set_immediate_dominator (CDI_DOMINATORS
, e_false
->dest
, split_bb
);
128 /* Determine whether "1 << x" is relatively cheap in word_mode. */
129 /* FIXME: This is the function that we need rtl.h and optabs.h for.
130 This function (and similar RTL-related cost code in e.g. IVOPTS) should
131 be moved to some kind of interface file for GIMPLE/RTL interactions. */
133 lshift_cheap_p (bool speed_p
)
135 /* FIXME: This should be made target dependent via this "this_target"
136 mechanism, similar to e.g. can_copy_init_p in gcse.c. */
137 static bool init
[2] = {false, false};
138 static bool cheap
[2] = {true, true};
140 /* If the targer has no lshift in word_mode, the operation will most
141 probably not be cheap. ??? Does GCC even work for such targets? */
142 if (optab_handler (ashl_optab
, word_mode
) == CODE_FOR_nothing
)
147 rtx reg
= gen_raw_REG (word_mode
, 10000);
148 int cost
= set_src_cost (gen_rtx_ASHIFT (word_mode
, const1_rtx
, reg
),
150 cheap
[speed_p
] = cost
< COSTS_N_INSNS (MAX_CASE_BIT_TESTS
);
151 init
[speed_p
] = true;
154 return cheap
[speed_p
];
157 /* Return true if a switch should be expanded as a bit test.
158 RANGE is the difference between highest and lowest case.
159 UNIQ is number of unique case node targets, not counting the default case.
160 COUNT is the number of comparisons needed, not counting the default case. */
163 expand_switch_using_bit_tests_p (tree range
,
165 unsigned int count
, bool speed_p
)
167 return (((uniq
== 1 && count
>= 3)
168 || (uniq
== 2 && count
>= 5)
169 || (uniq
== 3 && count
>= 6))
170 && lshift_cheap_p (speed_p
)
171 && compare_tree_int (range
, GET_MODE_BITSIZE (word_mode
)) < 0
172 && compare_tree_int (range
, 0) > 0);
175 /* Implement switch statements with bit tests
177 A GIMPLE switch statement can be expanded to a short sequence of bit-wise
178 comparisons. "switch(x)" is converted into "if ((1 << (x-MINVAL)) & CST)"
179 where CST and MINVAL are integer constants. This is better than a series
180 of compare-and-banch insns in some cases, e.g. we can implement:
182 if ((x==4) || (x==6) || (x==9) || (x==11))
184 as a single bit test:
186 if ((1<<x) & ((1<<4)|(1<<6)|(1<<9)|(1<<11)))
188 This transformation is only applied if the number of case targets is small,
189 if CST constains at least 3 bits, and "1 << x" is cheap. The bit tests are
190 performed in "word_mode".
192 The following example shows the code the transformation generates:
198 case '0': case '1': case '2': case '3': case '4':
199 case '5': case '6': case '7': case '8': case '9':
200 case 'A': case 'B': case 'C': case 'D': case 'E':
212 if (tmp1 > (70 - 48)) goto L2;
214 tmp3 = 0b11111100000001111111111;
215 if ((tmp2 & tmp3) != 0) goto L1 ; else goto L2;
222 TODO: There are still some improvements to this transformation that could
225 * A narrower mode than word_mode could be used if that is cheaper, e.g.
226 for x86_64 where a narrower-mode shift may result in smaller code.
228 * The compounded constant could be shifted rather than the one. The
229 test would be either on the sign bit or on the least significant bit,
230 depending on the direction of the shift. On some machines, the test
231 for the branch would be free if the bit to test is already set by the
234 This transformation was contributed by Roger Sayle, see this e-mail:
235 http://gcc.gnu.org/ml/gcc-patches/2003-01/msg01950.html
238 /* A case_bit_test represents a set of case nodes that may be
239 selected from using a bit-wise comparison. HI and LO hold
240 the integer to be tested against, TARGET_EDGE contains the
241 edge to the basic block to jump to upon success and BITS
242 counts the number of case nodes handled by this test,
243 typically the number of bits set in HI:LO. The LABEL field
244 is used to quickly identify all cases in this set without
245 looking at label_to_block for every case label. */
256 /* Comparison function for qsort to order bit tests by decreasing
257 probability of execution. Our best guess comes from a measured
258 profile. If the profile counts are equal, break even on the
259 number of case nodes, i.e. the node with the most cases gets
262 TODO: Actually this currently runs before a profile is available.
263 Therefore the case-as-bit-tests transformation should be done
264 later in the pass pipeline, or something along the lines of
265 "Efficient and effective branch reordering using profile data"
266 (Yang et. al., 2002) should be implemented (although, how good
267 is a paper is called "Efficient and effective ..." when the
268 latter is implied by the former, but oh well...). */
271 case_bit_test_cmp (const void *p1
, const void *p2
)
273 const struct case_bit_test
*const d1
= (const struct case_bit_test
*) p1
;
274 const struct case_bit_test
*const d2
= (const struct case_bit_test
*) p2
;
276 if (d2
->target_edge
->count
!= d1
->target_edge
->count
)
277 return d2
->target_edge
->count
- d1
->target_edge
->count
;
278 if (d2
->bits
!= d1
->bits
)
279 return d2
->bits
- d1
->bits
;
281 /* Stabilize the sort. */
282 return LABEL_DECL_UID (d2
->label
) - LABEL_DECL_UID (d1
->label
);
285 /* Expand a switch statement by a short sequence of bit-wise
286 comparisons. "switch(x)" is effectively converted into
287 "if ((1 << (x-MINVAL)) & CST)" where CST and MINVAL are
290 INDEX_EXPR is the value being switched on.
292 MINVAL is the lowest case value of in the case nodes,
293 and RANGE is highest value minus MINVAL. MINVAL and RANGE
294 are not guaranteed to be of the same type as INDEX_EXPR
295 (the gimplifier doesn't change the type of case label values,
296 and MINVAL and RANGE are derived from those values).
298 There *MUST* be MAX_CASE_BIT_TESTS or less unique case
302 emit_case_bit_tests (gimple swtch
, tree index_expr
,
303 tree minval
, tree range
)
305 struct case_bit_test test
[MAX_CASE_BIT_TESTS
];
306 unsigned int i
, j
, k
;
309 basic_block switch_bb
= gimple_bb (swtch
);
310 basic_block default_bb
, new_default_bb
, new_bb
;
312 bool update_dom
= dom_info_available_p (CDI_DOMINATORS
);
314 vec
<basic_block
> bbs_to_fix_dom
= vNULL
;
316 tree index_type
= TREE_TYPE (index_expr
);
317 tree unsigned_index_type
= unsigned_type_for (index_type
);
318 unsigned int branch_num
= gimple_switch_num_labels (swtch
);
320 gimple_stmt_iterator gsi
;
324 tree word_type_node
= lang_hooks
.types
.type_for_mode (word_mode
, 1);
325 tree word_mode_zero
= fold_convert (word_type_node
, integer_zero_node
);
326 tree word_mode_one
= fold_convert (word_type_node
, integer_one_node
);
328 memset (&test
, 0, sizeof (test
));
330 /* Get the edge for the default case. */
331 tmp
= gimple_switch_default_label (swtch
);
332 default_bb
= label_to_block (CASE_LABEL (tmp
));
333 default_edge
= find_edge (switch_bb
, default_bb
);
335 /* Go through all case labels, and collect the case labels, profile
336 counts, and other information we need to build the branch tests. */
338 for (i
= 1; i
< branch_num
; i
++)
341 tree cs
= gimple_switch_label (swtch
, i
);
342 tree label
= CASE_LABEL (cs
);
343 edge e
= find_edge (switch_bb
, label_to_block (label
));
344 for (k
= 0; k
< count
; k
++)
345 if (e
== test
[k
].target_edge
)
350 gcc_checking_assert (count
< MAX_CASE_BIT_TESTS
);
353 test
[k
].target_edge
= e
;
354 test
[k
].label
= label
;
361 lo
= tree_to_uhwi (int_const_binop (MINUS_EXPR
,
362 CASE_LOW (cs
), minval
));
363 if (CASE_HIGH (cs
) == NULL_TREE
)
366 hi
= tree_to_uhwi (int_const_binop (MINUS_EXPR
,
367 CASE_HIGH (cs
), minval
));
369 for (j
= lo
; j
<= hi
; j
++)
370 if (j
>= HOST_BITS_PER_WIDE_INT
)
371 test
[k
].hi
|= (HOST_WIDE_INT
) 1 << (j
- HOST_BITS_PER_INT
);
373 test
[k
].lo
|= (HOST_WIDE_INT
) 1 << j
;
376 qsort (test
, count
, sizeof (*test
), case_bit_test_cmp
);
378 /* We generate two jumps to the default case label.
379 Split the default edge, so that we don't have to do any PHI node
381 new_default_bb
= split_edge (default_edge
);
385 bbs_to_fix_dom
.create (10);
386 bbs_to_fix_dom
.quick_push (switch_bb
);
387 bbs_to_fix_dom
.quick_push (default_bb
);
388 bbs_to_fix_dom
.quick_push (new_default_bb
);
391 /* Now build the test-and-branch code. */
393 gsi
= gsi_last_bb (switch_bb
);
395 /* idx = (unsigned)x - minval. */
396 idx
= fold_convert (unsigned_index_type
, index_expr
);
397 idx
= fold_build2 (MINUS_EXPR
, unsigned_index_type
, idx
,
398 fold_convert (unsigned_index_type
, minval
));
399 idx
= force_gimple_operand_gsi (&gsi
, idx
,
400 /*simple=*/true, NULL_TREE
,
401 /*before=*/true, GSI_SAME_STMT
);
403 /* if (idx > range) goto default */
404 range
= force_gimple_operand_gsi (&gsi
,
405 fold_convert (unsigned_index_type
, range
),
406 /*simple=*/true, NULL_TREE
,
407 /*before=*/true, GSI_SAME_STMT
);
408 tmp
= fold_build2 (GT_EXPR
, boolean_type_node
, idx
, range
);
409 new_bb
= hoist_edge_and_branch_if_true (&gsi
, tmp
, default_edge
, update_dom
);
411 bbs_to_fix_dom
.quick_push (new_bb
);
412 gcc_assert (gimple_bb (swtch
) == new_bb
);
413 gsi
= gsi_last_bb (new_bb
);
415 /* Any blocks dominated by the GIMPLE_SWITCH, but that are not successors
416 of NEW_BB, are still immediately dominated by SWITCH_BB. Make it so. */
419 vec
<basic_block
> dom_bbs
;
422 dom_bbs
= get_dominated_by (CDI_DOMINATORS
, new_bb
);
423 FOR_EACH_VEC_ELT (dom_bbs
, i
, dom_son
)
425 edge e
= find_edge (new_bb
, dom_son
);
426 if (e
&& single_pred_p (e
->dest
))
428 set_immediate_dominator (CDI_DOMINATORS
, dom_son
, switch_bb
);
429 bbs_to_fix_dom
.safe_push (dom_son
);
434 /* csui = (1 << (word_mode) idx) */
435 csui
= make_ssa_name (word_type_node
, NULL
);
436 tmp
= fold_build2 (LSHIFT_EXPR
, word_type_node
, word_mode_one
,
437 fold_convert (word_type_node
, idx
));
438 tmp
= force_gimple_operand_gsi (&gsi
, tmp
,
439 /*simple=*/false, NULL_TREE
,
440 /*before=*/true, GSI_SAME_STMT
);
441 shift_stmt
= gimple_build_assign (csui
, tmp
);
442 gsi_insert_before (&gsi
, shift_stmt
, GSI_SAME_STMT
);
443 update_stmt (shift_stmt
);
445 /* for each unique set of cases:
446 if (const & csui) goto target */
447 for (k
= 0; k
< count
; k
++)
449 tmp
= build_int_cst_wide (word_type_node
, test
[k
].lo
, test
[k
].hi
);
450 tmp
= fold_build2 (BIT_AND_EXPR
, word_type_node
, csui
, tmp
);
451 tmp
= force_gimple_operand_gsi (&gsi
, tmp
,
452 /*simple=*/true, NULL_TREE
,
453 /*before=*/true, GSI_SAME_STMT
);
454 tmp
= fold_build2 (NE_EXPR
, boolean_type_node
, tmp
, word_mode_zero
);
455 new_bb
= hoist_edge_and_branch_if_true (&gsi
, tmp
, test
[k
].target_edge
,
458 bbs_to_fix_dom
.safe_push (new_bb
);
459 gcc_assert (gimple_bb (swtch
) == new_bb
);
460 gsi
= gsi_last_bb (new_bb
);
463 /* We should have removed all edges now. */
464 gcc_assert (EDGE_COUNT (gsi_bb (gsi
)->succs
) == 0);
466 /* If nothing matched, go to the default label. */
467 make_edge (gsi_bb (gsi
), new_default_bb
, EDGE_FALLTHRU
);
469 /* The GIMPLE_SWITCH is now redundant. */
470 gsi_remove (&gsi
, true);
474 /* Fix up the dominator tree. */
475 iterate_fix_dominators (CDI_DOMINATORS
, bbs_to_fix_dom
, true);
476 bbs_to_fix_dom
.release ();
481 Switch initialization conversion
483 The following pass changes simple initializations of scalars in a switch
484 statement into initializations from a static array. Obviously, the values
485 must be constant and known at compile time and a default branch must be
486 provided. For example, the following code:
510 a_5 = PHI <a_1, a_2, a_3, a_4>
511 b_5 = PHI <b_1, b_2, b_3, b_4>
516 static const int = CSWTCH01[] = {6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 4};
517 static const int = CSWTCH02[] = {8, 8, 9, 16, 16, 16, 16, 16, 16, 16,
520 if (((unsigned) argc) - 1 < 11)
522 a_6 = CSWTCH02[argc - 1];
523 b_6 = CSWTCH01[argc - 1];
533 There are further constraints. Specifically, the range of values across all
534 case labels must not be bigger than SWITCH_CONVERSION_BRANCH_RATIO (default
535 eight) times the number of the actual switch branches.
537 This transformation was contributed by Martin Jambor, see this e-mail:
538 http://gcc.gnu.org/ml/gcc-patches/2008-07/msg00011.html */
540 /* The main structure of the pass. */
541 struct switch_conv_info
543 /* The expression used to decide the switch branch. */
546 /* The following integer constants store the minimum and maximum value
547 covered by the case labels. */
551 /* The difference between the above two numbers. Stored here because it
552 is used in all the conversion heuristics, as well as for some of the
553 transformation, and it is expensive to re-compute it all the time. */
556 /* Basic block that contains the actual GIMPLE_SWITCH. */
557 basic_block switch_bb
;
559 /* Basic block that is the target of the default case. */
560 basic_block default_bb
;
562 /* The single successor block of all branches out of the GIMPLE_SWITCH,
563 if such a block exists. Otherwise NULL. */
564 basic_block final_bb
;
566 /* The probability of the default edge in the replaced switch. */
569 /* The count of the default edge in the replaced switch. */
570 gcov_type default_count
;
572 /* Combined count of all other (non-default) edges in the replaced switch. */
573 gcov_type other_count
;
575 /* Number of phi nodes in the final bb (that we'll be replacing). */
578 /* Array of default values, in the same order as phi nodes. */
579 tree
*default_values
;
581 /* Constructors of new static arrays. */
582 vec
<constructor_elt
, va_gc
> **constructors
;
584 /* Array of ssa names that are initialized with a value from a new static
586 tree
*target_inbound_names
;
588 /* Array of ssa names that are initialized with the default value if the
589 switch expression is out of range. */
590 tree
*target_outbound_names
;
592 /* The first load statement that loads a temporary from a new static array.
594 gimple arr_ref_first
;
596 /* The last load statement that loads a temporary from a new static array. */
599 /* String reason why the case wasn't a good candidate that is written to the
600 dump file, if there is one. */
603 /* Parameters for expand_switch_using_bit_tests. Should be computed
604 the same way as in expand_case. */
609 /* Collect information about GIMPLE_SWITCH statement SWTCH into INFO. */
612 collect_switch_conv_info (gimple swtch
, struct switch_conv_info
*info
)
614 unsigned int branch_num
= gimple_switch_num_labels (swtch
);
615 tree min_case
, max_case
;
616 unsigned int count
, i
;
620 memset (info
, 0, sizeof (*info
));
622 /* The gimplifier has already sorted the cases by CASE_LOW and ensured there
623 is a default label which is the first in the vector.
624 Collect the bits we can deduce from the CFG. */
625 info
->index_expr
= gimple_switch_index (swtch
);
626 info
->switch_bb
= gimple_bb (swtch
);
628 label_to_block (CASE_LABEL (gimple_switch_default_label (swtch
)));
629 e_default
= find_edge (info
->switch_bb
, info
->default_bb
);
630 info
->default_prob
= e_default
->probability
;
631 info
->default_count
= e_default
->count
;
632 FOR_EACH_EDGE (e
, ei
, info
->switch_bb
->succs
)
634 info
->other_count
+= e
->count
;
636 /* See if there is one common successor block for all branch
637 targets. If it exists, record it in FINAL_BB. */
638 FOR_EACH_EDGE (e
, ei
, info
->switch_bb
->succs
)
640 if (! single_pred_p (e
->dest
))
642 info
->final_bb
= e
->dest
;
647 FOR_EACH_EDGE (e
, ei
, info
->switch_bb
->succs
)
649 if (e
->dest
== info
->final_bb
)
652 if (single_pred_p (e
->dest
)
653 && single_succ_p (e
->dest
)
654 && single_succ (e
->dest
) == info
->final_bb
)
657 info
->final_bb
= NULL
;
661 /* Get upper and lower bounds of case values, and the covered range. */
662 min_case
= gimple_switch_label (swtch
, 1);
663 max_case
= gimple_switch_label (swtch
, branch_num
- 1);
665 info
->range_min
= CASE_LOW (min_case
);
666 if (CASE_HIGH (max_case
) != NULL_TREE
)
667 info
->range_max
= CASE_HIGH (max_case
);
669 info
->range_max
= CASE_LOW (max_case
);
672 int_const_binop (MINUS_EXPR
, info
->range_max
, info
->range_min
);
674 /* Get a count of the number of case labels. Single-valued case labels
675 simply count as one, but a case range counts double, since it may
676 require two compares if it gets lowered as a branching tree. */
678 for (i
= 1; i
< branch_num
; i
++)
680 tree elt
= gimple_switch_label (swtch
, i
);
683 && ! tree_int_cst_equal (CASE_LOW (elt
), CASE_HIGH (elt
)))
688 /* Get the number of unique non-default targets out of the GIMPLE_SWITCH
689 block. Assume a CFG cleanup would have already removed degenerate
690 switch statements, this allows us to just use EDGE_COUNT. */
691 info
->uniq
= EDGE_COUNT (gimple_bb (swtch
)->succs
) - 1;
694 /* Checks whether the range given by individual case statements of the SWTCH
695 switch statement isn't too big and whether the number of branches actually
696 satisfies the size of the new array. */
699 check_range (struct switch_conv_info
*info
)
701 gcc_assert (info
->range_size
);
702 if (!tree_fits_uhwi_p (info
->range_size
))
704 info
->reason
= "index range way too large or otherwise unusable";
708 if (tree_to_uhwi (info
->range_size
)
709 > ((unsigned) info
->count
* SWITCH_CONVERSION_BRANCH_RATIO
))
711 info
->reason
= "the maximum range-branch ratio exceeded";
718 /* Checks whether all but the FINAL_BB basic blocks are empty. */
721 check_all_empty_except_final (struct switch_conv_info
*info
)
726 FOR_EACH_EDGE (e
, ei
, info
->switch_bb
->succs
)
728 if (e
->dest
== info
->final_bb
)
731 if (!empty_block_p (e
->dest
))
733 info
->reason
= "bad case - a non-final BB not empty";
741 /* This function checks whether all required values in phi nodes in final_bb
742 are constants. Required values are those that correspond to a basic block
743 which is a part of the examined switch statement. It returns true if the
744 phi nodes are OK, otherwise false. */
747 check_final_bb (struct switch_conv_info
*info
)
749 gimple_stmt_iterator gsi
;
752 for (gsi
= gsi_start_phis (info
->final_bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
754 gimple phi
= gsi_stmt (gsi
);
759 for (i
= 0; i
< gimple_phi_num_args (phi
); i
++)
761 basic_block bb
= gimple_phi_arg_edge (phi
, i
)->src
;
763 if (bb
== info
->switch_bb
764 || (single_pred_p (bb
) && single_pred (bb
) == info
->switch_bb
))
768 val
= gimple_phi_arg_def (phi
, i
);
769 if (!is_gimple_ip_invariant (val
))
771 info
->reason
= "non-invariant value from a case";
772 return false; /* Non-invariant argument. */
774 reloc
= initializer_constant_valid_p (val
, TREE_TYPE (val
));
775 if ((flag_pic
&& reloc
!= null_pointer_node
)
776 || (!flag_pic
&& reloc
== NULL_TREE
))
780 = "value from a case would need runtime relocations";
783 = "value from a case is not a valid initializer";
793 /* The following function allocates default_values, target_{in,out}_names and
794 constructors arrays. The last one is also populated with pointers to
795 vectors that will become constructors of new arrays. */
798 create_temp_arrays (struct switch_conv_info
*info
)
802 info
->default_values
= XCNEWVEC (tree
, info
->phi_count
* 3);
803 /* ??? Macros do not support multi argument templates in their
804 argument list. We create a typedef to work around that problem. */
805 typedef vec
<constructor_elt
, va_gc
> *vec_constructor_elt_gc
;
806 info
->constructors
= XCNEWVEC (vec_constructor_elt_gc
, info
->phi_count
);
807 info
->target_inbound_names
= info
->default_values
+ info
->phi_count
;
808 info
->target_outbound_names
= info
->target_inbound_names
+ info
->phi_count
;
809 for (i
= 0; i
< info
->phi_count
; i
++)
810 vec_alloc (info
->constructors
[i
], tree_to_uhwi (info
->range_size
) + 1);
813 /* Free the arrays created by create_temp_arrays(). The vectors that are
814 created by that function are not freed here, however, because they have
815 already become constructors and must be preserved. */
818 free_temp_arrays (struct switch_conv_info
*info
)
820 XDELETEVEC (info
->constructors
);
821 XDELETEVEC (info
->default_values
);
824 /* Populate the array of default values in the order of phi nodes.
825 DEFAULT_CASE is the CASE_LABEL_EXPR for the default switch branch. */
828 gather_default_values (tree default_case
, struct switch_conv_info
*info
)
830 gimple_stmt_iterator gsi
;
831 basic_block bb
= label_to_block (CASE_LABEL (default_case
));
835 gcc_assert (CASE_LOW (default_case
) == NULL_TREE
);
837 if (bb
== info
->final_bb
)
838 e
= find_edge (info
->switch_bb
, bb
);
840 e
= single_succ_edge (bb
);
842 for (gsi
= gsi_start_phis (info
->final_bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
844 gimple phi
= gsi_stmt (gsi
);
845 tree val
= PHI_ARG_DEF_FROM_EDGE (phi
, e
);
847 info
->default_values
[i
++] = val
;
851 /* The following function populates the vectors in the constructors array with
852 future contents of the static arrays. The vectors are populated in the
853 order of phi nodes. SWTCH is the switch statement being converted. */
856 build_constructors (gimple swtch
, struct switch_conv_info
*info
)
858 unsigned i
, branch_num
= gimple_switch_num_labels (swtch
);
859 tree pos
= info
->range_min
;
861 for (i
= 1; i
< branch_num
; i
++)
863 tree cs
= gimple_switch_label (swtch
, i
);
864 basic_block bb
= label_to_block (CASE_LABEL (cs
));
867 gimple_stmt_iterator gsi
;
870 if (bb
== info
->final_bb
)
871 e
= find_edge (info
->switch_bb
, bb
);
873 e
= single_succ_edge (bb
);
876 while (tree_int_cst_lt (pos
, CASE_LOW (cs
)))
879 for (k
= 0; k
< info
->phi_count
; k
++)
883 elt
.index
= int_const_binop (MINUS_EXPR
, pos
, info
->range_min
);
885 = unshare_expr_without_location (info
->default_values
[k
]);
886 info
->constructors
[k
]->quick_push (elt
);
889 pos
= int_const_binop (PLUS_EXPR
, pos
, integer_one_node
);
891 gcc_assert (tree_int_cst_equal (pos
, CASE_LOW (cs
)));
895 high
= CASE_HIGH (cs
);
897 high
= CASE_LOW (cs
);
898 for (gsi
= gsi_start_phis (info
->final_bb
);
899 !gsi_end_p (gsi
); gsi_next (&gsi
))
901 gimple phi
= gsi_stmt (gsi
);
902 tree val
= PHI_ARG_DEF_FROM_EDGE (phi
, e
);
903 tree low
= CASE_LOW (cs
);
910 elt
.index
= int_const_binop (MINUS_EXPR
, pos
, info
->range_min
);
911 elt
.value
= unshare_expr_without_location (val
);
912 info
->constructors
[j
]->quick_push (elt
);
914 pos
= int_const_binop (PLUS_EXPR
, pos
, integer_one_node
);
915 } while (!tree_int_cst_lt (high
, pos
)
916 && tree_int_cst_lt (low
, pos
));
922 /* If all values in the constructor vector are the same, return the value.
923 Otherwise return NULL_TREE. Not supposed to be called for empty
927 constructor_contains_same_values_p (vec
<constructor_elt
, va_gc
> *vec
)
930 tree prev
= NULL_TREE
;
931 constructor_elt
*elt
;
933 FOR_EACH_VEC_SAFE_ELT (vec
, i
, elt
)
937 else if (!operand_equal_p (elt
->value
, prev
, OEP_ONLY_CONST
))
943 /* Return type which should be used for array elements, either TYPE,
944 or for integral type some smaller integral type that can still hold
945 all the constants. */
948 array_value_type (gimple swtch
, tree type
, int num
,
949 struct switch_conv_info
*info
)
951 unsigned int i
, len
= vec_safe_length (info
->constructors
[num
]);
952 constructor_elt
*elt
;
953 enum machine_mode mode
;
957 if (!INTEGRAL_TYPE_P (type
))
960 mode
= GET_CLASS_NARROWEST_MODE (GET_MODE_CLASS (TYPE_MODE (type
)));
961 if (GET_MODE_SIZE (TYPE_MODE (type
)) <= GET_MODE_SIZE (mode
))
964 if (len
< (optimize_bb_for_size_p (gimple_bb (swtch
)) ? 2 : 32))
967 FOR_EACH_VEC_SAFE_ELT (info
->constructors
[num
], i
, elt
)
971 if (TREE_CODE (elt
->value
) != INTEGER_CST
)
974 cst
= TREE_INT_CST (elt
->value
);
977 unsigned int prec
= GET_MODE_BITSIZE (mode
);
978 if (prec
> HOST_BITS_PER_WIDE_INT
)
981 if (sign
>= 0 && cst
== cst
.zext (prec
))
983 if (sign
== 0 && cst
== cst
.sext (prec
))
988 if (sign
<= 0 && cst
== cst
.sext (prec
))
997 mode
= GET_MODE_WIDER_MODE (mode
);
999 || GET_MODE_SIZE (mode
) >= GET_MODE_SIZE (TYPE_MODE (type
)))
1005 sign
= TYPE_UNSIGNED (type
) ? 1 : -1;
1006 smaller_type
= lang_hooks
.types
.type_for_mode (mode
, sign
>= 0);
1007 if (GET_MODE_SIZE (TYPE_MODE (type
))
1008 <= GET_MODE_SIZE (TYPE_MODE (smaller_type
)))
1011 return smaller_type
;
1014 /* Create an appropriate array type and declaration and assemble a static array
1015 variable. Also create a load statement that initializes the variable in
1016 question with a value from the static array. SWTCH is the switch statement
1017 being converted, NUM is the index to arrays of constructors, default values
1018 and target SSA names for this particular array. ARR_INDEX_TYPE is the type
1019 of the index of the new array, PHI is the phi node of the final BB that
1020 corresponds to the value that will be loaded from the created array. TIDX
1021 is an ssa name of a temporary variable holding the index for loads from the
1025 build_one_array (gimple swtch
, int num
, tree arr_index_type
, gimple phi
,
1026 tree tidx
, struct switch_conv_info
*info
)
1030 gimple_stmt_iterator gsi
= gsi_for_stmt (swtch
);
1031 location_t loc
= gimple_location (swtch
);
1033 gcc_assert (info
->default_values
[num
]);
1035 name
= copy_ssa_name (PHI_RESULT (phi
), NULL
);
1036 info
->target_inbound_names
[num
] = name
;
1038 cst
= constructor_contains_same_values_p (info
->constructors
[num
]);
1040 load
= gimple_build_assign (name
, cst
);
1043 tree array_type
, ctor
, decl
, value_type
, fetch
, default_type
;
1045 default_type
= TREE_TYPE (info
->default_values
[num
]);
1046 value_type
= array_value_type (swtch
, default_type
, num
, info
);
1047 array_type
= build_array_type (value_type
, arr_index_type
);
1048 if (default_type
!= value_type
)
1051 constructor_elt
*elt
;
1053 FOR_EACH_VEC_SAFE_ELT (info
->constructors
[num
], i
, elt
)
1054 elt
->value
= fold_convert (value_type
, elt
->value
);
1056 ctor
= build_constructor (array_type
, info
->constructors
[num
]);
1057 TREE_CONSTANT (ctor
) = true;
1058 TREE_STATIC (ctor
) = true;
1060 decl
= build_decl (loc
, VAR_DECL
, NULL_TREE
, array_type
);
1061 TREE_STATIC (decl
) = 1;
1062 DECL_INITIAL (decl
) = ctor
;
1064 DECL_NAME (decl
) = create_tmp_var_name ("CSWTCH");
1065 DECL_ARTIFICIAL (decl
) = 1;
1066 TREE_CONSTANT (decl
) = 1;
1067 TREE_READONLY (decl
) = 1;
1068 varpool_finalize_decl (decl
);
1070 fetch
= build4 (ARRAY_REF
, value_type
, decl
, tidx
, NULL_TREE
,
1072 if (default_type
!= value_type
)
1074 fetch
= fold_convert (default_type
, fetch
);
1075 fetch
= force_gimple_operand_gsi (&gsi
, fetch
, true, NULL_TREE
,
1076 true, GSI_SAME_STMT
);
1078 load
= gimple_build_assign (name
, fetch
);
1081 gsi_insert_before (&gsi
, load
, GSI_SAME_STMT
);
1083 info
->arr_ref_last
= load
;
1086 /* Builds and initializes static arrays initialized with values gathered from
1087 the SWTCH switch statement. Also creates statements that load values from
1091 build_arrays (gimple swtch
, struct switch_conv_info
*info
)
1093 tree arr_index_type
;
1094 tree tidx
, sub
, utype
;
1096 gimple_stmt_iterator gsi
;
1098 location_t loc
= gimple_location (swtch
);
1100 gsi
= gsi_for_stmt (swtch
);
1102 /* Make sure we do not generate arithmetics in a subrange. */
1103 utype
= TREE_TYPE (info
->index_expr
);
1104 if (TREE_TYPE (utype
))
1105 utype
= lang_hooks
.types
.type_for_mode (TYPE_MODE (TREE_TYPE (utype
)), 1);
1107 utype
= lang_hooks
.types
.type_for_mode (TYPE_MODE (utype
), 1);
1109 arr_index_type
= build_index_type (info
->range_size
);
1110 tidx
= make_ssa_name (utype
, NULL
);
1111 sub
= fold_build2_loc (loc
, MINUS_EXPR
, utype
,
1112 fold_convert_loc (loc
, utype
, info
->index_expr
),
1113 fold_convert_loc (loc
, utype
, info
->range_min
));
1114 sub
= force_gimple_operand_gsi (&gsi
, sub
,
1115 false, NULL
, true, GSI_SAME_STMT
);
1116 stmt
= gimple_build_assign (tidx
, sub
);
1118 gsi_insert_before (&gsi
, stmt
, GSI_SAME_STMT
);
1120 info
->arr_ref_first
= stmt
;
1122 for (gsi
= gsi_start_phis (info
->final_bb
), i
= 0;
1123 !gsi_end_p (gsi
); gsi_next (&gsi
), i
++)
1124 build_one_array (swtch
, i
, arr_index_type
, gsi_stmt (gsi
), tidx
, info
);
1127 /* Generates and appropriately inserts loads of default values at the position
1128 given by BSI. Returns the last inserted statement. */
1131 gen_def_assigns (gimple_stmt_iterator
*gsi
, struct switch_conv_info
*info
)
1134 gimple assign
= NULL
;
1136 for (i
= 0; i
< info
->phi_count
; i
++)
1138 tree name
= copy_ssa_name (info
->target_inbound_names
[i
], NULL
);
1139 info
->target_outbound_names
[i
] = name
;
1140 assign
= gimple_build_assign (name
, info
->default_values
[i
]);
1141 gsi_insert_before (gsi
, assign
, GSI_SAME_STMT
);
1142 update_stmt (assign
);
1147 /* Deletes the unused bbs and edges that now contain the switch statement and
1148 its empty branch bbs. BBD is the now dead BB containing the original switch
1149 statement, FINAL is the last BB of the converted switch statement (in terms
1153 prune_bbs (basic_block bbd
, basic_block final
)
1158 for (ei
= ei_start (bbd
->succs
); (e
= ei_safe_edge (ei
)); )
1164 delete_basic_block (bb
);
1166 delete_basic_block (bbd
);
1169 /* Add values to phi nodes in final_bb for the two new edges. E1F is the edge
1170 from the basic block loading values from an array and E2F from the basic
1171 block loading default values. BBF is the last switch basic block (see the
1172 bbf description in the comment below). */
1175 fix_phi_nodes (edge e1f
, edge e2f
, basic_block bbf
,
1176 struct switch_conv_info
*info
)
1178 gimple_stmt_iterator gsi
;
1181 for (gsi
= gsi_start_phis (bbf
), i
= 0;
1182 !gsi_end_p (gsi
); gsi_next (&gsi
), i
++)
1184 gimple phi
= gsi_stmt (gsi
);
1185 add_phi_arg (phi
, info
->target_inbound_names
[i
], e1f
, UNKNOWN_LOCATION
);
1186 add_phi_arg (phi
, info
->target_outbound_names
[i
], e2f
, UNKNOWN_LOCATION
);
1190 /* Creates a check whether the switch expression value actually falls into the
1191 range given by all the cases. If it does not, the temporaries are loaded
1192 with default values instead. SWTCH is the switch statement being converted.
1194 bb0 is the bb with the switch statement, however, we'll end it with a
1197 bb1 is the bb to be used when the range check went ok. It is derived from
1200 bb2 is the bb taken when the expression evaluated outside of the range
1201 covered by the created arrays. It is populated by loads of default
1204 bbF is a fall through for both bb1 and bb2 and contains exactly what
1205 originally followed the switch statement.
1207 bbD contains the switch statement (in the end). It is unreachable but we
1208 still need to strip off its edges.
1212 gen_inbound_check (gimple swtch
, struct switch_conv_info
*info
)
1214 tree label_decl1
= create_artificial_label (UNKNOWN_LOCATION
);
1215 tree label_decl2
= create_artificial_label (UNKNOWN_LOCATION
);
1216 tree label_decl3
= create_artificial_label (UNKNOWN_LOCATION
);
1217 gimple label1
, label2
, label3
;
1224 gimple_stmt_iterator gsi
;
1225 basic_block bb0
, bb1
, bb2
, bbf
, bbd
;
1226 edge e01
, e02
, e21
, e1d
, e1f
, e2f
;
1227 location_t loc
= gimple_location (swtch
);
1229 gcc_assert (info
->default_values
);
1231 bb0
= gimple_bb (swtch
);
1233 tidx
= gimple_assign_lhs (info
->arr_ref_first
);
1234 utype
= TREE_TYPE (tidx
);
1236 /* (end of) block 0 */
1237 gsi
= gsi_for_stmt (info
->arr_ref_first
);
1240 bound
= fold_convert_loc (loc
, utype
, info
->range_size
);
1241 cond_stmt
= gimple_build_cond (LE_EXPR
, tidx
, bound
, NULL_TREE
, NULL_TREE
);
1242 gsi_insert_before (&gsi
, cond_stmt
, GSI_SAME_STMT
);
1243 update_stmt (cond_stmt
);
1246 label2
= gimple_build_label (label_decl2
);
1247 gsi_insert_before (&gsi
, label2
, GSI_SAME_STMT
);
1248 last_assign
= gen_def_assigns (&gsi
, info
);
1251 label1
= gimple_build_label (label_decl1
);
1252 gsi_insert_before (&gsi
, label1
, GSI_SAME_STMT
);
1255 gsi
= gsi_start_bb (info
->final_bb
);
1256 label3
= gimple_build_label (label_decl3
);
1257 gsi_insert_before (&gsi
, label3
, GSI_SAME_STMT
);
1260 e02
= split_block (bb0
, cond_stmt
);
1263 e21
= split_block (bb2
, last_assign
);
1267 e1d
= split_block (bb1
, info
->arr_ref_last
);
1271 /* flags and profiles of the edge for in-range values */
1272 e01
= make_edge (bb0
, bb1
, EDGE_TRUE_VALUE
);
1273 e01
->probability
= REG_BR_PROB_BASE
- info
->default_prob
;
1274 e01
->count
= info
->other_count
;
1276 /* flags and profiles of the edge taking care of out-of-range values */
1277 e02
->flags
&= ~EDGE_FALLTHRU
;
1278 e02
->flags
|= EDGE_FALSE_VALUE
;
1279 e02
->probability
= info
->default_prob
;
1280 e02
->count
= info
->default_count
;
1282 bbf
= info
->final_bb
;
1284 e1f
= make_edge (bb1
, bbf
, EDGE_FALLTHRU
);
1285 e1f
->probability
= REG_BR_PROB_BASE
;
1286 e1f
->count
= info
->other_count
;
1288 e2f
= make_edge (bb2
, bbf
, EDGE_FALLTHRU
);
1289 e2f
->probability
= REG_BR_PROB_BASE
;
1290 e2f
->count
= info
->default_count
;
1292 /* frequencies of the new BBs */
1293 bb1
->frequency
= EDGE_FREQUENCY (e01
);
1294 bb2
->frequency
= EDGE_FREQUENCY (e02
);
1295 bbf
->frequency
= EDGE_FREQUENCY (e1f
) + EDGE_FREQUENCY (e2f
);
1297 /* Tidy blocks that have become unreachable. */
1298 prune_bbs (bbd
, info
->final_bb
);
1300 /* Fixup the PHI nodes in bbF. */
1301 fix_phi_nodes (e1f
, e2f
, bbf
, info
);
1303 /* Fix the dominator tree, if it is available. */
1304 if (dom_info_available_p (CDI_DOMINATORS
))
1306 vec
<basic_block
> bbs_to_fix_dom
;
1308 set_immediate_dominator (CDI_DOMINATORS
, bb1
, bb0
);
1309 set_immediate_dominator (CDI_DOMINATORS
, bb2
, bb0
);
1310 if (! get_immediate_dominator (CDI_DOMINATORS
, bbf
))
1311 /* If bbD was the immediate dominator ... */
1312 set_immediate_dominator (CDI_DOMINATORS
, bbf
, bb0
);
1314 bbs_to_fix_dom
.create (4);
1315 bbs_to_fix_dom
.quick_push (bb0
);
1316 bbs_to_fix_dom
.quick_push (bb1
);
1317 bbs_to_fix_dom
.quick_push (bb2
);
1318 bbs_to_fix_dom
.quick_push (bbf
);
1320 iterate_fix_dominators (CDI_DOMINATORS
, bbs_to_fix_dom
, true);
1321 bbs_to_fix_dom
.release ();
1325 /* The following function is invoked on every switch statement (the current one
1326 is given in SWTCH) and runs the individual phases of switch conversion on it
1327 one after another until one fails or the conversion is completed.
1328 Returns NULL on success, or a pointer to a string with the reason why the
1329 conversion failed. */
1332 process_switch (gimple swtch
)
1334 struct switch_conv_info info
;
1336 /* Group case labels so that we get the right results from the heuristics
1337 that decide on the code generation approach for this switch. */
1338 group_case_labels_stmt (swtch
);
1340 /* If this switch is now a degenerate case with only a default label,
1341 there is nothing left for us to do. */
1342 if (gimple_switch_num_labels (swtch
) < 2)
1343 return "switch is a degenerate case";
1345 collect_switch_conv_info (swtch
, &info
);
1347 /* No error markers should reach here (they should be filtered out
1348 during gimplification). */
1349 gcc_checking_assert (TREE_TYPE (info
.index_expr
) != error_mark_node
);
1351 /* A switch on a constant should have been optimized in tree-cfg-cleanup. */
1352 gcc_checking_assert (! TREE_CONSTANT (info
.index_expr
));
1354 if (info
.uniq
<= MAX_CASE_BIT_TESTS
)
1356 if (expand_switch_using_bit_tests_p (info
.range_size
,
1357 info
.uniq
, info
.count
,
1358 optimize_bb_for_speed_p
1359 (gimple_bb (swtch
))))
1362 fputs (" expanding as bit test is preferable\n", dump_file
);
1363 emit_case_bit_tests (swtch
, info
.index_expr
,
1364 info
.range_min
, info
.range_size
);
1366 loops_state_set (LOOPS_NEED_FIXUP
);
1371 /* This will be expanded as a decision tree in stmt.c:expand_case. */
1372 return " expanding as jumps is preferable";
1375 /* If there is no common successor, we cannot do the transformation. */
1376 if (! info
.final_bb
)
1377 return "no common successor to all case label target blocks found";
1379 /* Check the case label values are within reasonable range: */
1380 if (!check_range (&info
))
1382 gcc_assert (info
.reason
);
1386 /* For all the cases, see whether they are empty, the assignments they
1387 represent constant and so on... */
1388 if (! check_all_empty_except_final (&info
))
1390 gcc_assert (info
.reason
);
1393 if (!check_final_bb (&info
))
1395 gcc_assert (info
.reason
);
1399 /* At this point all checks have passed and we can proceed with the
1402 create_temp_arrays (&info
);
1403 gather_default_values (gimple_switch_default_label (swtch
), &info
);
1404 build_constructors (swtch
, &info
);
1406 build_arrays (swtch
, &info
); /* Build the static arrays and assignments. */
1407 gen_inbound_check (swtch
, &info
); /* Build the bounds check. */
1410 free_temp_arrays (&info
);
1414 /* The main function of the pass scans statements for switches and invokes
1415 process_switch on them. */
1419 const pass_data pass_data_convert_switch
=
1421 GIMPLE_PASS
, /* type */
1422 "switchconv", /* name */
1423 OPTGROUP_NONE
, /* optinfo_flags */
1424 true, /* has_execute */
1425 TV_TREE_SWITCH_CONVERSION
, /* tv_id */
1426 ( PROP_cfg
| PROP_ssa
), /* properties_required */
1427 0, /* properties_provided */
1428 0, /* properties_destroyed */
1429 0, /* todo_flags_start */
1430 ( TODO_update_ssa
| TODO_verify_ssa
1432 | TODO_verify_flow
), /* todo_flags_finish */
1435 class pass_convert_switch
: public gimple_opt_pass
1438 pass_convert_switch (gcc::context
*ctxt
)
1439 : gimple_opt_pass (pass_data_convert_switch
, ctxt
)
1442 /* opt_pass methods: */
1443 virtual bool gate (function
*) { return flag_tree_switch_conversion
!= 0; }
1444 virtual unsigned int execute (function
*);
1446 }; // class pass_convert_switch
1449 pass_convert_switch::execute (function
*fun
)
1453 FOR_EACH_BB_FN (bb
, fun
)
1455 const char *failure_reason
;
1456 gimple stmt
= last_stmt (bb
);
1457 if (stmt
&& gimple_code (stmt
) == GIMPLE_SWITCH
)
1461 expanded_location loc
= expand_location (gimple_location (stmt
));
1463 fprintf (dump_file
, "beginning to process the following "
1464 "SWITCH statement (%s:%d) : ------- \n",
1465 loc
.file
, loc
.line
);
1466 print_gimple_stmt (dump_file
, stmt
, 0, TDF_SLIM
);
1467 putc ('\n', dump_file
);
1470 failure_reason
= process_switch (stmt
);
1471 if (! failure_reason
)
1475 fputs ("Switch converted\n", dump_file
);
1476 fputs ("--------------------------------\n", dump_file
);
1479 /* Make no effort to update the post-dominator tree. It is actually not
1480 that hard for the transformations we have performed, but it is not
1481 supported by iterate_fix_dominators. */
1482 free_dominance_info (CDI_POST_DOMINATORS
);
1488 fputs ("Bailing out - ", dump_file
);
1489 fputs (failure_reason
, dump_file
);
1490 fputs ("\n--------------------------------\n", dump_file
);
1502 make_pass_convert_switch (gcc::context
*ctxt
)
1504 return new pass_convert_switch (ctxt
);