correctly? handle phi spilling in daemelspiller
[libfirm] / ir / be / bespilldaemel.c
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Naiv spilling algorithm
23  * @author      Matthias Braun
24  * @date        20.09.2005
25  * @version     $Id: bespillbelady.c 13913 2007-05-18 12:48:56Z matze $
26  * @summary
27  *   This implements a naiv spilling algorithm. It is design to produce similar
28  *   effects to the spill decisions produced by traditional graph coloring
29  *   register allocators that spill while they are coloring the graph.
30  *
31  *   This spiller walks over all blocks and looks for places with too high
32  *   register pressure where it spills the values that are cheapest to spill.
33  *   Spilling in this context means placing a spill instruction behind the
34  *   definition of the value and a reload before each usage.
35  */
36 #ifdef HAVE_CONFIG_H
37 #include "config.h"
38 #endif
39
40 #include "debug.h"
41
42 #include "irnodeset.h"
43 #include "irgwalk.h"
44 #include "irprintf.h"
45 #include "iredges_t.h"
46 #include "error.h"
47
48 #include "beirg.h"
49 #include "bespilloptions.h"
50 #include "bespill.h"
51 #include "bemodule.h"
52 #include "besched.h"
53 #include "bearch_t.h"
54 #include "be_t.h"
55 #include "benode_t.h"
56 #include "beirg.h"
57
58 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
59
60 typedef struct daemel_env_t daemel_env_t;
61 struct daemel_env_t {
62         spill_env_t                 *spill_env;
63         int                          n_regs;
64         const arch_env_t            *arch_env;
65         const arch_register_class_t *cls;
66         const be_lv_t               *lv;
67         bitset_t                    *spilled_nodes;
68 };
69
70 typedef struct spill_candidate_t spill_candidate_t;
71 struct spill_candidate_t {
72         double   costs;
73         ir_node *node;
74 };
75
76 static
77 int compare_spill_candidates_desc(const void *d1, const void *d2)
78 {
79         const spill_candidate_t *c1 = d1;
80         const spill_candidate_t *c2 = d2;
81
82         return (int) (c1->costs - c2->costs);
83 }
84
85 static
86 double get_spill_costs(daemel_env_t *env, ir_node *node)
87 {
88         const ir_edge_t *edge;
89         spill_env_t     *spill_env = env->spill_env;
90         double           costs     = be_get_spill_costs(spill_env, node, node);
91
92         foreach_out_edge(node, edge) {
93                 ir_node *use = get_edge_src_irn(edge);
94
95                 if(is_Phi(use)) {
96                         int      in         = get_edge_src_pos(edge);
97                         ir_node *block      = get_nodes_block(use);
98
99                         costs += be_get_reload_costs_on_edge(spill_env, node, block, in);
100                 } else {
101                         costs += be_get_reload_costs(spill_env, node, use);
102                 }
103         }
104
105         return costs;
106 }
107
108 /**
109  * spills a node by placing a reload before each usage
110  */
111 static
112 void spill_node(daemel_env_t *env, ir_node *node, ir_nodeset_t *nodes)
113 {
114         const ir_edge_t *edge;
115         spill_env_t     *spill_env       = env->spill_env;
116         const arch_register_class_t *cls = env->cls;
117
118         DBG((dbg, LEVEL_3, "\tspilling %+F\n", node));
119
120         foreach_out_edge(node, edge) {
121                 ir_node *use = get_edge_src_irn(edge);
122
123                 if(is_Phi(use)) {
124                         int      in         = get_edge_src_pos(edge);
125                         ir_node *block      = get_nodes_block(use);
126
127                         be_add_reload_on_edge(spill_env, node, block, in, cls, 1);
128                 } else if(!be_is_Keep(use)) {
129                         be_add_reload(spill_env, node, use, cls, 1);
130                 }
131         }
132
133         bitset_set(env->spilled_nodes, get_irn_idx(node));
134         ir_nodeset_remove(nodes, node);
135 }
136
137 /**
138  * spill @p n nodes from a nodeset. Removes the nodes from the nodeset and
139  * sets the spilled bits in env->spilled_nodes.
140  */
141 static
142 void do_spilling(daemel_env_t *env, ir_nodeset_t *nodes, ir_node *node)
143 {
144         size_t                       node_count         = ir_nodeset_size(nodes);
145         size_t                       additional_defines = 0;
146         int                          registers          = env->n_regs;
147         const arch_env_t            *arch_env           = env->arch_env;
148         const arch_register_class_t *cls                = env->cls;
149         spill_candidate_t           *candidates;
150         ir_nodeset_iterator_t        iter;
151         size_t                       i, arity;
152         int                          spills_needed;
153         size_t                       cand_idx;
154         ir_node                     *n;
155
156         /* mode_T nodes define several values at once. Count them */
157         if(get_irn_mode(node) == mode_T) {
158                 ir_node *proj  = sched_next(node);
159
160                 while(is_Proj(proj)) {
161                         if(arch_irn_consider_in_reg_alloc(arch_env, cls, proj)) {
162                                 ++additional_defines;
163                         }
164                         proj = sched_next(proj);
165                 }
166         }
167
168         spills_needed = (node_count + additional_defines) - registers;
169         if(spills_needed <= 0)
170                 return;
171         DBG((dbg, LEVEL_2, "\tspills needed after %+F: %d\n", node, spills_needed));
172
173         candidates = malloc(node_count * sizeof(candidates[0]));
174
175         /* construct array with spill candidates and calculate their costs */
176         i = 0;
177         foreach_ir_nodeset(nodes, n, iter) {
178                 spill_candidate_t *candidate = & candidates[i];
179
180                 candidate->node  = n;
181                 candidate->costs = get_spill_costs(env, n);
182                 ++i;
183         }
184         assert(i == node_count);
185
186         /* sort spill candidates */
187         qsort(candidates, node_count, sizeof(candidates[0]),
188               compare_spill_candidates_desc);
189
190         /* spill cheapest ones */
191         cand_idx = 0;
192         arity    = get_irn_arity(node);
193         while(spills_needed > 0) {
194                 spill_candidate_t *candidate = &candidates[cand_idx];
195                 ir_node           *cand_node = candidate->node;
196                 int                is_use;
197                 ++cand_idx;
198
199                 if(cand_idx >= node_count) {
200                         panic("can't spill enough values for node %+F\n", node);
201                 }
202
203                 /* make sure the node is not a use of the instruction */
204                 is_use = 0;
205                 for(i = 0; i < arity; ++i) {
206                         ir_node *in = get_irn_n(node, i);
207                         if(in == cand_node) {
208                                 is_use = 1;
209                                 break;
210                         }
211                 }
212                 if(is_use) {
213                         continue;
214                 }
215
216                 spill_node(env, cand_node, nodes);
217                 --spills_needed;
218         }
219
220         free(candidates);
221 }
222
223 /**
224  * similar to be_liveness_transfer.
225  * custom liveness transfer function, that doesn't place already spilled values
226  * into the liveness set
227  */
228 static
229 void liveness_transfer(daemel_env_t *env, ir_node *node, ir_nodeset_t *nodeset)
230 {
231         int i, arity;
232         const arch_register_class_t *cls      = env->cls;
233         const arch_env_t            *arch_env = env->arch_env;
234         const bitset_t              *bitset   = env->spilled_nodes;
235
236         /* You should better break out of your loop when hitting the first phi
237          * function. */
238         assert(!is_Phi(node) && "liveness_transfer produces invalid results for phi nodes");
239
240     if(arch_irn_consider_in_reg_alloc(arch_env, cls, node)) {
241         ir_nodeset_remove(nodeset, node);
242     }
243
244     arity = get_irn_arity(node);
245     for(i = 0; i < arity; ++i) {
246         ir_node *op = get_irn_n(node, i);
247
248         if(arch_irn_consider_in_reg_alloc(arch_env, cls, op)
249                    && !bitset_is_set(bitset, get_irn_idx(op))) {
250             ir_nodeset_insert(nodeset, op);
251                 }
252     }
253 }
254
255 /**
256  * make sure register pressure in a block is always equal or below the number
257  * of available registers
258  */
259 static
260 void spill_block(ir_node *block, void *data)
261 {
262         daemel_env_t                *env           = data;
263         const arch_env_t            *arch_env      = env->arch_env;
264         const arch_register_class_t *cls           = env->cls;
265         const be_lv_t               *lv            = env->lv;
266         ir_nodeset_t                 live_nodes;
267         ir_nodeset_iterator_t        iter;
268         ir_node                     *node;
269         bitset_t                    *spilled_nodes = env->spilled_nodes;
270         int                          phi_count;
271
272         DBG((dbg, LEVEL_1, "spilling block %+F\n", block));
273
274         ir_nodeset_init(&live_nodes);
275         be_liveness_end_of_block_ir_nodeset(lv, arch_env, cls, block, &live_nodes);
276
277         foreach_ir_nodeset(&live_nodes, node, iter) {
278                 DBG((dbg, LEVEL_2, "\t%+F is live-in... ", node));
279                 if(bitset_is_set(spilled_nodes, get_irn_idx(node))) {
280                         DBG((dbg, LEVEL_2, "but spilled; removing.\n"));
281                 } else {
282                         DBG((dbg, LEVEL_2, "keeping.\n"));
283                 }
284         }
285
286         sched_foreach_reverse(block, node) {
287                 if(is_Phi(node))
288                         break;
289
290                 if(is_Proj(node) || be_is_Keep(node)) {
291                         liveness_transfer(env, node, &live_nodes);
292                         continue;
293                 }
294
295                 do_spilling(env, &live_nodes, node);
296                 liveness_transfer(env, node, &live_nodes);
297         }
298         do_spilling(env, &live_nodes, node);
299
300         phi_count = 0;
301         int spilled_phis = 0;
302         sched_foreach(block, node) {
303                 if(!is_Phi(node))
304                         break;
305
306                 ++phi_count;
307                 if(bitset_is_set(spilled_nodes, get_irn_idx(node))) {
308                         ++spilled_phis;
309                 }
310         }
311         int regpressure       = ir_nodeset_size(&live_nodes) - spilled_phis;
312         int phi_spills_needed = regpressure - env->n_regs;
313         sched_foreach(block, node) {
314                 if(!is_Phi(node))
315                         break;
316                 if(phi_spills_needed <= 0)
317                         break;
318
319                 if(bitset_is_set(spilled_nodes, get_irn_idx(node))) {
320                         be_spill_phi(env->spill_env, node);
321                         --phi_spills_needed;
322                 }
323         }
324         assert(phi_spills_needed <= 0);
325
326         ir_nodeset_destroy(&live_nodes);
327 }
328
329 void be_spill_daemel(be_irg_t *birg, const arch_register_class_t *cls)
330 {
331         daemel_env_t  env;
332         ir_graph     *irg    = be_get_birg_irg(birg);
333         int           n_regs = cls->n_regs - be_put_ignore_regs(birg, cls, NULL);
334
335         if(n_regs == 0)
336                 return;
337
338         be_invalidate_liveness(birg);
339         be_assure_liveness(birg);
340
341         env.spill_env     = be_new_spill_env(birg);
342         env.n_regs        = n_regs;
343         env.arch_env      = be_get_birg_arch_env(birg);
344         env.cls           = cls;
345         env.lv            = be_get_birg_liveness(birg);
346         env.spilled_nodes = bitset_malloc(get_irg_last_idx(irg));
347
348         irg_block_walk_graph(irg, spill_block, NULL, &env);
349
350         bitset_free(env.spilled_nodes);
351
352         be_insert_spills_reloads(env.spill_env);
353
354         be_delete_spill_env(env.spill_env);
355 }
356
357 void be_init_daemelspill(void)
358 {
359         static be_spiller_t daemel_spiller = {
360                 be_spill_daemel
361         };
362
363         be_register_spiller("daemel", &daemel_spiller);
364         FIRM_DBG_REGISTER(dbg, "ir.be.spilldaemel");
365 }
366
367 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_doedelspill);