Fixed and simplified rot matcher
[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 "irgmod.h"
36 #include "error.h"
37
38 #include "beirg_t.h"
39 #include "belive_t.h"
40 #include "bearch_t.h"
41 #include "benode_t.h"
42 #include "besched_t.h"
43 #include "bemodule.h"
44
45 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
46
47 static const arch_env_t *arch_env;
48 static be_lv_t          *lv;
49 static ir_node          *current_node;
50 static ir_node          *prev_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(arch_env, node);
64         if(reg == NULL) {
65                 panic("No register assigned at %+F\n", 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(arch_env, node);
89         if(reg == NULL) {
90                 panic("No register assigned at %+F\n", 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_before_exchange(const ir_node *old_node, ir_node *new_node)
129 {
130         const arch_register_t       *reg;
131         const arch_register_class_t *cls;
132         unsigned                     reg_idx;
133         unsigned                     cls_idx;
134
135         DBG((dbg, LEVEL_1, "About to exchange %+F with %+F\n", old_node, new_node));
136
137         if (old_node == current_node) {
138                 if (is_Proj(new_node)) {
139                         current_node = get_Proj_pred(new_node);
140                 } else {
141                         current_node = new_node;
142                 }
143         }
144
145         if (!mode_is_data(get_irn_mode(old_node)))
146                 return;
147
148         reg = arch_get_irn_register(arch_env, old_node);
149         if (reg == NULL) {
150                 panic("No register assigned at %+F\n", old_node);
151         }
152         cls     = arch_register_get_class(reg);
153         reg_idx = arch_register_get_index(reg);
154         cls_idx = arch_register_class_index(cls);
155
156         if (register_values[cls_idx][reg_idx] == old_node) {
157                 register_values[cls_idx][reg_idx] = new_node;
158         }
159
160         be_liveness_remove(lv, old_node);
161 }
162
163 void be_peephole_after_exchange(ir_node *new_node)
164 {
165         be_liveness_introduce(lv, new_node);
166 }
167
168 void be_peephole_before_exchange_and_kill(const ir_node *old_node, ir_node *new_node)
169 {
170         const arch_register_t       *reg;
171         const arch_register_class_t *cls;
172         unsigned                     reg_idx;
173         unsigned                     cls_idx;
174
175         DBG((dbg, LEVEL_1, "About to exchange and kill %+F with %+F\n", old_node, new_node));
176
177         if (old_node == current_node) {
178                 /* current_node will be killed. Its scheduling predecessor
179                    must be processed next. */
180                 prev_node = sched_prev(current_node);
181         }
182
183         if (!mode_is_data(get_irn_mode(old_node)))
184                 return;
185
186         reg = arch_get_irn_register(arch_env, old_node);
187         if (reg == NULL) {
188                 panic("No register assigned at %+F\n", old_node);
189         }
190         assert(reg == arch_get_irn_register(arch_env, new_node) &&
191               "KILLING a node and replacing by different register is not allowed");
192
193         cls     = arch_register_get_class(reg);
194         reg_idx = arch_register_get_index(reg);
195         cls_idx = arch_register_class_index(cls);
196
197         if (register_values[cls_idx][reg_idx] == old_node) {
198                 register_values[cls_idx][reg_idx] = new_node;
199         }
200
201         be_liveness_remove(lv, old_node);
202 }
203
204 /**
205  * block-walker: run peephole optimization on the given block.
206  */
207 static void process_block(ir_node *block, void *data)
208 {
209         unsigned n_classes;
210         unsigned i;
211         int l;
212         (void) data;
213
214         /* construct initial register assignment */
215         n_classes = arch_env_get_n_reg_class(arch_env);
216         for(i = 0; i < n_classes; ++i) {
217                 const arch_register_class_t *cls    = arch_env_get_reg_class(arch_env, i);
218                 unsigned                     n_regs = arch_register_class_n_regs(cls);
219                 memset(register_values[i], 0, sizeof(ir_node*) * n_regs);
220         }
221
222         assert(lv->nodes && "live sets must be computed");
223         DBG((dbg, LEVEL_1, "\nProcessing block %+F (from end)\n", block));
224         be_lv_foreach(lv, block, be_lv_state_end, l) {
225                 ir_node *node = be_lv_get_irn(lv, block, l);
226                 set_reg_value(node);
227         }
228         DBG((dbg, LEVEL_1, "\nstart processing\n"));
229
230         /* walk the block from last insn to the first */
231         current_node = sched_last(block);
232         for( ; !sched_is_begin(current_node);
233                 current_node = prev_node != NULL ? prev_node : sched_prev(current_node)) {
234                 ir_op             *op;
235                 ir_node           *last;
236                 peephole_opt_func  peephole_node;
237
238                 prev_node = NULL;
239                 if (is_Phi(current_node))
240                         break;
241
242                 clear_defs(current_node);
243                 set_uses(current_node);
244
245                 op   = get_irn_op(current_node);
246                 peephole_node = (peephole_opt_func)op->ops.generic;
247                 if (peephole_node == NULL)
248                         continue;
249
250                 last = current_node;
251                 peephole_node(current_node);
252                 /* was the current node replaced? */
253                 if (current_node != last)
254                         set_uses(current_node);
255         }
256 }
257
258 /**
259  * Walk through the block schedule and skip all barrier nodes.
260  */
261 static void skip_barrier(ir_node *ret_blk, ir_graph *irg) {
262         ir_node *irn;
263
264         sched_foreach_reverse(ret_blk, irn) {
265                 if (be_is_Barrier(irn)) {
266                         const ir_edge_t *edge, *next;
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                         sched_remove(irn);
277                         kill_node(irn);
278                         break;
279                 }
280         }
281 }
282
283 /**
284  * Kill the Barrier nodes for better peephole optimization.
285  */
286 static void     kill_barriers(ir_graph *irg) {
287         ir_node *end_blk = get_irg_end_block(irg);
288         ir_node *start_blk;
289         int i;
290
291         /* skip the barrier on all return blocks */
292         for (i = get_Block_n_cfgpreds(end_blk) - 1; i >= 0; --i) {
293                 ir_node *be_ret = get_Block_cfgpred(end_blk, i);
294                 ir_node *ret_blk = get_nodes_block(be_ret);
295
296                 skip_barrier(ret_blk, irg);
297         }
298
299         /* skip the barrier on the start block */
300         start_blk = get_irg_start_block(irg);
301         skip_barrier(start_blk, irg);
302 }
303
304 /*
305  * Tries to optimize a beIncSp node with it's previous IncSP node.
306  * Must be run from a be_peephole_opt() context.
307  */
308 ir_node *be_peephole_IncSP_IncSP(ir_node *node)
309 {
310         int      pred_offs;
311         int      curr_offs;
312         int      offs;
313         ir_node *pred = be_get_IncSP_pred(node);
314
315         if (!be_is_IncSP(pred))
316                 return node;
317
318         if (get_irn_n_edges(pred) > 1)
319                 return node;
320
321         pred_offs = be_get_IncSP_offset(pred);
322         curr_offs = be_get_IncSP_offset(node);
323
324         if (pred_offs == BE_STACK_FRAME_SIZE_EXPAND) {
325                 if (curr_offs != BE_STACK_FRAME_SIZE_SHRINK) {
326                         return node;
327                 }
328                 offs = 0;
329         } else if (pred_offs == BE_STACK_FRAME_SIZE_SHRINK) {
330                 if (curr_offs != BE_STACK_FRAME_SIZE_EXPAND) {
331                         return node;
332                 }
333                 offs = 0;
334         } else if (curr_offs == BE_STACK_FRAME_SIZE_EXPAND ||
335                    curr_offs == BE_STACK_FRAME_SIZE_SHRINK) {
336                 return node;
337         } else {
338                 offs = curr_offs + pred_offs;
339         }
340
341         /* add node offset to pred and remove our IncSP */
342         be_set_IncSP_offset(pred, offs);
343
344         be_peephole_before_exchange_and_kill(node, pred);
345
346         /* rewire dependency/data edges */
347         edges_reroute_kind(node, pred, EDGE_KIND_DEP, current_ir_graph);
348         edges_reroute(node, pred, current_ir_graph);
349         sched_remove(node);
350         be_kill_node(node);
351
352         return pred;
353 }
354
355 void be_peephole_opt(be_irg_t *birg)
356 {
357         ir_graph   *irg = be_get_birg_irg(birg);
358         unsigned n_classes;
359         unsigned i;
360
361         /* barrier nodes are used for register allocations. They hinders
362          * peephole optimizations, so remove them here. */
363         kill_barriers(irg);
364
365         /* we sometimes find BadE nodes in float apps like optest_float.c or
366          * kahansum.c for example... */
367         be_liveness_invalidate(birg->lv);
368         be_liveness_assure_sets(be_assure_liveness(birg));
369
370         arch_env = be_get_birg_arch_env(birg);
371         lv       = be_get_birg_liveness(birg);
372
373         n_classes = arch_env_get_n_reg_class(arch_env);
374         register_values = alloca(sizeof(register_values[0]) * n_classes);
375         for(i = 0; i < n_classes; ++i) {
376                 const arch_register_class_t *cls    = arch_env_get_reg_class(arch_env, i);
377                 unsigned                     n_regs = arch_register_class_n_regs(cls);
378                 register_values[i] = alloca(sizeof(ir_node*) * n_regs);
379         }
380
381         irg_block_walk_graph(irg, process_block, NULL, NULL);
382 }
383
384 void be_peephole_init(void)
385 {
386         clear_irp_opcodes_generic_func();
387 }
388
389 void be_init_peephole(void)
390 {
391         FIRM_DBG_REGISTER(dbg, "firm.be.peephole");
392 }
393
394 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_spillbelady);