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         bool          allow_out_of_bounds;
  48         bool          changed;    /**< indicates whether a change was performed */
  49         ir_nodeset_t  processed;
  50 } walk_env_t;
  51
  52 typedef struct case_data_t {
  53         long     value;
  54         ir_node *target;
  55 } case_data_t;
  56
  57 typedef struct cond_env_t {
  58         ir_node  *sel;
  59         long      switch_min;
  60         long      switch_max;
  61         ir_node  *default_block;
  62         unsigned  num_cases;
  63         ir_node **defusers;           /**< the Projs pointing to the default case */
  64 } cond_env_t;
  65
  66 static void analyse_switch(cond_env_t *env, ir_node *cond)
  67 {
  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;
  73         int      i;
  74         ir_node *proj;
  75
  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;
  82                         continue;
  83                 }
  84
  85                 if (pn < switch_min)
  86                         switch_min = pn;
  87                 if (pn > switch_max)
  88                         switch_max = pn;
  89                 ++num_cases;
  90         }
  91         assert(default_block != NULL);
  92
  93         env->switch_min    = switch_min;
  94         env->switch_max    = switch_max;
  95         env->num_cases     = num_cases;
  96         env->default_block = default_block;
  97 }
  98
  99 static int casecmp(const void *a, const void *b)
 100 {
 101         const case_data_t *cda = (const case_data_t*)a;
 102         const case_data_t *cdb = (const case_data_t*)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(cond_env_t *env, dbg_info *dbgi, ir_node *block,
 117                               case_data_t *curcases, unsigned numcases)
 118 {
 119         ir_graph *irg = get_irn_irg(block);
 120     ir_mode  *cmp_mode;
 121     ir_node  *cmp_sel;
 122     ir_node  *sel_block;
 123
 124     /* Get the mode and sel node for the comparison. */
 125     cmp_mode  = get_irn_mode(env->sel);
 126     cmp_sel   = env->sel;
 127     sel_block = get_nodes_block(cmp_sel);
 128
 129     /*
 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.
 134      */
 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);
 138     }
 139
 140         if (numcases == 0) {
 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,
 147                                                 ir_relation_equal);
 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);
 151
 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,
 158                                                 ir_relation_equal);
 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);
 162                 ir_node *in[1];
 163                 ir_node *neblock;
 164
 165                 set_Block_cfgpred(curcases[0].target, 0, trueproj);
 166
 167                 in[0] = falseproj;
 168                 neblock = new_r_Block(irg, 1, in);
 169
 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);
 178         } else {
 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);
 185                 ir_node *in[1];
 186                 ir_node *ltblock;
 187                 ir_node *geblock;
 188
 189                 in[0]   = new_r_Proj(cond, mode_X, pn_Cond_true);
 190                 ltblock = new_r_Block(irg, 1, in);
 191
 192                 in[0]   = new_r_Proj(cond, mode_X, pn_Cond_false);
 193                 geblock = new_r_Block(irg, 1, in);
 194
 195                 create_if_cascade(env, dbgi, ltblock, curcases, midcase);
 196                 create_if_cascade(env, dbgi, geblock, curcases + midcase,
 197                                   numcases - midcase);
 198         }
 199 }
 200
 201 static void create_out_of_bounds_check(cond_env_t *env, ir_node *cond)
 202 {
 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);
 210         long           delta         = 0;
 211         ir_node       *max_const;
 212         ir_node       *proj_true;
 213         ir_node       *proj_false;
 214         ir_node       *cmp;
 215         ir_node       *oob_cond;
 216         ir_node       *in[1];
 217         ir_node       *new_block;
 218         size_t         n_default_preds;
 219         int            i;
 220         ir_node       *proj;
 221
 222         if (mode_is_signed(cmp_mode)) {
 223                 cmp_mode = find_unsigned_mode(cmp_mode);
 224                 sel      = new_r_Conv(block, sel, cmp_mode);
 225         }
 226
 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);
 231
 232                 delta            = env->switch_min;
 233                 env->switch_min  = 0;
 234                 env->switch_max -= delta;
 235                 set_Cond_selector(cond, sel);
 236         }
 237
 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_equal);
 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);
 244
 245         ARR_APP1(ir_node*, default_preds, proj_false);
 246
 247         /* create new block containing the cond */
 248         in[0] = proj_true;
 249         new_block = new_r_Block(irg, 1, in);
 250         set_nodes_block(cond, new_block);
 251
 252         /* adapt projs */
 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);
 261                         } else {
 262                                 new_pn = default_pn;
 263                         }
 264                         ARR_APP1(ir_node*, default_preds, proj);
 265                 }
 266
 267                 set_Proj_proj(proj, new_pn);
 268                 set_nodes_block(proj, new_block);
 269         }
 270
 271         /* adapt default block */
 272         n_default_preds = ARR_LEN(default_preds);
 273         if (n_default_preds > 1) {
 274                 size_t i;
 275
 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];
 279                         ir_node *block;
 280                         ir_node *in[1];
 281
 282                         in[0] = proj;
 283                         block = new_r_Block(irg, 1, in);
 284
 285                         default_preds[i] = new_r_Jmp(block);
 286                 }
 287         }
 288         set_irn_in(env->default_block, n_default_preds, default_preds);
 289
 290         DEL_ARR_F(default_preds);
 291 }
 292
 293 /**
 294  * Block-Walker: searches for Cond nodes with a non-boolean mode
 295  */
 296 static void find_cond_nodes(ir_node *block, void *ctx)
 297 {
 298         walk_env_t  *env = (walk_env_t *)ctx;
 299         ir_node     *projx;
 300         ir_node     *cond;
 301         ir_node     *sel;
 302         ir_mode     *sel_mode;
 303         long         default_pn;
 304         int          i;
 305         unsigned     j = 0;
 306         unsigned     numcases;
 307         ir_node     *proj;
 308         case_data_t *cases;
 309         ir_node     *condblock;
 310         ir_node     *defblock = NULL;
 311         dbg_info    *dbgi;
 312         cond_env_t   cond_env;
 313         unsigned long spare;
 314
 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)
 318                 return;
 319
 320         projx = get_Block_cfgpred(block, 0);
 321         if (!is_Proj(projx))
 322                 return;
 323         assert(get_irn_mode(projx) == mode_X);
 324
 325         cond = get_Proj_pred(projx);
 326         if (!is_Cond(cond))
 327                 return;
 328
 329         sel      = get_Cond_selector(cond);
 330         sel_mode = get_irn_mode(sel);
 331
 332         if (sel_mode == mode_b)
 333                 return;
 334
 335         if (ir_nodeset_contains(&env->processed, cond))
 336                 return;
 337         ir_nodeset_insert(&env->processed, cond);
 338
 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);
 342
 343         analyse_switch(&cond_env, cond);
 344
 345         /*
 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.
 348          */
 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);
 357                         env->changed = true;
 358                 }
 359                 return;
 360         }
 361
 362         /*
 363          * Switch should be transformed into an if cascade.
 364          * So first order the cases, so we can do a binary search on them.
 365          */
 366         env->changed = true;
 367
 368         numcases = get_irn_n_outs(cond) - 1; /* does not contain default case */
 369         cases    = XMALLOCN(case_data_t, numcases);
 370
 371         default_pn        = get_Cond_default_proj(cond);
 372         cond_env.sel      = sel;
 373         cond_env.defusers = NEW_ARR_F(ir_node*, 0);
 374
 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);
 379
 380                 if (pn == default_pn) {
 381                         defblock = target;
 382                         continue;
 383                 }
 384
 385                 cases[j].value  = pn;
 386                 cases[j].target = target;
 387                 j++;
 388         }
 389         assert(j == numcases);
 390
 391         if (defblock == NULL)
 392                 panic("Switch %+F has no default proj", cond);
 393
 394         qsort(cases, numcases, sizeof(cases[0]), casecmp);
 395
 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);
 400
 401         /* Connect new default case users */
 402         set_irn_in(defblock, ARR_LEN(cond_env.defusers), cond_env.defusers);
 403
 404         xfree(cases);
 405         DEL_ARR_F(cond_env.defusers);
 406 }
 407
 408 void lower_switch(ir_graph *irg, unsigned spare_size, int allow_out_of_bounds)
 409 {
 410         walk_env_t env;
 411         env.changed             = false;
 412         env.spare_size          = spare_size;
 413         env.allow_out_of_bounds = allow_out_of_bounds;
 414         ir_nodeset_init(&env.processed);
 415
 416         remove_critical_cf_edges(irg);
 417         assure_irg_outs(irg);
 418
 419         irg_block_walk_graph(irg, find_cond_nodes, NULL, &env);
 420         ir_nodeset_destroy(&env.processed);
 421
 422         if (env.changed) {
 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);
 428         }
 429 }