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