nsz Git - libfirm/blob - ir/be/bessaconstr.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       SSA construction for a set of nodes
  23  * @author      Sebastian Hack, Daniel Grund, Matthias Braun, Christian Wuerdig
  24  * @date        04.05.2005
  25  * @version     $Id$
  26  *
  27  * The problem: Given a value and a set of "copies" that are known to
  28  * represent the same abstract value, rewire all usages of the original value
  29  * to their closest copy while introducing phis as necessary.
  30  *
  31  * Algorithm: Mark all blocks in the iterated dominance frontiers of the value
  32  * and it's copies. Link the copies ordered by dominance to the blocks.  Then
  33  * we search for each use all definitions in the current block, if none is
  34  * found, then we search one in the immediate dominator. If we are in a block
  35  * of the dominance frontier, create a phi and do the same search for all
  36  * phi arguments.
  37  *
  38  * A copy in this context means, that you want to introduce several new
  39  * abstract values (in Firm: nodes) for which you know, that they
  40  * represent the same concrete value. This is the case if you
  41  * - copy
  42  * - spill and reload
  43  * - re-materialize
  44  * a value.
  45  *
  46  * This function reroutes all uses of the original value to the copies in the
  47  * corresponding dominance subtrees and creates Phi functions where necessary.
  48  */
  49 #include "config.h"
  50
  51 /* statev in this file is extensive, so only enable if needed */
  52 #define DISABLE_STATEV
  53
  54 #include "bessaconstr.h"
  55 #include "bemodule.h"
  56 #include "besched.h"
  57 #include "beintlive_t.h"
  58 #include "beirg.h"
  59 #include "be_t.h"
  60 #include "benode.h"
  61
  62 #include "debug.h"
  63 #include "error.h"
  64 #include "pdeq.h"
  65 #include "array.h"
  66 #include "irdom.h"
  67
  68 #include "ircons.h"
  69 #include "iredges_t.h"
  70
  71 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
  72
  73 /**
  74  * Calculates the iterated dominance frontier of a set of blocks. Marks the
  75  * blocks as visited. Sets the link fields of the blocks in the dominance
  76  * frontier to the block itself.
  77  */
  78 static void mark_iterated_dominance_frontiers(
  79                 const be_ssa_construction_env_t *env)
  80 {
  81         stat_ev_cnt_decl(blocks);
  82         DBG((dbg, LEVEL_3, "Dominance Frontier:"));
  83         stat_ev_tim_push();
  84         while (!waitq_empty(env->worklist)) {
  85                 int i;
  86                 ir_node *block = waitq_get(env->worklist);
  87                 ir_node **domfront = be_get_dominance_frontier(env->domfronts, block);
  88                 int domfront_len = ARR_LEN(domfront);
  89
  90                 for (i = 0; i < domfront_len; ++i) {
  91                         ir_node *y = domfront[i];
  92                         if (Block_block_visited(y))
  93                                 continue;
  94
  95                         if (!irn_visited(y)) {
  96                                 set_irn_link(y, NULL);
  97                                 waitq_put(env->worklist, y);
  98                         }
  99
 100                         DBG((dbg, LEVEL_3, " %+F", y));
 101                         mark_Block_block_visited(y);
 102                         stat_ev_cnt_inc(blocks);
 103                 }
 104         }
 105         stat_ev_tim_pop("bessaconstr_idf_time");
 106         stat_ev_cnt_done(blocks, "bessaconstr_idf_blocks");
 107         DBG((dbg, LEVEL_3, "\n"));
 108 }
 109
 110 static ir_node *search_def_end_of_block(be_ssa_construction_env_t *env,
 111                                         ir_node *block);
 112
 113 static ir_node *create_phi(be_ssa_construction_env_t *env, ir_node *block,
 114                            ir_node *link_with)
 115 {
 116         int i, n_preds = get_Block_n_cfgpreds(block);
 117         ir_graph *irg = get_Block_irg(block);
 118         ir_node **ins = ALLOCAN(ir_node*, n_preds);
 119         ir_node  *dummy;
 120         ir_node  *phi;
 121
 122         assert(n_preds > 1);
 123
 124         dummy = new_r_Dummy(irg, env->mode);
 125         for (i = 0; i < n_preds; ++i) {
 126                 ins[i] = dummy;
 127         }
 128         phi = be_new_Phi(block, n_preds, ins, env->mode, env->phi_cls);
 129         if (env->new_phis != NULL) {
 130                 ARR_APP1(ir_node*, env->new_phis, phi);
 131         }
 132
 133         if (env->mode != mode_M) {
 134                 sched_add_after(block, phi);
 135         }
 136
 137         DBG((dbg, LEVEL_2, "\tcreating phi %+F in %+F\n", phi, block));
 138         set_irn_link(link_with, phi);
 139         mark_irn_visited(block);
 140
 141         for (i = 0; i < n_preds; ++i) {
 142                 ir_node *pred_block = get_Block_cfgpred_block(block, i);
 143                 ir_node *pred_def   = search_def_end_of_block(env, pred_block);
 144
 145                 set_irn_n(phi, i, pred_def);
 146         }
 147
 148         return phi;
 149 }
 150
 151 static ir_node *get_def_at_idom(be_ssa_construction_env_t *env, ir_node *block)
 152 {
 153         ir_node *dom = get_Block_idom(block);
 154         assert(dom != NULL);
 155         return search_def_end_of_block(env, dom);
 156 }
 157
 158 static ir_node *search_def_end_of_block(be_ssa_construction_env_t *env,
 159                                         ir_node *block)
 160 {
 161         if (irn_visited(block)) {
 162                 assert(get_irn_link(block) != NULL);
 163                 return get_irn_link(block);
 164         } else if (Block_block_visited(block)) {
 165                 return create_phi(env, block, block);
 166         } else {
 167                 ir_node *def = get_def_at_idom(env, block);
 168                 mark_irn_visited(block);
 169                 set_irn_link(block, def);
 170                 return def;
 171         }
 172 }
 173
 174 static ir_node *search_def(be_ssa_construction_env_t *env, ir_node *at)
 175 {
 176         ir_node *block = get_nodes_block(at);
 177         ir_node *node;
 178         ir_node *def;
 179
 180         DBG((dbg, LEVEL_3, "\t...searching def at %+F\n", at));
 181
 182         /* no defs in the current block we can do the normal searching */
 183         if (!irn_visited(block) && !Block_block_visited(block)) {
 184                 DBG((dbg, LEVEL_3, "\t...continue at idom\n"));
 185                 return get_def_at_idom(env, block);
 186         }
 187
 188         /* there are defs in the current block, walk the linked list to find
 189            the one immediately dominating us
 190          */
 191         node = block;
 192         def  = get_irn_link(node);
 193         while (def != NULL) {
 194                 if (!value_dominates(at, def)) {
 195                         DBG((dbg, LEVEL_3, "\t...found dominating def %+F\n", def));
 196                         return def;
 197                 }
 198
 199                 node = def;
 200                 def  = get_irn_link(node);
 201         }
 202
 203         /* block in dominance frontier? create a phi then */
 204         if (Block_block_visited(block)) {
 205                 DBG((dbg, LEVEL_3, "\t...create phi at block %+F\n", block));
 206                 assert(!is_Phi(node));
 207                 return create_phi(env, block, node);
 208         }
 209
 210         DBG((dbg, LEVEL_3, "\t...continue at idom (after checking block)\n"));
 211         return get_def_at_idom(env, block);
 212 }
 213
 214 /**
 215  * Adds a definition into the link field of the block. The definitions are
 216  * sorted by dominance. A non-visited block means no definition has been
 217  * inserted yet.
 218  */
 219 static void introduce_def_at_block(ir_node *block, ir_node *def)
 220 {
 221         if (irn_visited_else_mark(block)) {
 222                 ir_node *node = block;
 223                 ir_node *current_def;
 224
 225                 for (;;) {
 226                         current_def = get_irn_link(node);
 227                         if (current_def == def) {
 228                                 /* already in block */
 229                                 return;
 230                         }
 231                         if (current_def == NULL)
 232                                 break;
 233                         if (value_dominates(current_def, def))
 234                                 break;
 235                         node = current_def;
 236                 }
 237
 238                 set_irn_link(node, def);
 239                 set_irn_link(def, current_def);
 240         } else {
 241                 set_irn_link(block, def);
 242                 set_irn_link(def, NULL);
 243         }
 244 }
 245
 246 void be_ssa_construction_init(be_ssa_construction_env_t *env, ir_graph *irg)
 247 {
 248         ir_node *sb   = get_irg_start_block(irg);
 249         int n_blocks  = get_Block_dom_max_subtree_pre_num(sb);
 250
 251         stat_ev_ctx_push_fobj("bessaconstr", irg);
 252         stat_ev_tim_push();
 253
 254         (void) n_blocks;
 255         stat_ev_dbl("bessaconstr_n_blocks", n_blocks);
 256
 257         memset(env, 0, sizeof(env[0]));
 258         be_assure_dom_front(irg);
 259
 260         env->irg       = irg;
 261         env->domfronts = be_get_irg_dom_front(irg);
 262         env->new_phis  = NEW_ARR_F(ir_node*, 0);
 263         env->worklist  = new_waitq();
 264
 265         ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED
 266                         | IR_RESOURCE_BLOCK_VISITED | IR_RESOURCE_IRN_LINK);
 267
 268         /* we use the visited flag to indicate blocks in the dominance frontier
 269          * and blocks that already have the relevant value at the end calculated */
 270         inc_irg_visited(irg);
 271         /* We use the block visited flag to indicate blocks in the dominance
 272          * frontier of some values (and this potentially needing phis) */
 273         inc_irg_block_visited(irg);
 274 }
 275
 276 void be_ssa_construction_destroy(be_ssa_construction_env_t *env)
 277 {
 278         stat_ev_int("bessaconstr_phis", ARR_LEN(env->new_phis));
 279         del_waitq(env->worklist);
 280         DEL_ARR_F(env->new_phis);
 281
 282         ir_free_resources(env->irg, IR_RESOURCE_IRN_VISITED
 283                         | IR_RESOURCE_BLOCK_VISITED | IR_RESOURCE_IRN_LINK);
 284
 285         stat_ev_tim_pop("bessaconstr_total_time");
 286         stat_ev_ctx_pop("bessaconstr");
 287 }
 288
 289 void be_ssa_construction_add_copy(be_ssa_construction_env_t *env,
 290                                   ir_node *copy)
 291 {
 292         ir_node *block;
 293
 294         assert(env->iterated_domfront_calculated == 0);
 295
 296         if (env->mode == NULL) {
 297                 env->mode    = get_irn_mode(copy);
 298                 env->phi_cls = arch_get_irn_reg_class_out(copy);
 299         } else {
 300                 assert(env->mode == get_irn_mode(copy));
 301         }
 302
 303         block = get_nodes_block(copy);
 304
 305         if (!irn_visited(block)) {
 306                 waitq_put(env->worklist, block);
 307         }
 308         introduce_def_at_block(block, copy);
 309 }
 310
 311 void be_ssa_construction_add_copies(be_ssa_construction_env_t *env,
 312                                     ir_node **copies, size_t copies_len)
 313 {
 314         size_t i;
 315
 316         assert(env->iterated_domfront_calculated == 0);
 317
 318         if (env->mode == NULL) {
 319                 env->mode    = get_irn_mode(copies[0]);
 320                 env->phi_cls = arch_get_irn_reg_class_out(copies[0]);
 321         }
 322
 323         for (i = 0; i < copies_len; ++i) {
 324                 ir_node *copy  = copies[i];
 325                 ir_node *block = get_nodes_block(copy);
 326
 327                 assert(env->mode == get_irn_mode(copy));
 328                 if (!irn_visited(block)) {
 329                         waitq_put(env->worklist, block);
 330                 }
 331                 introduce_def_at_block(block, copy);
 332         }
 333 }
 334
 335 void be_ssa_construction_set_ignore_uses(be_ssa_construction_env_t *env,
 336                                          const ir_nodeset_t *ignore_uses)
 337 {
 338         env->ignore_uses = ignore_uses;
 339 }
 340
 341 ir_node **be_ssa_construction_get_new_phis(be_ssa_construction_env_t *env)
 342 {
 343         return env->new_phis;
 344 }
 345
 346 void be_ssa_construction_fix_users_array(be_ssa_construction_env_t *env,
 347                                          ir_node **nodes, size_t nodes_len)
 348 {
 349         const ir_edge_t *edge, *next;
 350         size_t i;
 351         stat_ev_cnt_decl(uses);
 352
 353         be_timer_push(T_SSA_CONSTR);
 354
 355         if (!env->iterated_domfront_calculated) {
 356                 mark_iterated_dominance_frontiers(env);
 357                 env->iterated_domfront_calculated = 1;
 358         }
 359
 360         stat_ev_tim_push();
 361         for (i = 0; i < nodes_len; ++i) {
 362                 ir_node *value = nodes[i];
 363
 364                 /*
 365                  * Search the valid def for each use and set it.
 366                  */
 367                 foreach_out_edge_safe(value, edge, next) {
 368                         ir_node *use = get_edge_src_irn(edge);
 369                         ir_node *at  = use;
 370                         int pos      = get_edge_src_pos(edge);
 371                         ir_node *def;
 372
 373                         if (env->ignore_uses != NULL &&
 374                            ir_nodeset_contains(env->ignore_uses, use))
 375                                 continue;
 376                         if (is_Anchor(use) || is_End(use))
 377                                 continue;
 378
 379                         if (is_Phi(use)) {
 380                                 ir_node *block     = get_nodes_block(use);
 381                                 ir_node *predblock = get_Block_cfgpred_block(block, pos);
 382                                 at = sched_last(predblock);
 383                         }
 384
 385                         def = search_def(env, at);
 386
 387                         if (def == NULL) {
 388                                 panic("no definition found for %+F at position %d", use, pos);
 389                         }
 390
 391                         DBG((dbg, LEVEL_2, "\t%+F(%d) -> %+F\n", use, pos, def));
 392                         set_irn_n(use, pos, def);
 393                         stat_ev_cnt_inc(uses);
 394                 }
 395         }
 396         be_timer_pop(T_SSA_CONSTR);
 397
 398         stat_ev_tim_pop("bessaconstr_fix_time");
 399         stat_ev_cnt_done(uses, "bessaconstr_uses");
 400 }
 401
 402 void be_ssa_construction_fix_users(be_ssa_construction_env_t *env, ir_node *value)
 403 {
 404         be_ssa_construction_fix_users_array(env, &value, 1);
 405 }
 406
 407
 408 void be_ssa_construction_update_liveness_phis(be_ssa_construction_env_t *env,
 409                                               be_lv_t *lv)
 410 {
 411         int i, n;
 412
 413         be_timer_push(T_SSA_CONSTR);
 414
 415         n = ARR_LEN(env->new_phis);
 416         for (i = 0; i < n; ++i) {
 417                 ir_node *phi = env->new_phis[i];
 418                 be_liveness_introduce(lv, phi);
 419         }
 420
 421         be_timer_pop(T_SSA_CONSTR);
 422 }
 423
 424 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_ssaconstr);
 425 void be_init_ssaconstr(void)
 426 {
 427         FIRM_DBG_REGISTER(dbg, "firm.be.ssaconstr");
 428 }