2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Handles state switching. This is basically the belady spill
23 * algorithm optimized for the 1-register case.
24 * @author Matthias Braun
33 #include "irgraph_t.h"
37 #include "iredges_t.h"
40 #include "irnodeset.h"
41 #include "irnodemap.h"
42 #include "adt/cpset.h"
51 #include "bessaconstr.h"
53 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
55 typedef struct spill_info_t {
56 struct spill_info_t *next;
62 typedef struct minibelady_env_t {
64 const arch_register_t *reg;
67 create_reload_func create_reload;
68 create_spill_func create_spill;
70 ir_nodemap_t spill_infos;
72 be_uses_t *uses; /**< env for the next-use magic */
75 typedef struct block_info_t {
80 static inline block_info_t *new_block_info(struct obstack *obst, ir_node *block)
82 block_info_t *res = OALLOCZ(obst, block_info_t);
84 assert(is_Block(block));
85 set_irn_link(block, res);
86 mark_irn_visited(block);
91 static inline block_info_t *get_block_info(ir_node *block)
93 assert(irn_visited(block));
94 return (block_info_t*) get_irn_link(block);
97 static inline spill_info_t *create_spill_info(minibelady_env_t *env, ir_node *state)
99 spill_info_t *spill_info = OALLOCZ(&env->obst, spill_info_t);
100 spill_info->value = state;
101 spill_info->reloads = NEW_ARR_F(ir_node*, 0);
103 ir_nodemap_insert(&env->spill_infos, state, spill_info);
104 //ir_fprintf(stderr, "Insert %+F -> %p\n", state, spill_info);
106 spill_info->next = env->spills;
107 env->spills = spill_info;
112 static inline spill_info_t *get_spill_info(minibelady_env_t *env, const ir_node *node)
114 spill_info_t *spill_info
115 = (spill_info_t*) ir_nodemap_get(&env->spill_infos, node);
116 //ir_fprintf(stderr, "Get %+F -> %p\n", node, spill_info);
120 static spill_info_t *create_spill(minibelady_env_t *env, ir_node *state, int force)
122 spill_info_t *spill_info;
126 spill_info = get_spill_info(env, state);
127 if (spill_info == NULL) {
128 spill_info = create_spill_info(env, state);
129 } else if (spill_info->spill != NULL) {
133 if (sched_is_scheduled(state)) {
137 next = sched_next(after);
138 } while (is_Proj(next) || is_Phi(next) || be_is_Keep(next));
142 spill_info->spill = env->create_spill(env->func_env, state, force, after);
147 static void create_reload(minibelady_env_t *env, ir_node *state,
148 ir_node *before, ir_node *last_state)
150 spill_info_t *spill_info = create_spill(env, state, 0);
151 ir_node *spill = spill_info->spill;
154 reload = env->create_reload(env->func_env, state, spill, before,
156 ARR_APP1(ir_node*, spill_info->reloads, reload);
159 static void spill_phi(minibelady_env_t *env, ir_node *phi)
161 ir_graph *irg = get_irn_irg(phi);
162 ir_node *block = get_nodes_block(phi);
163 int arity = get_irn_arity(phi);
164 ir_node **phi_in = ALLOCAN(ir_node*, arity);
165 ir_node *dummy = new_r_Dummy(irg, mode_M);
166 ir_node *spill_to_kill = NULL;
167 spill_info_t *spill_info;
170 /* does a spill exist for the phis value? */
171 spill_info = get_spill_info(env, phi);
172 if (spill_info != NULL) {
173 spill_to_kill = spill_info->spill;
175 spill_info = create_spill_info(env, phi);
178 /* create a new phi-M with bad preds */
179 for (i = 0; i < arity; ++i) {
183 DBG((dbg, LEVEL_2, "\tcreate Phi-M for %+F\n", phi));
186 spill_info->spill = be_new_Phi(block, arity, phi_in, mode_M, NULL);
187 sched_add_after(block, spill_info->spill);
189 if (spill_to_kill != NULL) {
190 exchange(spill_to_kill, spill_info->spill);
191 sched_remove(spill_to_kill);
194 /* create spills for the phi values */
195 for (i = 0; i < arity; ++i) {
196 ir_node *in = get_irn_n(phi, i);
197 spill_info_t *pred_spill = create_spill(env, in, 1);
198 set_irn_n(spill_info->spill, i, pred_spill->spill);
202 static void belady(minibelady_env_t *env, ir_node *block);
205 * Collects all values live-in at block @p block and all phi results in this
207 * Then it adds the best values (at most n_regs) to the blocks start_workset.
208 * The phis among the remaining values get spilled: Introduce pseudo-copies of
209 * their args to break interference and make it possible to spill them to the
212 static block_info_t *compute_block_start_state(minibelady_env_t *env, ir_node *block)
214 block_info_t *block_info;
215 be_next_use_t next_use;
217 ir_node *best_starter, *first;
221 int outer_loop_allowed;
224 /* Create the block info for this block. */
225 block_info = new_block_info(&env->obst, block);
226 n_cfgpreds = get_Block_n_cfgpreds(block);
228 /* no cfgpred -> no value active */
229 if (n_cfgpreds == 0) {
230 block_info->start_state = NULL;
234 /* for 1 pred only: simply take the the end-state of the pred */
235 if (n_cfgpreds == 1) {
236 ir_node *pred_block = get_Block_cfgpred_block(block, 0);
237 block_info_t *pred_info;
239 /* process pred block */
240 belady(env, pred_block);
242 pred_info = get_block_info(pred_block);
244 DBG((dbg, LEVEL_2, "Taking end state from %+F: %+F\n", pred_block, pred_info->end_state));
245 block_info->start_state = pred_info->end_state;
249 /* Collect all values living at start of block */
250 DBG((dbg, LEVEL_2, "Living at start of %+F:\n", block));
251 first = sched_first(block);
252 loop = get_irn_loop(block);
254 best_time = USES_INFINITY;
255 outer_loop_allowed = 1;
257 /* check all Phis first */
258 sched_foreach(block, node) {
261 if (arch_get_irn_register(node) != env->reg)
264 DBG((dbg, LEVEL_2, "\t...checking %+F\n", node));
265 next_use = be_get_next_use(env->uses, first, node, 0);
267 if (USES_IS_INFINITE(next_use.time)) {
268 DBG((dbg, LEVEL_2, "\tnot taken (dead)\n"));
272 if (next_use.outermost_loop >= get_loop_depth(loop)) {
273 if (outer_loop_allowed || next_use.time < best_time) {
274 DBG((dbg, LEVEL_2, "\ttaken (%u, loop %d)\n", next_use.time,
275 next_use.outermost_loop));
277 if (best_starter != NULL) {
278 /* spill the phi as it is not used */
279 spill_phi(env, best_starter);
282 best_time = next_use.time;
283 outer_loop_allowed = 0;
286 if (outer_loop_allowed && next_use.time < best_time) {
287 DBG((dbg, LEVEL_2, "\ttaken (%u, loop %d)\n", next_use.time,
288 next_use.outermost_loop));
289 if (best_starter != NULL) {
290 /* spill the phi as it is not used */
291 spill_phi(env, best_starter);
294 best_time = next_use.time;
298 if (best_starter != node) {
299 /* spill the phi as it is not used */
300 spill_phi(env, best_starter);
304 /* check all Live-Ins */
305 be_lv_foreach(env->lv, block, be_lv_state_in, i) {
306 node = be_lv_get_irn(env->lv, block, i);
308 if (!mode_is_data(get_irn_mode(node)))
311 if (arch_get_irn_register(node) != env->reg)
314 DBG((dbg, LEVEL_2, "\t...checking %+F\n", node));
315 next_use = be_get_next_use(env->uses, first, node, 0);
317 if (USES_IS_INFINITE(next_use.time)) {
318 DBG((dbg, LEVEL_2, "\tnot taken (dead)\n"));
322 if (next_use.outermost_loop >= get_loop_depth(loop)) {
323 if (outer_loop_allowed || next_use.time < best_time) {
324 DBG((dbg, LEVEL_2, "\ttaken (%u, loop %d)\n", next_use.time,
325 next_use.outermost_loop));
327 if (best_starter != NULL && is_Phi(best_starter)) {
328 /* spill the phi as it is not used */
329 spill_phi(env, best_starter);
332 best_time = next_use.time;
333 outer_loop_allowed = 0;
336 if (outer_loop_allowed && next_use.time < best_time) {
337 DBG((dbg, LEVEL_2, "\ttaken (%u, loop %d)\n", next_use.time,
338 next_use.outermost_loop));
339 if (best_starter != NULL && is_Phi(best_starter)) {
340 /* spill the phi as it is not used */
341 spill_phi(env, best_starter);
344 best_time = next_use.time;
349 block_info->start_state = best_starter;
355 * For the given block @p block, decide for each values
356 * whether it is used from a register or is reloaded
359 static void belady(minibelady_env_t *env, ir_node *block)
361 ir_node *current_state;
363 block_info_t *block_info;
365 /* Don't do a block twice */
366 if (irn_visited(block))
369 /* compute value to start with */
370 block_info = compute_block_start_state(env, block);
372 /* get the starting workset for this block */
373 DBG((dbg, LEVEL_3, "\n"));
374 DBG((dbg, LEVEL_3, "Decide for %+F\n", block));
376 current_state = block_info->start_state;
377 DBG((dbg, LEVEL_3, "Start value: %+F\n", current_state));
379 /* process the block from start to end */
380 DBG((dbg, LEVEL_3, "Processing...\n"));
382 sched_foreach(block, node) {
384 ir_node *need_val = NULL;
386 /* projs are handled with the tuple value.
387 * Phis are no real instr (see insert_starters()) */
388 if (is_Proj(node) || is_Phi(node)) {
392 /* check which state is desired for the node */
393 arity = get_irn_arity(node);
394 for (i = 0; i < arity; ++i) {
395 const arch_register_t *reg;
396 ir_node *in = get_irn_n(node, i);
398 if (!mode_is_data(get_irn_mode(in)))
401 reg = arch_get_irn_register(in);
402 if (reg == env->reg) {
403 assert(need_val == NULL);
405 DBG((dbg, LEVEL_3, "\t... need state %+F\n", need_val));
408 /* create a reload to match state if necessary */
409 if (need_val != NULL && need_val != current_state) {
410 ir_node *before = node;
411 DBG((dbg, LEVEL_3, "\t... reloading %+F\n", need_val));
412 create_reload(env, need_val, before, current_state);
413 current_state = need_val;
416 DBG((dbg, LEVEL_3, " ...%+F\n", node));
418 /* record state changes by the node */
419 if (get_irn_mode(node) == mode_T) {
420 const ir_edge_t *edge;
422 foreach_out_edge(node, edge) {
423 const arch_register_t *reg;
424 ir_node *proj = get_edge_src_irn(edge);
426 if (!mode_is_data(get_irn_mode(proj)))
429 reg = arch_get_irn_register(proj);
430 if (reg == env->reg) {
431 current_state = proj;
432 DBG((dbg, LEVEL_3, "\t... current_state <- %+F\n", current_state));
436 if (mode_is_data(get_irn_mode(node))) {
437 const arch_register_t *reg = arch_get_irn_register(node);
438 if (reg == env->reg) {
439 current_state = node;
440 DBG((dbg, LEVEL_3, "\t... current_state <- %+F\n", current_state));
446 /* Remember end-workset for this block */
447 block_info->end_state = current_state;
448 DBG((dbg, LEVEL_3, "End value for %+F: %+F\n", block, current_state));
451 static void belady_walker(ir_node *block, void *data)
453 belady((minibelady_env_t*) data, block);
456 static ir_node *get_end_of_block_insertion_point(ir_node *block)
458 ir_node *last = sched_last(block);
460 /* skip Projs and Keep-alikes behind the jump... */
461 while (is_Proj(last) || be_is_Keep(last)) {
462 last = sched_prev(last);
465 if (!is_cfop(last)) {
466 last = sched_next(last);
467 /* last node must be a cfop, only exception is the start block */
468 assert(last == get_irg_start_block(get_irn_irg(block)));
475 * We must adapt the live-outs to the live-ins at each block-border.
477 static void fix_block_borders(ir_node *block, void *data)
479 minibelady_env_t *env = (minibelady_env_t*)data;
480 ir_graph *irg = get_irn_irg(block);
481 ir_node *startblock = get_irg_start_block(irg);
484 block_info_t *block_info;
486 if (block == startblock)
489 DBG((dbg, LEVEL_3, "\n"));
491 block_info = get_block_info(block);
493 DBG((dbg, LEVEL_3, "Fixing %+F (needs %+F)\n", block,
494 block_info->start_state));
496 /* process all pred blocks */
497 arity = get_irn_arity(block);
498 for (i = 0; i < arity; ++i) {
499 ir_node *pred = get_Block_cfgpred_block(block, i);
500 block_info_t *pred_info = get_block_info(pred);
501 ir_node *need_state = block_info->start_state;
503 if (need_state == NULL)
506 if (is_Phi(need_state) && get_nodes_block(need_state) == block) {
507 need_state = get_irn_n(need_state, i);
510 DBG((dbg, LEVEL_3, " Pred %+F (ends in %+F, we need %+F)\n", pred,
511 pred_info->end_state, need_state));
513 if (pred_info->end_state != need_state) {
514 ir_node *insert_point = get_end_of_block_insertion_point(pred);
517 DBG((dbg, LEVEL_3, " Creating reload for %+F\n", need_state));
518 create_reload(env, need_state, insert_point, pred_info->end_state);
523 void be_assure_state(ir_graph *irg, const arch_register_t *reg, void *func_env,
524 create_spill_func create_spill,
525 create_reload_func create_reload)
527 minibelady_env_t env;
529 be_lv_t *lv = be_assure_liveness(irg);
531 be_liveness_assure_sets(lv);
532 assure_loopinfo(irg);
534 obstack_init(&env.obst);
536 env.func_env = func_env;
537 env.create_spill = create_spill;
538 env.create_reload = create_reload;
539 env.lv = be_get_irg_liveness(irg);
540 env.uses = be_begin_uses(irg, env.lv);
542 ir_nodemap_init(&env.spill_infos);
545 ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED | IR_RESOURCE_IRN_LINK);
546 inc_irg_visited(irg);
549 irg_block_walk_graph(irg, NULL, belady_walker, &env);
551 /* fix block end_states that don't match the next blocks start_state */
552 irg_block_walk_graph(irg, fix_block_borders, NULL, &env);
554 ir_free_resources(irg, IR_RESOURCE_IRN_VISITED | IR_RESOURCE_IRN_LINK);
556 /* reconstruct ssa-form */
558 while (info != NULL) {
559 be_ssa_construction_env_t senv;
563 be_ssa_construction_init(&senv, irg);
564 if (sched_is_scheduled(info->value))
565 be_ssa_construction_add_copy(&senv, info->value);
566 be_ssa_construction_add_copies(&senv,
567 info->reloads, ARR_LEN(info->reloads));
568 be_ssa_construction_fix_users(&senv, info->value);
571 be_ssa_construction_update_liveness_phis(&senv, lv);
573 be_liveness_update(lv, info->value);
574 len = ARR_LEN(info->reloads);
575 for (i = 0; i < len; ++i) {
576 ir_node *reload = info->reloads[i];
577 be_liveness_update(lv, reload);
581 phis = be_ssa_construction_get_new_phis(&senv);
583 /* set register requirements for phis */
585 for (i = 0; i < len; ++i) {
586 ir_node *phi = phis[i];
587 arch_set_irn_register(phi, env.reg);
589 be_ssa_construction_destroy(&senv);
594 /* some nodes might be dead now. */
595 be_remove_dead_nodes_from_schedule(irg);
597 ir_nodemap_destroy(&env.spill_infos);
598 be_end_uses(env.uses);
599 obstack_free(&env.obst, NULL);
602 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_state)
603 void be_init_state(void)
605 FIRM_DBG_REGISTER(dbg, "firm.be.state");