2 * Author: Daniel Grund, Sebastian Hack
4 * Copyright: (c) Universitaet Karlsruhe
5 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 #include "iredges_t.h"
26 #include "besched_t.h"
29 #include "bechordal_t.h"
32 /* This enables re-computation of values. Current state: Unfinished and buggy. */
35 typedef struct _reloader_t reloader_t;
36 typedef struct _spill_info_t spill_info_t;
43 struct _spill_info_t {
44 ir_node *spilled_node;
45 reloader_t *reloaders;
48 typedef struct _spill_ctx_t {
49 ir_node *spilled; /**< The spilled node. */
50 ir_node *user; /**< The node this spill is for. */
51 ir_node *spill; /**< The spill itself. */
55 const arch_register_class_t *cls;
56 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 */
61 decide_irn_t is_spilled_phi;/**< callback func to decide if a phi needs special spilling */
62 void *data; /**< data passed to all callbacks */
63 DEBUG_ONLY(firm_dbg_module_t *dbg;)
66 /* associated Phi -> Spill*/
67 typedef struct _phi_spill_assoc_t {
73 * Compare two Phi->Spill associations.
75 static int cmp_phi_spill_assoc(const void *a, const void *b, size_t n) {
76 const phi_spill_assoc_t *p1 = a;
77 const phi_spill_assoc_t *p2 = b;
78 return p1->phi != p2->phi;
82 * compare two spill contexts.
84 static int cmp_spillctx(const void *a, const void *b, size_t n) {
85 const spill_ctx_t *p = a;
86 const spill_ctx_t *q = b;
87 return p->user != q->user || p->spilled != q->spilled;
91 * Compare two spill infos.
93 static int cmp_spillinfo(const void *x, const void *y, size_t size) {
94 const spill_info_t *xx = x;
95 const spill_info_t *yy = y;
96 return xx->spilled_node != yy->spilled_node;
100 /* Sets the debug module of a spill environment. */
101 void be_set_spill_env_dbg_module(spill_env_t *env, firm_dbg_module_t *dbg) {
106 /* Creates a new spill environment. */
107 spill_env_t *be_new_spill_env(const be_chordal_env_t *chordal_env, decide_irn_t is_spilled_phi, void *data) {
108 spill_env_t *env = xmalloc(sizeof(env[0]));
109 env->spill_ctxs = new_set(cmp_spillctx, 1024);
110 env->spills = new_set(cmp_spillinfo, 1024);
111 env->cls = chordal_env->cls;
112 env->is_spilled_phi = is_spilled_phi;
114 env->chordal_env = chordal_env;
115 obstack_init(&env->obst);
119 void be_set_is_spilled_phi(spill_env_t *env, decide_irn_t is_spilled_phi, void *data) {
120 env->is_spilled_phi = is_spilled_phi;
124 /* Deletes a spill environment. */
125 void be_delete_spill_env(spill_env_t *senv) {
126 del_set(senv->spill_ctxs);
127 del_set(senv->spills);
128 obstack_free(&senv->obst, NULL);
133 * Returns a spill context. If the context did not exists, create one.
135 * @param sc the set containing all spill contexts
136 * @param to_spill the node that should be spilled
137 * @param ctx_irn an user of the spilled node
139 * @return a spill context.
141 static spill_ctx_t *be_get_spill_ctx(set *sc, ir_node *to_spill, ir_node *ctx_irn) {
144 templ.spilled = to_spill;
145 templ.user = ctx_irn;
148 return set_insert(sc, &templ, sizeof(templ), HASH_COMBINE(HASH_PTR(to_spill), HASH_PTR(ctx_irn)));
154 * @param senv the spill environment
155 * @param irn the node that should be spilled
156 * @param ctx_irn an user of the spilled node
158 * @return a be_Spill node
160 static ir_node *be_spill_irn(spill_env_t *senv, ir_node *irn, ir_node *ctx_irn) {
162 const be_main_env_t *env = senv->chordal_env->birg->main_env;
163 DBG((senv->dbg, LEVEL_1, "%+F in ctx %+F\n", irn, ctx_irn));
165 // Has the value already been spilled?
166 ctx = be_get_spill_ctx(senv->spill_ctxs, irn, ctx_irn);
170 /* Trying to spill an already spilled value, no need for a new spill
171 * node then, we can simply connect to the same one for this reload
173 if(be_is_Reload(irn)) {
174 return get_irn_n(irn, be_pos_Reload_mem);
177 ctx->spill = be_spill(env->arch_env, irn, ctx_irn);
182 * If the first usage of a Phi result would be out of memory
183 * there is no sense in allocating a register for it.
184 * Thus we spill it and all its operands to the same spill slot.
185 * Therefore the phi/dataB becomes a phi/Memory
187 * @param senv the spill environment
188 * @param phi the Phi node that should be spilled
189 * @param ctx_irn an user of the spilled node
191 * @return a be_Spill node
193 static ir_node *be_spill_phi(spill_env_t *senv, ir_node *phi, ir_node *ctx_irn, unsigned visited_nr, set *already_visited_phis) {
194 int i, n = get_irn_arity(phi);
195 ir_graph *irg = senv->chordal_env->irg;
196 ir_node *bl = get_nodes_block(phi);
197 ir_node **ins, *phi_spill;
198 phi_spill_assoc_t key;
202 DBG((senv->dbg, LEVEL_1, "%+F in ctx %+F\n", phi, ctx_irn));
204 /* build a new PhiM */
205 NEW_ARR_A(ir_node *, ins, n);
206 for (i = 0; i < n; ++i) {
207 ins[i] = new_r_Bad(irg);
209 phi_spill = new_r_Phi(senv->chordal_env->irg, bl, n, ins, mode_M);
211 key.spill = phi_spill;
212 set_insert(already_visited_phis, &key, sizeof(key), HASH_PTR(phi));
214 /* search an existing spill for this context */
215 ctx = be_get_spill_ctx(senv->spill_ctxs, phi, ctx_irn);
217 /* if not found spill the phi */
219 set_irn_visited(phi, visited_nr);
221 /* collect all arguments of the phi */
222 for (i = 0; i < n; ++i) {
223 ir_node *arg = get_irn_n(phi, i);
225 phi_spill_assoc_t *entry;
227 if(is_Phi(arg) && pset_find_ptr(senv->mem_phis, arg)) {
228 if (get_irn_visited(arg) < visited_nr)
229 sub_res = be_spill_phi(senv, arg, ctx_irn, visited_nr, already_visited_phis);
231 /* we already visited the argument phi: get it's spill */
234 entry = set_find(already_visited_phis, &key, sizeof(key), HASH_PTR(arg));
235 assert(entry && "argument phi already visited, but no spill found?!?");
236 sub_res = entry->spill;
237 assert(sub_res && "spill missing?!?");
241 sub_res = be_spill_irn(senv, arg, ctx_irn);
243 set_irn_n(phi_spill, i, sub_res);
246 ctx->spill = phi_spill;
254 * @param senv the spill environment
255 * @param to_spill the node that should be spilled
257 * @return a be_Spill node
259 static ir_node *be_spill_node(spill_env_t *senv, ir_node *to_spill, unsigned visited_nr) {
260 ir_graph *irg = get_irn_irg(to_spill);
261 int save_optimize = get_optimize();
262 int save_normalize = get_opt_normalize();
263 set *already_visited_phis = new_set(cmp_phi_spill_assoc, 10);
267 * Disable optimization so that the phi functions do not
271 set_opt_normalize(0);
273 if (pset_find_ptr(senv->mem_phis, to_spill))
274 res = be_spill_phi(senv, to_spill, to_spill, visited_nr, already_visited_phis);
276 res = be_spill_irn(senv, to_spill, to_spill);
278 del_set(already_visited_phis);
280 /* reset the optimizations */
281 set_optimize(save_optimize);
282 set_opt_normalize(save_normalize);
292 * Check if a spilled node could be rematerialized.
294 * @param senv the spill environment
295 * @param spill the Spill node
296 * @param spilled the node that was spilled
297 * @param reloader a irn that requires a reload
299 static int check_remat_conditions(spill_env_t *senv, ir_node *spill, ir_node *spilled, ir_node *reloader) {
302 /* check for 'normal' spill and general remat condition */
303 if (!be_is_Spill(spill) || !arch_irn_is(senv->chordal_env->birg->main_env->arch_env, spilled, rematerializable))
306 /* check availability of original arguments */
307 if (is_Block(reloader)) {
309 /* we want to remat at the end of a block.
310 * thus all arguments must be alive at the end of the block
312 for (pos=0, max=get_irn_arity(spilled); pos<max; ++pos) {
313 ir_node *arg = get_irn_n(spilled, pos);
314 if (!is_live_end(reloader, arg))
320 /* we want to remat before the insn reloader
321 * thus an arguments is alive if
322 * - it interferes with the reloaders result
324 * - or it is (last-) used by reloader itself
326 for (pos=0, max=get_irn_arity(spilled); pos<max; ++pos) {
327 ir_node *arg = get_irn_n(spilled, pos);
330 if (values_interfere(reloader, arg))
333 for (i=0, m=get_irn_arity(reloader); i<m; ++i) {
334 ir_node *rel_arg = get_irn_n(reloader, i);
339 /* arg is not alive before reloader */
351 #else /* BUGGY_REMAT */
354 * A very simple rematerialization checker.
356 * @param senv the spill environment
357 * @param spill the Spill node
358 * @param spilled the node that was spilled
359 * @param reloader a irn that requires a reload
361 static int check_remat_conditions(spill_env_t *senv, ir_node *spill, ir_node *spilled, ir_node *reloader) {
362 const arch_env_t *aenv = senv->chordal_env->birg->main_env->arch_env;
364 return get_irn_arity(spilled) == 0 &&
365 be_is_Spill(spill) &&
366 arch_irn_is(aenv, spilled, rematerializable);
369 #endif /* BUGGY_REMAT */
374 * Re-materialize a node.
376 * @param senv the spill environment
377 * @param spilled the node that was spilled
378 * @param reloader a irn that requires a reload
380 static ir_node *do_remat(spill_env_t *senv, ir_node *spilled, ir_node *reloader) {
382 ir_node *bl = (is_Block(reloader)) ? reloader : get_nodes_block(reloader);
384 /* recompute the value */
385 res = new_ir_node(get_irn_dbg_info(spilled), senv->chordal_env->irg, bl,
387 get_irn_mode(spilled),
388 get_irn_arity(spilled),
389 get_irn_in(spilled) + 1);
390 copy_node_attr(spilled, res);
392 DBG((senv->dbg, LEVEL_1, "Insert remat %+F before reloader %+F\n", res, reloader));
394 /* insert in schedule */
395 if (is_Block(reloader)) {
396 ir_node *insert = sched_skip(reloader, 0, sched_skip_cf_predicator, (void *) senv->chordal_env->birg->main_env->arch_env);
397 sched_add_after(insert, res);
399 sched_add_before(reloader, res);
406 * Walker: fills the mem_phis set by evaluating Phi nodes
407 * using the is_spilled_phi() callback.
409 static void phi_walker(ir_node *irn, void *env) {
410 spill_env_t *senv = env;
413 const arch_env_t *arch = senv->chordal_env->birg->main_env->arch_env;
414 if (arch_irn_has_reg_class(arch, irn, 0, senv->cls) &&
415 senv->is_spilled_phi(irn, senv->data)) {
416 DBG((senv->dbg, LEVEL_1, " %+F\n", irn));
417 pset_insert_ptr(senv->mem_phis, irn);
422 void be_insert_spills_reloads(spill_env_t *senv, pset *reload_set) {
423 const arch_env_t *aenv = senv->chordal_env->birg->main_env->arch_env;
424 ir_graph *irg = senv->chordal_env->irg;
429 /* get all special spilled phis */
430 DBG((senv->dbg, LEVEL_1, "Mem-phis:\n"));
431 senv->mem_phis = pset_new_ptr_default();
432 irg_walk_graph(senv->chordal_env->irg, phi_walker, NULL, senv);
434 /* Add reloads for mem_phis */
435 /* BETTER: These reloads (1) should only be inserted, if they are really needed */
436 DBG((senv->dbg, LEVEL_1, "Reloads for mem-phis:\n"));
437 for(irn = pset_first(senv->mem_phis); irn; irn = pset_next(senv->mem_phis)) {
439 DBG((senv->dbg, LEVEL_1, " Mem-phi %+F\n", irn));
440 foreach_out_edge(irn, e) {
441 ir_node *user = e->src;
442 if (is_Phi(user) && !pset_find_ptr(senv->mem_phis, user)) {
443 ir_node *use_bl = get_nodes_block(user);
444 DBG((senv->dbg, LEVEL_1, " non-mem-phi user %+F\n", user));
445 be_add_reload_on_edge(senv, irn, use_bl, e->pos); /* (1) */
450 visited_nr = get_irg_visited(irg) + 1;
451 set_irg_visited(irg, visited_nr);
453 /* process each spilled node */
454 DBG((senv->dbg, LEVEL_1, "Insert spills and reloads:\n"));
455 for(si = set_first(senv->spills); si; si = set_next(senv->spills)) {
457 ir_mode *mode = get_irn_mode(si->spilled_node);
459 pset *values = pset_new_ptr(16);
461 /* go through all reloads for this spill */
462 for(rld = si->reloaders; rld; rld = rld->next) {
465 /* the spill for this reloader */
466 ir_node *spill = be_spill_node(senv, si->spilled_node, visited_nr);
469 if (check_remat_conditions(senv, spill, si->spilled_node, rld->reloader)) {
470 new_val = do_remat(senv, si->spilled_node, rld->reloader);
471 //pdeq_putl(possibly_dead, spill);
476 new_val = be_reload(aenv, senv->cls, rld->reloader, mode, spill);
478 DBG((senv->dbg, LEVEL_1, " %+F of %+F before %+F\n", new_val, si->spilled_node, rld->reloader));
479 pset_insert_ptr(values, new_val);
481 pset_insert_ptr(reload_set, new_val);
484 /* introduce copies, rewire the uses */
485 assert(pset_count(values) > 0 && "???");
486 pset_insert_ptr(values, si->spilled_node);
487 be_ssa_constr_set_ignore(senv->chordal_env->dom_front, values, senv->mem_phis);
492 del_pset(senv->mem_phis);
494 be_remove_dead_nodes_from_schedule(senv->chordal_env->irg);
496 // reloads are placed now, but we might reuse the spill environment for further spilling decisions
497 del_set(senv->spills);
498 senv->spills = new_set(cmp_spillinfo, 1024);
501 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before) {
502 spill_info_t templ, *res;
505 templ.spilled_node = to_spill;
506 templ.reloaders = NULL;
507 res = set_insert(senv->spills, &templ, sizeof(templ), HASH_PTR(to_spill));
509 rel = obstack_alloc(&senv->obst, sizeof(rel[0]));
510 rel->reloader = before;
511 rel->next = res->reloaders;
512 res->reloaders = rel;
515 void be_add_reload_on_edge(spill_env_t *senv, ir_node *to_spill, ir_node *bl, int pos) {
516 ir_node *insert_bl = get_irn_arity(bl) == 1 ? sched_first(bl) : get_Block_cfgpred_block(bl, pos);
517 be_add_reload(senv, to_spill, insert_bl);
522 /****************************************
524 SPILL SLOT MANAGEMENT AND OPTS
526 ****************************************/
528 typedef struct _spill_slot_t {
532 ir_mode *largest_mode; /* the mode of all members with largest size */
535 typedef struct _ss_env_t {
537 be_chordal_env_t *cenv;
538 pmap *slots; /* maps spill_contexts to spill_slots */
539 pmap *types; /* maps modes to types */
540 DEBUG_ONLY(firm_dbg_module_t *dbg;)
545 * Walker: compute the spill slots
547 static void compute_spill_slots_walker(ir_node *spill, void *env) {
548 ss_env_t *ssenv = env;
553 if (!be_is_Spill(spill))
556 /* check, if this spill is for a context already known */
557 ctx = be_get_Spill_context(spill);
558 entry = pmap_find(ssenv->slots, ctx);
561 struct _arch_env_t *arch_env = ssenv->cenv->birg->main_env->arch_env;
562 const arch_register_class_t *cls = arch_get_irn_reg_class(arch_env, spill, be_pos_Spill_val);
563 ir_mode *largest_mode = arch_register_class_mode(cls);
565 /* this is a new spill context */
566 ss = obstack_alloc(&ssenv->ob, sizeof(*ss));
567 ss->members = pset_new_ptr(8);
568 ss->largest_mode = largest_mode;
569 ss->size = get_mode_size_bytes(ss->largest_mode);
570 ss->align = arch_isa_get_reg_class_alignment(arch_env->isa, cls);
571 pmap_insert(ssenv->slots, ctx, ss);
573 /* values with the same spill_ctx must go into the same spill slot */
577 /* ugly mega assert :-) */
580 struct _arch_env_t *arch_env = ssenv->cenv->birg->main_env->arch_env;
581 const arch_register_class_t *cls = arch_get_irn_reg_class(arch_env, spill, be_pos_Spill_val);
582 int size = get_mode_size_bytes(arch_register_class_mode(cls));
583 assert((int) ss->size == size && "Different sizes for the same spill slot are not allowed.");
584 for (irn = pset_first(ss->members); irn; irn = pset_next(ss->members)) {
585 /* use values_interfere here, because it uses the dominance check,
586 which does work for values in memory */
587 assert(!values_interfere(spill, irn) && "Spills for the same spill slot must not interfere!");
593 pset_insert_ptr(ss->members, spill);
597 * qsort compare function, sort spill slots by size.
599 static int ss_sorter(const void *v1, const void *v2) {
600 const spill_slot_t **ss1 = (const spill_slot_t **)v1;
601 const spill_slot_t **ss2 = (const spill_slot_t **)v2;
602 return ((int) (*ss2)->size) - ((int) (*ss1)->size);
607 * This function should optimize the spill slots.
608 * - Coalescing of multiple slots
609 * - Ordering the slots
611 * Input slots are in @p ssenv->slots
612 * @p size The count of initial spill slots in @p ssenv->slots
613 * This also is the size of the preallocated array @p ass
615 * @return An array of spill slots @p ass in specific order
617 static void optimize_slots(ss_env_t *ssenv, int size, spill_slot_t *ass[]) {
618 int i, o, used_slots;
622 pmap_foreach(ssenv->slots, entr)
623 ass[i++] = entr->value;
625 /* Sort the array to minimize fragmentation and cache footprint.
626 Large slots come first */
627 qsort(ass, size, sizeof(ass[0]), ss_sorter);
629 /* For each spill slot:
630 - assign a new offset to this slot
631 - xor find another slot to coalesce with */
633 for (i=0; i<size; ++i) { /* for each spill slot */
637 DBG((ssenv->dbg, LEVEL_1, "Spill slot %d members:\n", i));
638 for(n1 = pset_first(ass[i]->members); n1; n1 = pset_next(ass[i]->members))
639 DBG((ssenv->dbg, LEVEL_1, " %+F\n", n1));
642 for (o=0; o < used_slots && tgt_slot == -1; ++o) { /* for each offset-assigned spill slot */
643 /* check inter-slot-pairs for interference */
645 for(n1 = pset_first(ass[i]->members); n1; n1 = pset_next(ass[i]->members))
646 for(n2 = pset_first(ass[o]->members); n2; n2 = pset_next(ass[o]->members))
647 if(values_interfere(n1, n2)) {
648 pset_break(ass[i]->members);
649 pset_break(ass[o]->members);
650 DBG((ssenv->dbg, LEVEL_1, " Interf %+F -- %+F\n", n1, n2));
651 goto interf_detected;
654 /* if we are here, there is no interference between ass[i] and ass[o] */
657 interf_detected: /*nothing*/ ;
660 /* now the members of ass[i] join the members of ass[tgt_slot] */
662 /* do we need a new slot? */
663 if (tgt_slot == -1) {
664 tgt_slot = used_slots;
669 ass[tgt_slot]->size = ass[i]->size;
670 del_pset(ass[tgt_slot]->members);
671 ass[tgt_slot]->members = pset_new_ptr(8);
675 /* copy the members to the target pset */
676 /* NOTE: If src and tgt pset are the same, inserting while iterating is not allowed */
678 for(n1 = pset_first(ass[i]->members); n1; n1 = pset_next(ass[i]->members))
679 pset_insert_ptr(ass[tgt_slot]->members, n1);
683 #define ALIGN_SPILL_AREA 16
684 #define pset_foreach(pset, elm) for(elm=pset_first(pset); elm; elm=pset_next(pset))
687 * Returns a spill type for a mode. Keep them in a map to reduce
688 * the number of types.
690 * @param types a map containing all created types
691 * @param ss the spill slot
693 * Note that type types should are identical for every mode.
694 * This rule might break if two different register classes return the same
695 * mode but different alignments.
697 static ir_type *get_spill_type(pmap *types, spill_slot_t *ss) {
698 pmap_entry *e = pmap_find(types, ss->largest_mode);
703 snprintf(buf, sizeof(buf), "spill_slot_type_%s", get_mode_name(ss->largest_mode));
704 res = new_type_primitive(new_id_from_str(buf), ss->largest_mode);
705 set_type_alignment_bytes(res, ss->align);
706 pmap_insert(types, ss->largest_mode, res);
710 assert(get_type_alignment_bytes(res) == (int)ss->align);
716 * Create spill slot entities on the frame type.
718 * @param ssenv the spill environment
719 * @param n number of spill slots
720 * @param ss array of spill slots
722 static void assign_entities(ss_env_t *ssenv, int n_slots, spill_slot_t *ss[]) {
723 int i, offset, frame_align;
724 ir_type *frame = get_irg_frame_type(ssenv->cenv->irg);
726 /* aligning by increasing frame size */
727 offset = get_type_size_bits(frame) / 8;
728 offset = round_up2(offset, ALIGN_SPILL_AREA);
729 set_type_size_bytes(frame, -1);
731 /* create entities and assign offsets according to size and alignment*/
732 for (i = 0; i < n_slots; ++i) {
739 snprintf(buf, sizeof(buf), "spill_slot_%d", i);
740 name = new_id_from_str(buf);
742 spill_ent = new_entity(frame, name, get_spill_type(ssenv->types, ss[i]));
745 offset = round_up2(offset, ss[i]->align);
747 set_entity_offset_bytes(spill_ent, offset);
748 /* next possible offset */
749 offset += round_up2(ss[i]->size, ss[i]->align);
751 pset_foreach(ss[i]->members, irn)
752 be_set_Spill_entity(irn, spill_ent);
755 /* set final size of stack frame */
756 frame_align = get_type_alignment_bytes(frame);
757 set_type_size_bytes(frame, round_up2(offset, frame_align));
760 void be_compute_spill_offsets(be_chordal_env_t *cenv) {
766 obstack_init(&ssenv.ob);
768 ssenv.slots = pmap_create();
769 ssenv.types = pmap_create();
770 FIRM_DBG_REGISTER(ssenv.dbg, "ir.be.spillslots");
772 /* Get initial spill slots */
773 irg_walk_graph(cenv->irg, NULL, compute_spill_slots_walker, &ssenv);
775 /* Build an empty array for optimized spill slots */
776 ss_size = pmap_count(ssenv.slots);
777 ss = obstack_alloc(&ssenv.ob, ss_size * sizeof(*ss));
778 optimize_slots(&ssenv, ss_size, ss);
780 /* Integrate slots into the stack frame entity */
781 assign_entities(&ssenv, ss_size, ss);
784 pmap_foreach(ssenv.slots, pme)
785 del_pset(((spill_slot_t *)pme->value)->members);
786 pmap_destroy(ssenv.slots);
787 pmap_destroy(ssenv.types);
788 obstack_free(&ssenv.ob, NULL);
790 be_copy_entities_to_reloads(cenv->irg);