2 * Author: Daniel Grund, Sebastian Hack, Matthias Braun
4 * Copyright: (c) Universitaet Karlsruhe
5 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 #include "iredges_t.h"
17 #include "irbackedge_t.h"
26 #include "unionfind.h"
30 #include "besched_t.h"
34 #include "bechordal_t.h"
35 #include "bejavacoal.h"
36 #include "benodesets.h"
37 #include "bespilloptions.h"
38 #include "bestatevent.h"
40 // only rematerialise when costs are less than REMAT_COST_LIMIT
41 // TODO determine a good value here...
42 #define REMAT_COST_LIMIT 10
44 typedef struct _reloader_t reloader_t;
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;
57 /** the spill node, or a PhiM node */
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 */
65 const arch_register_class_t *cls;
66 const arch_env_t *arch_env;
67 const be_chordal_env_t *chordal_env;
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 */
74 DEBUG_ONLY(firm_dbg_module_t *dbg;)
78 * Compare two spill infos.
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;
87 * Returns spill info for a specific value (returns NULL if the info doesn't
90 static spill_info_t *find_spillinfo(const spill_env_t *env, ir_node *value) {
92 int hash = nodeset_hash(value);
94 info.spilled_node = value;
96 return set_find(env->spills, &info, sizeof(info), hash);
100 * Returns spill info for a specific value (the value that is to be spilled)
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);
106 info.spilled_node = value;
107 res = set_find(env->spills, &info, sizeof(info), hash);
110 info.reloaders = NULL;
112 info.old_spill = NULL;
113 res = set_insert(env->spills, &info, sizeof(info), hash);
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) {
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...
136 env->reload_cost = 5;
137 obstack_init(&env->obst);
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);
151 * | _ \| | __ _ ___ ___ | _ \ ___| | ___ __ _ __| |___
152 * | |_) | |/ _` |/ __/ _ \ | |_) / _ \ |/ _ \ / _` |/ _` / __|
153 * | __/| | (_| | (_| __/ | _ < __/ | (_) | (_| | (_| \__ \
154 * |_| |_|\__,_|\___\___| |_| \_\___|_|\___/ \__,_|\__,_|___/
158 void be_add_reload(spill_env_t *env, ir_node *to_spill, ir_node *before) {
162 assert(sched_is_scheduled(before));
163 assert(arch_irn_consider_in_reg_alloc(env->arch_env, env->cls, to_spill));
165 info = get_spillinfo(env, to_spill);
167 if(is_Phi(to_spill)) {
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);
176 rel = obstack_alloc(&env->obst, sizeof(rel[0]));
177 rel->reloader = before;
178 rel->next = info->reloaders;
179 info->reloaders = rel;
182 static ir_node *get_reload_insertion_point(ir_node *block, int pos) {
183 ir_node *predblock, *last;
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)
188 if(get_Block_n_cfgpreds(block) == 1) {
189 assert(!is_Phi(sched_first(block)));
190 return sched_first(block);
193 /* We have to reload the value in pred-block */
194 predblock = get_Block_cfgpred_block(block, pos);
195 last = sched_last(predblock);
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));
204 ir_graph *irg = get_irn_irg(block);
205 ir_node *startblock = get_irg_start_block(irg);
207 // last node must be a cfop, only exception is the start block
208 assert(last == startblock);
211 // add the reload before the (cond-)jump
215 void be_add_reload_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block, int pos) {
216 ir_node *before = get_reload_insertion_point(block, pos);
217 be_add_reload(env, to_spill, before);
220 void be_spill_phi(spill_env_t *env, ir_node *node) {
224 assert(is_Phi(node));
226 pset_insert_ptr(env->mem_phis, node);
228 // create spillinfos for the phi arguments
229 spill = get_spillinfo(env, node);
230 for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
231 ir_node *arg = get_irn_n(node, i);
232 get_spillinfo(env, arg);
235 // if we had a spill for the phi value before, then remove this spill from
236 // schedule, as we will remove it in the insert spill/reload phase
237 if(spill->spill != NULL && !is_Phi(spill->spill)) {
238 spill->old_spill = spill->spill;
245 * / ___|_ __ ___ __ _| |_ ___ / ___| _ __ (_) | |___
246 * | | | '__/ _ \/ _` | __/ _ \ \___ \| '_ \| | | / __|
247 * | |___| | | __/ (_| | || __/ ___) | |_) | | | \__ \
248 * \____|_| \___|\__,_|\__\___| |____/| .__/|_|_|_|___/
253 * Schedules a node after an instruction. (That is the place after all projs and phis
254 * that are scheduled after the instruction)
255 * This function also skips phi nodes at the beginning of a block
257 static void sched_add_after_insn(ir_node *sched_after, ir_node *node) {
258 ir_node *next = sched_next(sched_after);
259 while(is_Proj(next) || is_Phi(next)) {
260 next = sched_next(next);
262 assert(next != NULL);
264 if(sched_is_end(next)) {
265 sched_add_after(sched_last(get_nodes_block(sched_after)), node);
267 sched_add_before(next, node);
274 * @param senv the spill environment
275 * @param irn the node that should be spilled
276 * @param ctx_irn an user of the spilled node
278 * @return a be_Spill node
280 static void spill_irn(spill_env_t *env, spill_info_t *spillinfo) {
281 ir_node *to_spill = spillinfo->spilled_node;
283 DBG((env->dbg, LEVEL_1, "%+F\n", to_spill));
285 /* Trying to spill an already spilled value, no need for a new spill
286 * node then, we can simply connect to the same one for this reload
288 * (although rematerialization code should handle most of these cases
289 * this can still happen when spilling Phis)
291 if(be_is_Reload(to_spill)) {
292 spillinfo->spill = get_irn_n(to_spill, be_pos_Reload_mem);
296 if (arch_irn_is(env->arch_env, to_spill, dont_spill)) {
297 if (env->chordal_env->opts->vrfy_option == BE_CH_VRFY_WARN)
298 ir_fprintf(stderr, "Verify warning: spilling 'dont_spill' node %+F\n", to_spill);
299 else if (env->chordal_env->opts->vrfy_option == BE_CH_VRFY_ASSERT)
300 assert(0 && "Attempt to spill a node marked 'dont_spill'");
303 spillinfo->spill = be_spill(env->arch_env, to_spill);
304 sched_add_after_insn(to_spill, spillinfo->spill);
307 static void spill_node(spill_env_t *env, spill_info_t *spillinfo);
310 * If the first usage of a Phi result would be out of memory
311 * there is no sense in allocating a register for it.
312 * Thus we spill it and all its operands to the same spill slot.
313 * Therefore the phi/dataB becomes a phi/Memory
315 * @param senv the spill environment
316 * @param phi the Phi node that should be spilled
317 * @param ctx_irn an user of the spilled node
319 static void spill_phi(spill_env_t *env, spill_info_t *spillinfo) {
320 ir_node *phi = spillinfo->spilled_node;
322 int arity = get_irn_arity(phi);
323 ir_node *block = get_nodes_block(phi);
328 /* build a new PhiM */
329 ins = alloca(sizeof(ir_node*) * arity);
330 for(i = 0; i < arity; ++i) {
331 ins[i] = get_irg_bad(env->chordal_env->irg);
333 spillinfo->spill = new_r_Phi(env->chordal_env->irg, block, arity, ins, mode_M);
335 for(i = 0; i < arity; ++i) {
336 ir_node *arg = get_irn_n(phi, i);
337 spill_info_t *arg_info = get_spillinfo(env, arg);
339 spill_node(env, arg_info);
341 set_irn_n(spillinfo->spill, i, arg_info->spill);
344 // rewire reloads from old_spill to phi
345 if(spillinfo->old_spill != NULL) {
346 const ir_edge_t *edge, *next;
347 foreach_out_edge_safe(spillinfo->old_spill, edge, next) {
348 ir_node* reload = get_edge_src_irn(edge);
349 assert(be_is_Reload(reload) || is_Phi(reload));
350 set_irn_n(reload, get_edge_src_pos(edge), spillinfo->spill);
352 spillinfo->old_spill = NULL;
359 * @param senv the spill environment
360 * @param to_spill the node that should be spilled
362 static void spill_node(spill_env_t *env, spill_info_t *spillinfo) {
365 // the node should be tagged for spilling already...
366 if(spillinfo->spill != NULL)
369 to_spill = spillinfo->spilled_node;
370 if (is_Phi(to_spill) && pset_find_ptr(env->mem_phis, spillinfo->spilled_node)) {
371 spill_phi(env, spillinfo);
373 spill_irn(env, spillinfo);
380 * | _ \ ___ _ __ ___ __ _| |_ ___ _ __(_) __ _| (_)_______
381 * | |_) / _ \ '_ ` _ \ / _` | __/ _ \ '__| |/ _` | | |_ / _ \
382 * | _ < __/ | | | | | (_| | || __/ | | | (_| | | |/ / __/
383 * |_| \_\___|_| |_| |_|\__,_|\__\___|_| |_|\__,_|_|_/___\___|
388 * Tests whether value @p arg is available before node @p reloader
389 * @returns 1 if value is available, 0 otherwise
391 static int is_value_available(spill_env_t *env, ir_node *arg, ir_node *reloader) {
392 if(is_Unknown(arg) || arg == new_NoMem())
398 if(arg == get_irg_frame(env->chordal_env->irg))
401 /* the following test does not work while spilling,
402 * because the liveness info is not adapted yet to the effects of the
403 * additional spills/reloads.
405 * So we can only do this test for ignore registers (of our register class)
407 if(arch_get_irn_reg_class(env->arch_env, arg, -1) == env->chordal_env->cls
408 && arch_irn_is(env->arch_env, arg, ignore)) {
411 /* we want to remat before the insn reloader
412 * thus an arguments is alive if
413 * - it interferes with the reloaders result
414 * - or it is (last-) used by reloader itself
416 if (values_interfere(env->chordal_env->lv, reloader, arg)) {
420 arity = get_irn_arity(reloader);
421 for (i = 0; i < arity; ++i) {
422 ir_node *rel_arg = get_irn_n(reloader, i);
432 * Checks whether the node can principally be rematerialized
434 static int is_remat_node(spill_env_t *env, ir_node *node) {
435 const arch_env_t *arch_env = env->arch_env;
437 assert(!be_is_Spill(node));
439 if(arch_irn_is(arch_env, node, rematerializable)) {
443 if(be_is_StackParam(node))
450 * Check if a node is rematerializable. This tests for the following conditions:
452 * - The node itself is rematerializable
453 * - All arguments of the node are available or also rematerialisable
454 * - The costs for the rematerialisation operation is less or equal a limit
456 * Returns the costs needed for rematerialisation or something
457 * > REMAT_COST_LIMIT if remat is not possible.
459 static int check_remat_conditions_costs(spill_env_t *env, ir_node *spilled, ir_node *reloader, int parentcosts) {
464 if(!is_remat_node(env, spilled))
465 return REMAT_COST_LIMIT;
467 if(be_is_Reload(spilled)) {
470 costs += arch_get_op_estimated_cost(env->arch_env, spilled);
472 if(parentcosts + costs >= REMAT_COST_LIMIT) {
473 return REMAT_COST_LIMIT;
477 for(i = 0, arity = get_irn_arity(spilled); i < arity; ++i) {
478 ir_node *arg = get_irn_n(spilled, i);
480 if(is_value_available(env, arg, reloader))
483 // we have to rematerialize the argument as well...
485 /* we only support rematerializing 1 argument at the moment,
486 * so that we don't have to care about register pressure
488 return REMAT_COST_LIMIT;
492 costs += check_remat_conditions_costs(env, arg, reloader, parentcosts + costs);
493 if(parentcosts + costs >= REMAT_COST_LIMIT)
494 return REMAT_COST_LIMIT;
500 static int check_remat_conditions(spill_env_t *env, ir_node *spilled, ir_node *reloader) {
501 int costs = check_remat_conditions_costs(env, spilled, reloader, 0);
503 return costs < REMAT_COST_LIMIT;
507 * Re-materialize a node.
509 * @param senv the spill environment
510 * @param spilled the node that was spilled
511 * @param reloader a irn that requires a reload
513 static ir_node *do_remat(spill_env_t *env, ir_node *spilled, ir_node *reloader) {
516 ir_node *bl = get_nodes_block(reloader);
519 ins = alloca(get_irn_arity(spilled) * sizeof(ins[0]));
520 for(i = 0, arity = get_irn_arity(spilled); i < arity; ++i) {
521 ir_node *arg = get_irn_n(spilled, i);
523 if(is_value_available(env, arg, reloader)) {
526 ins[i] = do_remat(env, arg, reloader);
530 /* create a copy of the node */
531 res = new_ir_node(get_irn_dbg_info(spilled), env->chordal_env->irg, bl,
533 get_irn_mode(spilled),
534 get_irn_arity(spilled),
536 copy_node_attr(spilled, res);
537 new_backedge_info(res);
539 DBG((env->dbg, LEVEL_1, "Insert remat %+F before reloader %+F\n", res, reloader));
541 /* insert in schedule */
542 assert(!is_Block(reloader));
543 sched_add_before(reloader, res);
548 int be_get_reload_costs(spill_env_t *env, ir_node *to_spill, ir_node *before) {
549 spill_info_t *spill_info;
552 // is the node rematerializable?
553 int costs = check_remat_conditions_costs(env, to_spill, before, 0);
554 if(costs < REMAT_COST_LIMIT)
558 // do we already have a spill?
559 spill_info = find_spillinfo(env, to_spill);
560 if(spill_info != NULL && spill_info->spill != NULL)
561 return env->reload_cost;
563 return env->spill_cost + env->reload_cost;
566 int be_get_reload_costs_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block, int pos) {
567 ir_node *before = get_reload_insertion_point(block, pos);
568 return be_get_reload_costs(env, to_spill, before);
573 * |_ _|_ __ ___ ___ _ __| |_ | _ \ ___| | ___ __ _ __| |___
574 * | || '_ \/ __|/ _ \ '__| __| | |_) / _ \ |/ _ \ / _` |/ _` / __|
575 * | || | | \__ \ __/ | | |_ | _ < __/ | (_) | (_| | (_| \__ \
576 * |___|_| |_|___/\___|_| \__| |_| \_\___|_|\___/ \__,_|\__,_|___/
580 void be_insert_spills_reloads(spill_env_t *env) {
581 const arch_env_t *arch_env = env->arch_env;
587 /* process each spilled node */
588 for(si = set_first(env->spills); si; si = set_next(env->spills)) {
590 ir_mode *mode = get_irn_mode(si->spilled_node);
591 pset *values = pset_new_ptr(16);
593 /* go through all reloads for this spill */
594 for(rld = si->reloaders; rld; rld = rld->next) {
597 if (be_do_remats && check_remat_conditions(env, si->spilled_node, rld->reloader)) {
598 new_val = do_remat(env, si->spilled_node, rld->reloader);
601 /* make sure we have a spill */
602 if(si->spill == NULL) {
607 /* create a reload */
608 new_val = be_reload(arch_env, env->cls, rld->reloader, mode, si->spill);
612 DBG((env->dbg, LEVEL_1, " %+F of %+F before %+F\n", new_val, si->spilled_node, rld->reloader));
613 pset_insert_ptr(values, new_val);
616 if(pset_count(values) > 0) {
617 /* introduce copies, rewire the uses */
618 pset_insert_ptr(values, si->spilled_node);
619 be_ssa_constr_set_ignore(env->chordal_env->dom_front, env->chordal_env->lv, values, env->mem_phis);
624 si->reloaders = NULL;
627 if(be_stat_ev_is_active()) {
628 be_stat_ev("spill_spills", spills);
629 be_stat_ev("spill_reloads", reloads);
630 be_stat_ev("spill_remats", remats);
633 be_remove_dead_nodes_from_schedule(env->chordal_env->irg);
634 be_liveness_recompute(env->chordal_env->lv);