nsz Git - libfirm/blob - ir/opt/return.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   Normalize returns.
  23  * @author  Michael Beck
  24  */
  25 #include "config.h"
  26
  27 #include <stdbool.h>
  28
  29 #include "iroptimize.h"
  30 #include "irgraph_t.h"
  31 #include "ircons_t.h"
  32 #include "irnode_t.h"
  33 #include "irgmod.h"
  34 #include "irpass.h"
  35 #include "util.h"
  36 #include "raw_bitset.h"
  37
  38 /*
  39  * Normalize the Returns of a graph by creating a new End block
  40  * with One Return(Phi).
  41  * This is the preferred input for the if-conversion.
  42  *
  43  * In pseudocode, it means:
  44  *
  45  * if (a)
  46  *   return b;
  47  * else
  48  *   return c;
  49  *
  50  * is transformed into
  51  *
  52  * if (a)
  53  *   res = b;
  54  * else
  55  *   res = c;
  56  * return res;
  57  */
  58 void normalize_one_return(ir_graph *irg)
  59 {
  60         ir_node   *endbl         = get_irg_end_block(irg);
  61         ir_entity *entity        = get_irg_entity(irg);
  62         ir_type   *type          = get_entity_type(entity);
  63         int        n_ret_vals    = get_method_n_ress(type) + 1;
  64         int        n_rets        = 0;
  65         bool       filter_dbgi   = false;
  66         dbg_info  *combined_dbgi = NULL;
  67         unsigned  *returns;
  68         int i, j, k, n, last_idx;
  69         ir_node **in, **retvals, **endbl_in;
  70         ir_node *block;
  71
  72         /* look, if we have more than one return */
  73         n = get_Block_n_cfgpreds(endbl);
  74         if (n <= 0) {
  75                 /* The end block has no predecessors, we have an endless
  76                    loop. In that case, no returns exists. */
  77                 return;
  78         }
  79
  80         rbitset_alloca(returns, n);
  81
  82         for (i = 0; i < n; ++i) {
  83                 ir_node *node = get_Block_cfgpred(endbl, i);
  84
  85                 if (is_Return(node)) {
  86                         dbg_info *dbgi = get_irn_dbg_info(node);
  87
  88                         if (dbgi != NULL && dbgi != combined_dbgi) {
  89                                 if (filter_dbgi) {
  90                                         combined_dbgi = NULL;
  91                                 } else {
  92                                         combined_dbgi = dbgi;
  93                                         filter_dbgi   = true;
  94                                 }
  95                         }
  96
  97                         ++n_rets;
  98                         rbitset_set(returns, i);
  99                 }
 100         }
 101
 102         if (n_rets <= 1)
 103                 return;
 104
 105         in       = ALLOCAN(ir_node*, MAX(n_rets, n_ret_vals));
 106         retvals  = ALLOCAN(ir_node*, n_rets * n_ret_vals);
 107         endbl_in = ALLOCAN(ir_node*, n);
 108
 109         last_idx = 0;
 110         for (j = i = 0; i < n; ++i) {
 111                 ir_node *ret = get_Block_cfgpred(endbl, i);
 112
 113                 if (rbitset_is_set(returns, i)) {
 114                         ir_node *block = get_nodes_block(ret);
 115
 116                         /* create a new Jmp for every Ret and place the in in */
 117                         in[j] = new_r_Jmp(block);
 118
 119                         /* save the return values and shuffle them */
 120                         for (k = 0; k < n_ret_vals; ++k)
 121                                 retvals[j + k*n_rets] = get_irn_n(ret, k);
 122
 123                         ++j;
 124                 } else {
 125                         endbl_in[last_idx++] = ret;
 126                 }
 127         }
 128
 129         /* ok, create a new block with all created in's */
 130         block = new_r_Block(irg, n_rets, in);
 131
 132         /* now create the Phi nodes */
 133         for (j = i = 0; i < n_ret_vals; ++i, j += n_rets) {
 134                 ir_mode *mode = get_irn_mode(retvals[j]);
 135                 in[i] = new_r_Phi(block, n_rets, &retvals[j], mode);
 136         }
 137
 138         endbl_in[last_idx++] = new_rd_Return(combined_dbgi, block, in[0], n_ret_vals-1, &in[1]);
 139
 140         set_irn_in(endbl, last_idx, endbl_in);
 141
 142         /* invalidate analysis information:
 143          * a new Block was added, so dominator, outs and loop are inconsistent,
 144          * trouts and callee-state should be still valid
 145          */
 146         clear_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_DOMINANCE);
 147 }
 148
 149 /* Create a graph pass. */
 150 ir_graph_pass_t *normalize_one_return_pass(const char *name)
 151 {
 152         return def_graph_pass(name ? name : "one_ret", normalize_one_return);
 153 }
 154
 155 /**
 156  * Check, whether a Return can be moved on block upwards.
 157  *
 158  * In a block with a Return, all live nodes must be linked
 159  * with the Return, otherwise they are dead (because the Return leaves
 160  * the graph, so no more users of the other nodes can exists.
 161  *
 162  * We can move a Return, if its predecessors are Phi nodes or
 163  * comes from another block. In the later case, it is always possible
 164  * to move the Return one block up, because the predecessor block must
 165  * dominate the Return block (SSA) and then it dominates the predecessor
 166  * block of the Return block as well.
 167  *
 168  * All predecessors of the Return block must be Jmp's of course, or we
 169  * cannot move it up, so we add blocks if needed.
 170  */
 171 static bool can_move_ret(ir_node *ret)
 172 {
 173         ir_node *retbl = get_nodes_block(ret);
 174         int i, n = get_irn_arity(ret);
 175
 176         for (i = 0; i < n; ++i) {
 177                 ir_node *pred = get_irn_n(ret, i);
 178
 179                 if (! is_Phi(pred) && retbl == get_nodes_block(pred)) {
 180                         /* first condition failed, found a non-Phi predecessor
 181                          * then is in the Return block */
 182                         return false;
 183                 }
 184         }
 185
 186         /* check, that predecessors are Jmps */
 187         n = get_Block_n_cfgpreds(retbl);
 188         /* we cannot move above a labeled block, as this might kill the block */
 189         if (n <= 1 || get_Block_entity(retbl) != NULL)
 190                 return false;
 191         for (i = 0; i < n; ++i) {
 192                 ir_node *pred = get_Block_cfgpred(retbl, i);
 193
 194                 pred = skip_Tuple(pred);
 195                 if (! is_Jmp(pred) && !is_Bad(pred)) {
 196                         /* simply place a new block here */
 197                         ir_graph *irg  = get_irn_irg(retbl);
 198                         ir_node *block = new_r_Block(irg, 1, &pred);
 199                         ir_node *jmp   = new_r_Jmp(block);
 200                         set_Block_cfgpred(retbl, i, jmp);
 201                 }
 202         }
 203         return true;
 204 }
 205
 206 /*
 207  * Normalize the Returns of a graph by moving
 208  * the Returns upwards as much as possible.
 209  * This might be preferred for code generation.
 210  *
 211  * In pseudocode, it means:
 212  *
 213  * if (a)
 214  *   res = b;
 215  * else
 216  *   res = c;
 217  * return res;
 218  *
 219  * is transformed into
 220  *
 221  * if (a)
 222  *   return b;
 223  * else
 224  *   return c;
 225  */
 226 void normalize_n_returns(ir_graph *irg)
 227 {
 228         int i, j, n;
 229         ir_node  *list     = NULL;
 230         ir_node  *final    = NULL;
 231         unsigned  n_rets   = 0;
 232         unsigned  n_finals = 0;
 233         ir_node  *endbl    = get_irg_end_block(irg);
 234         int       n_ret_vals;
 235         ir_node **in;
 236         ir_node  *end;
 237
 238         /*
 239          * First, link all returns:
 240          * These must be predecessors of the endblock.
 241          * Place Returns that can be moved on list, all others
 242          * on final.
 243          */
 244         n = get_Block_n_cfgpreds(endbl);
 245         for (i = 0; i < n; ++i) {
 246                 ir_node *ret = get_Block_cfgpred(endbl, i);
 247
 248                 if (is_Bad(ret)) {
 249                         continue;
 250                 } else if (is_Return(ret) && can_move_ret(ret)) {
 251                         /*
 252                          * Ok, all conditions met, we can move this Return, put it
 253                          * on our work list.
 254                          */
 255                         set_irn_link(ret, list);
 256                         list = ret;
 257                         ++n_rets;
 258                 } else {
 259                         /* Put all nodes that are not changed on the final list. */
 260                         set_irn_link(ret, final);
 261                         final = ret;
 262                         ++n_finals;
 263                 }
 264         }
 265
 266         if (n_rets == 0)
 267                 return;
 268
 269         /*
 270          * Now move the Returns upwards. We move always one block up (and create n
 271          * new Returns), than we check if a newly created Return can be moved even
 272          * further. If yes, we simply add it to our work list, else to the final
 273          * list.
 274          */
 275         end        = get_irg_end(irg);
 276         n_ret_vals = get_irn_arity(list);
 277         in         = ALLOCAN(ir_node*, n_ret_vals);
 278         while (list != NULL) {
 279                 ir_node  *ret   = list;
 280                 ir_node  *block = get_nodes_block(ret);
 281                 dbg_info *dbgi  = get_irn_dbg_info(ret);
 282                 ir_node  *phiM;
 283
 284                 list = (ir_node*)get_irn_link(ret);
 285                 --n_rets;
 286
 287                 n = get_Block_n_cfgpreds(block);
 288                 for (i = 0; i < n; ++i) {
 289                         ir_node *jmp = get_Block_cfgpred(block, i);
 290                         ir_node *new_bl, *new_ret;
 291
 292                         if (is_Bad(jmp))
 293                                 continue;
 294                         assert(is_Jmp(jmp));
 295
 296                         new_bl = get_nodes_block(jmp);
 297
 298                         /* create the in-array for the new Return */
 299                         for (j = 0; j < n_ret_vals; ++j) {
 300                                 ir_node *pred = get_irn_n(ret, j);
 301
 302                                 in[j] = (is_Phi(pred) && get_nodes_block(pred) == block) ? get_Phi_pred(pred, i) : pred;
 303                         }
 304
 305                         new_ret = new_rd_Return(dbgi, new_bl, in[0], n_ret_vals-1, &in[1]);
 306
 307                         if (! is_Bad(new_ret)) {
 308                                 /*
 309                                  * The newly created node might be bad, if we
 310                                  * create it in a block with only Bad predecessors.
 311                                  * In that case ignore this block.
 312                                  *
 313                                  * We could even kill the jmp then ...
 314                                  */
 315                                 if (can_move_ret(new_ret)) {
 316                                         set_irn_link(new_ret, list);
 317                                         list = new_ret;
 318                                         ++n_rets;
 319                                 } else {
 320                                         set_irn_link(new_ret, final);
 321                                         final = new_ret;
 322                                         ++n_finals;
 323                                 }
 324                         }
 325
 326                         /* remove the Jmp, we have placed a Return here */
 327                         exchange(jmp, new_r_Bad(irg, mode_X));
 328                 }
 329
 330                 /*
 331                  * if the memory of the old Return is a PhiM, remove it
 332                  * from the keep-alives, or it will keep the block which
 333                  * will crash the dominator algorithm.
 334                  */
 335                 phiM = get_Return_mem(ret);
 336                 if (is_Phi(phiM)) {
 337                         n = get_End_n_keepalives(end);
 338                         for (i = 0; i < n; ++i) {
 339                                 if (get_End_keepalive(end, i) == phiM) {
 340                                         set_End_keepalive(end, i, new_r_Bad(irg, mode_M));
 341                                         break;
 342                                 }
 343                         }
 344                 }
 345         }
 346
 347         /*
 348          * Last step: Create a new endblock, with all nodes on the final list as
 349          * predecessors.
 350          */
 351         in = ALLOCAN(ir_node*, n_finals);
 352
 353         for (i = 0; final != NULL; ++i, final = (ir_node*)get_irn_link(final)) {
 354                 in[i] = final;
 355         }
 356
 357         exchange(endbl, new_r_Block(irg, n_finals, in));
 358
 359         /* Invalidate analysis information:
 360          * Blocks become dead and new Returns were deleted, so dominator, outs and
 361          * loop are inconsistent, trouts and callee-state should be still valid */
 362         clear_irg_state(irg, IR_GRAPH_STATE_CONSISTENT_DOMINANCE
 363                            | IR_GRAPH_STATE_CONSISTENT_POSTDOMINANCE
 364                            | IR_GRAPH_STATE_ONE_RETURN
 365                            | IR_GRAPH_STATE_CONSISTENT_OUTS
 366                            | IR_GRAPH_STATE_NO_UNREACHABLE_CODE
 367                            | IR_GRAPH_STATE_NO_BADS);
 368 }
 369
 370 /* Create a graph pass. */
 371 ir_graph_pass_t *normalize_n_returns_pass(const char *name)
 372 {
 373         return def_graph_pass(name ? name : "n_rets", normalize_n_returns);
 374 }