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 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif
  30
  31 #include <limits.h>
  32
  33 #include "ircons.h"
  34 #include "irgopt.h"
  35 #include "irgwalk.h"
  36 #include "irnode_t.h"
  37 #include "irouts.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_defaultProj(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         return ((case_data_t *) a)->value - ((case_data_t *) b)->value;
 102 }
 103
 104 /**
 105  * Creates an if cascade realizing binary search.
 106  */
 107 static void create_if_cascade(ifcas_env_t *env, ir_node *curblock,
 108                               case_data_t *curcases, int numcases)
 109 {
 110         assert(numcases > 0);
 111
 112         set_cur_block(curblock);
 113
 114         if(numcases == 1)
 115         {
 116                 /* only one case: "if(sel == val) goto target else goto default;" */
 117                 ir_node *val  = new_Const_long(get_irn_mode(env->sel), curcases[0].value);
 118                 ir_node *cmp  = new_Cmp(env->sel, val);
 119                 ir_node *proj = new_Proj(cmp, mode_b, pn_Cmp_Eq);
 120                 ir_node *cond = new_Cond(proj);
 121                 set_Block_cfgpred(curcases[0].target, 0, new_Proj(cond, mode_X, pn_Cond_true));
 122                 env->defusers[env->defindex++] = new_Proj(cond, mode_X, pn_Cond_false);
 123         } else if(numcases == 2) {
 124                 /* only two cases: "if(sel == val[0]) goto target[0];" */
 125                 ir_node *val  = new_Const_long(get_irn_mode(env->sel), curcases[0].value);
 126                 ir_node *cmp  = new_Cmp(env->sel, val);
 127                 ir_node *proj = new_Proj(cmp, mode_b, pn_Cmp_Eq);
 128                 ir_node *cond = new_Cond(proj);
 129                 ir_node *in[1];
 130                 ir_node *neblock;
 131
 132                 set_Block_cfgpred(curcases[0].target, 0, new_Proj(cond, mode_X, pn_Cond_true));
 133                 in[0] = new_Proj(cond, mode_X, pn_Cond_false);
 134                 neblock = new_Block(1, in);
 135
 136                 /* second part: "else if(sel == val[1]) goto target[1] else goto default;" */
 137                 val  = new_Const_long(get_irn_mode(env->sel), curcases[1].value);
 138                 cmp  = new_Cmp(env->sel, val);
 139                 proj = new_Proj(cmp, mode_b, pn_Cmp_Eq);
 140                 cond = new_Cond(proj);
 141                 set_Block_cfgpred(curcases[1].target, 0, new_Proj(cond, mode_X, pn_Cond_true));
 142                 env->defusers[env->defindex++] = new_Proj(cond, mode_X, pn_Cond_false);
 143         } else {
 144                 /* recursive case: split cases in the middle */
 145                 int midcase = numcases / 2;
 146                 ir_node *val  = new_Const_long(get_irn_mode(env->sel), curcases[midcase].value);
 147                 ir_node *cmp  = new_Cmp(env->sel, val);
 148                 ir_node *proj = new_Proj(cmp, mode_b, pn_Cmp_Lt);
 149                 ir_node *cond = new_Cond(proj);
 150                 ir_node *in[1];
 151                 ir_node *ltblock;
 152                 ir_node *geblock;
 153
 154                 in[0] = new_Proj(cond, mode_X, pn_Cond_true);
 155                 ltblock = new_Block(1, in);
 156
 157                 set_cur_block(curblock);
 158                 in[0] = new_Proj(cond, mode_X, pn_Cond_false);
 159                 geblock = new_Block(1, in);
 160
 161                 create_if_cascade(env, ltblock, curcases, midcase);
 162                 create_if_cascade(env, geblock, curcases + midcase, numcases - midcase);
 163         }
 164 }
 165
 166 /**
 167  * Block-Walker: searches for Cond nodes with a non-boolean mode
 168  */
 169 static void find_cond_nodes(ir_node *block, void *ctx)
 170 {
 171         walk_env_t  *env = ctx;
 172         ir_node     *projx;
 173         ir_node     *cond;
 174         ir_node     *sel;
 175         ir_mode     *sel_mode;
 176         long         default_pn;
 177         int          i, j = 0, numcases;
 178         ir_node     *proj;
 179         case_data_t *cases;
 180         ir_node     *condblock;
 181         ir_node     *defblock = NULL;
 182         ifcas_env_t  ifcas_env;
 183
 184         if(get_Block_n_cfgpreds(block) != 1)
 185                 return;
 186
 187         projx = get_Block_cfgpred(block, 0);
 188         if(!is_Proj(projx))
 189                 return;
 190         assert(get_irn_mode(projx) == mode_X);
 191
 192         cond = get_Proj_pred(projx);
 193         if(!is_Cond(cond))
 194                 return;
 195
 196         sel      = get_Cond_selector(cond);
 197         sel_mode = get_irn_mode(sel);
 198
 199         if(sel_mode == mode_b)    /* not a switch? */
 200                 return;
 201
 202         if(should_do_table_switch(cond, env->spare_size))
 203                 return;
 204
 205         /*
 206          * Switch should be transformed into an if cascade.
 207          * So first order the cases, so we can do a binary search on them.
 208          */
 209         env->changed = 1;
 210
 211         numcases = get_irn_n_outs(cond) - 1;      // does not contain default case
 212         NEW_ARR_A(case_data_t, cases, numcases);
 213
 214         default_pn = get_Cond_defaultProj(cond);
 215         ifcas_env.sel = sel;
 216         ifcas_env.defindex = 0;
 217         NEW_ARR_A(ir_node*, ifcas_env.defusers, numcases);
 218
 219         foreach_out_irn(cond, i, proj) {
 220                 long pn = get_Proj_proj(proj);
 221                 ir_node *target = get_irn_out(proj, 0);
 222                 assert(get_Block_n_cfgpreds(target) == 1 && "Encountered critical edge in switch");
 223
 224                 if(pn == default_pn)
 225                 {
 226                         defblock = target;
 227                         continue;
 228                 }
 229
 230                 cases[j].value  = pn;
 231                 cases[j].target = target;
 232                 j++;
 233         }
 234
 235         assert(defblock != NULL && "Switch without default proj");
 236         qsort(cases, numcases, sizeof(*cases), casecmp);
 237
 238         /* Now create the if cascade */
 239         condblock = get_nodes_block(cond);
 240         create_if_cascade(&ifcas_env, condblock, cases, numcases);
 241
 242         /* Connect new default case users */
 243         set_irn_in(defblock, ifcas_env.defindex, ifcas_env.defusers);
 244 }
 245
 246 /**
 247  * Lowers all Switches (Cond nodes with non-boolean mode) depending on spare_size.
 248  * They will either remain the same or be converted into if-cascades.
 249  *
 250  * @param irg        The ir graph to be lowered.
 251  * @param spare_size Allowed spare size for table switches in machine words.
 252  *                   (Default in edgfe: 128)
 253  */
 254 void lower_switch(ir_graph *irg, unsigned spare_size)
 255 {
 256         walk_env_t env;
 257         ir_graph *rem = current_ir_graph;
 258
 259         current_ir_graph = irg;
 260
 261         env.changed    = 0;
 262         env.spare_size = spare_size;
 263
 264         remove_critical_cf_edges(irg);
 265         assure_irg_outs(irg);
 266
 267         irg_block_walk_graph(irg, find_cond_nodes, NULL, &env);
 268
 269         if(env.changed) {
 270                 /* control flow changed */
 271                 set_irg_outs_inconsistent(irg);
 272                 set_irg_doms_inconsistent(irg);
 273                 set_irg_extblk_inconsistent(irg);
 274                 set_irg_loopinfo_inconsistent(irg);
 275         }
 276
 277         current_ir_graph = rem;
 278 }