Remove the unused parameter const arch_env_t *env from arch_get_irn_register().
[libfirm] / ir / be / bepeephole.c
1 /*
2  * Copyright (C) 1995-2008 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       Peephole optimisation framework keeps track of which registers contain which values
23  * @author      Matthias Braun
24  * @version     $Id$
25  */
26 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
29
30 #include "bepeephole.h"
31
32 #include "iredges_t.h"
33 #include "irgwalk.h"
34 #include "irprintf.h"
35 #include "ircons.h"
36 #include "irgmod.h"
37 #include "error.h"
38
39 #include "beirg_t.h"
40 #include "belive_t.h"
41 #include "bearch_t.h"
42 #include "benode_t.h"
43 #include "besched_t.h"
44 #include "bemodule.h"
45
46 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
47
48 static const arch_env_t *arch_env;
49 static be_lv_t          *lv;
50 static ir_node          *current_node;
51 ir_node               ***register_values;
52
53 static void clear_reg_value(ir_node *node)
54 {
55         const arch_register_t       *reg;
56         const arch_register_class_t *cls;
57         unsigned                     reg_idx;
58         unsigned                     cls_idx;
59
60         if(!mode_is_data(get_irn_mode(node)))
61                 return;
62
63         reg     = arch_get_irn_register(node);
64         if(reg == NULL) {
65                 panic("No register assigned at %+F", node);
66         }
67         if(arch_register_type_is(reg, virtual))
68                 return;
69         cls     = arch_register_get_class(reg);
70         reg_idx = arch_register_get_index(reg);
71         cls_idx = arch_register_class_index(cls);
72
73         //assert(register_values[cls_idx][reg_idx] != NULL);
74         DBG((dbg, LEVEL_1, "Clear Register %s\n", reg->name));
75         register_values[cls_idx][reg_idx] = NULL;
76 }
77
78 static void set_reg_value(ir_node *node)
79 {
80         const arch_register_t       *reg;
81         const arch_register_class_t *cls;
82         unsigned                     reg_idx;
83         unsigned                     cls_idx;
84
85         if(!mode_is_data(get_irn_mode(node)))
86                 return;
87
88         reg = arch_get_irn_register(node);
89         if(reg == NULL) {
90                 panic("No register assigned at %+F", node);
91         }
92         if(arch_register_type_is(reg, virtual))
93                 return;
94         cls     = arch_register_get_class(reg);
95         reg_idx = arch_register_get_index(reg);
96         cls_idx = arch_register_class_index(cls);
97
98         DBG((dbg, LEVEL_1, "Set Register %s: %+F\n", reg->name, node));
99         register_values[cls_idx][reg_idx] = node;
100 }
101
102 static void clear_defs(ir_node *node)
103 {
104         /* clear values defined */
105         if(get_irn_mode(node) == mode_T) {
106                 const ir_edge_t *edge;
107                 foreach_out_edge(node, edge) {
108                         ir_node *proj = get_edge_src_irn(edge);
109                         clear_reg_value(proj);
110                 }
111         } else {
112                 clear_reg_value(node);
113         }
114 }
115
116 static void set_uses(ir_node *node)
117 {
118         int i, arity;
119
120         /* set values used */
121         arity = get_irn_arity(node);
122         for(i = 0; i < arity; ++i) {
123                 ir_node *in = get_irn_n(node, i);
124                 set_reg_value(in);
125         }
126 }
127
128 void be_peephole_new_node(ir_node * nw)
129 {
130         be_liveness_introduce(lv, nw);
131 }
132
133 /**
134  * must be called from peephole optimisations before a node will be killed
135  * and its users will be redirected to new_node.
136  * so bepeephole can update it's internal state.
137  *
138  * Note: killing a node and rewiring os only allowed if new_node produces
139  * the same registers as old_node.
140  */
141 void be_peephole_before_exchange(const ir_node *old_node, ir_node *new_node)
142 {
143         const arch_register_t       *reg;
144         const arch_register_class_t *cls;
145         unsigned                     reg_idx;
146         unsigned                     cls_idx;
147
148         DBG((dbg, LEVEL_1, "About to exchange and kill %+F with %+F\n", old_node, new_node));
149
150         if (current_node == old_node) {
151                 /* next node to be processed will be killed. Its scheduling predecessor
152                  * must be processed next. */
153                 current_node = sched_next(current_node);
154                 assert (!is_Bad(current_node));
155         }
156
157         if (!mode_is_data(get_irn_mode(old_node)))
158                 return;
159
160         reg = arch_get_irn_register(old_node);
161         if (reg == NULL) {
162                 panic("No register assigned at %+F", old_node);
163         }
164         assert(reg == arch_get_irn_register(new_node) &&
165               "KILLING a node and replacing by different register is not allowed");
166
167         cls     = arch_register_get_class(reg);
168         reg_idx = arch_register_get_index(reg);
169         cls_idx = arch_register_class_index(cls);
170
171         if (register_values[cls_idx][reg_idx] == old_node) {
172                 register_values[cls_idx][reg_idx] = new_node;
173         }
174
175         be_liveness_remove(lv, old_node);
176 }
177
178 void be_peephole_exchange(ir_node *old, ir_node *nw)
179 {
180         be_peephole_before_exchange(old, nw);
181         sched_remove(old);
182         exchange(old, nw);
183         be_peephole_new_node(nw);
184 }
185
186 /**
187  * block-walker: run peephole optimization on the given block.
188  */
189 static void process_block(ir_node *block, void *data)
190 {
191         unsigned n_classes;
192         unsigned i;
193         int l;
194         (void) data;
195
196         /* construct initial register assignment */
197         n_classes = arch_env_get_n_reg_class(arch_env);
198         for(i = 0; i < n_classes; ++i) {
199                 const arch_register_class_t *cls    = arch_env_get_reg_class(arch_env, i);
200                 unsigned                     n_regs = arch_register_class_n_regs(cls);
201                 memset(register_values[i], 0, sizeof(ir_node*) * n_regs);
202         }
203
204         assert(lv->nodes && "live sets must be computed");
205         DBG((dbg, LEVEL_1, "\nProcessing block %+F (from end)\n", block));
206         be_lv_foreach(lv, block, be_lv_state_end, l) {
207                 ir_node *node = be_lv_get_irn(lv, block, l);
208                 set_reg_value(node);
209         }
210         DBG((dbg, LEVEL_1, "\nstart processing\n"));
211
212         /* walk the block from last insn to the first */
213         current_node = sched_last(block);
214         for( ; !sched_is_begin(current_node);
215                         current_node = sched_prev(current_node)) {
216                 ir_op             *op;
217                 peephole_opt_func  peephole_node;
218
219                 assert(!is_Bad(current_node));
220                 if (is_Phi(current_node))
221                         break;
222
223                 clear_defs(current_node);
224                 set_uses(current_node);
225
226                 op            = get_irn_op(current_node);
227                 peephole_node = (peephole_opt_func)op->ops.generic;
228                 if (peephole_node == NULL)
229                         continue;
230
231                 peephole_node(current_node);
232                 assert(!is_Bad(current_node));
233         }
234 }
235
236 static void kill_node_and_preds(ir_node *node)
237 {
238         int arity, i;
239
240         arity = get_irn_arity(node);
241         for (i = 0; i < arity; ++i) {
242                 ir_node *pred = get_irn_n(node, i);
243
244                 set_irn_n(node, i, new_Bad());
245                 if (get_irn_n_edges(pred) != 0)
246                         continue;
247
248                 kill_node_and_preds(pred);
249         }
250
251         if (!is_Proj(node))
252                 sched_remove(node);
253         kill_node(node);
254 }
255
256 /**
257  * Walk through the block schedule and skip all barrier nodes.
258  */
259 static void skip_barrier(ir_node *ret_blk, ir_graph *irg) {
260         ir_node *irn;
261
262         sched_foreach_reverse(ret_blk, irn) {
263                 const ir_edge_t *edge, *next;
264
265                 if (!be_is_Barrier(irn))
266                         continue;
267
268                 foreach_out_edge_safe(irn, edge, next) {
269                         ir_node *proj = get_edge_src_irn(edge);
270                         int      pn   = (int)get_Proj_proj(proj);
271                         ir_node *pred = get_irn_n(irn, pn);
272
273                         edges_reroute_kind(proj, pred, EDGE_KIND_NORMAL, irg);
274                         edges_reroute_kind(proj, pred, EDGE_KIND_DEP, irg);
275                 }
276
277                 kill_node_and_preds(irn);
278                 break;
279         }
280 }
281
282 /**
283  * Kill the Barrier nodes for better peephole optimization.
284  */
285 static void     kill_barriers(ir_graph *irg) {
286         ir_node *end_blk = get_irg_end_block(irg);
287         ir_node *start_blk;
288         int i;
289
290         /* skip the barrier on all return blocks */
291         for (i = get_Block_n_cfgpreds(end_blk) - 1; i >= 0; --i) {
292                 ir_node *be_ret = get_Block_cfgpred(end_blk, i);
293                 ir_node *ret_blk = get_nodes_block(be_ret);
294
295                 skip_barrier(ret_blk, irg);
296         }
297
298         /* skip the barrier on the start block */
299         start_blk = get_irg_start_block(irg);
300         skip_barrier(start_blk, irg);
301 }
302
303 /*
304  * Tries to optimize a beIncSp node with it's previous IncSP node.
305  * Must be run from a be_peephole_opt() context.
306  */
307 ir_node *be_peephole_IncSP_IncSP(ir_node *node)
308 {
309         int      pred_offs;
310         int      curr_offs;
311         int      offs;
312         ir_node *pred = be_get_IncSP_pred(node);
313
314         if (!be_is_IncSP(pred))
315                 return node;
316
317         if (get_irn_n_edges(pred) > 1)
318                 return node;
319
320         pred_offs = be_get_IncSP_offset(pred);
321         curr_offs = be_get_IncSP_offset(node);
322
323         if (pred_offs == BE_STACK_FRAME_SIZE_EXPAND) {
324                 if (curr_offs != BE_STACK_FRAME_SIZE_SHRINK) {
325                         return node;
326                 }
327                 offs = 0;
328         } else if (pred_offs == BE_STACK_FRAME_SIZE_SHRINK) {
329                 if (curr_offs != BE_STACK_FRAME_SIZE_EXPAND) {
330                         return node;
331                 }
332                 offs = 0;
333         } else if (curr_offs == BE_STACK_FRAME_SIZE_EXPAND ||
334                    curr_offs == BE_STACK_FRAME_SIZE_SHRINK) {
335                 return node;
336         } else {
337                 offs = curr_offs + pred_offs;
338         }
339
340         /* add node offset to pred and remove our IncSP */
341         be_set_IncSP_offset(pred, offs);
342
343         be_peephole_exchange(node, pred);
344         return pred;
345 }
346
347 void be_peephole_opt(be_irg_t *birg)
348 {
349         ir_graph   *irg = be_get_birg_irg(birg);
350         unsigned n_classes;
351         unsigned i;
352
353         /* barrier nodes are used for register allocations. They hinders
354          * peephole optimizations, so remove them here. */
355         kill_barriers(irg);
356
357         /* we sometimes find BadE nodes in float apps like optest_float.c or
358          * kahansum.c for example... */
359         be_liveness_invalidate(birg->lv);
360         be_liveness_assure_sets(be_assure_liveness(birg));
361
362         arch_env = be_get_birg_arch_env(birg);
363         lv       = be_get_birg_liveness(birg);
364
365         n_classes = arch_env_get_n_reg_class(arch_env);
366         register_values = alloca(sizeof(register_values[0]) * n_classes);
367         for(i = 0; i < n_classes; ++i) {
368                 const arch_register_class_t *cls    = arch_env_get_reg_class(arch_env, i);
369                 unsigned                     n_regs = arch_register_class_n_regs(cls);
370                 register_values[i] = alloca(sizeof(ir_node*) * n_regs);
371         }
372
373         irg_block_walk_graph(irg, process_block, NULL, NULL);
374 }
375
376 void be_peephole_init(void)
377 {
378         clear_irp_opcodes_generic_func();
379 }
380
381 void be_init_peephole(void)
382 {
383         FIRM_DBG_REGISTER(dbg, "firm.be.peephole");
384 }
385
386 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_peephole);