2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Lowering of Switches if necessary or advantageous.
23 * @author Moritz Kroll
40 #include "irnodeset.h"
42 #define foreach_out_irn(irn, i, outirn) for (i = get_irn_n_outs(irn) - 1;\
43 i >= 0 && (outirn = get_irn_out(irn, i)); --i)
45 typedef struct walk_env_t {
46 unsigned spare_size; /**< the allowed spare size for table switches */
47 bool allow_out_of_bounds;
48 bool changed; /**< indicates whether a change was performed */
49 ir_nodeset_t processed;
52 typedef struct case_data_t {
57 typedef struct cond_env_t {
61 ir_node *default_block;
63 ir_node **defusers; /**< the Projs pointing to the default case */
66 static void analyse_switch(cond_env_t *env, ir_node *cond)
68 long default_pn = get_Cond_default_proj(cond);
69 long switch_min = LONG_MAX;
70 long switch_max = LONG_MIN;
71 ir_node *default_block = NULL;
72 unsigned num_cases = 0;
76 foreach_out_irn(cond, i, proj) {
77 long pn = get_Proj_proj(proj);
78 if (pn == default_pn) {
79 ir_node *target = get_irn_out(proj, 0);
80 assert(default_block == NULL || default_block == target);
81 default_block = target;
91 assert(default_block != NULL);
93 env->switch_min = switch_min;
94 env->switch_max = switch_max;
95 env->num_cases = num_cases;
96 env->default_block = default_block;
99 static int casecmp(const void *a, const void *b)
101 const case_data_t *cda = (const case_data_t*)a;
102 const case_data_t *cdb = (const case_data_t*)b;
105 * Enforce unsigned sorting. Signed comparison will behave differently for
106 * 32-bit values, depending on sizeof(long). This will make the resulting
107 * array deterministic.
109 return ((unsigned long)cda->value > (unsigned long)cdb->value) -
110 ((unsigned long)cda->value < (unsigned long)cdb->value);
114 * Creates an if cascade realizing binary search.
116 static void create_if_cascade(cond_env_t *env, dbg_info *dbgi, ir_node *block,
117 case_data_t *curcases, unsigned numcases)
119 ir_graph *irg = get_irn_irg(block);
124 /* Get the mode and sel node for the comparison. */
125 cmp_mode = get_irn_mode(env->sel);
127 sel_block = get_nodes_block(cmp_sel);
130 * Make sure that an unsigned comparison is used, by converting the sel
131 * node to an unsigned mode and using that mode for the constants, too.
132 * This is important, because the qsort applied to the case labels uses
133 * an unsigned comparison and both comparison methods have to match.
135 if (mode_is_signed(cmp_mode)) {
136 cmp_mode = find_unsigned_mode(cmp_mode);
137 cmp_sel = new_r_Conv(sel_block, cmp_sel, cmp_mode);
141 /* zero cases: "goto default;" */
142 ARR_APP1(ir_node*, env->defusers, new_r_Jmp(block));
143 } else if (numcases == 1) {
144 /* only one case: "if (sel == val) goto target else goto default;" */
145 ir_node *val = new_r_Const_long(irg, cmp_mode, curcases[0].value);
146 ir_node *cmp = new_rd_Cmp(dbgi, block, cmp_sel, val,
148 ir_node *cond = new_rd_Cond(dbgi, block, cmp);
149 ir_node *trueproj = new_r_Proj(cond, mode_X, pn_Cond_true);
150 ir_node *falseproj = new_r_Proj(cond, mode_X, pn_Cond_false);
152 set_Block_cfgpred(curcases[0].target, 0, trueproj);
153 ARR_APP1(ir_node*, env->defusers, falseproj);
154 } else if (numcases == 2) {
155 /* only two cases: "if (sel == val[0]) goto target[0];" */
156 ir_node *val = new_r_Const_long(irg, cmp_mode, curcases[0].value);
157 ir_node *cmp = new_rd_Cmp(dbgi, block, cmp_sel, val,
159 ir_node *cond = new_rd_Cond(dbgi, block, cmp);
160 ir_node *trueproj = new_r_Proj(cond, mode_X, pn_Cond_true);
161 ir_node *falseproj = new_r_Proj(cond, mode_X, pn_Cond_false);
165 set_Block_cfgpred(curcases[0].target, 0, trueproj);
168 neblock = new_r_Block(irg, 1, in);
170 /* second part: "else if (sel == val[1]) goto target[1] else goto default;" */
171 val = new_r_Const_long(irg, cmp_mode, curcases[1].value);
172 cmp = new_rd_Cmp(dbgi, neblock, cmp_sel, val, ir_relation_equal);
173 cond = new_rd_Cond(dbgi, neblock, cmp);
174 trueproj = new_r_Proj(cond, mode_X, pn_Cond_true);
175 falseproj = new_r_Proj(cond, mode_X, pn_Cond_false);
176 set_Block_cfgpred(curcases[1].target, 0, trueproj);
177 ARR_APP1(ir_node*, env->defusers, falseproj);
179 /* recursive case: split cases in the middle */
180 int midcase = numcases / 2;
181 ir_node *val = new_r_Const_long(irg, cmp_mode,
182 curcases[midcase].value);
183 ir_node *cmp = new_rd_Cmp(dbgi, block, cmp_sel, val, ir_relation_less);
184 ir_node *cond = new_rd_Cond(dbgi, block, cmp);
189 in[0] = new_r_Proj(cond, mode_X, pn_Cond_true);
190 ltblock = new_r_Block(irg, 1, in);
192 in[0] = new_r_Proj(cond, mode_X, pn_Cond_false);
193 geblock = new_r_Block(irg, 1, in);
195 create_if_cascade(env, dbgi, ltblock, curcases, midcase);
196 create_if_cascade(env, dbgi, geblock, curcases + midcase,
201 static void create_out_of_bounds_check(cond_env_t *env, ir_node *cond)
203 ir_graph *irg = get_irn_irg(cond);
204 dbg_info *dbgi = get_irn_dbg_info(cond);
205 ir_node *sel = get_Cond_selector(cond);
206 ir_node *block = get_nodes_block(cond);
207 ir_mode *cmp_mode = get_irn_mode(sel);
208 ir_node **default_preds = NEW_ARR_F(ir_node*, 0);
209 unsigned long default_pn = get_Cond_default_proj(cond);
218 size_t n_default_preds;
222 if (mode_is_signed(cmp_mode)) {
223 cmp_mode = find_unsigned_mode(cmp_mode);
224 sel = new_r_Conv(block, sel, cmp_mode);
227 /* normalize so switch_min is at 0 */
228 if (env->switch_min != 0) {
229 ir_node *min_const = new_r_Const_long(irg, cmp_mode, env->switch_min);
230 sel = new_rd_Sub(dbgi, block, sel, min_const, cmp_mode);
232 delta = env->switch_min;
234 env->switch_max -= delta;
235 set_Cond_selector(cond, sel);
238 /* check for out-of-bounds */
239 max_const = new_r_Const_long(irg, cmp_mode, env->switch_max);
240 cmp = new_rd_Cmp(dbgi, block, sel, max_const, ir_relation_less);
241 oob_cond = new_rd_Cond(dbgi, block, cmp);
242 proj_true = new_r_Proj(oob_cond, mode_X, pn_Cond_true);
243 proj_false = new_r_Proj(oob_cond, mode_X, pn_Cond_false);
245 ARR_APP1(ir_node*, default_preds, proj_false);
247 /* create new block containing the cond */
249 new_block = new_r_Block(irg, 1, in);
250 set_nodes_block(cond, new_block);
253 foreach_out_irn(cond, i, proj) {
254 unsigned long pn = get_Proj_proj(proj);
255 unsigned long new_pn = pn - delta;
256 if (pn == default_pn) {
257 /* we might have to choose a new default_pn */
258 if (pn < (unsigned long) env->switch_max) {
259 new_pn = env->switch_max + 1;
260 set_Cond_default_proj(cond, new_pn);
264 ARR_APP1(ir_node*, default_preds, proj);
267 set_Proj_proj(proj, new_pn);
268 set_nodes_block(proj, new_block);
271 /* adapt default block */
272 n_default_preds = ARR_LEN(default_preds);
273 if (n_default_preds > 1) {
276 /* create new intermediate blocks so we don't have critical edges */
277 for (i = 0; i < n_default_preds; ++i) {
278 ir_node *proj = default_preds[i];
283 block = new_r_Block(irg, 1, in);
285 default_preds[i] = new_r_Jmp(block);
288 set_irn_in(env->default_block, n_default_preds, default_preds);
290 DEL_ARR_F(default_preds);
294 * Block-Walker: searches for Cond nodes with a non-boolean mode
296 static void find_cond_nodes(ir_node *block, void *ctx)
298 walk_env_t *env = (walk_env_t *)ctx;
310 ir_node *defblock = NULL;
315 /* because we split critical blocks only blocks with 1 predecessors may
316 * contain Proj->Cond nodes */
317 if (get_Block_n_cfgpreds(block) != 1)
320 projx = get_Block_cfgpred(block, 0);
323 assert(get_irn_mode(projx) == mode_X);
325 cond = get_Proj_pred(projx);
329 sel = get_Cond_selector(cond);
330 sel_mode = get_irn_mode(sel);
332 if (sel_mode == mode_b)
335 if (ir_nodeset_contains(&env->processed, cond))
337 ir_nodeset_insert(&env->processed, cond);
339 /* the algorithms here don't work reliable for modes bigger than 32
340 * since we operate with long numbers */
341 assert(get_mode_size_bits(sel_mode) <= 32);
343 analyse_switch(&cond_env, cond);
346 * Here we have: num_cases and [switch_min, switch_max] interval.
347 * We do an if-cascade if there are too many spare numbers.
349 spare = (unsigned long) cond_env.switch_max
350 - (unsigned long) cond_env.switch_min
351 - (unsigned long) cond_env.num_cases + 1;
352 if (spare < env->spare_size) {
353 /* we won't decompose the switch. But we might have to add
354 * out-of-bounds checking */
355 if (!env->allow_out_of_bounds) {
356 create_out_of_bounds_check(&cond_env, cond);
363 * Switch should be transformed into an if cascade.
364 * So first order the cases, so we can do a binary search on them.
368 numcases = get_irn_n_outs(cond) - 1; /* does not contain default case */
369 cases = XMALLOCN(case_data_t, numcases);
371 default_pn = get_Cond_default_proj(cond);
373 cond_env.defusers = NEW_ARR_F(ir_node*, 0);
375 foreach_out_irn(cond, i, proj) {
376 long pn = get_Proj_proj(proj);
377 ir_node *target = get_irn_out(proj, 0);
378 assert(get_Block_n_cfgpreds(target) == 1);
380 if (pn == default_pn) {
386 cases[j].target = target;
389 assert(j == numcases);
391 if (defblock == NULL)
392 panic("Switch %+F has no default proj", cond);
394 qsort(cases, numcases, sizeof(cases[0]), casecmp);
396 /* Now create the if cascade */
397 condblock = get_nodes_block(cond);
398 dbgi = get_irn_dbg_info(cond);
399 create_if_cascade(&cond_env, dbgi, condblock, cases, numcases);
401 /* Connect new default case users */
402 set_irn_in(defblock, ARR_LEN(cond_env.defusers), cond_env.defusers);
405 DEL_ARR_F(cond_env.defusers);
408 void lower_switch(ir_graph *irg, unsigned spare_size, int allow_out_of_bounds)
412 env.spare_size = spare_size;
413 env.allow_out_of_bounds = allow_out_of_bounds;
414 ir_nodeset_init(&env.processed);
416 remove_critical_cf_edges(irg);
417 assure_irg_outs(irg);
419 irg_block_walk_graph(irg, find_cond_nodes, NULL, &env);
420 ir_nodeset_destroy(&env.processed);
423 /* control flow changed */
424 set_irg_outs_inconsistent(irg);
425 set_irg_doms_inconsistent(irg);
426 set_irg_extblk_inconsistent(irg);
427 set_irg_loopinfo_inconsistent(irg);