fixed indents
[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 "pset.h"
12 #include "irnode_t.h"
13 #include "ircons_t.h"
14 #include "iredges_t.h"
15 #include "debug.h"
16 #include "irgwalk.h"
17
18 #include "besched.h"
19 #include "bespill.h"
20 #include "benode_t.h"
21 #include "bechordal_t.h"
22
23 typedef struct _reloader_t reloader_t;
24 typedef struct _spill_info_t spill_info_t;
25
26 struct _reloader_t {
27         reloader_t *next;
28         ir_node *reloader;
29 };
30
31 struct _spill_info_t {
32         ir_node *spilled_node;
33         reloader_t *reloaders;
34 };
35
36 typedef struct _spill_ctx_t {
37         ir_node *spilled;  /**< The spilled node. */
38         ir_node *user;     /**< The node this spill is for. */
39         ir_node *spill;    /**< The spill itself. */
40 } spill_ctx_t;
41
42 struct _spill_env_t {
43         firm_dbg_module_t *dbg;
44         const arch_register_class_t *cls;
45         const be_chordal_env_t *chordal_env;
46         struct obstack obst;
47         set *spill_ctxs;
48         set *spills;                            /**< all spill_info_t's, which must be placed */
49         pset *mem_phis;                         /**< set of all special spilled phis. allocated and freed seperately */
50         decide_irn_t is_mem_phi;        /**< callback func to decide if a phi needs special spilling */
51         void *data;                                     /**< data passed to all callbacks */
52 };
53
54 static int cmp_spillctx(const void *a, const void *b, size_t n) {
55         const spill_ctx_t *p = a;
56         const spill_ctx_t *q = b;
57         return !(p->user == q->user && p->spilled == q->spilled);
58 }
59
60 static int cmp_spillinfo(const void *x, const void *y, size_t size) {
61         const spill_info_t *xx = x;
62         const spill_info_t *yy = y;
63         return ! (xx->spilled_node == yy->spilled_node);
64 }
65
66 spill_env_t *be_new_spill_env(firm_dbg_module_t *dbg,
67                                                           const be_chordal_env_t *chordal_env,
68                                                           decide_irn_t is_mem_phi, void *data) {
69
70         spill_env_t *env = malloc(sizeof(env[0]));
71         env->spill_ctxs  = new_set(cmp_spillctx, 1024);
72         env->spills      = new_set(cmp_spillinfo, 1024);
73         env->cls         = chordal_env->cls;
74         env->dbg         = dbg;
75         env->is_mem_phi  = is_mem_phi;
76         env->data        = data;
77         env->chordal_env = chordal_env;
78         obstack_init(&env->obst);
79         return env;
80 }
81
82 void be_delete_spill_env(spill_env_t *senv) {
83         del_set(senv->spill_ctxs);
84         del_set(senv->spills);
85         obstack_free(&senv->obst, NULL);
86         free(senv);
87 }
88
89 static spill_ctx_t *be_get_spill_ctx(set *sc, ir_node *to_spill, ir_node *ctx_irn) {
90         spill_ctx_t templ;
91
92         templ.spilled = to_spill;
93         templ.user    = ctx_irn;
94         templ.spill   = NULL;
95
96         return set_insert(sc, &templ, sizeof(templ), HASH_COMBINE(HASH_PTR(to_spill), HASH_PTR(ctx_irn)));
97 }
98
99 static ir_node *be_spill_irn(spill_env_t *senv, ir_node *irn, ir_node *ctx_irn) {
100         spill_ctx_t *ctx;
101         DBG((senv->dbg, LEVEL_1, "%+F in ctx %+F\n", irn, ctx_irn));
102
103         ctx = be_get_spill_ctx(senv->spill_ctxs, irn, ctx_irn);
104         if(!ctx->spill) {
105                 const be_main_env_t *env = senv->chordal_env->main_env;
106                 ctx->spill = be_spill(env->node_factory, env->arch_env, irn, ctx_irn);
107         }
108
109         return ctx->spill;
110 }
111
112 /**
113  * If the first usage of a phi result would be out of memory
114  * there is no sense in allocating a register for it.
115  * Thus we spill it and all its operands to the same spill slot.
116  * Therefore the phi/dataB becomes a phi/Memory
117  */
118 static ir_node *be_spill_phi(spill_env_t *senv, ir_node *phi, ir_node *ctx_irn) {
119         int i, n = get_irn_arity(phi);
120         ir_node **ins, *bl = get_nodes_block(phi);
121         ir_graph *irg = senv->chordal_env->irg;
122         spill_ctx_t *ctx;
123
124         assert(is_Phi(phi));
125         DBG((senv->dbg, LEVEL_1, "%+F in ctx %+F\n", phi, ctx_irn));
126
127         /* search an existing spill for this context */
128         ctx = be_get_spill_ctx(senv->spill_ctxs, phi, ctx_irn);
129
130         /* if not found spill the phi */
131         if(!ctx->spill) {
132                 /* build a new PhiM with dummy in-array */
133                 ins  = malloc(n * sizeof(ins[0]));
134                 for(i=0; i<n; ++i)
135                         ins[i] = new_r_Unknown(irg, mode_M);
136                 ctx->spill = new_r_Phi(senv->chordal_env->irg, bl, n, ins, mode_M);
137                 free(ins);
138
139                 /* re-wire the phiM */
140                 for(i=0; i<n; ++i) {
141                         ir_node *arg = get_irn_n(phi, i);
142                         ir_node *sub_res;
143
144                         if(is_Phi(arg) && pset_find_ptr(senv->mem_phis, arg))
145                                 sub_res = be_spill_phi(senv, arg, ctx_irn);
146                         else
147                                 sub_res = be_spill_irn(senv, arg, ctx_irn);
148
149                         set_irn_n(ctx->spill, i, sub_res);
150                 }
151         }
152         return ctx->spill;
153 }
154
155 static ir_node *be_spill_node(spill_env_t *senv, ir_node *to_spill) {
156         ir_node *res;
157         if (pset_find_ptr(senv->mem_phis, to_spill))
158                 res = be_spill_phi(senv, to_spill, to_spill);
159         else
160                 res = be_spill_irn(senv, to_spill, to_spill);
161
162         return res;
163 }
164
165 static void phi_walker(ir_node *irn, void *env) {
166         spill_env_t *senv = env;
167         const arch_env_t *arch = senv->chordal_env->main_env->arch_env;
168
169         if (is_Phi(irn) && arch_irn_has_reg_class(arch, irn, 0, senv->cls)
170                         && senv->is_mem_phi(irn, senv->data)) {
171                 DBG((senv->dbg, LEVEL_1, "  %+F\n", irn));
172                 pset_insert_ptr(senv->mem_phis, irn);
173         }
174 }
175
176 void be_insert_spills_reloads(spill_env_t *senv, pset *reload_set) {
177         ir_graph *irg = senv->chordal_env->irg;
178         ir_node *irn;
179         spill_info_t *si;
180         struct obstack ob;
181
182         obstack_init(&ob);
183
184         /* get all special spilled phis */
185         DBG((senv->dbg, LEVEL_1, "Mem-phis:\n"));
186         senv->mem_phis = pset_new_ptr_default();
187         irg_walk_graph(senv->chordal_env->irg, phi_walker, NULL, senv);
188
189         /* Add reloads for mem_phis */
190         /* BETTER: These reloads (1) should only be inserted, if they are really needed */
191         DBG((senv->dbg, LEVEL_1, "Reloads for mem-phis:\n"));
192         for(irn = pset_first(senv->mem_phis); irn; irn = pset_next(senv->mem_phis)) {
193                 const ir_edge_t *e;
194                 DBG((senv->dbg, LEVEL_1, " Mem-phi %+F\n", irn));
195                 foreach_out_edge(irn, e) {
196                         ir_node *user = e->src;
197                         if (is_Phi(user) && !pset_find_ptr(senv->mem_phis, user)) {
198                                         ir_node *use_bl = get_nodes_block(user);
199                                         DBG((senv->dbg, LEVEL_1, " non-mem-phi user %+F\n", user));
200                                         be_add_reload_on_edge(senv, irn, use_bl, e->pos); /* (1) */
201                         }
202                 }
203         }
204
205         /* process each spilled node */
206         DBG((senv->dbg, LEVEL_1, "Insert spills and reloads:\n"));
207         for(si = set_first(senv->spills); si; si = set_next(senv->spills)) {
208                 reloader_t *rld;
209                 ir_node **reloads;
210                 int n_reloads = 0;
211                 ir_mode *mode = get_irn_mode(si->spilled_node);
212
213                 /* go through all reloads for this spill */
214                 for(rld = si->reloaders; rld; rld = rld->next) {
215                         /* the spill for this reloader */
216                         ir_node *spill   = be_spill_node(senv, si->spilled_node);
217
218                         /* the reload */
219                         ir_node *bl      = is_Block(rld->reloader) ? rld->reloader : get_nodes_block(rld->reloader);
220                         ir_node *reload  = new_Reload(senv->chordal_env->main_env->node_factory,
221                                 senv->cls, irg, bl, mode, spill);
222
223                         DBG((senv->dbg, LEVEL_1, " %+F of %+F before %+F\n", reload, si->spilled_node, rld->reloader));
224                         if(reload_set)
225                                 pset_insert_ptr(reload_set, reload);
226
227                         /* remember the reaload */
228                         obstack_ptr_grow(&ob, reload);
229                         sched_add_before(rld->reloader, reload);
230                         n_reloads++;
231                 }
232
233                 assert(n_reloads > 0);
234                 reloads = obstack_finish(&ob);
235                 be_introduce_copies_ignore(senv->chordal_env->dom_front, si->spilled_node,
236                                 n_reloads, reloads, senv->mem_phis);
237                 obstack_free(&ob, reloads);
238         }
239
240         obstack_free(&ob, NULL);
241
242         for(irn = pset_first(senv->mem_phis); irn; irn = pset_next(senv->mem_phis)) {
243                 int i, n;
244                 for(i = 0, n = get_irn_arity(irn); i < n; ++i)
245                         set_irn_n(irn, i, new_r_Bad(senv->chordal_env->irg));
246                 sched_remove(irn);
247         }
248
249         del_pset(senv->mem_phis);
250 }
251
252 void be_add_reload(spill_env_t *senv, ir_node *to_spill, ir_node *before) {
253         spill_info_t templ, *res;
254         reloader_t *rel;
255
256         templ.spilled_node = to_spill;
257         templ.reloaders    = NULL;
258         res = set_insert(senv->spills, &templ, sizeof(templ), HASH_PTR(to_spill));
259
260         rel           = obstack_alloc(&senv->obst, sizeof(rel[0]));
261         rel->reloader = before;
262         rel->next     = res->reloaders;
263         res->reloaders = rel;
264 }
265
266 void be_add_reload_on_edge(spill_env_t *senv, ir_node *to_spill, ir_node *bl, int pos) {
267         ir_node *insert_bl = get_irn_arity(bl) == 1 ? sched_first(bl) : get_Block_cfgpred_block(bl, pos);
268         be_add_reload(senv, to_spill, insert_bl);
269 }