]> git.ipfire.org Git - thirdparty/gcc.git/blob - gcc/tree-switch-conversion.c
Merge in trunk.
[thirdparty/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-2013 Free Software Foundation, Inc.
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3, or (at your option) any
10 later version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not, write to the Free
19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
20 02110-1301, USA. */
21
22 /* This file handles the lowering of GIMPLE_SWITCH to an indexed
23 load, or a series of bit-test-and-branch expressions. */
24
25 #include "config.h"
26 #include "system.h"
27 #include "coretypes.h"
28 #include "tm.h"
29 #include "line-map.h"
30 #include "params.h"
31 #include "flags.h"
32 #include "tree.h"
33 #include "basic-block.h"
34 #include "gimple.h"
35 #include "gimple-ssa.h"
36 #include "cgraph.h"
37 #include "tree-cfg.h"
38 #include "tree-phinodes.h"
39 #include "tree-ssanames.h"
40 #include "tree-pass.h"
41 #include "gimple-pretty-print.h"
42 #include "cfgloop.h"
43
44 /* ??? For lang_hooks.types.type_for_mode, but is there a word_mode
45 type in the GIMPLE type system that is language-independent? */
46 #include "langhooks.h"
47
48 /* Need to include expr.h and optabs.h for lshift_cheap_p. */
49 #include "expr.h"
50 #include "optabs.h"
51 \f
52 /* Maximum number of case bit tests.
53 FIXME: This should be derived from PARAM_CASE_VALUES_THRESHOLD and
54 targetm.case_values_threshold(), or be its own param. */
55 #define MAX_CASE_BIT_TESTS 3
56
57 /* Split the basic block at the statement pointed to by GSIP, and insert
58 a branch to the target basic block of E_TRUE conditional on tree
59 expression COND.
60
61 It is assumed that there is already an edge from the to-be-split
62 basic block to E_TRUE->dest block. This edge is removed, and the
63 profile information on the edge is re-used for the new conditional
64 jump.
65
66 The CFG is updated. The dominator tree will not be valid after
67 this transformation, but the immediate dominators are updated if
68 UPDATE_DOMINATORS is true.
69
70 Returns the newly created basic block. */
71
72 static basic_block
73 hoist_edge_and_branch_if_true (gimple_stmt_iterator *gsip,
74 tree cond, edge e_true,
75 bool update_dominators)
76 {
77 tree tmp;
78 gimple cond_stmt;
79 edge e_false;
80 basic_block new_bb, split_bb = gsi_bb (*gsip);
81 bool dominated_e_true = false;
82
83 gcc_assert (e_true->src == split_bb);
84
85 if (update_dominators
86 && get_immediate_dominator (CDI_DOMINATORS, e_true->dest) == split_bb)
87 dominated_e_true = true;
88
89 tmp = force_gimple_operand_gsi (gsip, cond, /*simple=*/true, NULL,
90 /*before=*/true, GSI_SAME_STMT);
91 cond_stmt = gimple_build_cond_from_tree (tmp, NULL_TREE, NULL_TREE);
92 gsi_insert_before (gsip, cond_stmt, GSI_SAME_STMT);
93
94 e_false = split_block (split_bb, cond_stmt);
95 new_bb = e_false->dest;
96 redirect_edge_pred (e_true, split_bb);
97
98 e_true->flags &= ~EDGE_FALLTHRU;
99 e_true->flags |= EDGE_TRUE_VALUE;
100
101 e_false->flags &= ~EDGE_FALLTHRU;
102 e_false->flags |= EDGE_FALSE_VALUE;
103 e_false->probability = REG_BR_PROB_BASE - e_true->probability;
104 e_false->count = split_bb->count - e_true->count;
105 new_bb->count = e_false->count;
106
107 if (update_dominators)
108 {
109 if (dominated_e_true)
110 set_immediate_dominator (CDI_DOMINATORS, e_true->dest, split_bb);
111 set_immediate_dominator (CDI_DOMINATORS, e_false->dest, split_bb);
112 }
113
114 return new_bb;
115 }
116
117
118 /* Determine whether "1 << x" is relatively cheap in word_mode. */
119 /* FIXME: This is the function that we need rtl.h and optabs.h for.
120 This function (and similar RTL-related cost code in e.g. IVOPTS) should
121 be moved to some kind of interface file for GIMPLE/RTL interactions. */
122 static bool
123 lshift_cheap_p (void)
124 {
125 /* FIXME: This should be made target dependent via this "this_target"
126 mechanism, similar to e.g. can_copy_init_p in gcse.c. */
127 static bool init[2] = {false, false};
128 static bool cheap[2] = {true, true};
129 bool speed_p;
130
131 /* If the targer has no lshift in word_mode, the operation will most
132 probably not be cheap. ??? Does GCC even work for such targets? */
133 if (optab_handler (ashl_optab, word_mode) == CODE_FOR_nothing)
134 return false;
135
136 speed_p = optimize_insn_for_speed_p ();
137
138 if (!init[speed_p])
139 {
140 rtx reg = gen_raw_REG (word_mode, 10000);
141 int cost = set_src_cost (gen_rtx_ASHIFT (word_mode, const1_rtx, reg),
142 speed_p);
143 cheap[speed_p] = cost < COSTS_N_INSNS (MAX_CASE_BIT_TESTS);
144 init[speed_p] = true;
145 }
146
147 return cheap[speed_p];
148 }
149
150 /* Return true if a switch should be expanded as a bit test.
151 RANGE is the difference between highest and lowest case.
152 UNIQ is number of unique case node targets, not counting the default case.
153 COUNT is the number of comparisons needed, not counting the default case. */
154
155 static bool
156 expand_switch_using_bit_tests_p (tree range,
157 unsigned int uniq,
158 unsigned int count)
159 {
160 return (((uniq == 1 && count >= 3)
161 || (uniq == 2 && count >= 5)
162 || (uniq == 3 && count >= 6))
163 && lshift_cheap_p ()
164 && compare_tree_int (range, GET_MODE_BITSIZE (word_mode)) < 0
165 && compare_tree_int (range, 0) > 0);
166 }
167 \f
168 /* Implement switch statements with bit tests
169
170 A GIMPLE switch statement can be expanded to a short sequence of bit-wise
171 comparisons. "switch(x)" is converted into "if ((1 << (x-MINVAL)) & CST)"
172 where CST and MINVAL are integer constants. This is better than a series
173 of compare-and-banch insns in some cases, e.g. we can implement:
174
175 if ((x==4) || (x==6) || (x==9) || (x==11))
176
177 as a single bit test:
178
179 if ((1<<x) & ((1<<4)|(1<<6)|(1<<9)|(1<<11)))
180
181 This transformation is only applied if the number of case targets is small,
182 if CST constains at least 3 bits, and "1 << x" is cheap. The bit tests are
183 performed in "word_mode".
184
185 The following example shows the code the transformation generates:
186
187 int bar(int x)
188 {
189 switch (x)
190 {
191 case '0': case '1': case '2': case '3': case '4':
192 case '5': case '6': case '7': case '8': case '9':
193 case 'A': case 'B': case 'C': case 'D': case 'E':
194 case 'F':
195 return 1;
196 }
197 return 0;
198 }
199
200 ==>
201
202 bar (int x)
203 {
204 tmp1 = x - 48;
205 if (tmp1 > (70 - 48)) goto L2;
206 tmp2 = 1 << tmp1;
207 tmp3 = 0b11111100000001111111111;
208 if ((tmp2 & tmp3) != 0) goto L1 ; else goto L2;
209 L1:
210 return 1;
211 L2:
212 return 0;
213 }
214
215 TODO: There are still some improvements to this transformation that could
216 be implemented:
217
218 * A narrower mode than word_mode could be used if that is cheaper, e.g.
219 for x86_64 where a narrower-mode shift may result in smaller code.
220
221 * The compounded constant could be shifted rather than the one. The
222 test would be either on the sign bit or on the least significant bit,
223 depending on the direction of the shift. On some machines, the test
224 for the branch would be free if the bit to test is already set by the
225 shift operation.
226
227 This transformation was contributed by Roger Sayle, see this e-mail:
228 http://gcc.gnu.org/ml/gcc-patches/2003-01/msg01950.html
229 */
230
231 /* A case_bit_test represents a set of case nodes that may be
232 selected from using a bit-wise comparison. HI and LO hold
233 the integer to be tested against, TARGET_EDGE contains the
234 edge to the basic block to jump to upon success and BITS
235 counts the number of case nodes handled by this test,
236 typically the number of bits set in HI:LO. The LABEL field
237 is used to quickly identify all cases in this set without
238 looking at label_to_block for every case label. */
239
240 struct case_bit_test
241 {
242 HOST_WIDE_INT hi;
243 HOST_WIDE_INT lo;
244 edge target_edge;
245 tree label;
246 int bits;
247 };
248
249 /* Comparison function for qsort to order bit tests by decreasing
250 probability of execution. Our best guess comes from a measured
251 profile. If the profile counts are equal, break even on the
252 number of case nodes, i.e. the node with the most cases gets
253 tested first.
254
255 TODO: Actually this currently runs before a profile is available.
256 Therefore the case-as-bit-tests transformation should be done
257 later in the pass pipeline, or something along the lines of
258 "Efficient and effective branch reordering using profile data"
259 (Yang et. al., 2002) should be implemented (although, how good
260 is a paper is called "Efficient and effective ..." when the
261 latter is implied by the former, but oh well...). */
262
263 static int
264 case_bit_test_cmp (const void *p1, const void *p2)
265 {
266 const struct case_bit_test *const d1 = (const struct case_bit_test *) p1;
267 const struct case_bit_test *const d2 = (const struct case_bit_test *) p2;
268
269 if (d2->target_edge->count != d1->target_edge->count)
270 return d2->target_edge->count - d1->target_edge->count;
271 if (d2->bits != d1->bits)
272 return d2->bits - d1->bits;
273
274 /* Stabilize the sort. */
275 return LABEL_DECL_UID (d2->label) - LABEL_DECL_UID (d1->label);
276 }
277
278 /* Expand a switch statement by a short sequence of bit-wise
279 comparisons. "switch(x)" is effectively converted into
280 "if ((1 << (x-MINVAL)) & CST)" where CST and MINVAL are
281 integer constants.
282
283 INDEX_EXPR is the value being switched on.
284
285 MINVAL is the lowest case value of in the case nodes,
286 and RANGE is highest value minus MINVAL. MINVAL and RANGE
287 are not guaranteed to be of the same type as INDEX_EXPR
288 (the gimplifier doesn't change the type of case label values,
289 and MINVAL and RANGE are derived from those values).
290
291 There *MUST* be MAX_CASE_BIT_TESTS or less unique case
292 node targets. */
293
294 static void
295 emit_case_bit_tests (gimple swtch, tree index_expr,
296 tree minval, tree range)
297 {
298 struct case_bit_test test[MAX_CASE_BIT_TESTS];
299 unsigned int i, j, k;
300 unsigned int count;
301
302 basic_block switch_bb = gimple_bb (swtch);
303 basic_block default_bb, new_default_bb, new_bb;
304 edge default_edge;
305 bool update_dom = dom_info_available_p (CDI_DOMINATORS);
306
307 vec<basic_block> bbs_to_fix_dom = vNULL;
308
309 tree index_type = TREE_TYPE (index_expr);
310 tree unsigned_index_type = unsigned_type_for (index_type);
311 unsigned int branch_num = gimple_switch_num_labels (swtch);
312
313 gimple_stmt_iterator gsi;
314 gimple shift_stmt;
315
316 tree idx, tmp, csui;
317 tree word_type_node = lang_hooks.types.type_for_mode (word_mode, 1);
318 tree word_mode_zero = fold_convert (word_type_node, integer_zero_node);
319 tree word_mode_one = fold_convert (word_type_node, integer_one_node);
320
321 memset (&test, 0, sizeof (test));
322
323 /* Get the edge for the default case. */
324 tmp = gimple_switch_default_label (swtch);
325 default_bb = label_to_block (CASE_LABEL (tmp));
326 default_edge = find_edge (switch_bb, default_bb);
327
328 /* Go through all case labels, and collect the case labels, profile
329 counts, and other information we need to build the branch tests. */
330 count = 0;
331 for (i = 1; i < branch_num; i++)
332 {
333 unsigned int lo, hi;
334 tree cs = gimple_switch_label (swtch, i);
335 tree label = CASE_LABEL (cs);
336 edge e = find_edge (switch_bb, label_to_block (label));
337 for (k = 0; k < count; k++)
338 if (e == test[k].target_edge)
339 break;
340
341 if (k == count)
342 {
343 gcc_checking_assert (count < MAX_CASE_BIT_TESTS);
344 test[k].hi = 0;
345 test[k].lo = 0;
346 test[k].target_edge = e;
347 test[k].label = label;
348 test[k].bits = 1;
349 count++;
350 }
351 else
352 test[k].bits++;
353
354 lo = tree_to_uhwi (int_const_binop (MINUS_EXPR,
355 CASE_LOW (cs), minval));
356 if (CASE_HIGH (cs) == NULL_TREE)
357 hi = lo;
358 else
359 hi = tree_to_uhwi (int_const_binop (MINUS_EXPR,
360 CASE_HIGH (cs), minval));
361
362 for (j = lo; j <= hi; j++)
363 if (j >= HOST_BITS_PER_WIDE_INT)
364 test[k].hi |= (HOST_WIDE_INT) 1 << (j - HOST_BITS_PER_INT);
365 else
366 test[k].lo |= (HOST_WIDE_INT) 1 << j;
367 }
368
369 qsort (test, count, sizeof (*test), case_bit_test_cmp);
370
371 /* We generate two jumps to the default case label.
372 Split the default edge, so that we don't have to do any PHI node
373 updating. */
374 new_default_bb = split_edge (default_edge);
375
376 if (update_dom)
377 {
378 bbs_to_fix_dom.create (10);
379 bbs_to_fix_dom.quick_push (switch_bb);
380 bbs_to_fix_dom.quick_push (default_bb);
381 bbs_to_fix_dom.quick_push (new_default_bb);
382 }
383
384 /* Now build the test-and-branch code. */
385
386 gsi = gsi_last_bb (switch_bb);
387
388 /* idx = (unsigned)x - minval. */
389 idx = fold_convert (unsigned_index_type, index_expr);
390 idx = fold_build2 (MINUS_EXPR, unsigned_index_type, idx,
391 fold_convert (unsigned_index_type, minval));
392 idx = force_gimple_operand_gsi (&gsi, idx,
393 /*simple=*/true, NULL_TREE,
394 /*before=*/true, GSI_SAME_STMT);
395
396 /* if (idx > range) goto default */
397 range = force_gimple_operand_gsi (&gsi,
398 fold_convert (unsigned_index_type, range),
399 /*simple=*/true, NULL_TREE,
400 /*before=*/true, GSI_SAME_STMT);
401 tmp = fold_build2 (GT_EXPR, boolean_type_node, idx, range);
402 new_bb = hoist_edge_and_branch_if_true (&gsi, tmp, default_edge, update_dom);
403 if (update_dom)
404 bbs_to_fix_dom.quick_push (new_bb);
405 gcc_assert (gimple_bb (swtch) == new_bb);
406 gsi = gsi_last_bb (new_bb);
407
408 /* Any blocks dominated by the GIMPLE_SWITCH, but that are not successors
409 of NEW_BB, are still immediately dominated by SWITCH_BB. Make it so. */
410 if (update_dom)
411 {
412 vec<basic_block> dom_bbs;
413 basic_block dom_son;
414
415 dom_bbs = get_dominated_by (CDI_DOMINATORS, new_bb);
416 FOR_EACH_VEC_ELT (dom_bbs, i, dom_son)
417 {
418 edge e = find_edge (new_bb, dom_son);
419 if (e && single_pred_p (e->dest))
420 continue;
421 set_immediate_dominator (CDI_DOMINATORS, dom_son, switch_bb);
422 bbs_to_fix_dom.safe_push (dom_son);
423 }
424 dom_bbs.release ();
425 }
426
427 /* csui = (1 << (word_mode) idx) */
428 csui = make_ssa_name (word_type_node, 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 gsi_insert_before (&gsi, shift_stmt, GSI_SAME_STMT);
436 update_stmt (shift_stmt);
437
438 /* for each unique set of cases:
439 if (const & csui) goto target */
440 for (k = 0; k < count; k++)
441 {
442 HOST_WIDE_INT a[2];
443
444 a[0] = test[k].lo;
445 a[1] = test[k].hi;
446 tmp = wide_int_to_tree (word_type_node,
447 wide_int::from_array (a, 2,
448 TYPE_PRECISION (word_type_node)));
449 tmp = fold_build2 (BIT_AND_EXPR, word_type_node, csui, tmp);
450 tmp = force_gimple_operand_gsi (&gsi, tmp,
451 /*simple=*/true, NULL_TREE,
452 /*before=*/true, GSI_SAME_STMT);
453 tmp = fold_build2 (NE_EXPR, boolean_type_node, tmp, word_mode_zero);
454 new_bb = hoist_edge_and_branch_if_true (&gsi, tmp, test[k].target_edge,
455 update_dom);
456 if (update_dom)
457 bbs_to_fix_dom.safe_push (new_bb);
458 gcc_assert (gimple_bb (swtch) == new_bb);
459 gsi = gsi_last_bb (new_bb);
460 }
461
462 /* We should have removed all edges now. */
463 gcc_assert (EDGE_COUNT (gsi_bb (gsi)->succs) == 0);
464
465 /* If nothing matched, go to the default label. */
466 make_edge (gsi_bb (gsi), new_default_bb, EDGE_FALLTHRU);
467
468 /* The GIMPLE_SWITCH is now redundant. */
469 gsi_remove (&gsi, true);
470
471 if (update_dom)
472 {
473 /* Fix up the dominator tree. */
474 iterate_fix_dominators (CDI_DOMINATORS, bbs_to_fix_dom, true);
475 bbs_to_fix_dom.release ();
476 }
477 }
478 \f
479 /*
480 Switch initialization conversion
481
482 The following pass changes simple initializations of scalars in a switch
483 statement into initializations from a static array. Obviously, the values
484 must be constant and known at compile time and a default branch must be
485 provided. For example, the following code:
486
487 int a,b;
488
489 switch (argc)
490 {
491 case 1:
492 case 2:
493 a_1 = 8;
494 b_1 = 6;
495 break;
496 case 3:
497 a_2 = 9;
498 b_2 = 5;
499 break;
500 case 12:
501 a_3 = 10;
502 b_3 = 4;
503 break;
504 default:
505 a_4 = 16;
506 b_4 = 1;
507 break;
508 }
509 a_5 = PHI <a_1, a_2, a_3, a_4>
510 b_5 = PHI <b_1, b_2, b_3, b_4>
511
512
513 is changed into:
514
515 static const int = CSWTCH01[] = {6, 6, 5, 1, 1, 1, 1, 1, 1, 1, 1, 4};
516 static const int = CSWTCH02[] = {8, 8, 9, 16, 16, 16, 16, 16, 16, 16,
517 16, 16, 10};
518
519 if (((unsigned) argc) - 1 < 11)
520 {
521 a_6 = CSWTCH02[argc - 1];
522 b_6 = CSWTCH01[argc - 1];
523 }
524 else
525 {
526 a_7 = 16;
527 b_7 = 1;
528 }
529 a_5 = PHI <a_6, a_7>
530 b_b = PHI <b_6, b_7>
531
532 There are further constraints. Specifically, the range of values across all
533 case labels must not be bigger than SWITCH_CONVERSION_BRANCH_RATIO (default
534 eight) times the number of the actual switch branches.
535
536 This transformation was contributed by Martin Jambor, see this e-mail:
537 http://gcc.gnu.org/ml/gcc-patches/2008-07/msg00011.html */
538
539 /* The main structure of the pass. */
540 struct switch_conv_info
541 {
542 /* The expression used to decide the switch branch. */
543 tree index_expr;
544
545 /* The following integer constants store the minimum and maximum value
546 covered by the case labels. */
547 tree range_min;
548 tree range_max;
549
550 /* The difference between the above two numbers. Stored here because it
551 is used in all the conversion heuristics, as well as for some of the
552 transformation, and it is expensive to re-compute it all the time. */
553 tree range_size;
554
555 /* Basic block that contains the actual GIMPLE_SWITCH. */
556 basic_block switch_bb;
557
558 /* Basic block that is the target of the default case. */
559 basic_block default_bb;
560
561 /* The single successor block of all branches out of the GIMPLE_SWITCH,
562 if such a block exists. Otherwise NULL. */
563 basic_block final_bb;
564
565 /* The probability of the default edge in the replaced switch. */
566 int default_prob;
567
568 /* The count of the default edge in the replaced switch. */
569 gcov_type default_count;
570
571 /* Combined count of all other (non-default) edges in the replaced switch. */
572 gcov_type other_count;
573
574 /* Number of phi nodes in the final bb (that we'll be replacing). */
575 int phi_count;
576
577 /* Array of default values, in the same order as phi nodes. */
578 tree *default_values;
579
580 /* Constructors of new static arrays. */
581 vec<constructor_elt, va_gc> **constructors;
582
583 /* Array of ssa names that are initialized with a value from a new static
584 array. */
585 tree *target_inbound_names;
586
587 /* Array of ssa names that are initialized with the default value if the
588 switch expression is out of range. */
589 tree *target_outbound_names;
590
591 /* The first load statement that loads a temporary from a new static array.
592 */
593 gimple arr_ref_first;
594
595 /* The last load statement that loads a temporary from a new static array. */
596 gimple arr_ref_last;
597
598 /* String reason why the case wasn't a good candidate that is written to the
599 dump file, if there is one. */
600 const char *reason;
601
602 /* Parameters for expand_switch_using_bit_tests. Should be computed
603 the same way as in expand_case. */
604 unsigned int uniq;
605 unsigned int count;
606 };
607
608 /* Collect information about GIMPLE_SWITCH statement SWTCH into INFO. */
609
610 static void
611 collect_switch_conv_info (gimple swtch, struct switch_conv_info *info)
612 {
613 unsigned int branch_num = gimple_switch_num_labels (swtch);
614 tree min_case, max_case;
615 unsigned int count, i;
616 edge e, e_default;
617 edge_iterator ei;
618
619 memset (info, 0, sizeof (*info));
620
621 /* The gimplifier has already sorted the cases by CASE_LOW and ensured there
622 is a default label which is the first in the vector.
623 Collect the bits we can deduce from the CFG. */
624 info->index_expr = gimple_switch_index (swtch);
625 info->switch_bb = gimple_bb (swtch);
626 info->default_bb =
627 label_to_block (CASE_LABEL (gimple_switch_default_label (swtch)));
628 e_default = find_edge (info->switch_bb, info->default_bb);
629 info->default_prob = e_default->probability;
630 info->default_count = e_default->count;
631 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
632 if (e != e_default)
633 info->other_count += e->count;
634
635 /* See if there is one common successor block for all branch
636 targets. If it exists, record it in FINAL_BB. */
637 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
638 {
639 if (! single_pred_p (e->dest))
640 {
641 info->final_bb = e->dest;
642 break;
643 }
644 }
645 if (info->final_bb)
646 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
647 {
648 if (e->dest == info->final_bb)
649 continue;
650
651 if (single_pred_p (e->dest)
652 && single_succ_p (e->dest)
653 && single_succ (e->dest) == info->final_bb)
654 continue;
655
656 info->final_bb = NULL;
657 break;
658 }
659
660 /* Get upper and lower bounds of case values, and the covered range. */
661 min_case = gimple_switch_label (swtch, 1);
662 max_case = gimple_switch_label (swtch, branch_num - 1);
663
664 info->range_min = CASE_LOW (min_case);
665 if (CASE_HIGH (max_case) != NULL_TREE)
666 info->range_max = CASE_HIGH (max_case);
667 else
668 info->range_max = CASE_LOW (max_case);
669
670 info->range_size =
671 int_const_binop (MINUS_EXPR, info->range_max, info->range_min);
672
673 /* Get a count of the number of case labels. Single-valued case labels
674 simply count as one, but a case range counts double, since it may
675 require two compares if it gets lowered as a branching tree. */
676 count = 0;
677 for (i = 1; i < branch_num; i++)
678 {
679 tree elt = gimple_switch_label (swtch, i);
680 count++;
681 if (CASE_HIGH (elt)
682 && ! tree_int_cst_equal (CASE_LOW (elt), CASE_HIGH (elt)))
683 count++;
684 }
685 info->count = count;
686
687 /* Get the number of unique non-default targets out of the GIMPLE_SWITCH
688 block. Assume a CFG cleanup would have already removed degenerate
689 switch statements, this allows us to just use EDGE_COUNT. */
690 info->uniq = EDGE_COUNT (gimple_bb (swtch)->succs) - 1;
691 }
692
693 /* Checks whether the range given by individual case statements of the SWTCH
694 switch statement isn't too big and whether the number of branches actually
695 satisfies the size of the new array. */
696
697 static bool
698 check_range (struct switch_conv_info *info)
699 {
700 gcc_assert (info->range_size);
701 if (!tree_fits_uhwi_p (info->range_size))
702 {
703 info->reason = "index range way too large or otherwise unusable";
704 return false;
705 }
706
707 if ((unsigned HOST_WIDE_INT) tree_to_uhwi (info->range_size)
708 > ((unsigned) info->count * SWITCH_CONVERSION_BRANCH_RATIO))
709 {
710 info->reason = "the maximum range-branch ratio exceeded";
711 return false;
712 }
713
714 return true;
715 }
716
717 /* Checks whether all but the FINAL_BB basic blocks are empty. */
718
719 static bool
720 check_all_empty_except_final (struct switch_conv_info *info)
721 {
722 edge e;
723 edge_iterator ei;
724
725 FOR_EACH_EDGE (e, ei, info->switch_bb->succs)
726 {
727 if (e->dest == info->final_bb)
728 continue;
729
730 if (!empty_block_p (e->dest))
731 {
732 info->reason = "bad case - a non-final BB not empty";
733 return false;
734 }
735 }
736
737 return true;
738 }
739
740 /* This function checks whether all required values in phi nodes in final_bb
741 are constants. Required values are those that correspond to a basic block
742 which is a part of the examined switch statement. It returns true if the
743 phi nodes are OK, otherwise false. */
744
745 static bool
746 check_final_bb (struct switch_conv_info *info)
747 {
748 gimple_stmt_iterator gsi;
749
750 info->phi_count = 0;
751 for (gsi = gsi_start_phis (info->final_bb); !gsi_end_p (gsi); gsi_next (&gsi))
752 {
753 gimple phi = gsi_stmt (gsi);
754 unsigned int i;
755
756 info->phi_count++;
757
758 for (i = 0; i < gimple_phi_num_args (phi); i++)
759 {
760 basic_block bb = gimple_phi_arg_edge (phi, i)->src;
761
762 if (bb == info->switch_bb
763 || (single_pred_p (bb) && single_pred (bb) == info->switch_bb))
764 {
765 tree reloc, val;
766
767 val = gimple_phi_arg_def (phi, i);
768 if (!is_gimple_ip_invariant (val))
769 {
770 info->reason = "non-invariant value from a case";
771 return false; /* Non-invariant argument. */
772 }
773 reloc = initializer_constant_valid_p (val, TREE_TYPE (val));
774 if ((flag_pic && reloc != null_pointer_node)
775 || (!flag_pic && reloc == NULL_TREE))
776 {
777 if (reloc)
778 info->reason
779 = "value from a case would need runtime relocations";
780 else
781 info->reason
782 = "value from a case is not a valid initializer";
783 return false;
784 }
785 }
786 }
787 }
788
789 return true;
790 }
791
792 /* The following function allocates default_values, target_{in,out}_names and
793 constructors arrays. The last one is also populated with pointers to
794 vectors that will become constructors of new arrays. */
795
796 static void
797 create_temp_arrays (struct switch_conv_info *info)
798 {
799 int i;
800
801 info->default_values = XCNEWVEC (tree, info->phi_count * 3);
802 /* ??? Macros do not support multi argument templates in their
803 argument list. We create a typedef to work around that problem. */
804 typedef vec<constructor_elt, va_gc> *vec_constructor_elt_gc;
805 info->constructors = XCNEWVEC (vec_constructor_elt_gc, info->phi_count);
806 info->target_inbound_names = info->default_values + info->phi_count;
807 info->target_outbound_names = info->target_inbound_names + info->phi_count;
808 for (i = 0; i < info->phi_count; i++)
809 vec_alloc (info->constructors[i], tree_to_uhwi (info->range_size) + 1);
810 }
811
812 /* Free the arrays created by create_temp_arrays(). The vectors that are
813 created by that function are not freed here, however, because they have
814 already become constructors and must be preserved. */
815
816 static void
817 free_temp_arrays (struct switch_conv_info *info)
818 {
819 XDELETEVEC (info->constructors);
820 XDELETEVEC (info->default_values);
821 }
822
823 /* Populate the array of default values in the order of phi nodes.
824 DEFAULT_CASE is the CASE_LABEL_EXPR for the default switch branch. */
825
826 static void
827 gather_default_values (tree default_case, struct switch_conv_info *info)
828 {
829 gimple_stmt_iterator gsi;
830 basic_block bb = label_to_block (CASE_LABEL (default_case));
831 edge e;
832 int i = 0;
833
834 gcc_assert (CASE_LOW (default_case) == NULL_TREE);
835
836 if (bb == info->final_bb)
837 e = find_edge (info->switch_bb, bb);
838 else
839 e = single_succ_edge (bb);
840
841 for (gsi = gsi_start_phis (info->final_bb); !gsi_end_p (gsi); gsi_next (&gsi))
842 {
843 gimple phi = gsi_stmt (gsi);
844 tree val = PHI_ARG_DEF_FROM_EDGE (phi, e);
845 gcc_assert (val);
846 info->default_values[i++] = val;
847 }
848 }
849
850 /* The following function populates the vectors in the constructors array with
851 future contents of the static arrays. The vectors are populated in the
852 order of phi nodes. SWTCH is the switch statement being converted. */
853
854 static void
855 build_constructors (gimple swtch, struct switch_conv_info *info)
856 {
857 unsigned i, branch_num = gimple_switch_num_labels (swtch);
858 tree pos = info->range_min;
859
860 for (i = 1; i < branch_num; i++)
861 {
862 tree cs = gimple_switch_label (swtch, i);
863 basic_block bb = label_to_block (CASE_LABEL (cs));
864 edge e;
865 tree high;
866 gimple_stmt_iterator gsi;
867 int j;
868
869 if (bb == info->final_bb)
870 e = find_edge (info->switch_bb, bb);
871 else
872 e = single_succ_edge (bb);
873 gcc_assert (e);
874
875 while (tree_int_cst_lt (pos, CASE_LOW (cs)))
876 {
877 int k;
878 for (k = 0; k < info->phi_count; k++)
879 {
880 constructor_elt elt;
881
882 elt.index = int_const_binop (MINUS_EXPR, pos, info->range_min);
883 elt.value
884 = unshare_expr_without_location (info->default_values[k]);
885 info->constructors[k]->quick_push (elt);
886 }
887
888 pos = int_const_binop (PLUS_EXPR, pos, build_int_cst (TREE_TYPE (pos), 1));
889 }
890 gcc_assert (tree_int_cst_equal (pos, CASE_LOW (cs)));
891
892 j = 0;
893 if (CASE_HIGH (cs))
894 high = CASE_HIGH (cs);
895 else
896 high = CASE_LOW (cs);
897 for (gsi = gsi_start_phis (info->final_bb);
898 !gsi_end_p (gsi); gsi_next (&gsi))
899 {
900 gimple phi = gsi_stmt (gsi);
901 tree val = PHI_ARG_DEF_FROM_EDGE (phi, e);
902 tree low = CASE_LOW (cs);
903 pos = CASE_LOW (cs);
904
905 do
906 {
907 constructor_elt elt;
908
909 elt.index = int_const_binop (MINUS_EXPR, pos, info->range_min);
910 elt.value = unshare_expr_without_location (val);
911 info->constructors[j]->quick_push (elt);
912
913 pos = int_const_binop (PLUS_EXPR, pos, build_int_cst (TREE_TYPE (pos), 1));
914 } while (!tree_int_cst_lt (high, pos)
915 && tree_int_cst_lt (low, pos));
916 j++;
917 }
918 }
919 }
920
921 /* If all values in the constructor vector are the same, return the value.
922 Otherwise return NULL_TREE. Not supposed to be called for empty
923 vectors. */
924
925 static tree
926 constructor_contains_same_values_p (vec<constructor_elt, va_gc> *vec)
927 {
928 unsigned int i;
929 tree prev = NULL_TREE;
930 constructor_elt *elt;
931
932 FOR_EACH_VEC_SAFE_ELT (vec, i, elt)
933 {
934 if (!prev)
935 prev = elt->value;
936 else if (!operand_equal_p (elt->value, prev, OEP_ONLY_CONST))
937 return NULL_TREE;
938 }
939 return prev;
940 }
941
942 /* Return type which should be used for array elements, either TYPE,
943 or for integral type some smaller integral type that can still hold
944 all the constants. */
945
946 static tree
947 array_value_type (gimple swtch, tree type, int num,
948 struct switch_conv_info *info)
949 {
950 unsigned int i, len = vec_safe_length (info->constructors[num]);
951 constructor_elt *elt;
952 enum machine_mode mode;
953 int sign = 0;
954 tree smaller_type;
955
956 if (!INTEGRAL_TYPE_P (type))
957 return type;
958
959 mode = GET_CLASS_NARROWEST_MODE (GET_MODE_CLASS (TYPE_MODE (type)));
960 if (GET_MODE_SIZE (TYPE_MODE (type)) <= GET_MODE_SIZE (mode))
961 return type;
962
963 if (len < (optimize_bb_for_size_p (gimple_bb (swtch)) ? 2 : 32))
964 return type;
965
966 FOR_EACH_VEC_SAFE_ELT (info->constructors[num], i, elt)
967 {
968 wide_int cst;
969
970 if (TREE_CODE (elt->value) != INTEGER_CST)
971 return type;
972
973 cst = elt->value;
974 while (1)
975 {
976 unsigned int prec = GET_MODE_BITSIZE (mode);
977 if (prec > HOST_BITS_PER_WIDE_INT)
978 return type;
979
980 if (sign >= 0 && cst == wi::zext (cst, prec))
981 {
982 if (sign == 0 && cst == wi::sext (cst, prec))
983 break;
984 sign = 1;
985 break;
986 }
987 if (sign <= 0 && cst == wi::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_SAFE_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, 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 tidx = make_ssa_name (utype, NULL);
1110 sub = fold_build2_loc (loc, MINUS_EXPR, utype,
1111 fold_convert_loc (loc, utype, info->index_expr),
1112 fold_convert_loc (loc, utype, info->range_min));
1113 sub = force_gimple_operand_gsi (&gsi, sub,
1114 false, NULL, true, GSI_SAME_STMT);
1115 stmt = gimple_build_assign (tidx, sub);
1116
1117 gsi_insert_before (&gsi, stmt, GSI_SAME_STMT);
1118 update_stmt (stmt);
1119 info->arr_ref_first = stmt;
1120
1121 for (gsi = gsi_start_phis (info->final_bb), i = 0;
1122 !gsi_end_p (gsi); gsi_next (&gsi), i++)
1123 build_one_array (swtch, i, arr_index_type, gsi_stmt (gsi), tidx, info);
1124 }
1125
1126 /* Generates and appropriately inserts loads of default values at the position
1127 given by BSI. Returns the last inserted statement. */
1128
1129 static gimple
1130 gen_def_assigns (gimple_stmt_iterator *gsi, struct switch_conv_info *info)
1131 {
1132 int i;
1133 gimple assign = NULL;
1134
1135 for (i = 0; i < info->phi_count; i++)
1136 {
1137 tree name = copy_ssa_name (info->target_inbound_names[i], NULL);
1138 info->target_outbound_names[i] = name;
1139 assign = gimple_build_assign (name, info->default_values[i]);
1140 gsi_insert_before (gsi, assign, GSI_SAME_STMT);
1141 update_stmt (assign);
1142 }
1143 return assign;
1144 }
1145
1146 /* Deletes the unused bbs and edges that now contain the switch statement and
1147 its empty branch bbs. BBD is the now dead BB containing the original switch
1148 statement, FINAL is the last BB of the converted switch statement (in terms
1149 of succession). */
1150
1151 static void
1152 prune_bbs (basic_block bbd, basic_block final)
1153 {
1154 edge_iterator ei;
1155 edge e;
1156
1157 for (ei = ei_start (bbd->succs); (e = ei_safe_edge (ei)); )
1158 {
1159 basic_block bb;
1160 bb = e->dest;
1161 remove_edge (e);
1162 if (bb != final)
1163 delete_basic_block (bb);
1164 }
1165 delete_basic_block (bbd);
1166 }
1167
1168 /* Add values to phi nodes in final_bb for the two new edges. E1F is the edge
1169 from the basic block loading values from an array and E2F from the basic
1170 block loading default values. BBF is the last switch basic block (see the
1171 bbf description in the comment below). */
1172
1173 static void
1174 fix_phi_nodes (edge e1f, edge e2f, basic_block bbf,
1175 struct switch_conv_info *info)
1176 {
1177 gimple_stmt_iterator gsi;
1178 int i;
1179
1180 for (gsi = gsi_start_phis (bbf), i = 0;
1181 !gsi_end_p (gsi); gsi_next (&gsi), i++)
1182 {
1183 gimple phi = gsi_stmt (gsi);
1184 add_phi_arg (phi, info->target_inbound_names[i], e1f, UNKNOWN_LOCATION);
1185 add_phi_arg (phi, info->target_outbound_names[i], e2f, UNKNOWN_LOCATION);
1186 }
1187 }
1188
1189 /* Creates a check whether the switch expression value actually falls into the
1190 range given by all the cases. If it does not, the temporaries are loaded
1191 with default values instead. SWTCH is the switch statement being converted.
1192
1193 bb0 is the bb with the switch statement, however, we'll end it with a
1194 condition instead.
1195
1196 bb1 is the bb to be used when the range check went ok. It is derived from
1197 the switch BB
1198
1199 bb2 is the bb taken when the expression evaluated outside of the range
1200 covered by the created arrays. It is populated by loads of default
1201 values.
1202
1203 bbF is a fall through for both bb1 and bb2 and contains exactly what
1204 originally followed the switch statement.
1205
1206 bbD contains the switch statement (in the end). It is unreachable but we
1207 still need to strip off its edges.
1208 */
1209
1210 static void
1211 gen_inbound_check (gimple swtch, struct switch_conv_info *info)
1212 {
1213 tree label_decl1 = create_artificial_label (UNKNOWN_LOCATION);
1214 tree label_decl2 = create_artificial_label (UNKNOWN_LOCATION);
1215 tree label_decl3 = create_artificial_label (UNKNOWN_LOCATION);
1216 gimple label1, label2, label3;
1217 tree utype, tidx;
1218 tree bound;
1219
1220 gimple cond_stmt;
1221
1222 gimple last_assign;
1223 gimple_stmt_iterator gsi;
1224 basic_block bb0, bb1, bb2, bbf, bbd;
1225 edge e01, e02, e21, e1d, e1f, e2f;
1226 location_t loc = gimple_location (swtch);
1227
1228 gcc_assert (info->default_values);
1229
1230 bb0 = gimple_bb (swtch);
1231
1232 tidx = gimple_assign_lhs (info->arr_ref_first);
1233 utype = TREE_TYPE (tidx);
1234
1235 /* (end of) block 0 */
1236 gsi = gsi_for_stmt (info->arr_ref_first);
1237 gsi_next (&gsi);
1238
1239 bound = fold_convert_loc (loc, utype, info->range_size);
1240 cond_stmt = gimple_build_cond (LE_EXPR, tidx, bound, NULL_TREE, NULL_TREE);
1241 gsi_insert_before (&gsi, cond_stmt, GSI_SAME_STMT);
1242 update_stmt (cond_stmt);
1243
1244 /* block 2 */
1245 label2 = gimple_build_label (label_decl2);
1246 gsi_insert_before (&gsi, label2, GSI_SAME_STMT);
1247 last_assign = gen_def_assigns (&gsi, info);
1248
1249 /* block 1 */
1250 label1 = gimple_build_label (label_decl1);
1251 gsi_insert_before (&gsi, label1, GSI_SAME_STMT);
1252
1253 /* block F */
1254 gsi = gsi_start_bb (info->final_bb);
1255 label3 = gimple_build_label (label_decl3);
1256 gsi_insert_before (&gsi, label3, GSI_SAME_STMT);
1257
1258 /* cfg fix */
1259 e02 = split_block (bb0, cond_stmt);
1260 bb2 = e02->dest;
1261
1262 e21 = split_block (bb2, last_assign);
1263 bb1 = e21->dest;
1264 remove_edge (e21);
1265
1266 e1d = split_block (bb1, info->arr_ref_last);
1267 bbd = e1d->dest;
1268 remove_edge (e1d);
1269
1270 /* flags and profiles of the edge for in-range values */
1271 e01 = make_edge (bb0, bb1, EDGE_TRUE_VALUE);
1272 e01->probability = REG_BR_PROB_BASE - info->default_prob;
1273 e01->count = info->other_count;
1274
1275 /* flags and profiles of the edge taking care of out-of-range values */
1276 e02->flags &= ~EDGE_FALLTHRU;
1277 e02->flags |= EDGE_FALSE_VALUE;
1278 e02->probability = info->default_prob;
1279 e02->count = info->default_count;
1280
1281 bbf = info->final_bb;
1282
1283 e1f = make_edge (bb1, bbf, EDGE_FALLTHRU);
1284 e1f->probability = REG_BR_PROB_BASE;
1285 e1f->count = info->other_count;
1286
1287 e2f = make_edge (bb2, bbf, EDGE_FALLTHRU);
1288 e2f->probability = REG_BR_PROB_BASE;
1289 e2f->count = info->default_count;
1290
1291 /* frequencies of the new BBs */
1292 bb1->frequency = EDGE_FREQUENCY (e01);
1293 bb2->frequency = EDGE_FREQUENCY (e02);
1294 bbf->frequency = EDGE_FREQUENCY (e1f) + EDGE_FREQUENCY (e2f);
1295
1296 /* Tidy blocks that have become unreachable. */
1297 prune_bbs (bbd, info->final_bb);
1298
1299 /* Fixup the PHI nodes in bbF. */
1300 fix_phi_nodes (e1f, e2f, bbf, info);
1301
1302 /* Fix the dominator tree, if it is available. */
1303 if (dom_info_available_p (CDI_DOMINATORS))
1304 {
1305 vec<basic_block> bbs_to_fix_dom;
1306
1307 set_immediate_dominator (CDI_DOMINATORS, bb1, bb0);
1308 set_immediate_dominator (CDI_DOMINATORS, bb2, bb0);
1309 if (! get_immediate_dominator (CDI_DOMINATORS, bbf))
1310 /* If bbD was the immediate dominator ... */
1311 set_immediate_dominator (CDI_DOMINATORS, bbf, bb0);
1312
1313 bbs_to_fix_dom.create (4);
1314 bbs_to_fix_dom.quick_push (bb0);
1315 bbs_to_fix_dom.quick_push (bb1);
1316 bbs_to_fix_dom.quick_push (bb2);
1317 bbs_to_fix_dom.quick_push (bbf);
1318
1319 iterate_fix_dominators (CDI_DOMINATORS, bbs_to_fix_dom, true);
1320 bbs_to_fix_dom.release ();
1321 }
1322 }
1323
1324 /* The following function is invoked on every switch statement (the current one
1325 is given in SWTCH) and runs the individual phases of switch conversion on it
1326 one after another until one fails or the conversion is completed.
1327 Returns NULL on success, or a pointer to a string with the reason why the
1328 conversion failed. */
1329
1330 static const char *
1331 process_switch (gimple swtch)
1332 {
1333 struct switch_conv_info info;
1334
1335 /* Group case labels so that we get the right results from the heuristics
1336 that decide on the code generation approach for this switch. */
1337 group_case_labels_stmt (swtch);
1338
1339 /* If this switch is now a degenerate case with only a default label,
1340 there is nothing left for us to do. */
1341 if (gimple_switch_num_labels (swtch) < 2)
1342 return "switch is a degenerate case";
1343
1344 collect_switch_conv_info (swtch, &info);
1345
1346 /* No error markers should reach here (they should be filtered out
1347 during gimplification). */
1348 gcc_checking_assert (TREE_TYPE (info.index_expr) != error_mark_node);
1349
1350 /* A switch on a constant should have been optimized in tree-cfg-cleanup. */
1351 gcc_checking_assert (! TREE_CONSTANT (info.index_expr));
1352
1353 if (info.uniq <= MAX_CASE_BIT_TESTS)
1354 {
1355 if (expand_switch_using_bit_tests_p (info.range_size,
1356 info.uniq, info.count))
1357 {
1358 if (dump_file)
1359 fputs (" expanding as bit test is preferable\n", dump_file);
1360 emit_case_bit_tests (swtch, info.index_expr,
1361 info.range_min, info.range_size);
1362 if (current_loops)
1363 loops_state_set (LOOPS_NEED_FIXUP);
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_default_label (swtch), &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 namespace {
1474
1475 const pass_data pass_data_convert_switch =
1476 {
1477 GIMPLE_PASS, /* type */
1478 "switchconv", /* name */
1479 OPTGROUP_NONE, /* optinfo_flags */
1480 true, /* has_gate */
1481 true, /* has_execute */
1482 TV_TREE_SWITCH_CONVERSION, /* tv_id */
1483 ( PROP_cfg | PROP_ssa ), /* properties_required */
1484 0, /* properties_provided */
1485 0, /* properties_destroyed */
1486 0, /* todo_flags_start */
1487 ( TODO_update_ssa | TODO_verify_ssa
1488 | TODO_verify_stmts
1489 | TODO_verify_flow ), /* todo_flags_finish */
1490 };
1491
1492 class pass_convert_switch : public gimple_opt_pass
1493 {
1494 public:
1495 pass_convert_switch (gcc::context *ctxt)
1496 : gimple_opt_pass (pass_data_convert_switch, ctxt)
1497 {}
1498
1499 /* opt_pass methods: */
1500 bool gate () { return switchconv_gate (); }
1501 unsigned int execute () { return do_switchconv (); }
1502
1503 }; // class pass_convert_switch
1504
1505 } // anon namespace
1506
1507 gimple_opt_pass *
1508 make_pass_convert_switch (gcc::context *ctxt)
1509 {
1510 return new pass_convert_switch (ctxt);
1511 }