More generalization
[libfirm] / ir / be / bespill.c
1 /**
2  * Author:      Daniel Grund
3  * Date:                29.09.2005
4  * Copyright:   (c) Universitaet Karlsruhe
5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
6  */
7
8 #include "pset.h"
9 #include "irnode_t.h"
10 #include "ircons_t.h"
11 #include "debug.h"
12
13 #include "besched.h"
14 #include "bespill.h"
15 #include "benode_t.h"
16
17 typedef struct _reloader_t reloader_t;
18 typedef struct _spill_info_t spill_info_t;
19
20 struct _reloader_t {
21         reloader_t *next;
22         ir_node *reloader;
23 };
24
25 struct _spill_info_t {
26         ir_node *spilled_node;
27         reloader_t *reloaders;
28 };
29
30 typedef struct _spill_ctx_t {
31         ir_node *spilled;  /**< The spilled node. */
32         ir_node *user;     /**< The node this spill is for. */
33         ir_node *spill;    /**< The spill itself. */
34 } spill_ctx_t;
35
36 struct _spill_env_t {
37         firm_dbg_module_t *dbg;
38         const arch_register_class_t *cls;
39         const be_main_session_env_t *session;
40         struct obstack obst;
41         set *spill_ctxs;
42         set *spills;            /**< all spill_info_t's, which must be placed */
43 };
44
45 static int cmp_spillctx(const void *a, const void *b, size_t n) {
46         const spill_ctx_t *p = a;
47         const spill_ctx_t *q = b;
48         return !(p->user == q->user && p->spilled == q->spilled);
49 }
50
51 static int cmp_spillinfo(const void *x, const void *y, size_t size) {
52         const spill_info_t *xx = x;
53         const spill_info_t *yy = y;
54         return ! (xx->spilled_node == yy->spilled_node);
55 }
56
57 spill_env_t *be_new_spill_env(const be_main_session_env_t *session,
58                 const arch_register_class_t *cls)
59 {
60         spill_env_t *env = malloc(sizeof(env[0]));
61         env->spill_ctxs = new_set(cmp_spillctx, 1024);
62         env->spills     = new_set(cmp_spillinfo, 1024);
63         env->session    = session;
64         env->cls        = cls;
65         env->dbg        = firm_dbg_register("be.ra.spill_env");
66         obstack_init(&env->obst);
67         return env;
68 }
69
70 void be_delete_spill_env(spill_env_t *senv)
71 {
72         del_set(senv->spill_ctxs);
73         del_set(senv->spills);
74         obstack_free(&senv->obst, NULL);
75         free(senv);
76 }
77
78 static spill_ctx_t *be_get_spill_ctx(set *sc, ir_node *to_spill, ir_node *ctx_irn) {
79         spill_ctx_t templ;
80
81         templ.spilled = to_spill;
82         templ.user    = ctx_irn;
83         templ.spill   = NULL;
84
85         return set_insert(sc, &templ, sizeof(templ), HASH_COMBINE(HASH_PTR(to_spill), HASH_PTR(ctx_irn)));
86 }
87
88 static ir_node *be_spill_irn(spill_env_t *senv, ir_node *irn, ir_node *ctx_irn) {
89         spill_ctx_t *ctx;
90 //      DBG((dbg, DBG_SPILL, "spill_irn %+F\n", irn));
91
92         ctx = be_get_spill_ctx(senv->spill_ctxs, irn, ctx_irn);
93         if(!ctx->spill) {
94                 const be_main_env_t *env = senv->session->main_env;
95                 ctx->spill = be_spill(env->node_factory, env->arch_env, irn);
96         }
97
98         return ctx->spill;
99 }
100
101 /**
102  * If the first usage of a phi result would be out of memory
103  * there is no sense in allocating a register for it.
104  * Thus we spill it and all its operands to the same spill slot.
105  * Therefore the phi/dataB becomes a phi/Memory
106  */
107 static ir_node *be_spill_phi(spill_env_t *senv, ir_node *phi, ir_node *ctx_irn,
108                 pset *mem_phis) {
109         int i, n = get_irn_arity(phi);
110         ir_node **ins, *bl = get_nodes_block(phi);
111         ir_graph *irg = senv->session->irg;
112         spill_ctx_t *ctx;
113
114         assert(is_Phi(phi));
115 //      DBG((dbg, DBG_SPILL, "spill_phi %+F\n", phi));
116
117         /* search an existing spill for this context */
118         ctx = be_get_spill_ctx(senv->spill_ctxs, phi, ctx_irn);
119
120         /* if not found spill the phi */
121         if(!ctx->spill) {
122                 /* build a new PhiM with dummy in-array */
123                 ins  = malloc(n * sizeof(ins[0]));
124                 for(i=0; i<n; ++i)
125                         ins[i] = new_r_Unknown(irg, mode_M);
126                 ctx->spill = new_r_Phi(senv->session->irg, bl, n, ins, mode_M);
127                 free(ins);
128
129                 /* re-wire the phiM */
130                 for(i=0; i<n; ++i) {
131                         ir_node *arg = get_irn_n(phi, i);
132                         ir_node *sub_res;
133
134                         if(is_Phi(arg) && pset_find_ptr(mem_phis, arg))
135                                 sub_res = be_spill_phi(senv, arg, ctx_irn, mem_phis);
136                         else
137                                 sub_res = be_spill_irn(senv, arg, ctx_irn);
138
139                         set_irn_n(ctx->spill, i, sub_res);
140                 }
141         }
142         return ctx->spill;
143 }
144
145 ir_node *be_spill_node(spill_env_t *senv, ir_node *to_spill, pset *mem_phis) {
146         ir_node *res;
147         if (pset_find_ptr(mem_phis, to_spill))
148                 res = be_spill_phi(senv, to_spill, to_spill, mem_phis);
149         else
150                 res = be_spill_irn(senv, to_spill, to_spill);
151
152         return res;
153 }
154
155 void insert_spills_reloads(spill_env_t *senv, pset *mem_phis, pset *reload_set)
156 {
157         ir_graph *irg = senv->session->irg;
158         ir_node *irn;
159         spill_info_t *si;
160         struct obstack ob;
161
162         obstack_init(&ob);
163
164         /* process each spilled node */
165         for(si = set_first(senv->spills); si; si = set_next(senv->spills)) {
166                 reloader_t *rld;
167                 ir_node **reloads;
168                 int n_reloads = 0;
169                 ir_mode *mode = get_irn_mode(si->spilled_node);
170
171                 /* go through all reloads for this spill */
172                 for(rld = si->reloaders; rld; rld = rld->next) {
173                         /* the spill for this reloader */
174                         ir_node *spill   = be_spill_node(senv, si->spilled_node, mem_phis);
175
176                         /* the reload */
177                         ir_node *bl      = is_Block(rld->reloader) ? rld->reloader : get_nodes_block(rld->reloader);
178                         ir_node *reload  = new_Reload(senv->session->main_env->node_factory,
179                                                                                                                 senv->cls, irg, bl, mode, spill);
180
181                         DBG((senv->dbg, LEVEL_2, " RELOADER %+F   Reload %+F of %+F\n",
182                                                 rld->reloader, reload, si->spilled_node));
183                         if(reload_set)
184                                 pset_insert_ptr(reload_set, reload);
185
186                         /* remember the reaload */
187                         obstack_ptr_grow(&ob, reload);
188                         sched_add_before(rld->reloader, reload);
189                         n_reloads++;
190                 }
191
192                 assert(n_reloads > 0);
193                 reloads = obstack_finish(&ob);
194                 be_introduce_copies_ignore(senv->session->dom_front, si->spilled_node,
195                                 n_reloads, reloads, mem_phis);
196                 obstack_free(&ob, reloads);
197         }
198
199         obstack_free(&ob, NULL);
200
201         for(irn = pset_first(mem_phis); irn; irn = pset_next(mem_phis)) {
202                 int i, n;
203                 for(i = 0, n = get_irn_arity(irn); i < n; ++i)
204                         set_irn_n(irn, i, new_r_Bad(senv->session->irg));
205                 sched_remove(irn);
206         }
207 }
208
209 void be_add_spill(spill_env_t *senv, ir_node *to_spill, ir_node *before)
210 {
211         spill_info_t templ, *res;
212         reloader_t *rel;
213
214         templ.spilled_node = to_spill;
215         templ.reloaders    = NULL;
216         res = set_insert(senv->spills, &templ, sizeof(templ), HASH_PTR(to_spill));
217
218         rel           = obstack_alloc(&senv->obst, sizeof(rel[0]));
219         rel->reloader = before;
220         rel->next     = res->reloaders;
221         res->reloaders = rel;
222 }
223
224 void be_add_spill_on_edge(spill_env_t *senv, ir_node *to_spill, ir_node *bl, int pos)
225 {
226         ir_node *insert_bl = get_irn_arity(bl) == 1
227                 ? sched_first(bl) : get_Block_cfgpred_block(bl, pos);
228         be_add_spill(senv, to_spill, insert_bl);
229 }