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

   1 /*
   2  * Copyright (C) 1995-2011 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 #include "config.h"
  27
  28 #include <limits.h>
  29 #include <stdbool.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 #include "lowering.h"
  39 #include "error.h"
  40 #include "irnodeset.h"
  41
  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)
  44
  45 typedef struct walk_env_t {
  46         unsigned      spare_size; /**< the allowed spare size for table switches */
  47         unsigned      small_switch;
  48         bool          allow_out_of_bounds;
  49         bool          changed;    /**< indicates whether a change was performed */
  50         ir_nodeset_t  processed;
  51 } walk_env_t;
  52
  53 typedef struct case_data_t {
  54         long     value;
  55         ir_node *target;
  56 } case_data_t;
  57
  58 typedef struct cond_env_t {
  59         ir_node  *sel;
  60         long      switch_min;
  61         long      switch_max;
  62         ir_node  *default_block;
  63         unsigned  num_cases;
  64         ir_node **defusers;           /**< the Projs pointing to the default case */
  65 } cond_env_t;
  66
  67 static void analyse_switch(cond_env_t *env, ir_node *cond)
  68 {
  69         long     default_pn    = get_Cond_default_proj(cond);
  70         long     switch_min    = LONG_MAX;
  71         long     switch_max    = LONG_MIN;
  72         ir_node *default_block = NULL;
  73         unsigned num_cases     = 0;
  74         int      i;
  75         ir_node *proj;
  76
  77         foreach_out_irn(cond, i, proj) {
  78                 long pn = get_Proj_proj(proj);
  79                 if (pn == default_pn) {
  80                         ir_node *target = get_irn_out(proj, 0);
  81                         assert(default_block == NULL || default_block == target);
  82                         default_block = target;
  83                         continue;
  84                 }
  85
  86                 if (pn < switch_min)
  87                         switch_min = pn;
  88                 if (pn > switch_max)
  89                         switch_max = pn;
  90                 ++num_cases;
  91         }
  92         assert(default_block != NULL);
  93
  94         env->switch_min    = switch_min;
  95         env->switch_max    = switch_max;
  96         env->num_cases     = num_cases;
  97         env->default_block = default_block;
  98 }
  99
 100 static int casecmp(const void *a, const void *b)
 101 {
 102         const case_data_t *cda = (const case_data_t*)a;
 103         const case_data_t *cdb = (const case_data_t*)b;
 104
 105         /*
 106          * Enforce unsigned sorting. Signed comparison will behave differently for
 107          * 32-bit values, depending on sizeof(long). This will make the resulting
 108          * array deterministic.
 109          */
 110         return ((unsigned long)cda->value > (unsigned long)cdb->value) -
 111                ((unsigned long)cda->value < (unsigned long)cdb->value);
 112 }
 113
 114 /**
 115  * Creates an if cascade realizing binary search.
 116  */
 117 static void create_if_cascade(cond_env_t *env, dbg_info *dbgi, ir_node *block,
 118                               case_data_t *curcases, unsigned numcases)
 119 {
 120         ir_graph *irg = get_irn_irg(block);
 121     ir_mode  *cmp_mode;
 122     ir_node  *cmp_sel;
 123     ir_node  *sel_block;
 124
 125     /* Get the mode and sel node for the comparison. */
 126     cmp_mode  = get_irn_mode(env->sel);
 127     cmp_sel   = env->sel;
 128     sel_block = get_nodes_block(cmp_sel);
 129
 130     /*
 131      * Make sure that an unsigned comparison is used, by converting the sel
 132      * node to an unsigned mode and using that mode for the constants, too.
 133      * This is important, because the qsort applied to the case labels uses
 134      * an unsigned comparison and both comparison methods have to match.
 135      */
 136     if (mode_is_signed(cmp_mode)) {
 137         cmp_mode = find_unsigned_mode(cmp_mode);
 138         cmp_sel  = new_r_Conv(sel_block, cmp_sel, cmp_mode);
 139     }
 140
 141         if (numcases == 0) {
 142                 /* zero cases: "goto default;" */
 143                 ARR_APP1(ir_node*, env->defusers, new_r_Jmp(block));
 144         } else if (numcases == 1) {
 145                 /* only one case: "if (sel == val) goto target else goto default;" */
 146                 ir_node *val       = new_r_Const_long(irg, cmp_mode, curcases[0].value);
 147                 ir_node *cmp       = new_rd_Cmp(dbgi, block, cmp_sel, val,
 148                                                 ir_relation_equal);
 149                 ir_node *cond      = new_rd_Cond(dbgi, block, cmp);
 150                 ir_node *trueproj  = new_r_Proj(cond, mode_X, pn_Cond_true);
 151                 ir_node *falseproj = new_r_Proj(cond, mode_X, pn_Cond_false);
 152
 153                 set_Block_cfgpred(curcases[0].target, 0, trueproj);
 154                 ARR_APP1(ir_node*, env->defusers, falseproj);
 155         } else if (numcases == 2) {
 156                 /* only two cases: "if (sel == val[0]) goto target[0];" */
 157                 ir_node *val       = new_r_Const_long(irg, cmp_mode, curcases[0].value);
 158                 ir_node *cmp       = new_rd_Cmp(dbgi, block, cmp_sel, val,
 159                                                 ir_relation_equal);
 160                 ir_node *cond      = new_rd_Cond(dbgi, block, cmp);
 161                 ir_node *trueproj  = new_r_Proj(cond, mode_X, pn_Cond_true);
 162                 ir_node *falseproj = new_r_Proj(cond, mode_X, pn_Cond_false);
 163                 ir_node *in[1];
 164                 ir_node *neblock;
 165
 166                 set_Block_cfgpred(curcases[0].target, 0, trueproj);
 167
 168                 in[0] = falseproj;
 169                 neblock = new_r_Block(irg, 1, in);
 170
 171                 /* second part: "else if (sel == val[1]) goto target[1] else goto default;" */
 172                 val       = new_r_Const_long(irg, cmp_mode, curcases[1].value);
 173                 cmp       = new_rd_Cmp(dbgi, neblock, cmp_sel, val, ir_relation_equal);
 174                 cond      = new_rd_Cond(dbgi, neblock, cmp);
 175                 trueproj  = new_r_Proj(cond, mode_X, pn_Cond_true);
 176                 falseproj = new_r_Proj(cond, mode_X, pn_Cond_false);
 177                 set_Block_cfgpred(curcases[1].target, 0, trueproj);
 178                 ARR_APP1(ir_node*, env->defusers, falseproj);
 179         } else {
 180                 /* recursive case: split cases in the middle */
 181                 int midcase = numcases / 2;
 182                 ir_node *val  = new_r_Const_long(irg, cmp_mode,
 183                                                  curcases[midcase].value);
 184                 ir_node *cmp  = new_rd_Cmp(dbgi, block, cmp_sel, val, ir_relation_less);
 185                 ir_node *cond = new_rd_Cond(dbgi, block, cmp);
 186                 ir_node *in[1];
 187                 ir_node *ltblock;
 188                 ir_node *geblock;
 189
 190                 in[0]   = new_r_Proj(cond, mode_X, pn_Cond_true);
 191                 ltblock = new_r_Block(irg, 1, in);
 192
 193                 in[0]   = new_r_Proj(cond, mode_X, pn_Cond_false);
 194                 geblock = new_r_Block(irg, 1, in);
 195
 196                 create_if_cascade(env, dbgi, ltblock, curcases, midcase);
 197                 create_if_cascade(env, dbgi, geblock, curcases + midcase,
 198                                   numcases - midcase);
 199         }
 200 }
 201
 202 static void create_out_of_bounds_check(cond_env_t *env, ir_node *cond)
 203 {
 204         ir_graph      *irg           = get_irn_irg(cond);
 205         dbg_info      *dbgi          = get_irn_dbg_info(cond);
 206         ir_node       *sel           = get_Cond_selector(cond);
 207         ir_node       *block         = get_nodes_block(cond);
 208         ir_mode       *cmp_mode      = get_irn_mode(sel);
 209         ir_node      **default_preds = NEW_ARR_F(ir_node*, 0);
 210         long           default_pn    = get_Cond_default_proj(cond);
 211         long           delta         = 0;
 212         ir_node       *max_const;
 213         ir_node       *proj_true;
 214         ir_node       *proj_false;
 215         ir_node       *cmp;
 216         ir_node       *oob_cond;
 217         ir_node       *in[1];
 218         ir_node       *new_block;
 219         size_t         n_default_preds;
 220         int            i;
 221         ir_node       *proj;
 222
 223         if (mode_is_signed(cmp_mode)) {
 224                 cmp_mode = find_unsigned_mode(cmp_mode);
 225                 sel      = new_r_Conv(block, sel, cmp_mode);
 226         }
 227
 228         /* normalize so switch_min is at 0 */
 229         if (env->switch_min != 0) {
 230                 ir_node *min_const  = new_r_Const_long(irg, cmp_mode, env->switch_min);
 231                 sel = new_rd_Sub(dbgi, block, sel, min_const, cmp_mode);
 232
 233                 delta            = env->switch_min;
 234                 env->switch_min  = 0;
 235                 env->switch_max -= delta;
 236                 set_Cond_selector(cond, sel);
 237         }
 238
 239         /* check for out-of-bounds */
 240         max_const  = new_r_Const_long(irg, cmp_mode, env->switch_max);
 241         cmp        = new_rd_Cmp(dbgi, block, sel, max_const, ir_relation_less_equal);
 242         oob_cond   = new_rd_Cond(dbgi, block, cmp);
 243         proj_true  = new_r_Proj(oob_cond, mode_X, pn_Cond_true);
 244         proj_false = new_r_Proj(oob_cond, mode_X, pn_Cond_false);
 245
 246         ARR_APP1(ir_node*, default_preds, proj_false);
 247
 248         /* create new block containing the cond */
 249         in[0] = proj_true;
 250         new_block = new_r_Block(irg, 1, in);
 251         set_nodes_block(cond, new_block);
 252
 253         /* adapt projs */
 254         foreach_out_irn(cond, i, proj) {
 255                 long pn     = get_Proj_proj(proj);
 256                 long new_pn = pn - delta;
 257                 if (pn == default_pn) {
 258                         /* we might have to choose a new default_pn */
 259                         if (pn < env->switch_max) {
 260                                 new_pn = env->switch_max + 1;
 261                                 set_Cond_default_proj(cond, new_pn);
 262                         } else {
 263                                 new_pn = default_pn;
 264                         }
 265                         ARR_APP1(ir_node*, default_preds, proj);
 266                 }
 267
 268                 set_Proj_proj(proj, new_pn);
 269                 set_nodes_block(proj, new_block);
 270         }
 271
 272         /* adapt default block */
 273         n_default_preds = ARR_LEN(default_preds);
 274         if (n_default_preds > 1) {
 275                 size_t i;
 276
 277                 /* create new intermediate blocks so we don't have critical edges */
 278                 for (i = 0; i < n_default_preds; ++i) {
 279                         ir_node *proj = default_preds[i];
 280                         ir_node *block;
 281                         ir_node *in[1];
 282
 283                         in[0] = proj;
 284                         block = new_r_Block(irg, 1, in);
 285
 286                         default_preds[i] = new_r_Jmp(block);
 287                 }
 288         }
 289         set_irn_in(env->default_block, n_default_preds, default_preds);
 290
 291         DEL_ARR_F(default_preds);
 292 }
 293
 294 /**
 295  * Block-Walker: searches for Cond nodes with a non-boolean mode
 296  */
 297 static void find_cond_nodes(ir_node *block, void *ctx)
 298 {
 299         walk_env_t  *env = (walk_env_t *)ctx;
 300         ir_node     *projx;
 301         ir_node     *cond;
 302         ir_node     *sel;
 303         ir_mode     *sel_mode;
 304         long         default_pn;
 305         int          i;
 306         unsigned     j = 0;
 307         unsigned     numcases;
 308         ir_node     *proj;
 309         case_data_t *cases;
 310         ir_node     *condblock;
 311         ir_node     *defblock = NULL;
 312         dbg_info    *dbgi;
 313         cond_env_t   cond_env;
 314         unsigned long spare;
 315         bool         lower_switch = false;
 316
 317         /* because we split critical blocks only blocks with 1 predecessors may
 318          * contain Proj->Cond nodes */
 319         if (get_Block_n_cfgpreds(block) != 1)
 320                 return;
 321
 322         projx = get_Block_cfgpred(block, 0);
 323         if (!is_Proj(projx))
 324                 return;
 325         assert(get_irn_mode(projx) == mode_X);
 326
 327         cond = get_Proj_pred(projx);
 328         if (!is_Cond(cond))
 329                 return;
 330
 331         sel      = get_Cond_selector(cond);
 332         sel_mode = get_irn_mode(sel);
 333
 334         if (sel_mode == mode_b)
 335                 return;
 336
 337         if (ir_nodeset_contains(&env->processed, cond))
 338                 return;
 339         ir_nodeset_insert(&env->processed, cond);
 340
 341         /* the algorithms here don't work reliable for modes bigger than 32
 342          * since we operate with long numbers */
 343         assert(get_mode_size_bits(sel_mode) <= 32);
 344
 345         analyse_switch(&cond_env, cond);
 346
 347         /*
 348          * Here we have: num_cases and [switch_min, switch_max] interval.
 349          * We do an if-cascade if there are too many spare numbers.
 350          */
 351         spare = (unsigned long) cond_env.switch_max
 352                 - (unsigned long) cond_env.switch_min
 353                 - (unsigned long) cond_env.num_cases + 1;
 354         lower_switch |= spare >= env->spare_size;
 355         lower_switch |= cond_env.num_cases <= env->small_switch;
 356
 357         if (!lower_switch) {
 358                 /* we won't decompose the switch. But we might have to add
 359                  * out-of-bounds checking */
 360                 if (!env->allow_out_of_bounds) {
 361                         create_out_of_bounds_check(&cond_env, cond);
 362                         env->changed = true;
 363                 }
 364                 return;
 365         }
 366
 367         /*
 368          * Switch should be transformed into an if cascade.
 369          * So first order the cases, so we can do a binary search on them.
 370          */
 371         env->changed = true;
 372
 373         numcases = get_irn_n_outs(cond) - 1; /* does not contain default case */
 374         cases    = XMALLOCN(case_data_t, numcases);
 375
 376         default_pn        = get_Cond_default_proj(cond);
 377         cond_env.sel      = sel;
 378         cond_env.defusers = NEW_ARR_F(ir_node*, 0);
 379
 380         foreach_out_irn(cond, i, proj) {
 381                 long pn = get_Proj_proj(proj);
 382                 ir_node *target = get_irn_out(proj, 0);
 383                 assert(get_Block_n_cfgpreds(target) == 1);
 384
 385                 if (pn == default_pn) {
 386                         defblock = target;
 387                         continue;
 388                 }
 389
 390                 cases[j].value  = pn;
 391                 cases[j].target = target;
 392                 j++;
 393         }
 394         assert(j == numcases);
 395
 396         if (defblock == NULL)
 397                 panic("Switch %+F has no default proj", cond);
 398
 399         qsort(cases, numcases, sizeof(cases[0]), casecmp);
 400
 401         /* Now create the if cascade */
 402         condblock = get_nodes_block(cond);
 403         dbgi      = get_irn_dbg_info(cond);
 404         create_if_cascade(&cond_env, dbgi, condblock, cases, numcases);
 405
 406         /* Connect new default case users */
 407         set_irn_in(defblock, ARR_LEN(cond_env.defusers), cond_env.defusers);
 408
 409         xfree(cases);
 410         DEL_ARR_F(cond_env.defusers);
 411 }
 412
 413 void lower_switch(ir_graph *irg, unsigned small_switch, unsigned spare_size,
 414                   int allow_out_of_bounds)
 415 {
 416         walk_env_t env;
 417         env.changed             = false;
 418         env.spare_size          = spare_size;
 419         env.small_switch        = small_switch;
 420         env.allow_out_of_bounds = allow_out_of_bounds;
 421         ir_nodeset_init(&env.processed);
 422
 423         remove_critical_cf_edges(irg);
 424         assure_irg_outs(irg);
 425
 426         irg_block_walk_graph(irg, find_cond_nodes, NULL, &env);
 427         ir_nodeset_destroy(&env.processed);
 428
 429         if (env.changed) {
 430                 /* control flow changed */
 431                 set_irg_doms_inconsistent(irg);
 432                 set_irg_extblk_inconsistent(irg);
 433         }
 434 }