nsz Git - libfirm/blob - ir/be/bespill.c

   1 /*
   2  * Author:      Daniel Grund, Sebastian Hack, Matthias Braun
   3  * Date:                29.09.2005
   4  * Copyright:   (c) Universitaet Karlsruhe
   5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
   6  */
   7 #ifdef HAVE_CONFIG_H
   8 #include "config.h"
   9 #endif
  10
  11 #include <stdlib.h>
  12
  13 #include "pset.h"
  14 #include "irnode_t.h"
  15 #include "ircons_t.h"
  16 #include "iredges_t.h"
  17 #include "irprintf.h"
  18 #include "ident_t.h"
  19 #include "type_t.h"
  20 #include "entity_t.h"
  21 #include "debug.h"
  22 #include "irgwalk.h"
  23 #include "array.h"
  24 #include "pdeq.h"
  25 #include "unionfind.h"
  26 #include "execfreq.h"
  27
  28 #include "belive_t.h"
  29 #include "besched_t.h"
  30 #include "bespill.h"
  31 #include "belive_t.h"
  32 #include "benode_t.h"
  33 #include "bechordal_t.h"
  34 #include "bejavacoal.h"
  35
  36 // only rematerialise when costs are less than REMAT_COST_LIMIT
  37 // TODO determine a good value here...
  38 #define REMAT_COST_LIMIT        80
  39
  40 typedef struct _reloader_t reloader_t;
  41
  42 struct _reloader_t {
  43         reloader_t *next;
  44         ir_node *reloader;
  45 };
  46
  47 typedef struct _spill_info_t {
  48         ir_node *spilled_node;
  49         reloader_t *reloaders;
  50
  51         ir_node *spill;
  52 } spill_info_t;
  53
  54 struct _spill_env_t {
  55         const arch_register_class_t *cls;
  56         const arch_env_t *arch_env;
  57         const be_chordal_env_t *chordal_env;
  58         struct obstack obst;
  59         set *spills;                            /**< all spill_info_t's, which must be placed */
  60         pset *mem_phis;                         /**< set of all special spilled phis. allocated and freed separately */
  61
  62         DEBUG_ONLY(firm_dbg_module_t *dbg;)
  63 };
  64
  65 /**
  66  * Compare two spill infos.
  67  */
  68 static int cmp_spillinfo(const void *x, const void *y, size_t size) {
  69         const spill_info_t *xx = x;
  70         const spill_info_t *yy = y;
  71         return xx->spilled_node != yy->spilled_node;
  72 }
  73
  74 /**
  75  * Returns spill info for a specific value (the value that is to be spilled)
  76  */
  77 static spill_info_t *get_spillinfo(const spill_env_t *env, ir_node *value) {
  78         spill_info_t info, *res;
  79         int hash = HASH_PTR(value);
  80
  81         info.spilled_node = value;
  82         res = set_find(env->spills, &info, sizeof(info), hash);
  83
  84         if (res == NULL) {
  85                 info.reloaders = NULL;
  86                 info.spill = NULL;
  87                 res = set_insert(env->spills, &info, sizeof(info), hash);
  88         }
  89
  90         return res;
  91 }
  92
  93 DEBUG_ONLY(
  94 /* Sets the debug module of a spill environment. */
  95 void be_set_spill_env_dbg_module(spill_env_t *env, firm_dbg_module_t *dbg) {
  96         env->dbg = dbg;
  97 }
  98 )
  99
 100 /* Creates a new spill environment. */
 101 spill_env_t *be_new_spill_env(const be_chordal_env_t *chordal_env) {
 102         spill_env_t *env        = xmalloc(sizeof(env[0]));
 103         env->spills                     = new_set(cmp_spillinfo, 1024);
 104         env->cls                        = chordal_env->cls;
 105         env->chordal_env        = chordal_env;
 106         env->arch_env       = env->chordal_env->birg->main_env->arch_env;
 107         env->mem_phis           = pset_new_ptr_default();
 108         obstack_init(&env->obst);
 109         return env;
 110 }
 111
 112 /* Deletes a spill environment. */
 113 void be_delete_spill_env(spill_env_t *env) {
 114         del_set(env->spills);
 115         del_pset(env->mem_phis);
 116         obstack_free(&env->obst, NULL);
 117         free(env);
 118 }
 119
 120 /**
 121  *  ____  _                  ____      _                 _
 122  * |  _ \| | __ _  ___ ___  |  _ \ ___| | ___   __ _  __| |___
 123  * | |_) | |/ _` |/ __/ _ \ | |_) / _ \ |/ _ \ / _` |/ _` / __|
 124  * |  __/| | (_| | (_|  __/ |  _ <  __/ | (_) | (_| | (_| \__ \
 125  * |_|   |_|\__,_|\___\___| |_| \_\___|_|\___/ \__,_|\__,_|___/
 126  *
 127  */
 128
 129 void be_add_reload(spill_env_t *env, ir_node *to_spill, ir_node *before) {
 130         spill_info_t *info;
 131         reloader_t *rel;
 132
 133         assert(sched_is_scheduled(before));
 134         assert(arch_irn_consider_in_reg_alloc(env->arch_env, env->cls, to_spill));
 135
 136         info = get_spillinfo(env, to_spill);
 137
 138         if(is_Phi(to_spill)) {
 139                 int i, arity;
 140                 // create spillinfos for the phi arguments
 141                 for(i = 0, arity = get_irn_arity(to_spill); i < arity; ++i) {
 142                         ir_node *arg = get_irn_n(to_spill, i);
 143                         get_spillinfo(env, arg);
 144                 }
 145         }
 146
 147         rel           = obstack_alloc(&env->obst, sizeof(rel[0]));
 148         rel->reloader = before;
 149         rel->next     = info->reloaders;
 150         info->reloaders = rel;
 151 }
 152
 153 void be_add_reload_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block, int pos) {
 154         ir_node *predblock, *last;
 155
 156         /* simply add the reload to the beginning of the block if we only have 1 predecessor
 157          * (we don't need to check for phis as there can't be any in a block with only 1 pred)
 158          */
 159         if(get_Block_n_cfgpreds(block) == 1) {
 160                 assert(!is_Phi(sched_first(block)));
 161                 be_add_reload(env, to_spill, sched_first(block));
 162                 return;
 163         }
 164
 165         /* We have to reload the value in pred-block */
 166         predblock = get_Block_cfgpred_block(block, pos);
 167         last = sched_last(predblock);
 168
 169         /* we might have projs and keepanys behind the jump... */
 170         while(is_Proj(last) || be_is_Keep(last)) {
 171                 last = sched_prev(last);
 172                 assert(!sched_is_end(last));
 173         }
 174         assert(is_cfop(last));
 175
 176         // add the reload before the (cond-)jump
 177         be_add_reload(env, to_spill, last);
 178 }
 179
 180 void be_spill_phi(spill_env_t *env, ir_node *node) {
 181         int i, arity;
 182
 183         assert(is_Phi(node));
 184
 185         pset_insert_ptr(env->mem_phis, node);
 186
 187         // create spillinfos for the phi arguments
 188         get_spillinfo(env, node);
 189         for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
 190                 ir_node *arg = get_irn_n(node, i);
 191                 get_spillinfo(env, arg);
 192         }
 193 }
 194
 195 /*
 196  *   ____                _         ____        _ _ _
 197  *  / ___|_ __ ___  __ _| |_ ___  / ___| _ __ (_) | |___
 198  * | |   | '__/ _ \/ _` | __/ _ \ \___ \| '_ \| | | / __|
 199  * | |___| | |  __/ (_| | ||  __/  ___) | |_) | | | \__ \
 200  *  \____|_|  \___|\__,_|\__\___| |____/| .__/|_|_|_|___/
 201  *                                      |_|
 202  */
 203
 204 /**
 205  * Schedules a node after an instruction. (That is the place after all projs and phis
 206  * that are scheduled after the instruction)
 207  * This function also skips phi nodes at the beginning of a block
 208  */
 209 static void sched_add_after_insn(ir_node *sched_after, ir_node *node) {
 210         ir_node *next = sched_next(sched_after);
 211         while(is_Proj(next) || is_Phi(next)) {
 212                 next = sched_next(next);
 213         }
 214         assert(next != NULL);
 215
 216         if(sched_is_end(next)) {
 217                 sched_add_after(sched_last(get_nodes_block(sched_after)), node);
 218         } else {
 219                 sched_add_before(next, node);
 220         }
 221 }
 222
 223 /**
 224  * Creates a spill.
 225  *
 226  * @param senv      the spill environment
 227  * @param irn       the node that should be spilled
 228  * @param ctx_irn   an user of the spilled node
 229  *
 230  * @return a be_Spill node
 231  */
 232 static void spill_irn(spill_env_t *env, spill_info_t *spillinfo) {
 233         ir_node *to_spill = spillinfo->spilled_node;
 234
 235         DBG((env->dbg, LEVEL_1, "%+F\n", to_spill));
 236
 237         /* Trying to spill an already spilled value, no need for a new spill
 238          * node then, we can simply connect to the same one for this reload
 239          *
 240          * (although rematerialization code should handle most of these cases
 241          * this can still happen when spilling Phis)
 242          */
 243         if(be_is_Reload(to_spill)) {
 244                 spillinfo->spill = get_irn_n(to_spill, be_pos_Reload_mem);
 245                 return;
 246         }
 247
 248         if (arch_irn_is(env->arch_env, to_spill, dont_spill)) {
 249                 if (env->chordal_env->opts->vrfy_option == BE_CH_VRFY_WARN)
 250                         ir_fprintf(stderr, "Verify warning: spilling 'dont_spill' node %+F\n", to_spill);
 251                 else if (env->chordal_env->opts->vrfy_option == BE_CH_VRFY_ASSERT)
 252                         assert(0 && "Attempt to spill a node marked 'dont_spill'");
 253         }
 254
 255         spillinfo->spill = be_spill(env->arch_env, to_spill);
 256         sched_add_after_insn(to_spill, spillinfo->spill);
 257 }
 258
 259 static void spill_node(spill_env_t *env, spill_info_t *spillinfo);
 260
 261 /**
 262  * If the first usage of a Phi result would be out of memory
 263  * there is no sense in allocating a register for it.
 264  * Thus we spill it and all its operands to the same spill slot.
 265  * Therefore the phi/dataB becomes a phi/Memory
 266  *
 267  * @param senv      the spill environment
 268  * @param phi       the Phi node that should be spilled
 269  * @param ctx_irn   an user of the spilled node
 270  */
 271 static void spill_phi(spill_env_t *env, spill_info_t *spillinfo) {
 272         ir_node *phi = spillinfo->spilled_node;
 273         int i;
 274         int arity = get_irn_arity(phi);
 275         ir_node     *block    = get_nodes_block(phi);
 276         ir_node     **ins;
 277
 278         assert(is_Phi(phi));
 279
 280         /* build a new PhiM */
 281         ins = alloca(sizeof(ir_node*) * arity);
 282         for(i = 0; i < arity; ++i) {
 283                 ins[i] = get_irg_bad(env->chordal_env->irg);
 284         }
 285         spillinfo->spill = new_r_Phi(env->chordal_env->irg, block, arity, ins, mode_M);
 286
 287         for(i = 0; i < arity; ++i) {
 288                 ir_node *arg = get_irn_n(phi, i);
 289                 spill_info_t *arg_info = get_spillinfo(env, arg);
 290
 291                 spill_node(env, arg_info);
 292
 293                 set_irn_n(spillinfo->spill, i, arg_info->spill);
 294         }
 295 }
 296
 297 /**
 298  * Spill a node.
 299  *
 300  * @param senv      the spill environment
 301  * @param to_spill  the node that should be spilled
 302  */
 303 static void spill_node(spill_env_t *env, spill_info_t *spillinfo) {
 304         ir_node *to_spill;
 305
 306         // the node should be tagged for spilling already...
 307         if(spillinfo->spill != NULL)
 308                 return;
 309
 310         to_spill = spillinfo->spilled_node;
 311         if (is_Phi(to_spill) && pset_find_ptr(env->mem_phis, spillinfo->spilled_node)) {
 312                 spill_phi(env, spillinfo);
 313         } else {
 314                 spill_irn(env, spillinfo);
 315         }
 316 }
 317
 318 /*
 319  *
 320  *  ____                      _            _       _ _
 321  * |  _ \ ___ _ __ ___   __ _| |_ ___ _ __(_) __ _| (_)_______
 322  * | |_) / _ \ '_ ` _ \ / _` | __/ _ \ '__| |/ _` | | |_  / _ \
 323  * |  _ <  __/ | | | | | (_| | ||  __/ |  | | (_| | | |/ /  __/
 324  * |_| \_\___|_| |_| |_|\__,_|\__\___|_|  |_|\__,_|_|_/___\___|
 325  *
 326  */
 327
 328 /**
 329  * Tests whether value @p arg is available before node @p reloader
 330  * @returns 1 if value is available, 0 otherwise
 331  */
 332 static int is_value_available(spill_env_t *env, ir_node *arg, ir_node *reloader) {
 333         if(is_Unknown(arg) || arg == new_NoMem())
 334                 return 1;
 335
 336         if(be_is_Spill(arg))
 337                 return 1;
 338
 339         if(arg == get_irg_frame(env->chordal_env->irg))
 340                 return 1;
 341
 342         /* the following test does not work while spilling,
 343          * because the liveness info is not adapted yet to the effects of the
 344          * additional spills/reloads.
 345          *
 346          * So we can only do this test for ignore registers (of our register class)
 347          */
 348         if(arch_get_irn_reg_class(env->arch_env, arg, -1) == env->chordal_env->cls
 349            && arch_irn_is(env->arch_env, arg, ignore)) {
 350                 int i, arity;
 351
 352                 /* we want to remat before the insn reloader
 353                  * thus an arguments is alive if
 354                  *   - it interferes with the reloaders result
 355                  *   - or it is (last-) used by reloader itself
 356                  */
 357                 if (values_interfere(env->chordal_env->lv, reloader, arg)) {
 358                         return 1;
 359                 }
 360
 361                 arity = get_irn_arity(reloader);
 362                 for (i = 0; i < arity; ++i) {
 363                         ir_node *rel_arg = get_irn_n(reloader, i);
 364                         if (rel_arg == arg)
 365                                 return 1;
 366                 }
 367         }
 368
 369         return 0;
 370 }
 371
 372 /**
 373  * Checks whether the node can principally be rematerialized
 374  */
 375 static int is_remat_node(spill_env_t *env, ir_node *node) {
 376         const arch_env_t *arch_env = env->arch_env;
 377
 378         assert(!be_is_Spill(node));
 379
 380         if(be_is_Reload(node))
 381                 return 1;
 382
 383         // TODO why does arch_irn_is say rematerializable anyway?
 384         if(be_is_Barrier(node))
 385                 return 0;
 386
 387         if(arch_irn_is(arch_env, node, rematerializable))
 388                 return 1;
 389
 390         if(be_is_StackParam(node))
 391                 return 1;
 392
 393         return 0;
 394 }
 395
 396 /**
 397  * Check if a node is rematerializable. This tests for the following conditions:
 398  *
 399  * - The node itself is rematerializable
 400  * - All arguments of the node are available or also rematerialisable
 401  * - The costs for the rematerialisation operation is less or equal a limit
 402  *
 403  * Returns the costs needed for rematerialisation or something
 404  * > REMAT_COST_LIMIT if remat is not possible.
 405  */
 406 static int check_remat_conditions_costs(spill_env_t *env, ir_node *spilled, ir_node *reloader, int parentcosts) {
 407         int i, arity;
 408         int argremats;
 409         int costs = 0;
 410
 411         if(!is_remat_node(env, spilled))
 412                 return REMAT_COST_LIMIT;
 413
 414         if(be_is_Reload(spilled)) {
 415                 costs += 2;
 416         } else {
 417                 costs += arch_get_op_estimated_cost(env->arch_env, spilled);
 418         }
 419         if(parentcosts + costs >= REMAT_COST_LIMIT)
 420                 return REMAT_COST_LIMIT;
 421
 422         argremats = 0;
 423         for(i = 0, arity = get_irn_arity(spilled); i < arity; ++i) {
 424                 ir_node *arg = get_irn_n(spilled, i);
 425
 426                 if(is_value_available(env, arg, reloader))
 427                         continue;
 428
 429                 // we have to rematerialize the argument as well...
 430                 if(argremats >= 1) {
 431                         /* we only support rematerializing 1 argument at the moment,
 432                          * so that we don't have to care about register pressure
 433                          */
 434                         return REMAT_COST_LIMIT;
 435                 }
 436                 argremats++;
 437
 438                 // TODO can we get more accurate costs than +1?
 439                 costs += check_remat_conditions_costs(env, arg, reloader, parentcosts + costs);
 440                 if(parentcosts + costs >= REMAT_COST_LIMIT)
 441                         return REMAT_COST_LIMIT;
 442         }
 443
 444         return costs;
 445 }
 446
 447 static int check_remat_conditions(spill_env_t *env, ir_node *spilled, ir_node *reloader) {
 448         int costs = check_remat_conditions_costs(env, spilled, reloader, 1);
 449
 450         return costs < REMAT_COST_LIMIT;
 451 }
 452
 453 /**
 454  * Re-materialize a node.
 455  *
 456  * @param senv      the spill environment
 457  * @param spilled   the node that was spilled
 458  * @param reloader  a irn that requires a reload
 459  */
 460 static ir_node *do_remat(spill_env_t *env, ir_node *spilled, ir_node *reloader) {
 461         int i, arity;
 462         ir_node *res;
 463         ir_node *bl = get_nodes_block(reloader);
 464         ir_node **ins;
 465
 466         ins = alloca(get_irn_arity(spilled) * sizeof(ins[0]));
 467         for(i = 0, arity = get_irn_arity(spilled); i < arity; ++i) {
 468                 ir_node *arg = get_irn_n(spilled, i);
 469
 470                 if(is_value_available(env, arg, reloader)) {
 471                         ins[i] = arg;
 472                 } else {
 473                         ins[i] = do_remat(env, arg, reloader);
 474                 }
 475         }
 476
 477         /* create a copy of the node */
 478         res = new_ir_node(get_irn_dbg_info(spilled), env->chordal_env->irg, bl,
 479                 get_irn_op(spilled),
 480                 get_irn_mode(spilled),
 481                 get_irn_arity(spilled),
 482                 ins);
 483         copy_node_attr(spilled, res);
 484
 485         DBG((env->dbg, LEVEL_1, "Insert remat %+F before reloader %+F\n", res, reloader));
 486
 487         /* insert in schedule */
 488         assert(!is_Block(reloader));
 489         sched_add_before(reloader, res);
 490
 491         return res;
 492 }
 493
 494 /*
 495  *  ___                     _     ____      _                 _
 496  * |_ _|_ __  ___  ___ _ __| |_  |  _ \ ___| | ___   __ _  __| |___
 497  *  | || '_ \/ __|/ _ \ '__| __| | |_) / _ \ |/ _ \ / _` |/ _` / __|
 498  *  | || | | \__ \  __/ |  | |_  |  _ <  __/ | (_) | (_| | (_| \__ \
 499  * |___|_| |_|___/\___|_|   \__| |_| \_\___|_|\___/ \__,_|\__,_|___/
 500  *
 501  */
 502
 503 void be_insert_spills_reloads(spill_env_t *env) {
 504         const arch_env_t *arch_env = env->arch_env;
 505         spill_info_t *si;
 506
 507         /* process each spilled node */
 508         DBG((env->dbg, LEVEL_1, "Insert spills and reloads:\n"));
 509         for(si = set_first(env->spills); si; si = set_next(env->spills)) {
 510                 reloader_t *rld;
 511                 ir_mode *mode = get_irn_mode(si->spilled_node);
 512                 pset *values = pset_new_ptr(16);
 513
 514                 /* go through all reloads for this spill */
 515                 for(rld = si->reloaders; rld; rld = rld->next) {
 516                         ir_node *new_val;
 517
 518                         if (check_remat_conditions(env, si->spilled_node, rld->reloader)) {
 519                                 new_val = do_remat(env, si->spilled_node, rld->reloader);
 520                         } else {
 521                                 /* make sure we have a spill */
 522                                 spill_node(env, si);
 523
 524                                 /* do a reload */
 525                                 new_val = be_reload(arch_env, env->cls, rld->reloader, mode, si->spill);
 526                         }
 527
 528                         DBG((env->dbg, LEVEL_1, " %+F of %+F before %+F\n", new_val, si->spilled_node, rld->reloader));
 529                         pset_insert_ptr(values, new_val);
 530                 }
 531
 532                 if(pset_count(values) > 0) {
 533                         /* introduce copies, rewire the uses */
 534                         pset_insert_ptr(values, si->spilled_node);
 535                         be_ssa_constr_set_ignore(env->chordal_env->dom_front, env->chordal_env->lv, values, env->mem_phis);
 536                 }
 537
 538                 del_pset(values);
 539         }
 540
 541         // reloads are placed now, but we might reuse the spill environment for further spilling decisions
 542         del_set(env->spills);
 543         env->spills = new_set(cmp_spillinfo, 1024);
 544
 545         be_remove_dead_nodes_from_schedule(env->chordal_env->irg);
 546         //be_liveness_add_missing(env->chordal_env->lv);
 547         be_liveness_recompute(env->chordal_env->lv);
 548 }