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"
25 #include "unionfind.h"
29 #include "besched_t.h"
33 #include "bechordal_t.h"
34 #include "bejavacoal.h"
36 // only rematerialise when costs are less than REMAT_COST_LIMIT
37 // TODO determine a good value here...
38 #define REMAT_COST_LIMIT 80
40 typedef struct _reloader_t reloader_t;
47 typedef struct _spill_info_t {
48 ir_node *spilled_node;
49 reloader_t *reloaders;
55 const arch_register_class_t *cls;
56 const arch_env_t *arch_env;
57 const be_chordal_env_t *chordal_env;
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 */
62 DEBUG_ONLY(firm_dbg_module_t *dbg;)
66 * Compare two spill infos.
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;
75 * Returns spill info for a specific value (the value that is to be spilled)
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);
81 info.spilled_node = value;
82 res = set_find(env->spills, &info, sizeof(info), hash);
85 info.reloaders = NULL;
87 res = set_insert(env->spills, &info, sizeof(info), hash);
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) {
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);
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);
122 * | _ \| | __ _ ___ ___ | _ \ ___| | ___ __ _ __| |___
123 * | |_) | |/ _` |/ __/ _ \ | |_) / _ \ |/ _ \ / _` |/ _` / __|
124 * | __/| | (_| | (_| __/ | _ < __/ | (_) | (_| | (_| \__ \
125 * |_| |_|\__,_|\___\___| |_| \_\___|_|\___/ \__,_|\__,_|___/
129 void be_add_reload(spill_env_t *env, ir_node *to_spill, ir_node *before) {
133 assert(sched_is_scheduled(before));
134 assert(arch_irn_consider_in_reg_alloc(env->arch_env, env->cls, to_spill));
136 info = get_spillinfo(env, to_spill);
138 if(is_Phi(to_spill)) {
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);
147 rel = obstack_alloc(&env->obst, sizeof(rel[0]));
148 rel->reloader = before;
149 rel->next = info->reloaders;
150 info->reloaders = rel;
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;
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)
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));
165 /* We have to reload the value in pred-block */
166 predblock = get_Block_cfgpred_block(block, pos);
167 last = sched_last(predblock);
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));
174 assert(is_cfop(last));
176 // add the reload before the (cond-)jump
177 be_add_reload(env, to_spill, last);
180 void be_spill_phi(spill_env_t *env, ir_node *node) {
183 assert(is_Phi(node));
185 pset_insert_ptr(env->mem_phis, node);
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);
197 * / ___|_ __ ___ __ _| |_ ___ / ___| _ __ (_) | |___
198 * | | | '__/ _ \/ _` | __/ _ \ \___ \| '_ \| | | / __|
199 * | |___| | | __/ (_| | || __/ ___) | |_) | | | \__ \
200 * \____|_| \___|\__,_|\__\___| |____/| .__/|_|_|_|___/
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
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);
214 assert(next != NULL);
216 if(sched_is_end(next)) {
217 sched_add_after(sched_last(get_nodes_block(sched_after)), node);
219 sched_add_before(next, node);
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
230 * @return a be_Spill node
232 static void spill_irn(spill_env_t *env, spill_info_t *spillinfo) {
233 ir_node *to_spill = spillinfo->spilled_node;
235 DBG((env->dbg, LEVEL_1, "%+F\n", to_spill));
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
240 * (although rematerialization code should handle most of these cases
241 * this can still happen when spilling Phis)
243 if(be_is_Reload(to_spill)) {
244 spillinfo->spill = get_irn_n(to_spill, be_pos_Reload_mem);
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'");
255 spillinfo->spill = be_spill(env->arch_env, to_spill);
256 sched_add_after_insn(to_spill, spillinfo->spill);
259 static void spill_node(spill_env_t *env, spill_info_t *spillinfo);
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
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
271 static void spill_phi(spill_env_t *env, spill_info_t *spillinfo) {
272 ir_node *phi = spillinfo->spilled_node;
274 int arity = get_irn_arity(phi);
275 ir_node *block = get_nodes_block(phi);
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);
285 spillinfo->spill = new_r_Phi(env->chordal_env->irg, block, arity, ins, mode_M);
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);
291 spill_node(env, arg_info);
293 set_irn_n(spillinfo->spill, i, arg_info->spill);
300 * @param senv the spill environment
301 * @param to_spill the node that should be spilled
303 static void spill_node(spill_env_t *env, spill_info_t *spillinfo) {
306 // the node should be tagged for spilling already...
307 if(spillinfo->spill != NULL)
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);
314 spill_irn(env, spillinfo);
321 * | _ \ ___ _ __ ___ __ _| |_ ___ _ __(_) __ _| (_)_______
322 * | |_) / _ \ '_ ` _ \ / _` | __/ _ \ '__| |/ _` | | |_ / _ \
323 * | _ < __/ | | | | | (_| | || __/ | | | (_| | | |/ / __/
324 * |_| \_\___|_| |_| |_|\__,_|\__\___|_| |_|\__,_|_|_/___\___|
329 * Tests whether value @p arg is available before node @p reloader
330 * @returns 1 if value is available, 0 otherwise
332 static int is_value_available(spill_env_t *env, ir_node *arg, ir_node *reloader) {
333 if(is_Unknown(arg) || arg == new_NoMem())
339 if(arg == get_irg_frame(env->chordal_env->irg))
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.
346 * So we can only do this test for ignore registers (of our register class)
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)) {
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
357 if (values_interfere(env->chordal_env->lv, reloader, arg)) {
361 arity = get_irn_arity(reloader);
362 for (i = 0; i < arity; ++i) {
363 ir_node *rel_arg = get_irn_n(reloader, i);
373 * Checks whether the node can principally be rematerialized
375 static int is_remat_node(spill_env_t *env, ir_node *node) {
376 const arch_env_t *arch_env = env->arch_env;
378 assert(!be_is_Spill(node));
380 if(be_is_Reload(node))
383 // TODO why does arch_irn_is say rematerializable anyway?
384 if(be_is_Barrier(node))
387 if(arch_irn_is(arch_env, node, rematerializable))
390 if(be_is_StackParam(node))
397 * Check if a node is rematerializable. This tests for the following conditions:
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
403 * Returns the costs needed for rematerialisation or something
404 * > REMAT_COST_LIMIT if remat is not possible.
406 static int check_remat_conditions_costs(spill_env_t *env, ir_node *spilled, ir_node *reloader, int parentcosts) {
411 if(!is_remat_node(env, spilled))
412 return REMAT_COST_LIMIT;
414 if(be_is_Reload(spilled)) {
417 costs += arch_get_op_estimated_cost(env->arch_env, spilled);
419 if(parentcosts + costs >= REMAT_COST_LIMIT)
420 return REMAT_COST_LIMIT;
423 for(i = 0, arity = get_irn_arity(spilled); i < arity; ++i) {
424 ir_node *arg = get_irn_n(spilled, i);
426 if(is_value_available(env, arg, reloader))
429 // we have to rematerialize the argument as well...
431 /* we only support rematerializing 1 argument at the moment,
432 * so that we don't have to care about register pressure
434 return REMAT_COST_LIMIT;
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;
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);
450 return costs < REMAT_COST_LIMIT;
454 * Re-materialize a node.
456 * @param senv the spill environment
457 * @param spilled the node that was spilled
458 * @param reloader a irn that requires a reload
460 static ir_node *do_remat(spill_env_t *env, ir_node *spilled, ir_node *reloader) {
463 ir_node *bl = get_nodes_block(reloader);
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);
470 if(is_value_available(env, arg, reloader)) {
473 ins[i] = do_remat(env, arg, reloader);
477 /* create a copy of the node */
478 res = new_ir_node(get_irn_dbg_info(spilled), env->chordal_env->irg, bl,
480 get_irn_mode(spilled),
481 get_irn_arity(spilled),
483 copy_node_attr(spilled, res);
485 DBG((env->dbg, LEVEL_1, "Insert remat %+F before reloader %+F\n", res, reloader));
487 /* insert in schedule */
488 assert(!is_Block(reloader));
489 sched_add_before(reloader, res);
496 * |_ _|_ __ ___ ___ _ __| |_ | _ \ ___| | ___ __ _ __| |___
497 * | || '_ \/ __|/ _ \ '__| __| | |_) / _ \ |/ _ \ / _` |/ _` / __|
498 * | || | | \__ \ __/ | | |_ | _ < __/ | (_) | (_| | (_| \__ \
499 * |___|_| |_|___/\___|_| \__| |_| \_\___|_|\___/ \__,_|\__,_|___/
503 void be_insert_spills_reloads(spill_env_t *env) {
504 const arch_env_t *arch_env = env->arch_env;
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)) {
511 ir_mode *mode = get_irn_mode(si->spilled_node);
512 pset *values = pset_new_ptr(16);
514 /* go through all reloads for this spill */
515 for(rld = si->reloaders; rld; rld = rld->next) {
518 if (check_remat_conditions(env, si->spilled_node, rld->reloader)) {
519 new_val = do_remat(env, si->spilled_node, rld->reloader);
521 /* make sure we have a spill */
525 new_val = be_reload(arch_env, env->cls, rld->reloader, mode, si->spill);
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);
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);
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);
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);