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
  38 #define foreach_out_irn(irn, i, outirn) for(i = get_irn_n_outs(irn) - 1;\
  39         i >= 0 && (outirn = get_irn_out(irn, i)); --i)
  40
  41 typedef struct walk_env {
  42         unsigned         spare_size;        /**< the allowed spare size for table switches */
  43         int              changed;           /**< indicates whether a change was performed */
  44 } walk_env_t;
  45
  46 typedef struct case_data {
  47         long     value;
  48         ir_node *target;
  49 } case_data_t;
  50
  51 typedef struct ifcas_env {
  52         ir_node  *sel;
  53         int       defindex;
  54         ir_node **defusers;                 /**< the Projs pointing to the default case */
  55 } ifcas_env_t;
  56
  57 /**
  58  * Evaluate a switch and decide whether we should build a table switch.
  59  *
  60  * @param cond       The Cond node representing the switch.
  61  * @param spare_size Allowed spare size for table switches in machine words.
  62  *                   (Default in edgfe: 128)
  63  */
  64 static int should_do_table_switch(ir_node *cond, unsigned spare_size)
  65 {
  66         long     default_pn;
  67         int      i;
  68         ir_node *proj;
  69         long switch_min = LONG_MAX, switch_max = LONG_MIN;
  70         unsigned long spare, num_cases = 0;
  71
  72         /* TODO: Minimum size for jump table? */
  73         if (get_irn_n_outs(cond) <= 4)
  74                 return 0;
  75
  76         default_pn = get_Cond_defaultProj(cond);
  77
  78         foreach_out_irn(cond, i, proj) {
  79                 long pn = get_Proj_proj(proj);
  80                 if (pn == default_pn)
  81                         continue;
  82
  83                 if (pn < switch_min)
  84                         switch_min = pn;
  85                 if (pn > switch_max)
  86                         switch_max = pn;
  87                 ++num_cases;
  88         }
  89
  90         /*
  91          * Here we have: num_cases and [switch_min, switch_max] interval.
  92          * We do an if-cascade if there are too many spare numbers.
  93          */
  94         spare = (unsigned long) switch_max - (unsigned long) switch_min - num_cases + 1;
  95         return spare < spare_size;
  96 }
  97
  98 static int casecmp(const void *a, const void *b)
  99 {
 100         const case_data_t *cda = a;
 101         const case_data_t *cdb = b;
 102         return (cda->value > cdb->value) - (cda->value < cdb->value);
 103 }
 104
 105 /**
 106  * Creates an if cascade realizing binary search.
 107  */
 108 static void create_if_cascade(ifcas_env_t *env, ir_node *curblock,
 109                               case_data_t *curcases, int numcases)
 110 {
 111         assert(numcases >= 0);
 112
 113         set_cur_block(curblock);
 114
 115         if (numcases == 0) {
 116                 /* zero cases: "goto default;" */
 117                 env->defusers[env->defindex++] = new_Jmp();
 118         } else if (numcases == 1) {
 119                 /* only one case: "if(sel == val) goto target else goto default;" */
 120                 ir_node *val  = new_Const_long(get_irn_mode(env->sel), curcases[0].value);
 121                 ir_node *cmp  = new_Cmp(env->sel, val);
 122                 ir_node *proj = new_Proj(cmp, mode_b, pn_Cmp_Eq);
 123                 ir_node *cond = new_Cond(proj);
 124                 set_Block_cfgpred(curcases[0].target, 0, new_Proj(cond, mode_X, pn_Cond_true));
 125                 env->defusers[env->defindex++] = new_Proj(cond, mode_X, pn_Cond_false);
 126         } else if (numcases == 2) {
 127                 /* only two cases: "if(sel == val[0]) goto target[0];" */
 128                 ir_node *val  = new_Const_long(get_irn_mode(env->sel), curcases[0].value);
 129                 ir_node *cmp  = new_Cmp(env->sel, val);
 130                 ir_node *proj = new_Proj(cmp, mode_b, pn_Cmp_Eq);
 131                 ir_node *cond = new_Cond(proj);
 132                 ir_node *in[1];
 133                 ir_node *neblock;
 134
 135                 set_Block_cfgpred(curcases[0].target, 0, new_Proj(cond, mode_X, pn_Cond_true));
 136                 in[0] = new_Proj(cond, mode_X, pn_Cond_false);
 137                 neblock = new_Block(1, in);
 138
 139                 /* second part: "else if(sel == val[1]) goto target[1] else goto default;" */
 140                 val  = new_Const_long(get_irn_mode(env->sel), curcases[1].value);
 141                 cmp  = new_Cmp(env->sel, val);
 142                 proj = new_Proj(cmp, mode_b, pn_Cmp_Eq);
 143                 cond = new_Cond(proj);
 144                 set_Block_cfgpred(curcases[1].target, 0, new_Proj(cond, mode_X, pn_Cond_true));
 145                 env->defusers[env->defindex++] = new_Proj(cond, mode_X, pn_Cond_false);
 146         } else {
 147                 /* recursive case: split cases in the middle */
 148                 int midcase = numcases / 2;
 149                 ir_node *val  = new_Const_long(get_irn_mode(env->sel), curcases[midcase].value);
 150                 ir_node *cmp  = new_Cmp(env->sel, val);
 151                 ir_node *proj = new_Proj(cmp, mode_b, pn_Cmp_Lt);
 152                 ir_node *cond = new_Cond(proj);
 153                 ir_node *in[1];
 154                 ir_node *ltblock;
 155                 ir_node *geblock;
 156
 157                 in[0] = new_Proj(cond, mode_X, pn_Cond_true);
 158                 ltblock = new_Block(1, in);
 159
 160                 set_cur_block(curblock);
 161                 in[0] = new_Proj(cond, mode_X, pn_Cond_false);
 162                 geblock = new_Block(1, in);
 163
 164                 create_if_cascade(env, ltblock, curcases, midcase);
 165                 create_if_cascade(env, geblock, curcases + midcase, numcases - midcase);
 166         }
 167 }
 168
 169 /**
 170  * Block-Walker: searches for Cond nodes with a non-boolean mode
 171  */
 172 static void find_cond_nodes(ir_node *block, void *ctx)
 173 {
 174         walk_env_t  *env = ctx;
 175         ir_node     *projx;
 176         ir_node     *cond;
 177         ir_node     *sel;
 178         ir_mode     *sel_mode;
 179         long         default_pn;
 180         int          i, j = 0, numcases;
 181         ir_node     *proj;
 182         case_data_t *cases;
 183         ir_node     *condblock;
 184         ir_node     *defblock = NULL;
 185         ifcas_env_t  ifcas_env;
 186
 187         if (get_Block_n_cfgpreds(block) != 1)
 188                 return;
 189
 190         projx = get_Block_cfgpred(block, 0);
 191         if (!is_Proj(projx))
 192                 return;
 193         assert(get_irn_mode(projx) == mode_X);
 194
 195         cond = get_Proj_pred(projx);
 196         if (!is_Cond(cond))
 197                 return;
 198
 199         sel      = get_Cond_selector(cond);
 200         sel_mode = get_irn_mode(sel);
 201
 202         if (sel_mode == mode_b)    /* not a switch? */
 203                 return;
 204
 205         if (should_do_table_switch(cond, env->spare_size))
 206                 return;
 207
 208         /*
 209          * Switch should be transformed into an if cascade.
 210          * So first order the cases, so we can do a binary search on them.
 211          */
 212         env->changed = 1;
 213
 214         numcases = get_irn_n_outs(cond) - 1;      // does not contain default case
 215         NEW_ARR_A(case_data_t, cases, numcases);
 216
 217         default_pn = get_Cond_defaultProj(cond);
 218         ifcas_env.sel = sel;
 219         ifcas_env.defindex = 0;
 220         NEW_ARR_A(ir_node*, ifcas_env.defusers, numcases);
 221
 222         foreach_out_irn(cond, i, proj) {
 223                 long pn = get_Proj_proj(proj);
 224                 ir_node *target = get_irn_out(proj, 0);
 225                 assert(get_Block_n_cfgpreds(target) == 1 && "Encountered critical edge in switch");
 226
 227                 if (pn == default_pn) {
 228                         defblock = target;
 229                         continue;
 230                 }
 231
 232                 cases[j].value  = pn;
 233                 cases[j].target = target;
 234                 j++;
 235         }
 236
 237         assert(defblock != NULL && "Switch without default proj");
 238         qsort(cases, numcases, sizeof(*cases), casecmp);
 239
 240         /* Now create the if cascade */
 241         condblock = get_nodes_block(cond);
 242         create_if_cascade(&ifcas_env, condblock, cases, numcases);
 243
 244         /* Connect new default case users */
 245         set_irn_in(defblock, ifcas_env.defindex, ifcas_env.defusers);
 246 }
 247
 248 /**
 249  * Lowers all Switches (Cond nodes with non-boolean mode) depending on spare_size.
 250  * They will either remain the same or be converted into if-cascades.
 251  *
 252  * @param irg        The ir graph to be lowered.
 253  * @param spare_size Allowed spare size for table switches in machine words.
 254  *                   (Default in edgfe: 128)
 255  */
 256 void lower_switch(ir_graph *irg, unsigned spare_size)
 257 {
 258         walk_env_t env;
 259         ir_graph *rem = current_ir_graph;
 260
 261         current_ir_graph = irg;
 262
 263         env.changed    = 0;
 264         env.spare_size = spare_size;
 265
 266         remove_critical_cf_edges(irg);
 267         assure_irg_outs(irg);
 268
 269         irg_block_walk_graph(irg, find_cond_nodes, NULL, &env);
 270
 271         if (env.changed) {
 272                 /* control flow changed */
 273                 set_irg_outs_inconsistent(irg);
 274                 set_irg_doms_inconsistent(irg);
 275                 set_irg_extblk_inconsistent(irg);
 276                 set_irg_loopinfo_inconsistent(irg);
 277         }
 278         current_ir_graph = rem;
 279 }