removed MAX macro, added irtools.h therefor
[libfirm] / ir / be / bespill.c
1 /**
2  * Author:      Daniel Grund, Sebastian Hack
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 "ident_t.h"
18 #include "type_t.h"
19 #include "entity_t.h"
20 #include "debug.h"
21 #include "irgwalk.h"
22 #include "array.h"
23 #include "pdeq.h"
24
25 #include "belive_t.h"
26 #include "besched_t.h"
27 #include "bespill.h"
28 #include "benode_t.h"
29 #include "bechordal_t.h"
30
31 #define REMAT
32 /* This enables re-computation of values. Current state: Unfinished and buggy. */
33 #undef BUGGY_REMAT
34
35 typedef struct _reloader_t reloader_t;
36 typedef struct _spill_info_t spill_info_t;
37
38 struct _reloader_t {
39         reloader_t *next;
40         ir_node *reloader;
41 };
42
43 struct _spill_info_t {
44         ir_node *spilled_node;
45         reloader_t *reloaders;
46 };
47
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. */
52 } spill_ctx_t;
53
54 struct _spill_env_t {
55         const arch_register_class_t *cls;
56         const be_chordal_env_t *chordal_env;
57         struct obstack obst;
58         set *spill_ctxs;
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         ir_node **copies;                       /**< set of copies placed because of phi spills */
62         DEBUG_ONLY(firm_dbg_module_t *dbg;)
63 };
64
65 /* associated Phi -> Spill*/
66 typedef struct _phi_spill_assoc_t {
67         ir_node *phi;
68         ir_node *spill;
69 } phi_spill_assoc_t;
70
71 /**
72  * Compare two Phi->Spill associations.
73  */
74 static int cmp_phi_spill_assoc(const void *a, const void *b, size_t n) {
75         const phi_spill_assoc_t *p1 = a;
76         const phi_spill_assoc_t *p2 = b;
77         return p1->phi != p2->phi;
78 }
79
80 /**
81  * compare two spill contexts.
82  */
83 static int cmp_spillctx(const void *a, const void *b, size_t n) {
84         const spill_ctx_t *p = a;
85         const spill_ctx_t *q = b;
86         return p->user != q->user || p->spilled != q->spilled;
87 }
88
89 /**
90  * Compare two spill infos.
91  */
92 static int cmp_spillinfo(const void *x, const void *y, size_t size) {
93         const spill_info_t *xx = x;
94         const spill_info_t *yy = y;
95         return xx->spilled_node != yy->spilled_node;
96 }
97
98 DEBUG_ONLY(
99 /* Sets the debug module of a spill environment. */
100 void be_set_spill_env_dbg_module(spill_env_t *env, firm_dbg_module_t *dbg) {
101         env->dbg = dbg;
102 }
103 )
104
105 /* Creates a new spill environment. */
106 spill_env_t *be_new_spill_env(const be_chordal_env_t *chordal_env) {
107         spill_env_t *env        = xmalloc(sizeof(env[0]));
108         env->spill_ctxs         = new_set(cmp_spillctx, 1024);
109         env->spills                     = new_set(cmp_spillinfo, 1024);
110         env->cls                        = chordal_env->cls;
111         env->chordal_env        = chordal_env;
112         env->mem_phis           = pset_new_ptr_default();
113         env->copies                     = NEW_ARR_F(ir_node*, 0);
114         obstack_init(&env->obst);
115         return env;
116 }
117
118 /* Deletes a spill environment. */
119 void be_delete_spill_env(spill_env_t *env) {
120         del_set(env->spill_ctxs);
121         del_set(env->spills);
122         del_pset(env->mem_phis);
123         DEL_ARR_F(env->copies);
124         obstack_free(&env->obst, NULL);
125         free(env);
126 }
127
128 /**
129  * Returns a spill context. If the context did not exists, create one.
130  *
131  * @param sc        the set containing all spill contexts
132  * @param to_spill  the node that should be spilled
133  * @param ctx_irn   an user of the spilled node
134  *
135  * @return a spill context.
136  */
137 static spill_ctx_t *be_get_spill_ctx(set *sc, ir_node *to_spill, ir_node *ctx_irn) {
138         spill_ctx_t templ;
139
140         templ.spilled = to_spill;
141         templ.user    = ctx_irn;
142         templ.spill   = NULL;
143
144         return set_insert(sc, &templ, sizeof(templ), HASH_COMBINE(HASH_PTR(to_spill), HASH_PTR(ctx_irn)));
145 }
146
147 /**
148  * Creates a spill.
149  *
150  * @param senv      the spill environment
151  * @param irn       the node that should be spilled
152  * @param ctx_irn   an user of the spilled node
153  *
154  * @return a be_Spill node
155  */
156 static ir_node *be_spill_irn(spill_env_t *senv, ir_node *irn, ir_node *ctx_irn) {
157         spill_ctx_t *ctx;
158         const be_main_env_t *env = senv->chordal_env->birg->main_env;
159         DBG((senv->dbg, LEVEL_1, "%+F in ctx %+F\n", irn, ctx_irn));
160
161         // Has the value already been spilled?
162         ctx = be_get_spill_ctx(senv->spill_ctxs, irn, ctx_irn);
163         if(ctx->spill)
164                 return ctx->spill;
165
166         /* Trying to spill an already spilled value, no need for a new spill
167          * node then, we can simply connect to the same one for this reload
168          */
169         if(be_is_Reload(irn)) {
170                 return get_irn_n(irn, be_pos_Reload_mem);
171         }
172
173         ctx->spill = be_spill(env->arch_env, irn, ctx_irn);
174
175         return ctx->spill;
176 }
177
178 /**
179  * Removes all copies introduced for phi-spills
180  */
181 static void remove_copies(spill_env_t *env) {
182         int i;
183
184         for(i = 0; i < ARR_LEN(env->copies); ++i) {
185                 ir_node *node = env->copies[i];
186                 ir_node *src;
187                 const ir_edge_t *edge, *ne;
188
189                 assert(be_is_Copy(node));
190
191                 src = be_get_Copy_op(node);
192                 foreach_out_edge_safe(node, edge, ne) {
193                         ir_node *user = get_edge_src_irn(edge);
194                         int user_pos  = get_edge_src_pos(edge);
195
196                         set_irn_n(user, user_pos, src);
197                 }
198         }
199
200         ARR_SETLEN(ir_node*, env->copies, 0);
201 }
202
203 /**
204  * Searchs the schedule of a block backwards until we reach the first
205  * use or def of a value or a phi.
206  * Returns the node before this node (so that you can do sched_add_before)
207  */
208 static ir_node *find_last_use_def(spill_env_t *env, ir_node *block, ir_node *value) {
209         ir_node *node, *last;
210
211         last = NULL;
212         sched_foreach_reverse(block, node) {
213                 int i, arity;
214
215                 if(is_Phi(node)) {
216                         return last;
217                 }
218                 if(value == node) {
219                         return last;
220                 }
221                 for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
222                         ir_node *arg = get_irn_n(node, i);
223                         if(arg == value) {
224                                 return last;
225                         }
226                 }
227                 last = node;
228         }
229
230         // simply return first node if no def or use found
231         return sched_first(block);
232 }
233
234 /**
235  * If the first usage of a Phi result would be out of memory
236  * there is no sense in allocating a register for it.
237  * Thus we spill it and all its operands to the same spill slot.
238  * Therefore the phi/dataB becomes a phi/Memory
239  *
240  * @param senv      the spill environment
241  * @param phi       the Phi node that should be spilled
242  * @param ctx_irn   an user of the spilled node
243  *
244  * @return a be_Spill node
245  */
246 static ir_node *spill_phi(spill_env_t *senv, ir_node *phi, ir_node *ctx_irn, set *already_visited_phis, bitset_t *bs) {
247         int         i;
248         int arity = get_irn_arity(phi);
249         ir_graph    *irg      = senv->chordal_env->irg;
250         ir_node     *bl       = get_nodes_block(phi);
251         ir_node     **ins, *phi_spill;
252         phi_spill_assoc_t key;
253         spill_ctx_t *ctx;
254
255         assert(is_Phi(phi));
256         DBG((senv->dbg, LEVEL_1, "%+F in ctx %+F\n", phi, ctx_irn));
257
258         /* build a new PhiM */
259         NEW_ARR_A(ir_node *, ins, arity);
260         for (i = 0; i < arity; ++i) {
261                 ins[i] = new_r_Bad(irg);
262         }
263         phi_spill = new_r_Phi(senv->chordal_env->irg, bl, arity, ins, mode_M);
264         key.phi   = phi;
265         key.spill = phi_spill;
266         set_insert(already_visited_phis, &key, sizeof(key), HASH_PTR(phi));
267         bitset_set(bs, get_irn_idx(phi));
268
269         /* search an existing spill for this context */
270         ctx = be_get_spill_ctx(senv->spill_ctxs, phi, ctx_irn);
271
272         /* if not found spill the phi */
273         if (! ctx->spill) {
274                 /* collect all arguments of the phi */
275                 for (i = 0; i < arity; ++i) {
276                         ir_node *arg = get_irn_n(phi, i);
277                         ir_node *sub_res;
278                         phi_spill_assoc_t *entry;
279
280                         if(is_Phi(arg) && pset_find_ptr(senv->mem_phis, arg)) {
281                                 // looping edge?
282                                 if(arg == phi) {
283                                         sub_res = phi_spill;
284                                 } else if (! bitset_is_set(bs, get_irn_idx(arg))) {
285                                         sub_res = spill_phi(senv, arg, ctx_irn, already_visited_phis, bs);
286                                 } else {
287                                         /* we already visited the argument phi: get it's spill */
288                                         key.phi   = arg;
289                                         key.spill = NULL;
290                                         entry     = set_find(already_visited_phis, &key, sizeof(key), HASH_PTR(arg));
291                                         assert(entry && "argument phi already visited, but no spill found?!?");
292                                         sub_res   = entry->spill;
293                                         assert(sub_res && "spill missing?!?");
294                                 }
295                         } else {
296                                 sub_res = be_spill_irn(senv, arg, ctx_irn);
297                         }
298
299                         set_irn_n(phi_spill, i, sub_res);
300                 }
301
302                 ctx->spill = phi_spill;
303         }
304         return ctx->spill;
305 }
306
307 /**
308  * Spill a node.
309  *
310  * @param senv      the spill environment
311  * @param to_spill  the node that should be spilled
312  *
313  * @return a be_Spill node
314  */
315 static ir_node *be_spill_node(spill_env_t *senv, ir_node *to_spill) {
316         ir_graph *irg = get_irn_irg(to_spill);
317         ir_node  *res;
318
319         if (pset_find_ptr(senv->mem_phis, to_spill)) {
320                 set *already_visited_phis = new_set(cmp_phi_spill_assoc, 10);
321                 bitset_t *bs = bitset_alloca(get_irg_last_idx(irg));
322                 res = spill_phi(senv, to_spill, to_spill, already_visited_phis, bs);
323                 del_set(already_visited_phis);
324         } else {
325                 res = be_spill_irn(senv, to_spill, to_spill);
326         }
327
328         return res;
329 }
330
331 #ifdef REMAT
332
333 #ifdef BUGGY_REMAT
334
335 /**
336  * Check if a spilled node could be rematerialized.
337  *
338  * @param senv      the spill environment
339  * @param spill     the Spill node
340  * @param spilled   the node that was spilled
341  * @param reloader  a irn that requires a reload
342  */
343 static int check_remat_conditions(spill_env_t *senv, ir_node *spill, ir_node *spilled, ir_node *reloader) {
344         int pos, max;
345
346         /* check for 'normal' spill and general remat condition */
347         if (!be_is_Spill(spill) || !arch_irn_is(senv->chordal_env->birg->main_env->arch_env, spilled, rematerializable))
348                 return 0;
349
350         /* check availability of original arguments */
351         if (is_Block(reloader)) {
352
353                 /* we want to remat at the end of a block.
354                  * thus all arguments must be alive at the end of the block
355                  */
356                 for (pos=0, max=get_irn_arity(spilled); pos<max; ++pos) {
357                         ir_node *arg = get_irn_n(spilled, pos);
358                         if (!is_live_end(reloader, arg))
359                                 return 0;
360                 }
361
362         } else {
363
364                 /* we want to remat before the insn reloader
365                  * thus an arguments is alive if
366                  *   - it interferes with the reloaders result
367                  * or
368                  *   - or it is (last-) used by reloader itself
369                  */
370                 for (pos=0, max=get_irn_arity(spilled); pos<max; ++pos) {
371                         ir_node *arg = get_irn_n(spilled, pos);
372                         int i, m;
373
374                         if (values_interfere(reloader, arg))
375                                 goto is_alive;
376
377                         for (i=0, m=get_irn_arity(reloader); i<m; ++i) {
378                                 ir_node *rel_arg = get_irn_n(reloader, i);
379                                 if (rel_arg == arg)
380                                         goto is_alive;
381                         }
382
383                         /* arg is not alive before reloader */
384                         return 0;
385
386 is_alive:       ;
387
388                 }
389
390         }
391
392         return 1;
393 }
394
395 #else /* BUGGY_REMAT */
396
397 /**
398  * A very simple rematerialization checker.
399  *
400  * @param senv      the spill environment
401  * @param spill     the Spill node
402  * @param spilled   the node that was spilled
403  * @param reloader  a irn that requires a reload
404  */
405 static int check_remat_conditions(spill_env_t *senv, ir_node *spill, ir_node *spilled, ir_node *reloader) {
406         const arch_env_t *aenv = senv->chordal_env->birg->main_env->arch_env;
407
408         return get_irn_arity(spilled) == 0 &&
409                    be_is_Spill(spill) &&
410                    arch_irn_is(aenv, spilled, rematerializable);
411 }
412
413 #endif /* BUGGY_REMAT */
414
415 #endif /* REMAT */
416
417 /**
418  * Re-materialize a node.
419  *
420  * @param senv      the spill environment
421  * @param spilled   the node that was spilled
422  * @param reloader  a irn that requires a reload
423  */
424 static ir_node *do_remat(spill_env_t *senv, ir_node *spilled, ir_node *reloader) {
425         ir_node *res;
426         ir_node *bl = (is_Block(reloader)) ? reloader : get_nodes_block(reloader);
427
428         /* recompute the value */
429         res = new_ir_node(get_irn_dbg_info(spilled), senv->chordal_env->irg, bl,
430                 get_irn_op(spilled),
431                 get_irn_mode(spilled),
432                 get_irn_arity(spilled),
433                 get_irn_in(spilled) + 1);
434         copy_node_attr(spilled, res);
435
436         DBG((senv->dbg, LEVEL_1, "Insert remat %+F before reloader %+F\n", res, reloader));
437
438         /* insert in schedule */
439         if (is_Block(reloader)) {
440                 ir_node *insert = sched_skip(reloader, 0, sched_skip_cf_predicator, (void *) senv->chordal_env->birg->main_env->arch_env);
441                 sched_add_after(insert, res);
442         } else {
443                 sched_add_before(reloader, res);
444         }
445
446         return res;
447 }
448
449 void be_spill_phi(spill_env_t *env, ir_node *node) {
450         assert(is_Phi(node));
451
452         pset_insert_ptr(env->mem_phis, node);
453 }
454
455 void be_insert_spills_reloads(spill_env_t *env) {
456         const arch_env_t *arch_env = env->chordal_env->birg->main_env->arch_env;
457         ir_node *node;
458         spill_info_t *si;
459
460         DBG((env->dbg, LEVEL_1, "Reloads for mem-phis:\n"));
461         foreach_pset(env->mem_phis, node) {
462                 const ir_edge_t *e;
463                 int i, arity;
464
465                 assert(is_Phi(node));
466
467                 /* We have to place copy nodes in the predecessor blocks to temporarily
468                  * produce new values that get separate spill slots
469                  */
470                 for(i = 0, arity = get_irn_arity(node); i < arity; ++i) {
471                         ir_node *pred_block, *arg, *copy, *insert_point;
472
473                         /* Don't do anything for looping edges (there's no need
474                          * and placing copies here breaks stuff as it suddenly
475                          * generates new living values through the whole loop)
476                          */
477                         arg = get_irn_n(node, i);
478                         if(arg == node)
479                                 continue;
480
481                         pred_block = get_Block_cfgpred_block(get_nodes_block(node), i);
482                         copy = be_new_Copy(env->cls, get_irn_irg(arg), pred_block, arg);
483
484                         ARR_APP1(ir_node*, env->copies, copy);
485                         insert_point = find_last_use_def(env, pred_block, arg);
486                         sched_add_before(insert_point, copy);
487
488                         set_irn_n(node, i, copy);
489                 }
490
491                 /* Add reloads for mem_phis */
492                 /* BETTER: These reloads (1) should only be inserted, if they are really needed */
493                 DBG((env->dbg, LEVEL_1, " Mem-phi %+F\n", node));
494                 foreach_out_edge(node, e) {
495                         ir_node *user = e->src;
496                         if (is_Phi(user) && !pset_find_ptr(env->mem_phis, user)) {
497                                 ir_node *use_bl = get_nodes_block(user);
498                                 DBG((env->dbg, LEVEL_1, " non-mem-phi user %+F\n", user));
499                                 be_add_reload_on_edge(env, node, use_bl, e->pos); /* (1) */
500                         }
501                 }
502         }
503
504         /* process each spilled node */
505         DBG((env->dbg, LEVEL_1, "Insert spills and reloads:\n"));
506         for(si = set_first(env->spills); si; si = set_next(env->spills)) {
507                 reloader_t *rld;
508                 ir_mode *mode = get_irn_mode(si->spilled_node);
509                 pset *values = pset_new_ptr(16);
510
511                 /* go through all reloads for this spill */
512                 for(rld = si->reloaders; rld; rld = rld->next) {
513                         ir_node *new_val;
514
515                         /* the spill for this reloader */
516                         ir_node *spill   = be_spill_node(env, si->spilled_node);
517
518 #ifdef REMAT
519                         if (check_remat_conditions(env, spill, si->spilled_node, rld->reloader)) {
520                                 new_val = do_remat(env, si->spilled_node, rld->reloader);
521                         } else
522 #endif
523                                 /* do a reload */
524                                 new_val = be_reload(arch_env, env->cls, rld->reloader, mode, spill);
525
526                         DBG((env->dbg, LEVEL_1, " %+F of %+F before %+F\n", new_val, si->spilled_node, rld->reloader));
527                         pset_insert_ptr(values, new_val);
528                 }
529
530                 /* introduce copies, rewire the uses */
531                 assert(pset_count(values) > 0 && "???");
532                 pset_insert_ptr(values, si->spilled_node);
533                 be_ssa_constr_set_ignore(env->chordal_env->dom_front, values, env->mem_phis);
534
535                 del_pset(values);
536         }
537
538         remove_copies(env);
539
540         // reloads are placed now, but we might reuse the spill environment for further spilling decisions
541         del_set(env->spills);
542         env->spills = new_set(cmp_spillinfo, 1024);
543 }
544
545 void be_add_reload(spill_env_t *env, ir_node *to_spill, ir_node *before) {
546         spill_info_t templ, *res;
547         reloader_t *rel;
548
549         assert(sched_is_scheduled(before));
550         assert(arch_irn_consider_in_reg_alloc(env->chordal_env->birg->main_env->arch_env, env->cls, to_spill));
551
552         templ.spilled_node = to_spill;
553         templ.reloaders    = NULL;
554         res = set_insert(env->spills, &templ, sizeof(templ), HASH_PTR(to_spill));
555
556         rel           = obstack_alloc(&env->obst, sizeof(rel[0]));
557         rel->reloader = before;
558         rel->next     = res->reloaders;
559         res->reloaders = rel;
560 }
561
562 void be_add_reload_on_edge(spill_env_t *env, ir_node *to_spill, ir_node *block, int pos) {
563         ir_node *predblock, *last;
564
565         /* simply add the reload to the beginning of the block if we only have 1 predecessor
566          * (we don't need to check for phis as there can't be any in a block with only 1 pred)
567          */
568         if(get_Block_n_cfgpreds(block) == 1) {
569                 assert(!is_Phi(sched_first(block)));
570                 be_add_reload(env, to_spill, sched_first(block));
571                 return;
572         }
573
574         // We have to reload the value in pred-block
575         predblock = get_Block_cfgpred_block(block, pos);
576         last = sched_last(predblock);
577         // there should be exactly 1 jump at the end of the block
578         assert(is_cfop(last));
579
580         // add the reload before the (cond-)jump
581         be_add_reload(env, to_spill, last);
582 }
583
584 /****************************************
585
586         SPILL SLOT MANAGEMENT AND OPTS
587
588 ****************************************/
589
590 typedef struct _spill_slot_t {
591         unsigned size;
592         unsigned align;
593         pset *members;
594         ir_mode *largest_mode;  /* the mode of all members with largest size */
595 } spill_slot_t;
596
597 typedef struct _ss_env_t {
598         struct obstack ob;
599         be_chordal_env_t *cenv;
600         pmap *slots;            /* maps spill_contexts to spill_slots */
601         pmap *types;    /* maps modes to types */
602         DEBUG_ONLY(firm_dbg_module_t *dbg;)
603 } ss_env_t;
604
605
606 /**
607  * Walker: compute the spill slots
608  */
609 static void compute_spill_slots_walker(ir_node *spill, void *env) {
610         ss_env_t *ssenv = env;
611         ir_node *ctx;
612         pmap_entry *entry;
613         spill_slot_t *ss;
614
615         if (!be_is_Spill(spill))
616                 return;
617
618         /* check, if this spill is for a context already known */
619         ctx = be_get_Spill_context(spill);
620         entry = pmap_find(ssenv->slots, ctx);
621
622         if (!entry) {
623                 struct _arch_env_t *arch_env     = ssenv->cenv->birg->main_env->arch_env;
624                 const arch_register_class_t *cls = arch_get_irn_reg_class(arch_env, spill, be_pos_Spill_val);
625                 ir_mode *largest_mode            = arch_register_class_mode(cls);
626
627                 /* this is a new spill context */
628                 ss = obstack_alloc(&ssenv->ob, sizeof(*ss));
629                 ss->members      = pset_new_ptr(8);
630                 ss->largest_mode = largest_mode;
631                 ss->size         = get_mode_size_bytes(ss->largest_mode);
632                 ss->align        = arch_isa_get_reg_class_alignment(arch_env->isa, cls);
633                 pmap_insert(ssenv->slots, ctx, ss);
634         } else {
635                 /* values with the same spill_ctx must go into the same spill slot */
636                 ss = entry->value;
637
638 #ifndef NDEBUG
639                 /* ugly mega assert :-) */
640                 {
641                         ir_node *irn;
642                         struct _arch_env_t *arch_env     = ssenv->cenv->birg->main_env->arch_env;
643                         const arch_register_class_t *cls = arch_get_irn_reg_class(arch_env, spill, be_pos_Spill_val);
644                         int size = get_mode_size_bytes(arch_register_class_mode(cls));
645                         assert((int) ss->size == size && "Different sizes for the same spill slot are not allowed.");
646                         for (irn = pset_first(ss->members); irn; irn = pset_next(ss->members)) {
647                                 /* use values_interfere here, because it uses the dominance check,
648                                          which does work for values in memory */
649                                 assert(!values_interfere(spill, irn) && "Spills for the same spill slot must not interfere!");
650                         }
651                 }
652 #endif /* NDEBUG */
653         }
654
655         pset_insert_ptr(ss->members, spill);
656 }
657
658 /**
659  * qsort compare function, sort spill slots by size.
660  */
661 static int ss_sorter(const void *v1, const void *v2) {
662         const spill_slot_t **ss1 = (const spill_slot_t **)v1;
663         const spill_slot_t **ss2 = (const spill_slot_t **)v2;
664         return ((int) (*ss2)->size) - ((int) (*ss1)->size);
665 }
666
667
668 /**
669  * This function should optimize the spill slots.
670  *  - Coalescing of multiple slots
671  *  - Ordering the slots
672  *
673  * Input slots are in @p ssenv->slots
674  * @p size The count of initial spill slots in @p ssenv->slots
675  *         This also is the size of the preallocated array @p ass
676  *
677  * @return An array of spill slots @p ass in specific order
678  **/
679 static void optimize_slots(ss_env_t *ssenv, int size, spill_slot_t *ass[]) {
680         int i, o, used_slots;
681         pmap_entry *entr;
682
683         i=0;
684         pmap_foreach(ssenv->slots, entr)
685                 ass[i++] = entr->value;
686
687         /* Sort the array to minimize fragmentation and cache footprint.
688            Large slots come first */
689         qsort(ass, size, sizeof(ass[0]), ss_sorter);
690
691         /* For each spill slot:
692                 - assign a new offset to this slot
693             - xor find another slot to coalesce with */
694         used_slots = 0;
695         for (i=0; i<size; ++i) { /* for each spill slot */
696                 ir_node *n1;
697                 int tgt_slot = -1;
698
699                 DBG((ssenv->dbg, LEVEL_1, "Spill slot %d members:\n", i));
700                 for(n1 = pset_first(ass[i]->members); n1; n1 = pset_next(ass[i]->members))
701                         DBG((ssenv->dbg, LEVEL_1, "  %+F\n", n1));
702
703
704                 for (o=0; o < used_slots && tgt_slot == -1; ++o) { /* for each offset-assigned spill slot */
705                         /* check inter-slot-pairs for interference */
706                         ir_node *n2;
707                         for(n1 = pset_first(ass[i]->members); n1; n1 = pset_next(ass[i]->members))
708                                 for(n2 = pset_first(ass[o]->members); n2; n2 = pset_next(ass[o]->members))
709                                         if(values_interfere(n1, n2)) {
710                                                 pset_break(ass[i]->members);
711                                                 pset_break(ass[o]->members);
712                                                 DBG((ssenv->dbg, LEVEL_1, "    Interf %+F -- %+F\n", n1, n2));
713                                                 goto interf_detected;
714                                         }
715
716                         /* if we are here, there is no interference between ass[i] and ass[o] */
717                         tgt_slot = o;
718
719 interf_detected: /*nothing*/ ;
720                 }
721
722                 /* now the members of ass[i] join the members of ass[tgt_slot] */
723
724                 /* do we need a new slot? */
725                 if (tgt_slot == -1) {
726                         tgt_slot = used_slots;
727                         used_slots++;
728
729                         /* init slot */
730                         if (tgt_slot != i) {
731                                 ass[tgt_slot]->size = ass[i]->size;
732                                 del_pset(ass[tgt_slot]->members);
733                                 ass[tgt_slot]->members = pset_new_ptr(8);
734                         }
735                 }
736
737                 /* copy the members to the target pset */
738                 /* NOTE: If src and tgt pset are the same, inserting while iterating is not allowed */
739                 if (tgt_slot != i)
740                         for(n1 = pset_first(ass[i]->members); n1; n1 = pset_next(ass[i]->members))
741                                         pset_insert_ptr(ass[tgt_slot]->members, n1);
742         }
743 }
744
745 #define ALIGN_SPILL_AREA 16
746 #define pset_foreach(pset, elm)  for(elm=pset_first(pset); elm; elm=pset_next(pset))
747
748 /**
749  * Returns a spill type for a mode. Keep them in a map to reduce
750  * the number of types.
751  *
752  * @param types  a map containing all created types
753  * @param ss     the spill slot
754  *
755  * Note that type types should are identical for every mode.
756  * This rule might break if two different register classes return the same
757  * mode but different alignments.
758  */
759 static ir_type *get_spill_type(pmap *types, spill_slot_t *ss) {
760         pmap_entry *e = pmap_find(types, ss->largest_mode);
761         ir_type *res;
762
763         if (! e) {
764                 char buf[64];
765                 snprintf(buf, sizeof(buf), "spill_slot_type_%s", get_mode_name(ss->largest_mode));
766                 res = new_type_primitive(new_id_from_str(buf), ss->largest_mode);
767                 set_type_alignment_bytes(res, ss->align);
768                 pmap_insert(types, ss->largest_mode, res);
769         } else {
770                 res = e->value;
771                 assert(get_type_alignment_bytes(res) == (int)ss->align);
772         }
773
774         return res;
775 }
776
777 /**
778  * Create spill slot entities on the frame type.
779  *
780  * @param ssenv   the spill environment
781  * @param n       number of spill slots
782  * @param ss      array of spill slots
783  */
784 static void assign_entities(ss_env_t *ssenv, int n_slots, spill_slot_t *ss[]) {
785         int i, offset, frame_align;
786         ir_type *frame = get_irg_frame_type(ssenv->cenv->irg);
787
788         /* aligning by increasing frame size */
789         offset = get_type_size_bits(frame) / 8;
790         offset = round_up2(offset, ALIGN_SPILL_AREA);
791         set_type_size_bytes(frame, -1);
792
793         /* create entities and assign offsets according to size and alignment*/
794         for (i = 0; i < n_slots; ++i) {
795                 char buf[64];
796                 ident *name;
797                 entity *spill_ent;
798                 ir_node *irn;
799
800                 /* build entity */
801                 snprintf(buf, sizeof(buf), "spill_slot_%d", i);
802                 name = new_id_from_str(buf);
803
804                 spill_ent = new_entity(frame, name, get_spill_type(ssenv->types, ss[i]));
805
806                 /* align */
807                 offset = round_up2(offset, ss[i]->align);
808                 /* set */
809                 set_entity_offset_bytes(spill_ent, offset);
810                 /* next possible offset */
811                 offset += round_up2(ss[i]->size, ss[i]->align);
812
813                 pset_foreach(ss[i]->members, irn)
814                         be_set_Spill_entity(irn, spill_ent);
815         }
816
817
818         /* set final size of stack frame */
819         frame_align = get_type_alignment_bytes(frame);
820         set_type_size_bytes(frame, round_up2(offset, frame_align));
821 }
822
823 void be_compute_spill_offsets(be_chordal_env_t *cenv) {
824         ss_env_t ssenv;
825         spill_slot_t **ss;
826         int ss_size;
827         pmap_entry *pme;
828
829         obstack_init(&ssenv.ob);
830         ssenv.cenv  = cenv;
831         ssenv.slots = pmap_create();
832         ssenv.types = pmap_create();
833         FIRM_DBG_REGISTER(ssenv.dbg, "ir.be.spillslots");
834
835         /* Get initial spill slots */
836         irg_walk_graph(cenv->irg, NULL, compute_spill_slots_walker, &ssenv);
837
838         /* Build an empty array for optimized spill slots */
839         ss_size = pmap_count(ssenv.slots);
840         ss = obstack_alloc(&ssenv.ob, ss_size * sizeof(*ss));
841         optimize_slots(&ssenv, ss_size, ss);
842
843         /* Integrate slots into the stack frame entity */
844         assign_entities(&ssenv, ss_size, ss);
845
846         /* Clean up */
847         pmap_foreach(ssenv.slots, pme)
848         del_pset(((spill_slot_t *)pme->value)->members);
849         pmap_destroy(ssenv.slots);
850         pmap_destroy(ssenv.types);
851         obstack_free(&ssenv.ob, NULL);
852
853         be_copy_entities_to_reloads(cenv->irg);
854 }