nsz Git - libfirm/blob - ir/opt/condeval.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   Partial condition evaluation
  23  * @date    10. Sep. 2006
  24  * @author  Christoph Mallon, Matthias Braun
  25  * @version $Id$
  26  */
  27 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif
  30
  31 #include "iroptimize.h"
  32
  33 #include <assert.h>
  34 #include "array.h"
  35 #include "debug.h"
  36 #include "ircons.h"
  37 #include "irgmod.h"
  38 #include "irgopt.h"
  39 #include "irgwalk.h"
  40 #include "irnode.h"
  41 #include "irnode_t.h"
  42 #include "iredges.h"
  43 #include "iredges_t.h"
  44 #include "irtools.h"
  45 #include "irgraph.h"
  46 #include "tv.h"
  47
  48 //#define AVOID_PHIB
  49
  50 DEBUG_ONLY(static firm_dbg_module_t *dbg);
  51
  52 /**
  53  * Add the new predecessor x to node node, which is either a Block or a Phi
  54  */
  55 static void add_pred(ir_node* node, ir_node* x)
  56 {
  57         ir_node** ins;
  58         int n;
  59         int i;
  60
  61         assert(is_Block(node) || is_Phi(node));
  62
  63         n = get_irn_arity(node);
  64         NEW_ARR_A(ir_node*, ins, n + 1);
  65         for (i = 0; i < n; i++)
  66                 ins[i] = get_irn_n(node, i);
  67         ins[n] = x;
  68         set_irn_in(node, n + 1, ins);
  69 }
  70
  71 static ir_node *search_def_and_create_phis(ir_node *block, ir_mode *mode)
  72 {
  73         int i;
  74         int n_cfgpreds;
  75         ir_graph *irg;
  76         ir_node *phi;
  77         ir_node **in;
  78
  79         // This is needed because we create bads sometimes
  80         if(is_Bad(block))
  81                 return new_Bad();
  82
  83         // already processed this block?
  84         if(irn_visited(block)) {
  85                 ir_node *value = (ir_node*) get_irn_link(block);
  86                 return value;
  87         }
  88
  89         irg = get_irn_irg(block);
  90         assert(block != get_irg_start_block(irg));
  91
  92         // blocks with only 1 pred need no phi
  93         n_cfgpreds = get_Block_n_cfgpreds(block);
  94         if(n_cfgpreds == 1) {
  95                 ir_node *pred_block = get_Block_cfgpred_block(block, 0);
  96                 ir_node *value      = search_def_and_create_phis(pred_block, mode);
  97
  98                 set_irn_link(block, value);
  99                 mark_irn_visited(block);
 100                 return value;
 101         }
 102
 103         // create a new phi
 104         NEW_ARR_A(ir_node*, in, n_cfgpreds);
 105         for(i = 0; i < n_cfgpreds; ++i)
 106                 in[i] = new_Unknown(mode);
 107
 108         phi = new_r_Phi(irg, block, n_cfgpreds, in, mode);
 109         set_irn_link(block, phi);
 110         mark_irn_visited(block);
 111
 112         // set phi preds
 113         for(i = 0; i < n_cfgpreds; ++i) {
 114                 ir_node *pred_block = get_Block_cfgpred_block(block, i);
 115                 ir_node *pred_val = search_def_and_create_phis(pred_block, mode);
 116
 117                 set_irn_n(phi, i, pred_val);
 118         }
 119
 120         return phi;
 121 }
 122
 123 /**
 124  * Given a set of values this function constructs SSA-form for the users of the
 125  * first value (the users are determined through the out-edges of the value).
 126  * Uses the irn_visited flags. Works without using the dominance tree.
 127  */
 128 static void construct_ssa(ir_node * const *blocks, ir_node * const *vals, int n_vals)
 129 {
 130         int i;
 131         ir_graph *irg;
 132         ir_mode *mode;
 133         const ir_edge_t *edge;
 134         const ir_edge_t *next;
 135         ir_node *value;
 136
 137         assert(n_vals == 2);
 138
 139         irg = get_irn_irg(vals[0]);
 140         inc_irg_visited(irg);
 141
 142         mode = get_irn_mode(vals[0]);
 143         for(i = 0; i < n_vals; ++i) {
 144                 ir_node *value = vals[i];
 145                 ir_node *value_block = blocks[i];
 146
 147                 assert(get_irn_mode(value) == mode);
 148
 149                 set_irn_link(value_block, value);
 150                 mark_irn_visited(value_block);
 151         }
 152
 153         // Only fix the users of the first, i.e. the original node
 154         value = vals[0];
 155
 156         foreach_out_edge_safe(value, edge, next) {
 157                 ir_node *user = get_edge_src_irn(edge);
 158                 int j = get_edge_src_pos(edge);
 159                 ir_node *user_block = get_nodes_block(user);
 160                 ir_node *newval;
 161
 162                 // ignore keeps
 163                 if(get_irn_op(user) == op_End)
 164                         continue;
 165
 166                 if (user_block == blocks[1])
 167                         continue;
 168
 169                 DB((dbg, LEVEL_3, ">>> Fixing user %+F (pred %d == %+F)\n", user, j, get_irn_n(user, j)));
 170
 171                 if(is_Phi(user)) {
 172                         ir_node *pred_block = get_Block_cfgpred_block(user_block, j);
 173                         newval = search_def_and_create_phis(pred_block, mode);
 174                 } else {
 175                         newval = search_def_and_create_phis(user_block, mode);
 176                 }
 177
 178                 // don't fix newly created phis from the SSA construction
 179                 if (newval != user) {
 180                         DB((dbg, LEVEL_4, ">>>> Setting input %d of %+F to %+F\n", j, user, newval));
 181                         set_irn_n(user, j, newval);
 182                 }
 183         }
 184 }
 185
 186 static void split_critical_edge(ir_node *block, int pos) {
 187         ir_graph *irg = get_irn_irg(block);
 188         ir_node *in[1];
 189         ir_node *new_block;
 190         ir_node *new_jmp;
 191
 192         in[0] = get_Block_cfgpred(block, pos);
 193         new_block = new_r_Block(irg, 1, in);
 194         new_jmp = new_r_Jmp(irg, new_block);
 195         set_Block_cfgpred(block, pos, new_jmp);
 196 }
 197
 198 typedef struct condeval_env_t {
 199         ir_node       *true_block;
 200         pn_Cmp         pnc;
 201         ir_node       *cnst;
 202         tarval        *tv;
 203         unsigned long  visited_nr;
 204
 205         ir_node       *cnst_pred;   /**< the block before the constant */
 206         int            cnst_pos;    /**< the pos to the constant block (needed to
 207                                           kill that edge later) */
 208 } condeval_env_t;
 209
 210 static ir_node *copy_and_fix_node(const condeval_env_t *env, ir_node *block,
 211                                   ir_node *copy_block, int j, ir_node *node) {
 212         int      i, arity;
 213         ir_node *copy;
 214
 215         /* we can evaluate Phis right now, all other nodes get copied */
 216         if (is_Phi(node)) {
 217                 copy = get_Phi_pred(node, j);
 218                 /* we might have to evaluate a phi-cascades */
 219                 if(get_irn_visited(copy) >= env->visited_nr) {
 220                         copy = get_irn_link(copy);
 221                 }
 222         } else {
 223                 copy = exact_copy(node);
 224                 set_nodes_block(copy, copy_block);
 225
 226                 assert(get_irn_mode(copy) != mode_X);
 227
 228                 arity = get_irn_arity(copy);
 229                 for(i = 0; i < arity; ++i) {
 230                         ir_node *pred     = get_irn_n(copy, i);
 231                         ir_node *new_pred;
 232
 233                         if(get_nodes_block(pred) != block)
 234                                 continue;
 235
 236                         if(get_irn_visited(pred) >= env->visited_nr) {
 237                                 new_pred = get_irn_link(pred);
 238                         } else {
 239                                 new_pred = copy_and_fix_node(env, block, copy_block, j, pred);
 240                         }
 241                         set_irn_n(copy, i, new_pred);
 242                 }
 243         }
 244
 245         set_irn_link(node, copy);
 246         set_irn_visited(node, env->visited_nr);
 247
 248         return copy;
 249 }
 250
 251 static void copy_and_fix(const condeval_env_t *env, ir_node *block,
 252                          ir_node *copy_block, int j) {
 253         const ir_edge_t *edge;
 254
 255         /* Look at all nodes in the cond_block and copy them into pred */
 256         foreach_out_edge(block, edge) {
 257                 ir_node *node = get_edge_src_irn(edge);
 258                 ir_node *copy;
 259                 ir_mode *mode;
 260
 261                 if (is_Block(node)) {
 262                         /* Block->Block edge, should be the MacroBlock edge */
 263                         assert(get_Block_MacroBlock(node) == block && "Block->Block edge found");
 264                         continue;
 265                 }
 266
 267                 /* ignore control flow */
 268                 mode = get_irn_mode(node);
 269                 if (mode == mode_X || is_Cond(node))
 270                         continue;
 271 #ifdef AVOID_PHIB
 272                 /* we may not copy mode_b nodes, because this could produce phi with
 273                  * mode_bs which can't be handled in all backends. Instead we duplicate
 274                  * the node and move it to it's users */
 275                 if (mode == mode_b) {
 276                         const ir_edge_t *edge, *next;
 277                         ir_node *pred;
 278                         int      pn;
 279
 280                         assert(is_Proj(node));
 281
 282                         pred = get_Proj_pred(node);
 283                         pn   = get_Proj_proj(node);
 284
 285                         foreach_out_edge_safe(node, edge, next) {
 286                                 ir_node *cmp_copy;
 287                                 ir_node *user       = get_edge_src_irn(edge);
 288                                 int pos             = get_edge_src_pos(edge);
 289                                 ir_node *user_block = get_nodes_block(user);
 290
 291                                 if(user_block == block)
 292                                         continue;
 293
 294                                 cmp_copy = exact_copy(pred);
 295                                 set_nodes_block(cmp_copy, user_block);
 296                                 copy = new_r_Proj(current_ir_graph, user_block, cmp_copy, mode_b, pn);
 297                                 set_irn_n(user, pos, copy);
 298                         }
 299                         continue;
 300                 }
 301 #endif
 302
 303                 copy = copy_and_fix_node(env, block, copy_block, j, node);
 304
 305                 /* we might hit values in blocks that have already been processed by a
 306                  * recursive find_phi_with_const call */
 307                 assert(get_irn_visited(copy) <= env->visited_nr);
 308                 if(get_irn_visited(copy) >= env->visited_nr) {
 309                         ir_node *prev_copy = get_irn_link(copy);
 310                         if(prev_copy != NULL)
 311                                 set_irn_link(node, prev_copy);
 312                 }
 313         }
 314
 315         /* fix data-flow (and reconstruct SSA if needed) */
 316         foreach_out_edge(block, edge) {
 317                 ir_node *vals[2];
 318                 ir_node *blocks[2];
 319                 ir_node *node = get_edge_src_irn(edge);
 320                 ir_mode *mode;
 321
 322                 if (is_Block(node)) {
 323                         /* Block->Block edge, should be the MacroBlock edge */
 324                         assert(get_Block_MacroBlock(node) == block && "Block->Block edge found");
 325                         continue;
 326                 }
 327
 328                 mode = get_irn_mode(node);
 329                 if (mode == mode_X || is_Cond(node))
 330                         continue;
 331 #ifdef AVOID_PHIB
 332                 if (mode == mode_b)
 333                         continue;
 334 #endif
 335
 336                 DB((dbg, LEVEL_2, ">> Fixing users of %+F\n", node));
 337
 338                 blocks[0] = block;
 339                 vals[0] = node;
 340                 blocks[1] = copy_block;
 341                 vals[1] = get_irn_link(node);
 342                 construct_ssa(blocks, vals, 2);
 343         }
 344 }
 345
 346 /**
 347  * returns wether the cmp evaluates to true or false, or can't be evaluated!
 348  * 1: true, 0: false, -1: can't evaluate
 349  */
 350 static int eval_cmp(pn_Cmp pnc, tarval *tv1, tarval *tv2) {
 351         pn_Cmp cmp_result = tarval_cmp(tv1, tv2);
 352
 353         // does the compare evaluate to true?
 354         if(cmp_result == pn_Cmp_False)
 355                 return -1;
 356         if((cmp_result & pnc) != cmp_result)
 357                 return 0;
 358
 359         return 1;
 360 }
 361
 362 static ir_node *find_const(condeval_env_t *env, ir_node *jump, ir_node *value)
 363 {
 364         ir_node *block = get_nodes_block(jump);
 365
 366         if(irn_visited(value))
 367                 return NULL;
 368         mark_irn_visited(value);
 369
 370         if(is_Const(value)) {
 371                 tarval *tv_const = get_Const_tarval(env->cnst);
 372                 tarval *tv       = get_Const_tarval(value);
 373
 374                 if(eval_cmp(env->pnc, tv, tv_const) <= 0) {
 375                         return NULL;
 376                 }
 377
 378                 DB((
 379                         dbg, LEVEL_1,
 380                         "> Found condition evaluation candidate %+F->%+F\n",
 381                         env->true_block, block
 382                 ));
 383
 384                 // adjust true_block to point directly towards our jump
 385                 add_pred(env->true_block, jump);
 386
 387                 split_critical_edge(env->true_block, 0);
 388
 389                 // we need a bigger visited nr when going back
 390                 env->visited_nr++;
 391
 392                 return block;
 393         }
 394
 395         if(is_Phi(value)) {
 396                 int i, arity;
 397
 398                 /* the phi has to be in the same block as the jump */
 399                 if(get_nodes_block(value) != block) {
 400                         return NULL;
 401                 }
 402
 403                 arity = get_irn_arity(value);
 404                 for(i = 0; i < arity; ++i) {
 405                         ir_node *copy_block;
 406                         ir_node *phi_pred = get_Phi_pred(value, i);
 407                         ir_node *cfgpred  = get_Block_cfgpred(block, i);
 408
 409                         copy_block = find_const(env, cfgpred, phi_pred);
 410                         if(copy_block == NULL)
 411                                 continue;
 412
 413                         /* copy duplicated nodes in copy_block and fix SSA */
 414                         copy_and_fix(env, block, copy_block, i);
 415
 416                         if(copy_block == get_nodes_block(cfgpred)) {
 417                                 env->cnst_pred = block;
 418                                 env->cnst_pos  = i;
 419                         }
 420
 421                         /* return now as we can't process more possibilities in 1 run */
 422                         return copy_block;
 423                 }
 424         }
 425
 426         return NULL;
 427 }
 428
 429 static ir_node *find_candidate(condeval_env_t *env, ir_node *jump,
 430                                ir_node *value)
 431 {
 432         ir_node *block = get_nodes_block(jump);
 433
 434         if(irn_visited(value)) {
 435                 return NULL;
 436         }
 437         mark_irn_visited(value);
 438
 439         if(is_Const(value)) {
 440                 tarval *tv = get_Const_tarval(value);
 441
 442                 if(tv != env->tv)
 443                         return NULL;
 444
 445                 DB((
 446                         dbg, LEVEL_1,
 447                         "> Found condition evaluation candidate %+F->%+F\n",
 448                         env->true_block, block
 449                 ));
 450
 451                 // adjust true_block to point directly towards our jump
 452                 add_pred(env->true_block, jump);
 453
 454                 split_critical_edge(env->true_block, 0);
 455
 456                 // we need a bigger visited nr when going back
 457                 env->visited_nr++;
 458
 459                 return block;
 460         }
 461         if(is_Phi(value)) {
 462                 int i, arity;
 463
 464                 // the phi has to be in the same block as the jump
 465                 if(get_nodes_block(value) != block)
 466                         return NULL;
 467
 468                 arity = get_irn_arity(value);
 469                 for(i = 0; i < arity; ++i) {
 470                         ir_node *copy_block;
 471                         ir_node *phi_pred = get_Phi_pred(value, i);
 472                         ir_node *cfgpred  = get_Block_cfgpred(block, i);
 473
 474                         copy_block = find_candidate(env, cfgpred, phi_pred);
 475                         if(copy_block == NULL)
 476                                 continue;
 477
 478                         /* copy duplicated nodes in copy_block and fix SSA */
 479                         copy_and_fix(env, block, copy_block, i);
 480
 481                         if(copy_block == get_nodes_block(cfgpred)) {
 482                                 env->cnst_pred = block;
 483                                 env->cnst_pos  = i;
 484                         }
 485
 486                         // return now as we can't process more possibilities in 1 run
 487                         return copy_block;
 488                 }
 489         }
 490         if(is_Proj(value)) {
 491                 ir_node *left;
 492                 ir_node *right;
 493                 int      pnc;
 494                 ir_node *cmp = get_Proj_pred(value);
 495                 if(!is_Cmp(cmp))
 496                         return NULL;
 497
 498                 left  = get_Cmp_left(cmp);
 499                 right = get_Cmp_right(cmp);
 500                 pnc   = get_Proj_proj(value);
 501
 502                 /* we assume that the constant is on the right side, swap left/right
 503                  * if needed */
 504                 if(is_Const(left)) {
 505                         ir_node *t = left;
 506                         left       = right;
 507                         right      = t;
 508
 509                         pnc        = get_inversed_pnc(pnc);
 510                 }
 511
 512                 if(!is_Const(right))
 513                         return 0;
 514
 515                 if(get_nodes_block(left) != block) {
 516                         return 0;
 517                 }
 518
 519                 /* negate condition when we're looking for the false block */
 520                 if(env->tv == get_tarval_b_false()) {
 521                         pnc = get_negated_pnc(pnc, get_irn_mode(right));
 522                 }
 523
 524                 // (recursively) look if a pred of a phi is a constant
 525                 env->pnc  = pnc;
 526                 env->cnst = right;
 527
 528                 return find_const(env, jump, left);
 529         }
 530
 531         return NULL;
 532 }
 533
 534 /**
 535  * Block-walker: searches for the following construct
 536  *
 537  *  Const or Phi with constants
 538  *           |
 539  *          Cmp
 540  *           |
 541  *         Cond
 542  *          /
 543  *       ProjX
 544  *        /
 545  *     Block
 546  */
 547 static void cond_eval(ir_node* block, void* data)
 548 {
 549         condeval_env_t env;
 550         int *changed = data;
 551         ir_node *selector;
 552         ir_node *projx;
 553         ir_node *cond;
 554         ir_node *copy_block;
 555         int      selector_evaluated;
 556         const ir_edge_t *edge, *next;
 557         ir_node* bad;
 558         size_t   cnst_pos;
 559
 560         if(get_Block_n_cfgpreds(block) != 1)
 561                 return;
 562
 563         projx = get_Block_cfgpred(block, 0);
 564         if (!is_Proj(projx))
 565                 return;
 566         assert(get_irn_mode(projx) == mode_X);
 567
 568         cond = get_Proj_pred(projx);
 569         if (!is_Cond(cond))
 570                 return;
 571
 572         selector = get_Cond_selector(cond);
 573         // TODO handle switch Conds
 574         if (get_irn_mode(selector) != mode_b)
 575                 return;
 576
 577         /* handle cases that can be immediately evalutated */
 578         selector_evaluated = -1;
 579         if(is_Proj(selector)) {
 580                 ir_node *cmp = get_Proj_pred(selector);
 581                 if(is_Cmp(cmp)) {
 582                         ir_node *left  = get_Cmp_left(cmp);
 583                         ir_node *right = get_Cmp_right(cmp);
 584                         if(is_Const(left) && is_Const(right)) {
 585                                 int     pnc      = get_Proj_proj(selector);
 586                                 tarval *tv_left  = get_Const_tarval(left);
 587                                 tarval *tv_right = get_Const_tarval(right);
 588
 589                                 selector_evaluated = eval_cmp(pnc, tv_left, tv_right);
 590                                 if(selector_evaluated < 0)
 591                                         return;
 592                         }
 593                 }
 594         } else if(is_Const(selector)) {
 595                 tarval *tv = get_Const_tarval(selector);
 596                 if(tv == get_tarval_b_true()) {
 597                         selector_evaluated = 1;
 598                 } else {
 599                         assert(tv == get_tarval_b_false());
 600                         selector_evaluated = 0;
 601                 }
 602         }
 603
 604         env.cnst_pred = NULL;
 605         if (get_Proj_proj(projx) == pn_Cond_false) {
 606                 env.tv = get_tarval_b_false();
 607                 if(selector_evaluated >= 0)
 608                         selector_evaluated = !selector_evaluated;
 609         } else {
 610                 env.tv = get_tarval_b_true();
 611         }
 612
 613         if(selector_evaluated == 0) {
 614                 bad = new_Bad();
 615                 exchange(projx, bad);
 616                 *changed = 1;
 617                 return;
 618         } else if(selector_evaluated == 1) {
 619                 dbg_info *dbgi = get_irn_dbg_info(selector);
 620                 ir_node  *jmp  = new_rd_Jmp(dbgi, current_ir_graph, get_nodes_block(projx));
 621                 exchange(projx, jmp);
 622                 *changed = 1;
 623                 return;
 624         }
 625
 626         // (recursively) look if a pred of a phi is a constant
 627         env.true_block = block;
 628         inc_irg_visited(current_ir_graph);
 629         env.visited_nr = get_irg_visited(current_ir_graph);
 630
 631         copy_block = find_candidate(&env, projx, selector);
 632         if (copy_block == NULL)
 633                 return;
 634
 635         /* we have to remove the edge towards the pred as the pred now
 636          * jumps into the true_block. We also have to shorten phis
 637          * in our block because of this */
 638         bad      = new_Bad();
 639         cnst_pos = env.cnst_pos;
 640
 641         /* shorten phis */
 642         foreach_out_edge_safe(env.cnst_pred, edge, next) {
 643                 ir_node *node = get_edge_src_irn(edge);
 644
 645                 if(is_Phi(node))
 646                         set_Phi_pred(node, cnst_pos, bad);
 647         }
 648
 649         set_Block_cfgpred(env.cnst_pred, cnst_pos, bad);
 650
 651         /* the graph is changed now */
 652         *changed = 1;
 653 }
 654
 655 void opt_cond_eval(ir_graph* irg)
 656 {
 657         int changed, rerun;
 658
 659         FIRM_DBG_REGISTER(dbg, "firm.opt.condeval");
 660
 661         DB((dbg, LEVEL_1, "===> Performing condition evaluation on %+F\n", irg));
 662
 663         remove_critical_cf_edges(irg);
 664         normalize_proj_nodes(irg);
 665
 666         edges_assure(irg);
 667         set_using_irn_link(irg);
 668         set_using_visited(irg);
 669
 670         changed = 0;
 671         do {
 672                 rerun = 0;
 673                 irg_block_walk_graph(irg, cond_eval, NULL, &rerun);
 674                 changed |= rerun;
 675         } while (rerun);
 676
 677         if (changed) {
 678                 /* control flow changed, some blocks may become dead */
 679                 set_irg_outs_inconsistent(irg);
 680                 set_irg_doms_inconsistent(irg);
 681                 set_irg_extblk_inconsistent(irg);
 682                 set_irg_loopinfo_inconsistent(irg);
 683         }
 684
 685         clear_using_visited(irg);
 686         clear_using_irn_link(irg);
 687 }