nsz Git - libfirm/blob - ir/lower/lower_switch.c

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   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.
  10  *
  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.
  14  *
  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
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief   Lowering of Switches if necessary or advantageous.
  23  * @author  Moritz Kroll
  24  * @version $Id$
  25  */
  26
  27 #include "config.h"
  28
  29 #include <limits.h>
  30
  31 #include "array_t.h"
  32 #include "ircons.h"
  33 #include "irgopt.h"
  34 #include "irgwalk.h"
  35 #include "irnode_t.h"
  36 #include "irouts.h"
  37 #include "irpass_t.h"
  38
  39 #define foreach_out_irn(irn, i, outirn) for (i = get_irn_n_outs(irn) - 1;\
  40         i >= 0 && (outirn = get_irn_out(irn, i)); --i)
  41
  42 typedef struct walk_env {
  43         unsigned         spare_size;        /**< the allowed spare size for table switches */
  44         int              changed;           /**< indicates whether a change was performed */
  45 } walk_env_t;
  46
  47 typedef struct case_data {
  48         long     value;
  49         ir_node *target;
  50 } case_data_t;
  51
  52 typedef struct ifcas_env {
  53         ir_node  *sel;
  54         int       defindex;
  55         ir_node **defusers;                 /**< the Projs pointing to the default case */
  56 } ifcas_env_t;
  57
  58 /**
  59  * Evaluate a switch and decide whether we should build a table switch.
  60  *
  61  * @param cond       The Cond node representing the switch.
  62  * @param spare_size Allowed spare size for table switches in machine words.
  63  *                   (Default in edgfe: 128)
  64  */
  65 static int should_do_table_switch(ir_node *cond, unsigned spare_size)
  66 {
  67         long     default_pn;
  68         int      i;
  69         ir_node *proj;
  70         long switch_min = LONG_MAX, switch_max = LONG_MIN;
  71         unsigned long spare, num_cases = 0;
  72
  73         /* TODO: Minimum size for jump table? */
  74         if (get_irn_n_outs(cond) <= 4)
  75                 return 0;
  76
  77         default_pn = get_Cond_default_proj(cond);
  78
  79         foreach_out_irn(cond, i, proj) {
  80                 long pn = get_Proj_proj(proj);
  81                 if (pn == default_pn)
  82                         continue;
  83
  84                 if (pn < switch_min)
  85                         switch_min = pn;
  86                 if (pn > switch_max)
  87                         switch_max = pn;
  88                 ++num_cases;
  89         }
  90
  91         /*
  92          * Here we have: num_cases and [switch_min, switch_max] interval.
  93          * We do an if-cascade if there are too many spare numbers.
  94          */
  95         spare = (unsigned long) switch_max - (unsigned long) switch_min - num_cases + 1;
  96         return spare < spare_size;
  97 }
  98
  99 static int casecmp(const void *a, const void *b)
 100 {
 101         const case_data_t *cda = a;
 102         const case_data_t *cdb = b;
 103
 104         /*
 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.
 108          */
 109         return ((unsigned long)cda->value > (unsigned long)cdb->value) -
 110                ((unsigned long)cda->value < (unsigned long)cdb->value);
 111 }
 112
 113 /**
 114  * Creates an if cascade realizing binary search.
 115  */
 116 static void create_if_cascade(ifcas_env_t *env, ir_node *curblock,
 117                               case_data_t *curcases, int numcases)
 118 {
 119     ir_mode *cmp_mode;
 120     ir_node *cmp_sel;
 121     ir_node *sel_block;
 122
 123     /* Get the mode and sel node for the comparison. */
 124     cmp_mode  = get_irn_mode(env->sel);
 125     cmp_sel   = env->sel;
 126     sel_block = get_nodes_block(cmp_sel);
 127
 128     /*
 129      * Make sure that an unsigned comparison is used, by converting the sel
 130      * node to an unsigned mode and using that mode for the constants, too.
 131      * This is important, because the qsort applied to the case labels uses
 132      * an unsigned comparison and both comparison methods have to match.
 133      */
 134     if (mode_is_signed(cmp_mode))
 135     {
 136         cmp_mode = find_unsigned_mode(cmp_mode);
 137         cmp_sel  = new_r_Conv(sel_block, cmp_sel, cmp_mode);
 138     }
 139
 140         assert(numcases >= 0);
 141
 142         set_cur_block(curblock);
 143
 144         if (numcases == 0) {
 145                 /* zero cases: "goto default;" */
 146                 env->defusers[env->defindex++] = new_Jmp();
 147         } else if (numcases == 1) {
 148                 /* only one case: "if (sel == val) goto target else goto default;" */
 149                 ir_node *val  = new_Const_long(cmp_mode, curcases[0].value);
 150                 ir_node *cmp  = new_Cmp(cmp_sel, val);
 151                 ir_node *proj = new_Proj(cmp, mode_b, pn_Cmp_Eq);
 152                 ir_node *cond = new_Cond(proj);
 153                 set_Block_cfgpred(curcases[0].target, 0, new_Proj(cond, mode_X, pn_Cond_true));
 154                 env->defusers[env->defindex++] = new_Proj(cond, mode_X, pn_Cond_false);
 155         } else if (numcases == 2) {
 156                 /* only two cases: "if (sel == val[0]) goto target[0];" */
 157                 ir_node *val  = new_Const_long(cmp_mode, curcases[0].value);
 158                 ir_node *cmp  = new_Cmp(cmp_sel, val);
 159                 ir_node *proj = new_Proj(cmp, mode_b, pn_Cmp_Eq);
 160                 ir_node *cond = new_Cond(proj);
 161                 ir_node *in[1];
 162                 ir_node *neblock;
 163
 164                 set_Block_cfgpred(curcases[0].target, 0, new_Proj(cond, mode_X, pn_Cond_true));
 165                 in[0] = new_Proj(cond, mode_X, pn_Cond_false);
 166                 neblock = new_Block(1, in);
 167                 set_cur_block(neblock);
 168
 169                 /* second part: "else if (sel == val[1]) goto target[1] else goto default;" */
 170                 val  = new_Const_long(cmp_mode, curcases[1].value);
 171                 cmp  = new_Cmp(cmp_sel, val);
 172                 proj = new_Proj(cmp, mode_b, pn_Cmp_Eq);
 173                 cond = new_Cond(proj);
 174                 set_Block_cfgpred(curcases[1].target, 0, new_Proj(cond, mode_X, pn_Cond_true));
 175                 env->defusers[env->defindex++] = new_Proj(cond, mode_X, pn_Cond_false);
 176         } else {
 177                 /* recursive case: split cases in the middle */
 178                 int midcase = numcases / 2;
 179                 ir_node *val  = new_Const_long(cmp_mode, curcases[midcase].value);
 180                 ir_node *cmp  = new_Cmp(cmp_sel, val);
 181                 ir_node *proj = new_Proj(cmp, mode_b, pn_Cmp_Lt);
 182                 ir_node *cond = new_Cond(proj);
 183                 ir_node *in[1];
 184                 ir_node *ltblock;
 185                 ir_node *geblock;
 186
 187                 in[0] = new_Proj(cond, mode_X, pn_Cond_true);
 188                 ltblock = new_Block(1, in);
 189
 190                 set_cur_block(curblock);
 191                 in[0] = new_Proj(cond, mode_X, pn_Cond_false);
 192                 geblock = new_Block(1, in);
 193                 set_cur_block(geblock);
 194
 195                 create_if_cascade(env, ltblock, curcases, midcase);
 196                 create_if_cascade(env, geblock, curcases + midcase, numcases - midcase);
 197         }
 198 }
 199
 200 /**
 201  * Block-Walker: searches for Cond nodes with a non-boolean mode
 202  */
 203 static void find_cond_nodes(ir_node *block, void *ctx)
 204 {
 205         walk_env_t  *env = ctx;
 206         ir_node     *projx;
 207         ir_node     *cond;
 208         ir_node     *sel;
 209         ir_mode     *sel_mode;
 210         long         default_pn;
 211         int          i, j = 0, numcases;
 212         ir_node     *proj;
 213         case_data_t *cases;
 214         ir_node     *condblock;
 215         ir_node     *defblock = NULL;
 216         ifcas_env_t  ifcas_env;
 217
 218         if (get_Block_n_cfgpreds(block) != 1)
 219                 return;
 220
 221         projx = get_Block_cfgpred(block, 0);
 222         if (!is_Proj(projx))
 223                 return;
 224         assert(get_irn_mode(projx) == mode_X);
 225
 226         cond = get_Proj_pred(projx);
 227         if (!is_Cond(cond))
 228                 return;
 229
 230         sel      = get_Cond_selector(cond);
 231         sel_mode = get_irn_mode(sel);
 232
 233         if (sel_mode == mode_b)    /* not a switch? */
 234                 return;
 235
 236         if (should_do_table_switch(cond, env->spare_size))
 237                 return;
 238
 239         /*
 240          * Switch should be transformed into an if cascade.
 241          * So first order the cases, so we can do a binary search on them.
 242          */
 243         env->changed = 1;
 244
 245         numcases = get_irn_n_outs(cond) - 1;      // does not contain default case
 246         NEW_ARR_A(case_data_t, cases, numcases);
 247
 248         default_pn = get_Cond_default_proj(cond);
 249         ifcas_env.sel = sel;
 250         ifcas_env.defindex = 0;
 251         NEW_ARR_A(ir_node*, ifcas_env.defusers, numcases);
 252
 253         foreach_out_irn(cond, i, proj) {
 254                 long pn = get_Proj_proj(proj);
 255                 ir_node *target = get_irn_out(proj, 0);
 256                 assert(get_Block_n_cfgpreds(target) == 1 && "Encountered critical edge in switch");
 257
 258                 if (pn == default_pn) {
 259                         defblock = target;
 260                         continue;
 261                 }
 262
 263                 cases[j].value  = pn;
 264                 cases[j].target = target;
 265                 j++;
 266         }
 267
 268         assert(defblock != NULL && "Switch without default proj");
 269         qsort(cases, numcases, sizeof(*cases), casecmp);
 270
 271         /* Now create the if cascade */
 272         condblock = get_nodes_block(cond);
 273         create_if_cascade(&ifcas_env, condblock, cases, numcases);
 274
 275         /* Connect new default case users */
 276         set_irn_in(defblock, ifcas_env.defindex, ifcas_env.defusers);
 277 }
 278
 279 /**
 280  * Lowers all Switches (Cond nodes with non-boolean mode) depending on spare_size.
 281  * They will either remain the same or be converted into if-cascades.
 282  *
 283  * @param irg        The ir graph to be lowered.
 284  * @param spare_size Allowed spare size for table switches in machine words.
 285  *                   (Default in edgfe: 128)
 286  */
 287 void lower_switch(ir_graph *irg, unsigned spare_size)
 288 {
 289         walk_env_t env;
 290         ir_graph *rem = current_ir_graph;
 291
 292         current_ir_graph = irg;
 293
 294         env.changed    = 0;
 295         env.spare_size = spare_size;
 296
 297         remove_critical_cf_edges(irg);
 298         assure_irg_outs(irg);
 299
 300         irg_block_walk_graph(irg, find_cond_nodes, NULL, &env);
 301
 302         if (env.changed) {
 303                 /* control flow changed */
 304                 set_irg_outs_inconsistent(irg);
 305                 set_irg_doms_inconsistent(irg);
 306                 set_irg_extblk_inconsistent(irg);
 307                 set_irg_loopinfo_inconsistent(irg);
 308         }
 309         current_ir_graph = rem;
 310 }
 311
 312 struct pass_t {
 313         ir_graph_pass_t pass;
 314         unsigned        spare_size;
 315 };
 316
 317 /**
 318  * Wrapper for running lower_switch() as a pass.
 319  */
 320 static int pass_wrapper(ir_graph *irg, void *context)
 321 {
 322         struct pass_t *pass = context;
 323
 324         lower_switch(irg, pass->spare_size);
 325         return 0;
 326 }
 327
 328 /* creates a pass for lower_switch */
 329 ir_graph_pass_t *lower_switch_pass(const char *name, unsigned spare_size)
 330 {
 331         struct pass_t *pass = XMALLOCZ(struct pass_t);
 332
 333         pass->spare_size = spare_size;
 334         return def_graph_pass_constructor(
 335                 &pass->pass, name ? name : "lower_switch", pass_wrapper);
 336 }