tree-flow.h (copy_ssa_name_fn): New function.
[gcc.git] / gcc / tree-switch-conversion.c
1 /* Lower GIMPLE_SWITCH expressions to something more efficient than
2 a jump table.
3 Copyright (C) 2006, 2008, 2009, 2010, 2011, 2012
4 Free Software Foundation, Inc.
5
6 This file is part of GCC.
7
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
11 later version.
12
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
16 for more details.
17
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
21 02110-1301, USA. */
22
23 /* This file handles the lowering of GIMPLE_SWITCH to an indexed
24 load, or a series of bit-test-and-branch expressions. */
25
26 #include "config.h"
27 #include "system.h"
28 #include "coretypes.h"
29 #include "tm.h"
30 #include "line-map.h"
31 #include "params.h"
32 #include "flags.h"
33 #include "tree.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"
40
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"
44
45 /* Need to include expr.h and optabs.h for lshift_cheap_p. */
46 #include "expr.h"
47 #include "optabs.h"
48 \f
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
53
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
56 expression COND.
57
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
61 jump.
62
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.
66
67 Returns the newly created basic block. */
68
69 static basic_block
70 hoist_edge_and_branch_if_true (gimple_stmt_iterator *gsip,
71 tree cond, edge e_true,
72 bool update_dominators)
73 {
74 tree tmp;
75 gimple cond_stmt;
76 edge e_false;
77 basic_block new_bb, split_bb = gsi_bb (*gsip);
78 bool dominated_e_true = false;
79
80 gcc_assert (e_true->src == split_bb);
81
82 if (update_dominators
83 && get_immediate_dominator (CDI_DOMINATORS, e_true->dest) == split_bb)
84 dominated_e_true = true;
85
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);
90
91 e_false = split_block (split_bb, cond_stmt);
92 new_bb = e_false->dest;
93 redirect_edge_pred (e_true, split_bb);
94
95 e_true->flags &= ~EDGE_FALLTHRU;
96 e_true->flags |= EDGE_TRUE_VALUE;
97
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;
103
104 if (update_dominators)
105 {
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);
109 }
110
111 return new_bb;
112 }
113
114
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. */
119 static bool
120 lshift_cheap_p (void)
121 {
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};
126 bool speed_p;
127
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)
131 return false;
132
133 speed_p = optimize_insn_for_speed_p ();
134
135 if (!init[speed_p])
136 {
137 rtx reg = gen_raw_REG (word_mode, 10000);
138 int cost = set_src_cost (gen_rtx_ASHIFT (word_mode, const1_rtx, reg),
139 speed_p);
140 cheap[speed_p] = cost < COSTS_N_INSNS (MAX_CASE_BIT_TESTS);
141 init[speed_p] = true;
142 }
143
144 return cheap[speed_p];
145 }
146
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. */
151
152 static bool
153 expand_switch_using_bit_tests_p (tree range,
154 unsigned int uniq,
155 unsigned int count)
156 {
157 return (((uniq == 1 && count >= 3)
158 || (uniq == 2 && count >= 5)
159 || (uniq == 3 && count >= 6))
160 && lshift_cheap_p ()
161 && compare_tree_int (range, GET_MODE_BITSIZE (word_mode)) < 0
162 && compare_tree_int (range, 0) > 0);
163 }
164 \f
165 /* Implement switch statements with bit tests
166
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:
171
172 if ((x==4) || (x==6) || (x==9) || (x==11))
173
174 as a single bit test:
175
176 if ((1<<x) & ((1<<4)|(1<<6)|(1<<9)|(1<<11)))
177
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".
181
182 The following example shows the code the transformation generates:
183
184 int bar(int x)
185 {
186 switch (x)
187 {
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':
191 case 'F':
192 return 1;
193 }
194 return 0;
195 }
196
197 ==>
198
199 bar (int x)
200 {
201 tmp1 = x - 48;
202 if (tmp1 > (70 - 48)) goto L2;
203 tmp2 = 1 << tmp1;
204 tmp3 = 0b11111100000001111111111;
205 if ((tmp2 & tmp3) != 0) goto L1 ; else goto L2;
206 L1:
207 return 1;
208 L2:
209 return 0;
210 }
211
212 TODO: There are still some improvements to this transformation that could
213 be implemented:
214
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.
217
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
222 shift operation.
223
224 This transformation was contributed by Roger Sayle, see this e-mail:
225 http://gcc.gnu.org/ml/gcc-patches/2003-01/msg01950.html
226 */
227
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. */
236
237 struct case_bit_test
238 {
239 HOST_WIDE_INT hi;
240 HOST_WIDE_INT lo;
241 edge target_edge;
242 tree label;
243 int bits;
244 };
245
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
250 tested first.
251
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...). */
259
260 static int
261 case_bit_test_cmp (const void *p1, const void *p2)
262 {
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;
265
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;
270
271 /* Stabilize the sort. */
272 return LABEL_DECL_UID (d2->label) - LABEL_DECL_UID (d1->label);
273 }
274
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
278 integer constants.
279
280 INDEX_EXPR is the value being switched on.
281
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).
287
288 There *MUST* be MAX_CASE_BIT_TESTS or less unique case
289 node targets. */
290
291 static void
292 emit_case_bit_tests (gimple swtch, tree index_expr,
293 tree minval, tree range)
294 {
295 struct case_bit_test test[MAX_CASE_BIT_TESTS];
296 unsigned int i, j, k;
297 unsigned int count;
298
299 basic_block switch_bb = gimple_bb (swtch);
300 basic_block default_bb, new_default_bb, new_bb;
301 edge default_edge;
302 bool update_dom = dom_info_available_p (CDI_DOMINATORS);
303
304 VEC (basic_block, heap) *bbs_to_fix_dom = NULL;
305
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);
309
310 gimple_stmt_iterator gsi;
311 gimple shift_stmt;
312
313 tree idx, tmp, csui;
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);
317
318 memset (&test, 0, sizeof (test));
319
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);
324
325 /* Go through all case labels, and collect the case labels, profile
326 counts, and other information we need to build the branch tests. */
327 count = 0;
328 for (i = 1; i < branch_num; i++)
329 {
330 unsigned int lo, hi;
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)
336 break;
337
338 if (k == count)
339 {
340 gcc_checking_assert (count < MAX_CASE_BIT_TESTS);
341 test[k].hi = 0;
342 test[k].lo = 0;
343 test[k].target_edge = e;
344 test[k].label = label;
345 test[k].bits = 1;
346 count++;
347 }
348 else
349 test[k].bits++;
350
351 lo = tree_low_cst (int_const_binop (MINUS_EXPR,
352 CASE_LOW (cs), minval),
353 1);
354 if (CASE_HIGH (cs) == NULL_TREE)
355 hi = lo;
356 else
357 hi = tree_low_cst (int_const_binop (MINUS_EXPR,
358 CASE_HIGH (cs), minval),
359 1);
360
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);
364 else
365 test[k].lo |= (HOST_WIDE_INT) 1 << j;
366 }
367
368 qsort (test, count, sizeof(*test), case_bit_test_cmp);
369
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);
374
375 if (update_dom)
376 {
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);
381 }
382
383 /* Now build the test-and-branch code. */
384
385 gsi = gsi_last_bb (switch_bb);
386
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);
394
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 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);
406
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)
410 {
411 VEC (basic_block, heap) *dom_bbs;
412 basic_block dom_son;
413
414 dom_bbs = get_dominated_by (CDI_DOMINATORS, new_bb);
415 FOR_EACH_VEC_ELT (basic_block, dom_bbs, i, dom_son)
416 {
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 VEC_safe_push (basic_block, heap, bbs_to_fix_dom, dom_son);
422 }
423 VEC_free (basic_block, heap, dom_bbs);
424 }
425
426 /* csui = (1 << (word_mode) idx) */
427 tmp = create_tmp_var (word_type_node, "csui");
428 csui = make_ssa_name (tmp, NULL);
429 tmp = fold_build2 (LSHIFT_EXPR, word_type_node, word_mode_one,
430 fold_convert (word_type_node, idx));
431 tmp = force_gimple_operand_gsi (&gsi, tmp,
432 /*simple=*/false, NULL_TREE,
433 /*before=*/true, GSI_SAME_STMT);
434 shift_stmt = gimple_build_assign (csui, tmp);
435 SSA_NAME_DEF_STMT (csui) = shift_stmt;
436 gsi_insert_before (&gsi, shift_stmt, GSI_SAME_STMT);
437 update_stmt (shift_stmt);
438
439 /* for each unique set of cases:
440 if (const & csui) goto target */
441 for (k = 0; k < count; k++)
442 {
443 tmp = build_int_cst_wide (word_type_node, test[k].lo, test[k].hi);
444 tmp = fold_build2 (BIT_AND_EXPR, word_type_node, csui, tmp);
445 tmp = force_gimple_operand_gsi (&gsi, tmp,
446 /*simple=*/true, NULL_TREE,
447 /*before=*/true, GSI_SAME_STMT);
448 tmp = fold_build2 (NE_EXPR, boolean_type_node, tmp, word_mode_zero);
449 new_bb = hoist_edge_and_branch_if_true (&gsi, tmp, test[k].target_edge,
450 update_dom);
451 if (update_dom)
452 VEC_safe_push (basic_block, heap, bbs_to_fix_dom, new_bb);
453 gcc_assert (gimple_bb (swtch) == new_bb);
454 gsi = gsi_last_bb (new_bb);
455 }
456
457 /* We should have removed all edges now. */
458 gcc_assert (EDGE_COUNT (gsi_bb (gsi)->succs) == 0);
459
460 /* If nothing matched, go to the default label. */
461 make_edge (gsi_bb (gsi), new_default_bb, EDGE_FALLTHRU);
462
463 /* The GIMPLE_SWITCH is now redundant. */
464 gsi_remove (&gsi, true);
465
466 if (update_dom)
467 {
468 /* Fix up the dominator tree. */
469 iterate_fix_dominators (CDI_DOMINATORS, bbs_to_fix_dom, true);
470 VEC_free (basic_block, heap, bbs_to_fix_dom);
471 }
472 }
473 \f
474 /*
475 Switch initialization conversion
476
477 The following pass changes simple initializations of scalars in a switch
478 statement into initializations from a static array. Obviously, the values
479 must be constant and known at compile time and a default branch must be
480 provided. For example, the following code:
481
482 int a,b;
483
484 switch (argc)
485 {
486 case 1:
487 case 2:
488 a_1 = 8;
489 b_1 = 6;
490 break;
491 case 3:
492 a_2 = 9;
493 b_2 = 5;
494 break;
495 case 12:
496 a_3 = 10;
497 b_3 = 4;
498 break;
499 default:
500 a_4 = 16;
501 b_4 = 1;
502 break;
503 }
504 a_5 = PHI <a_1, a_2, a_3, a_4>
505 b_5 = PHI <b_1, b_2, b_3, b_4>
506
507
508 is changed into:
509
510 static const int = CSWTCH01[] = {6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 4};
511 static const int = CSWTCH02[] = {8, 8, 9, 16, 16, 16, 16, 16, 16, 16,
512 16, 16, 10};
513
514 if (((unsigned) argc) - 1 < 11)
515 {
516 a_6 = CSWTCH02[argc - 1];
517 b_6 = CSWTCH01[argc - 1];
518 }
519 else
520 {
521 a_7 = 16;
522 b_7 = 1;
523 }
524 a_5 = PHI <a_6, a_7>
525 b_b = PHI <b_6, b_7>
526
527 There are further constraints. Specifically, the range of values across all
528 case labels must not be bigger than SWITCH_CONVERSION_BRANCH_RATIO (default
529 eight) times the number of the actual switch branches.
530
531 This transformation was contributed by Martin Jambor, see this e-mail:
532 http://gcc.gnu.org/ml/gcc-patches/2008-07/msg00011.html */
533
534 /* The main structure of the pass. */
535 struct switch_conv_info
536 {
537 /* The expression used to decide the switch branch. */
538 tree index_expr;
539
540 /* The following integer constants store the minimum and maximum value
541 covered by the case labels. */
542 tree range_min;
543 tree range_max;
544
545 /* The difference between the above two numbers. Stored here because it
546 is used in all the conversion heuristics, as well as for some of the
547 transformation, and it is expensive to re-compute it all the time. */
548 tree range_size;
549
550 /* Basic block that contains the actual GIMPLE_SWITCH. */
551 basic_block switch_bb;
552
553 /* Basic block that is the target of the default case. */
554 basic_block default_bb;
555
556 /* The single successor block of all branches out of the GIMPLE_SWITCH,
557 if such a block exists. Otherwise NULL. */
558 basic_block final_bb;
559
560 /* The probability of the default edge in the replaced switch. */
561 int default_prob;
562
563 /* The count of the default edge in the replaced switch. */
564 gcov_type default_count;
565
566 /* Combined count of all other (non-default) edges in the replaced switch. */
567 gcov_type other_count;
568
569 /* Number of phi nodes in the final bb (that we'll be replacing). */
570 int phi_count;
571
572 /* Array of default values, in the same order as phi nodes. */
573 tree *default_values;
574
575 /* Constructors of new static arrays. */
576 VEC (constructor_elt, gc) **constructors;
577
578 /* Array of ssa names that are initialized with a value from a new static
579 array. */
580 tree *target_inbound_names;
581
582 /* Array of ssa names that are initialized with the default value if the
583 switch expression is out of range. */
584 tree *target_outbound_names;
585
586 /* The first load statement that loads a temporary from a new static array.
587 */
588 gimple arr_ref_first;
589
590 /* The last load statement that loads a temporary from a new static array. */
591 gimple arr_ref_last;
592
593 /* String reason why the case wasn't a good candidate that is written to the
594 dump file, if there is one. */
595 const char *reason;
596
597 /* Parameters for expand_switch_using_bit_tests. Should be computed
598 the same way as in expand_case. */
599 unsigned int uniq;
600 unsigned int count;
601 };
602
603 /* Collect information about GIMPLE_SWITCH statement SWTCH into INFO. */
604
605 static void
606 collect_switch_conv_info (gimple swtch, struct switch_conv_info *info)
607 {
608 unsigned int branch_num = gimple_switch_num_labels (swtch);
609 tree min_case, max_case;
610 unsigned int count, i;
611 edge e, e_default;
612 edge_iterator ei;
613
614 memset (info, 0, sizeof (*info));
615
616 /* The gimplifier has already sorted the cases by CASE_LOW and ensured there
617 is a default label which is the first in the vector. */
618 gcc_assert (CASE_LOW (gimple_switch_label (swtch, 0)) == NULL_TREE);
619
620 /* Collect the bits we can deduce from the CFG. */
621 info->index_expr = gimple_switch_index (swtch);
622 info->switch_bb = gimple_bb (swtch);
623 info->default_bb =
624 label_to_block (CASE_LABEL (gimple_switch_label (swtch, 0)));
625 e_default = find_edge (info->switch_bb, info->default_bb);
626 info->default_prob = e_default->probability;
627 info->default_count = e_default->count;
628 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
629 if (e != e_default)
630 info->other_count += e->count;
631
632 /* See if there is one common successor block for all branch
633 targets. If it exists, record it in FINAL_BB. */
634 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
635 {
636 if (! single_pred_p (e->dest))
637 {
638 info->final_bb = e->dest;
639 break;
640 }
641 }
642 if (info->final_bb)
643 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
644 {
645 if (e->dest == info->final_bb)
646 continue;
647
648 if (single_pred_p (e->dest)
649 && single_succ_p (e->dest)
650 && single_succ (e->dest) == info->final_bb)
651 continue;
652
653 info->final_bb = NULL;
654 break;
655 }
656
657 /* Get upper and lower bounds of case values, and the covered range. */
658 min_case = gimple_switch_label (swtch, 1);
659 max_case = gimple_switch_label (swtch, branch_num - 1);
660
661 info->range_min = CASE_LOW (min_case);
662 if (CASE_HIGH (max_case) != NULL_TREE)
663 info->range_max = CASE_HIGH (max_case);
664 else
665 info->range_max = CASE_LOW (max_case);
666
667 info->range_size =
668 int_const_binop (MINUS_EXPR, info->range_max, info->range_min);
669
670 /* Get a count of the number of case labels. Single-valued case labels
671 simply count as one, but a case range counts double, since it may
672 require two compares if it gets lowered as a branching tree. */
673 count = 0;
674 for (i = 1; i < branch_num; i++)
675 {
676 tree elt = gimple_switch_label (swtch, i);
677 count++;
678 if (CASE_HIGH (elt)
679 && ! tree_int_cst_equal (CASE_LOW (elt), CASE_HIGH (elt)))
680 count++;
681 }
682 info->count = count;
683
684 /* Get the number of unique non-default targets out of the GIMPLE_SWITCH
685 block. Assume a CFG cleanup would have already removed degenerate
686 switch statements, this allows us to just use EDGE_COUNT. */
687 info->uniq = EDGE_COUNT (gimple_bb (swtch)->succs) - 1;
688 }
689
690 /* Checks whether the range given by individual case statements of the SWTCH
691 switch statement isn't too big and whether the number of branches actually
692 satisfies the size of the new array. */
693
694 static bool
695 check_range (struct switch_conv_info *info)
696 {
697 gcc_assert (info->range_size);
698 if (!host_integerp (info->range_size, 1))
699 {
700 info->reason = "index range way too large or otherwise unusable";
701 return false;
702 }
703
704 if ((unsigned HOST_WIDE_INT) tree_low_cst (info->range_size, 1)
705 > ((unsigned) info->count * SWITCH_CONVERSION_BRANCH_RATIO))
706 {
707 info->reason = "the maximum range-branch ratio exceeded";
708 return false;
709 }
710
711 return true;
712 }
713
714 /* Checks whether all but the FINAL_BB basic blocks are empty. */
715
716 static bool
717 check_all_empty_except_final (struct switch_conv_info *info)
718 {
719 edge e;
720 edge_iterator ei;
721
722 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
723 {
724 if (e->dest == info->final_bb)
725 continue;
726
727 if (!empty_block_p (e->dest))
728 {
729 info->reason = "bad case - a non-final BB not empty";
730 return false;
731 }
732 }
733
734 return true;
735 }
736
737 /* This function checks whether all required values in phi nodes in final_bb
738 are constants. Required values are those that correspond to a basic block
739 which is a part of the examined switch statement. It returns true if the
740 phi nodes are OK, otherwise false. */
741
742 static bool
743 check_final_bb (struct switch_conv_info *info)
744 {
745 gimple_stmt_iterator gsi;
746
747 info->phi_count = 0;
748 for (gsi = gsi_start_phis (info->final_bb); !gsi_end_p (gsi); gsi_next (&gsi))
749 {
750 gimple phi = gsi_stmt (gsi);
751 unsigned int i;
752
753 info->phi_count++;
754
755 for (i = 0; i < gimple_phi_num_args (phi); i++)
756 {
757 basic_block bb = gimple_phi_arg_edge (phi, i)->src;
758
759 if (bb == info->switch_bb
760 || (single_pred_p (bb) && single_pred (bb) == info->switch_bb))
761 {
762 tree reloc, val;
763
764 val = gimple_phi_arg_def (phi, i);
765 if (!is_gimple_ip_invariant (val))
766 {
767 info->reason = "non-invariant value from a case";
768 return false; /* Non-invariant argument. */
769 }
770 reloc = initializer_constant_valid_p (val, TREE_TYPE (val));
771 if ((flag_pic && reloc != null_pointer_node)
772 || (!flag_pic && reloc == NULL_TREE))
773 {
774 if (reloc)
775 info->reason
776 = "value from a case would need runtime relocations";
777 else
778 info->reason
779 = "value from a case is not a valid initializer";
780 return false;
781 }
782 }
783 }
784 }
785
786 return true;
787 }
788
789 /* The following function allocates default_values, target_{in,out}_names and
790 constructors arrays. The last one is also populated with pointers to
791 vectors that will become constructors of new arrays. */
792
793 static void
794 create_temp_arrays (struct switch_conv_info *info)
795 {
796 int i;
797
798 info->default_values = XCNEWVEC (tree, info->phi_count * 3);
799 info->constructors = XCNEWVEC (VEC (constructor_elt, gc) *, info->phi_count);
800 info->target_inbound_names = info->default_values + info->phi_count;
801 info->target_outbound_names = info->target_inbound_names + info->phi_count;
802 for (i = 0; i < info->phi_count; i++)
803 info->constructors[i]
804 = VEC_alloc (constructor_elt, gc, tree_low_cst (info->range_size, 1) + 1);
805 }
806
807 /* Free the arrays created by create_temp_arrays(). The vectors that are
808 created by that function are not freed here, however, because they have
809 already become constructors and must be preserved. */
810
811 static void
812 free_temp_arrays (struct switch_conv_info *info)
813 {
814 XDELETEVEC (info->constructors);
815 XDELETEVEC (info->default_values);
816 }
817
818 /* Populate the array of default values in the order of phi nodes.
819 DEFAULT_CASE is the CASE_LABEL_EXPR for the default switch branch. */
820
821 static void
822 gather_default_values (tree default_case, struct switch_conv_info *info)
823 {
824 gimple_stmt_iterator gsi;
825 basic_block bb = label_to_block (CASE_LABEL (default_case));
826 edge e;
827 int i = 0;
828
829 gcc_assert (CASE_LOW (default_case) == NULL_TREE);
830
831 if (bb == info->final_bb)
832 e = find_edge (info->switch_bb, bb);
833 else
834 e = single_succ_edge (bb);
835
836 for (gsi = gsi_start_phis (info->final_bb); !gsi_end_p (gsi); gsi_next (&gsi))
837 {
838 gimple phi = gsi_stmt (gsi);
839 tree val = PHI_ARG_DEF_FROM_EDGE (phi, e);
840 gcc_assert (val);
841 info->default_values[i++] = val;
842 }
843 }
844
845 /* The following function populates the vectors in the constructors array with
846 future contents of the static arrays. The vectors are populated in the
847 order of phi nodes. SWTCH is the switch statement being converted. */
848
849 static void
850 build_constructors (gimple swtch, struct switch_conv_info *info)
851 {
852 unsigned i, branch_num = gimple_switch_num_labels (swtch);
853 tree pos = info->range_min;
854
855 for (i = 1; i < branch_num; i++)
856 {
857 tree cs = gimple_switch_label (swtch, i);
858 basic_block bb = label_to_block (CASE_LABEL (cs));
859 edge e;
860 tree high;
861 gimple_stmt_iterator gsi;
862 int j;
863
864 if (bb == info->final_bb)
865 e = find_edge (info->switch_bb, bb);
866 else
867 e = single_succ_edge (bb);
868 gcc_assert (e);
869
870 while (tree_int_cst_lt (pos, CASE_LOW (cs)))
871 {
872 int k;
873 for (k = 0; k < info->phi_count; k++)
874 {
875 constructor_elt *elt;
876
877 elt = VEC_quick_push (constructor_elt,
878 info->constructors[k], NULL);
879 elt->index = int_const_binop (MINUS_EXPR, pos,
880 info->range_min);
881 elt->value = info->default_values[k];
882 }
883
884 pos = int_const_binop (PLUS_EXPR, pos, integer_one_node);
885 }
886 gcc_assert (tree_int_cst_equal (pos, CASE_LOW (cs)));
887
888 j = 0;
889 if (CASE_HIGH (cs))
890 high = CASE_HIGH (cs);
891 else
892 high = CASE_LOW (cs);
893 for (gsi = gsi_start_phis (info->final_bb);
894 !gsi_end_p (gsi); gsi_next (&gsi))
895 {
896 gimple phi = gsi_stmt (gsi);
897 tree val = PHI_ARG_DEF_FROM_EDGE (phi, e);
898 tree low = CASE_LOW (cs);
899 pos = CASE_LOW (cs);
900
901 do
902 {
903 constructor_elt *elt;
904
905 elt = VEC_quick_push (constructor_elt,
906 info->constructors[j], NULL);
907 elt->index = int_const_binop (MINUS_EXPR, pos, info->range_min);
908 elt->value = val;
909
910 pos = int_const_binop (PLUS_EXPR, pos, integer_one_node);
911 } while (!tree_int_cst_lt (high, pos)
912 && tree_int_cst_lt (low, pos));
913 j++;
914 }
915 }
916 }
917
918 /* If all values in the constructor vector are the same, return the value.
919 Otherwise return NULL_TREE. Not supposed to be called for empty
920 vectors. */
921
922 static tree
923 constructor_contains_same_values_p (VEC (constructor_elt, gc) *vec)
924 {
925 unsigned int i;
926 tree prev = NULL_TREE;
927 constructor_elt *elt;
928
929 FOR_EACH_VEC_ELT (constructor_elt, vec, i, elt)
930 {
931 if (!prev)
932 prev = elt->value;
933 else if (!operand_equal_p (elt->value, prev, OEP_ONLY_CONST))
934 return NULL_TREE;
935 }
936 return prev;
937 }
938
939 /* Return type which should be used for array elements, either TYPE,
940 or for integral type some smaller integral type that can still hold
941 all the constants. */
942
943 static tree
944 array_value_type (gimple swtch, tree type, int num,
945 struct switch_conv_info *info)
946 {
947 unsigned int i, len = VEC_length (constructor_elt, info->constructors[num]);
948 constructor_elt *elt;
949 enum machine_mode mode;
950 int sign = 0;
951 tree smaller_type;
952
953 if (!INTEGRAL_TYPE_P (type))
954 return type;
955
956 mode = GET_CLASS_NARROWEST_MODE (GET_MODE_CLASS (TYPE_MODE (type)));
957 if (GET_MODE_SIZE (TYPE_MODE (type)) <= GET_MODE_SIZE (mode))
958 return type;
959
960 if (len < (optimize_bb_for_size_p (gimple_bb (swtch)) ? 2 : 32))
961 return type;
962
963 FOR_EACH_VEC_ELT (constructor_elt, info->constructors[num], i, elt)
964 {
965 double_int cst;
966
967 if (TREE_CODE (elt->value) != INTEGER_CST)
968 return type;
969
970 cst = TREE_INT_CST (elt->value);
971 while (1)
972 {
973 unsigned int prec = GET_MODE_BITSIZE (mode);
974 if (prec > HOST_BITS_PER_WIDE_INT)
975 return type;
976
977 if (sign >= 0
978 && double_int_equal_p (cst, double_int_zext (cst, prec)))
979 {
980 if (sign == 0
981 && double_int_equal_p (cst, double_int_sext (cst, prec)))
982 break;
983 sign = 1;
984 break;
985 }
986 if (sign <= 0
987 && double_int_equal_p (cst, double_int_sext (cst, prec)))
988 {
989 sign = -1;
990 break;
991 }
992
993 if (sign == 1)
994 sign = 0;
995
996 mode = GET_MODE_WIDER_MODE (mode);
997 if (mode == VOIDmode
998 || GET_MODE_SIZE (mode) >= GET_MODE_SIZE (TYPE_MODE (type)))
999 return type;
1000 }
1001 }
1002
1003 if (sign == 0)
1004 sign = TYPE_UNSIGNED (type) ? 1 : -1;
1005 smaller_type = lang_hooks.types.type_for_mode (mode, sign >= 0);
1006 if (GET_MODE_SIZE (TYPE_MODE (type))
1007 <= GET_MODE_SIZE (TYPE_MODE (smaller_type)))
1008 return type;
1009
1010 return smaller_type;
1011 }
1012
1013 /* Create an appropriate array type and declaration and assemble a static array
1014 variable. Also create a load statement that initializes the variable in
1015 question with a value from the static array. SWTCH is the switch statement
1016 being converted, NUM is the index to arrays of constructors, default values
1017 and target SSA names for this particular array. ARR_INDEX_TYPE is the type
1018 of the index of the new array, PHI is the phi node of the final BB that
1019 corresponds to the value that will be loaded from the created array. TIDX
1020 is an ssa name of a temporary variable holding the index for loads from the
1021 new array. */
1022
1023 static void
1024 build_one_array (gimple swtch, int num, tree arr_index_type, gimple phi,
1025 tree tidx, struct switch_conv_info *info)
1026 {
1027 tree name, cst;
1028 gimple load;
1029 gimple_stmt_iterator gsi = gsi_for_stmt (swtch);
1030 location_t loc = gimple_location (swtch);
1031
1032 gcc_assert (info->default_values[num]);
1033
1034 name = copy_ssa_name (PHI_RESULT (phi), NULL);
1035 info->target_inbound_names[num] = name;
1036
1037 cst = constructor_contains_same_values_p (info->constructors[num]);
1038 if (cst)
1039 load = gimple_build_assign (name, cst);
1040 else
1041 {
1042 tree array_type, ctor, decl, value_type, fetch, default_type;
1043
1044 default_type = TREE_TYPE (info->default_values[num]);
1045 value_type = array_value_type (swtch, default_type, num, info);
1046 array_type = build_array_type (value_type, arr_index_type);
1047 if (default_type != value_type)
1048 {
1049 unsigned int i;
1050 constructor_elt *elt;
1051
1052 FOR_EACH_VEC_ELT (constructor_elt, info->constructors[num], i, elt)
1053 elt->value = fold_convert (value_type, elt->value);
1054 }
1055 ctor = build_constructor (array_type, info->constructors[num]);
1056 TREE_CONSTANT (ctor) = true;
1057 TREE_STATIC (ctor) = true;
1058
1059 decl = build_decl (loc, VAR_DECL, NULL_TREE, array_type);
1060 TREE_STATIC (decl) = 1;
1061 DECL_INITIAL (decl) = ctor;
1062
1063 DECL_NAME (decl) = create_tmp_var_name ("CSWTCH");
1064 DECL_ARTIFICIAL (decl) = 1;
1065 TREE_CONSTANT (decl) = 1;
1066 TREE_READONLY (decl) = 1;
1067 varpool_finalize_decl (decl);
1068
1069 fetch = build4 (ARRAY_REF, value_type, decl, tidx, NULL_TREE,
1070 NULL_TREE);
1071 if (default_type != value_type)
1072 {
1073 fetch = fold_convert (default_type, fetch);
1074 fetch = force_gimple_operand_gsi (&gsi, fetch, true, NULL_TREE,
1075 true, GSI_SAME_STMT);
1076 }
1077 load = gimple_build_assign (name, fetch);
1078 }
1079
1080 gsi_insert_before (&gsi, load, GSI_SAME_STMT);
1081 update_stmt (load);
1082 info->arr_ref_last = load;
1083 }
1084
1085 /* Builds and initializes static arrays initialized with values gathered from
1086 the SWTCH switch statement. Also creates statements that load values from
1087 them. */
1088
1089 static void
1090 build_arrays (gimple swtch, struct switch_conv_info *info)
1091 {
1092 tree arr_index_type;
1093 tree tidx, sub, tmp, utype;
1094 gimple stmt;
1095 gimple_stmt_iterator gsi;
1096 int i;
1097 location_t loc = gimple_location (swtch);
1098
1099 gsi = gsi_for_stmt (swtch);
1100
1101 /* Make sure we do not generate arithmetics in a subrange. */
1102 utype = TREE_TYPE (info->index_expr);
1103 if (TREE_TYPE (utype))
1104 utype = lang_hooks.types.type_for_mode (TYPE_MODE (TREE_TYPE (utype)), 1);
1105 else
1106 utype = lang_hooks.types.type_for_mode (TYPE_MODE (utype), 1);
1107
1108 arr_index_type = build_index_type (info->range_size);
1109 tmp = create_tmp_var (utype, "csui");
1110 tidx = make_ssa_name (tmp, 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);
1117 SSA_NAME_DEF_STMT (tidx) = stmt;
1118
1119 gsi_insert_before (&gsi, stmt, GSI_SAME_STMT);
1120 update_stmt (stmt);
1121 info->arr_ref_first = stmt;
1122
1123 for (gsi = gsi_start_phis (info->final_bb), i = 0;
1124 !gsi_end_p (gsi); gsi_next (&gsi), i++)
1125 build_one_array (swtch, i, arr_index_type, gsi_stmt (gsi), tidx, info);
1126 }
1127
1128 /* Generates and appropriately inserts loads of default values at the position
1129 given by BSI. Returns the last inserted statement. */
1130
1131 static gimple
1132 gen_def_assigns (gimple_stmt_iterator *gsi, struct switch_conv_info *info)
1133 {
1134 int i;
1135 gimple assign = NULL;
1136
1137 for (i = 0; i < info->phi_count; i++)
1138 {
1139 tree name = copy_ssa_name (info->target_inbound_names[i], NULL);
1140 info->target_outbound_names[i] = name;
1141 assign = gimple_build_assign (name, info->default_values[i]);
1142 gsi_insert_before (gsi, assign, GSI_SAME_STMT);
1143 update_stmt (assign);
1144 }
1145 return assign;
1146 }
1147
1148 /* Deletes the unused bbs and edges that now contain the switch statement and
1149 its empty branch bbs. BBD is the now dead BB containing the original switch
1150 statement, FINAL is the last BB of the converted switch statement (in terms
1151 of succession). */
1152
1153 static void
1154 prune_bbs (basic_block bbd, basic_block final)
1155 {
1156 edge_iterator ei;
1157 edge e;
1158
1159 for (ei = ei_start (bbd->succs); (e = ei_safe_edge (ei)); )
1160 {
1161 basic_block bb;
1162 bb = e->dest;
1163 remove_edge (e);
1164 if (bb != final)
1165 delete_basic_block (bb);
1166 }
1167 delete_basic_block (bbd);
1168 }
1169
1170 /* Add values to phi nodes in final_bb for the two new edges. E1F is the edge
1171 from the basic block loading values from an array and E2F from the basic
1172 block loading default values. BBF is the last switch basic block (see the
1173 bbf description in the comment below). */
1174
1175 static void
1176 fix_phi_nodes (edge e1f, edge e2f, basic_block bbf,
1177 struct switch_conv_info *info)
1178 {
1179 gimple_stmt_iterator gsi;
1180 int i;
1181
1182 for (gsi = gsi_start_phis (bbf), i = 0;
1183 !gsi_end_p (gsi); gsi_next (&gsi), i++)
1184 {
1185 gimple phi = gsi_stmt (gsi);
1186 add_phi_arg (phi, info->target_inbound_names[i], e1f, UNKNOWN_LOCATION);
1187 add_phi_arg (phi, info->target_outbound_names[i], e2f, UNKNOWN_LOCATION);
1188 }
1189 }
1190
1191 /* Creates a check whether the switch expression value actually falls into the
1192 range given by all the cases. If it does not, the temporaries are loaded
1193 with default values instead. SWTCH is the switch statement being converted.
1194
1195 bb0 is the bb with the switch statement, however, we'll end it with a
1196 condition instead.
1197
1198 bb1 is the bb to be used when the range check went ok. It is derived from
1199 the switch BB
1200
1201 bb2 is the bb taken when the expression evaluated outside of the range
1202 covered by the created arrays. It is populated by loads of default
1203 values.
1204
1205 bbF is a fall through for both bb1 and bb2 and contains exactly what
1206 originally followed the switch statement.
1207
1208 bbD contains the switch statement (in the end). It is unreachable but we
1209 still need to strip off its edges.
1210 */
1211
1212 static void
1213 gen_inbound_check (gimple swtch, struct switch_conv_info *info)
1214 {
1215 tree label_decl1 = create_artificial_label (UNKNOWN_LOCATION);
1216 tree label_decl2 = create_artificial_label (UNKNOWN_LOCATION);
1217 tree label_decl3 = create_artificial_label (UNKNOWN_LOCATION);
1218 gimple label1, label2, label3;
1219 tree utype, tidx;
1220 tree bound;
1221
1222 gimple cond_stmt;
1223
1224 gimple last_assign;
1225 gimple_stmt_iterator gsi;
1226 basic_block bb0, bb1, bb2, bbf, bbd;
1227 edge e01, e02, e21, e1d, e1f, e2f;
1228 location_t loc = gimple_location (swtch);
1229
1230 gcc_assert (info->default_values);
1231
1232 bb0 = gimple_bb (swtch);
1233
1234 tidx = gimple_assign_lhs (info->arr_ref_first);
1235 utype = TREE_TYPE (tidx);
1236
1237 /* (end of) block 0 */
1238 gsi = gsi_for_stmt (info->arr_ref_first);
1239 gsi_next (&gsi);
1240
1241 bound = fold_convert_loc (loc, utype, info->range_size);
1242 cond_stmt = gimple_build_cond (LE_EXPR, tidx, bound, NULL_TREE, NULL_TREE);
1243 gsi_insert_before (&gsi, cond_stmt, GSI_SAME_STMT);
1244 update_stmt (cond_stmt);
1245
1246 /* block 2 */
1247 label2 = gimple_build_label (label_decl2);
1248 gsi_insert_before (&gsi, label2, GSI_SAME_STMT);
1249 last_assign = gen_def_assigns (&gsi, info);
1250
1251 /* block 1 */
1252 label1 = gimple_build_label (label_decl1);
1253 gsi_insert_before (&gsi, label1, GSI_SAME_STMT);
1254
1255 /* block F */
1256 gsi = gsi_start_bb (info->final_bb);
1257 label3 = gimple_build_label (label_decl3);
1258 gsi_insert_before (&gsi, label3, GSI_SAME_STMT);
1259
1260 /* cfg fix */
1261 e02 = split_block (bb0, cond_stmt);
1262 bb2 = e02->dest;
1263
1264 e21 = split_block (bb2, last_assign);
1265 bb1 = e21->dest;
1266 remove_edge (e21);
1267
1268 e1d = split_block (bb1, info->arr_ref_last);
1269 bbd = e1d->dest;
1270 remove_edge (e1d);
1271
1272 /* flags and profiles of the edge for in-range values */
1273 e01 = make_edge (bb0, bb1, EDGE_TRUE_VALUE);
1274 e01->probability = REG_BR_PROB_BASE - info->default_prob;
1275 e01->count = info->other_count;
1276
1277 /* flags and profiles of the edge taking care of out-of-range values */
1278 e02->flags &= ~EDGE_FALLTHRU;
1279 e02->flags |= EDGE_FALSE_VALUE;
1280 e02->probability = info->default_prob;
1281 e02->count = info->default_count;
1282
1283 bbf = info->final_bb;
1284
1285 e1f = make_edge (bb1, bbf, EDGE_FALLTHRU);
1286 e1f->probability = REG_BR_PROB_BASE;
1287 e1f->count = info->other_count;
1288
1289 e2f = make_edge (bb2, bbf, EDGE_FALLTHRU);
1290 e2f->probability = REG_BR_PROB_BASE;
1291 e2f->count = info->default_count;
1292
1293 /* frequencies of the new BBs */
1294 bb1->frequency = EDGE_FREQUENCY (e01);
1295 bb2->frequency = EDGE_FREQUENCY (e02);
1296 bbf->frequency = EDGE_FREQUENCY (e1f) + EDGE_FREQUENCY (e2f);
1297
1298 /* Tidy blocks that have become unreachable. */
1299 prune_bbs (bbd, info->final_bb);
1300
1301 /* Fixup the PHI nodes in bbF. */
1302 fix_phi_nodes (e1f, e2f, bbf, info);
1303
1304 /* Fix the dominator tree, if it is available. */
1305 if (dom_info_available_p (CDI_DOMINATORS))
1306 {
1307 VEC (basic_block, heap) *bbs_to_fix_dom;
1308
1309 set_immediate_dominator (CDI_DOMINATORS, bb1, bb0);
1310 set_immediate_dominator (CDI_DOMINATORS, bb2, bb0);
1311 if (! get_immediate_dominator (CDI_DOMINATORS, bbf))
1312 /* If bbD was the immediate dominator ... */
1313 set_immediate_dominator (CDI_DOMINATORS, bbf, bb0);
1314
1315 bbs_to_fix_dom = VEC_alloc (basic_block, heap, 4);
1316 VEC_quick_push (basic_block, bbs_to_fix_dom, bb0);
1317 VEC_quick_push (basic_block, bbs_to_fix_dom, bb1);
1318 VEC_quick_push (basic_block, bbs_to_fix_dom, bb2);
1319 VEC_quick_push (basic_block, bbs_to_fix_dom, bbf);
1320
1321 iterate_fix_dominators (CDI_DOMINATORS, bbs_to_fix_dom, true);
1322 VEC_free (basic_block, heap, bbs_to_fix_dom);
1323 }
1324 }
1325
1326 /* The following function is invoked on every switch statement (the current one
1327 is given in SWTCH) and runs the individual phases of switch conversion on it
1328 one after another until one fails or the conversion is completed.
1329 Returns NULL on success, or a pointer to a string with the reason why the
1330 conversion failed. */
1331
1332 static const char *
1333 process_switch (gimple swtch)
1334 {
1335 struct switch_conv_info info;
1336
1337 /* Group case labels so that we get the right results from the heuristics
1338 that decide on the code generation approach for this switch. */
1339 group_case_labels_stmt (swtch);
1340
1341 /* If this switch is now a degenerate case with only a default label,
1342 there is nothing left for us to do. */
1343 if (gimple_switch_num_labels (swtch) < 2)
1344 return "switch is a degenerate case";
1345
1346 collect_switch_conv_info (swtch, &info);
1347
1348 /* No error markers should reach here (they should be filtered out
1349 during gimplification). */
1350 gcc_checking_assert (TREE_TYPE (info.index_expr) != error_mark_node);
1351
1352 /* A switch on a constant should have been optimized in tree-cfg-cleanup. */
1353 gcc_checking_assert (! TREE_CONSTANT (info.index_expr));
1354
1355 if (info.uniq <= MAX_CASE_BIT_TESTS)
1356 {
1357 if (expand_switch_using_bit_tests_p (info.range_size,
1358 info.uniq, info.count))
1359 {
1360 if (dump_file)
1361 fputs (" expanding as bit test is preferable\n", dump_file);
1362 emit_case_bit_tests (swtch, info.index_expr,
1363 info.range_min, info.range_size);
1364 return NULL;
1365 }
1366
1367 if (info.uniq <= 2)
1368 /* This will be expanded as a decision tree in stmt.c:expand_case. */
1369 return " expanding as jumps is preferable";
1370 }
1371
1372 /* If there is no common successor, we cannot do the transformation. */
1373 if (! info.final_bb)
1374 return "no common successor to all case label target blocks found";
1375
1376 /* Check the case label values are within reasonable range: */
1377 if (!check_range (&info))
1378 {
1379 gcc_assert (info.reason);
1380 return info.reason;
1381 }
1382
1383 /* For all the cases, see whether they are empty, the assignments they
1384 represent constant and so on... */
1385 if (! check_all_empty_except_final (&info))
1386 {
1387 gcc_assert (info.reason);
1388 return info.reason;
1389 }
1390 if (!check_final_bb (&info))
1391 {
1392 gcc_assert (info.reason);
1393 return info.reason;
1394 }
1395
1396 /* At this point all checks have passed and we can proceed with the
1397 transformation. */
1398
1399 create_temp_arrays (&info);
1400 gather_default_values (gimple_switch_label (swtch, 0), &info);
1401 build_constructors (swtch, &info);
1402
1403 build_arrays (swtch, &info); /* Build the static arrays and assignments. */
1404 gen_inbound_check (swtch, &info); /* Build the bounds check. */
1405
1406 /* Cleanup: */
1407 free_temp_arrays (&info);
1408 return NULL;
1409 }
1410
1411 /* The main function of the pass scans statements for switches and invokes
1412 process_switch on them. */
1413
1414 static unsigned int
1415 do_switchconv (void)
1416 {
1417 basic_block bb;
1418
1419 FOR_EACH_BB (bb)
1420 {
1421 const char *failure_reason;
1422 gimple stmt = last_stmt (bb);
1423 if (stmt && gimple_code (stmt) == GIMPLE_SWITCH)
1424 {
1425 if (dump_file)
1426 {
1427 expanded_location loc = expand_location (gimple_location (stmt));
1428
1429 fprintf (dump_file, "beginning to process the following "
1430 "SWITCH statement (%s:%d) : ------- \n",
1431 loc.file, loc.line);
1432 print_gimple_stmt (dump_file, stmt, 0, TDF_SLIM);
1433 putc ('\n', dump_file);
1434 }
1435
1436 failure_reason = process_switch (stmt);
1437 if (! failure_reason)
1438 {
1439 if (dump_file)
1440 {
1441 fputs ("Switch converted\n", dump_file);
1442 fputs ("--------------------------------\n", dump_file);
1443 }
1444
1445 /* Make no effort to update the post-dominator tree. It is actually not
1446 that hard for the transformations we have performed, but it is not
1447 supported by iterate_fix_dominators. */
1448 free_dominance_info (CDI_POST_DOMINATORS);
1449 }
1450 else
1451 {
1452 if (dump_file)
1453 {
1454 fputs ("Bailing out - ", dump_file);
1455 fputs (failure_reason, dump_file);
1456 fputs ("\n--------------------------------\n", dump_file);
1457 }
1458 }
1459 }
1460 }
1461
1462 return 0;
1463 }
1464
1465 /* The pass gate. */
1466
1467 static bool
1468 switchconv_gate (void)
1469 {
1470 return flag_tree_switch_conversion != 0;
1471 }
1472
1473 struct gimple_opt_pass pass_convert_switch =
1474 {
1475 {
1476 GIMPLE_PASS,
1477 "switchconv", /* name */
1478 switchconv_gate, /* gate */
1479 do_switchconv, /* execute */
1480 NULL, /* sub */
1481 NULL, /* next */
1482 0, /* static_pass_number */
1483 TV_TREE_SWITCH_CONVERSION, /* tv_id */
1484 PROP_cfg | PROP_ssa, /* properties_required */
1485 0, /* properties_provided */
1486 0, /* properties_destroyed */
1487 0, /* todo_flags_start */
1488 TODO_update_ssa
1489 | TODO_ggc_collect | TODO_verify_ssa
1490 | TODO_verify_stmts
1491 | TODO_verify_flow /* todo_flags_finish */
1492 }
1493 };