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