bearch: Add and use be_foreach_value().
[libfirm] / ir / be / bepeephole.c
1 /*
2  * Copyright (C) 1995-2011 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  */
25 #include "config.h"
26
27 #include "array_t.h"
28 #include "bepeephole.h"
29
30 #include "iredges_t.h"
31 #include "irgwalk.h"
32 #include "irprintf.h"
33 #include "ircons.h"
34 #include "irgmod.h"
35 #include "heights.h"
36 #include "error.h"
37
38 #include "beirg.h"
39 #include "belive_t.h"
40 #include "bearch.h"
41 #include "beintlive_t.h"
42 #include "benode.h"
43 #include "besched.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         unsigned               reg_idx;
57
58         if (!mode_is_data(get_irn_mode(node)))
59                 return;
60
61         reg = arch_get_irn_register(node);
62         if (reg == NULL) {
63                 panic("No register assigned at %+F", node);
64         }
65         if (reg->type & arch_register_type_virtual)
66                 return;
67         reg_idx = reg->global_index;
68
69         DB((dbg, LEVEL_1, "Clear Register %s\n", reg->name));
70         register_values[reg_idx] = NULL;
71 }
72
73 static void set_reg_value(ir_node *node)
74 {
75         const arch_register_t *reg;
76         unsigned               reg_idx;
77
78         if (!mode_is_data(get_irn_mode(node)))
79                 return;
80
81         reg = arch_get_irn_register(node);
82         if (reg == NULL) {
83                 panic("No register assigned at %+F", node);
84         }
85         if (reg->type & arch_register_type_virtual)
86                 return;
87         reg_idx = reg->global_index;
88
89         DB((dbg, LEVEL_1, "Set Register %s: %+F\n", reg->name, node));
90         register_values[reg_idx] = node;
91 }
92
93 static void clear_defs(ir_node *node)
94 {
95         /* clear values defined */
96         be_foreach_value(node, value,
97                 clear_reg_value(value);
98         );
99 }
100
101 static void set_uses(ir_node *node)
102 {
103         int i, arity;
104
105         /* set values used */
106         arity = get_irn_arity(node);
107         for (i = 0; i < arity; ++i) {
108                 ir_node *in = get_irn_n(node, i);
109                 set_reg_value(in);
110         }
111 }
112
113 void be_peephole_new_node(ir_node * nw)
114 {
115         be_liveness_introduce(lv, nw);
116 }
117
118 /**
119  * must be called from peephole optimisations before a node will be killed
120  * and its users will be redirected to new_node.
121  * so bepeephole can update its internal state.
122  *
123  * Note: killing a node and rewiring is only allowed if new_node produces
124  * the same registers as old_node.
125  */
126 static void be_peephole_before_exchange(const ir_node *old_node,
127                                         ir_node *new_node)
128 {
129         const arch_register_t *reg;
130         unsigned               reg_idx;
131         bool                   old_is_current = false;
132
133         DB((dbg, LEVEL_1, "About to exchange and kill %+F with %+F\n", old_node, new_node));
134
135         assert(sched_is_scheduled(skip_Proj_const(old_node)));
136         assert(sched_is_scheduled(skip_Proj(new_node)));
137
138         if (current_node == old_node) {
139                 old_is_current = true;
140
141                 /* next node to be processed will be killed. Its scheduling predecessor
142                  * must be processed next. */
143                 current_node = sched_next(current_node);
144                 assert (!is_Bad(current_node));
145
146                 /* we can't handle liveness updates correctly when exchange current node
147                  * with something behind it */
148                 assert(value_dominates(skip_Proj(new_node), skip_Proj_const(old_node)));
149         }
150
151         if (!mode_is_data(get_irn_mode(old_node)))
152                 return;
153
154         reg = arch_get_irn_register(old_node);
155         if (reg == NULL) {
156                 panic("No register assigned at %+F", old_node);
157         }
158         assert(reg == arch_get_irn_register(new_node) &&
159               "KILLING a node and replacing by different register is not allowed");
160
161         reg_idx = reg->global_index;
162         if (register_values[reg_idx] == old_node || old_is_current) {
163                 register_values[reg_idx] = new_node;
164         }
165
166         be_liveness_remove(lv, old_node);
167 }
168
169 void be_peephole_exchange(ir_node *old, ir_node *nw)
170 {
171         be_peephole_before_exchange(old, nw);
172         sched_remove(old);
173         exchange(old, nw);
174         be_peephole_new_node(nw);
175 }
176
177 /**
178  * block-walker: run peephole optimization on the given block.
179  */
180 static void process_block(ir_node *block, void *data)
181 {
182         (void) data;
183
184         /* construct initial register assignment */
185         memset(register_values, 0, sizeof(ir_node*) * arch_env->n_registers);
186
187         assert(lv->sets_valid && "live sets must be computed");
188         DB((dbg, LEVEL_1, "\nProcessing block %+F (from end)\n", block));
189         be_lv_foreach(lv, block, be_lv_state_end, node) {
190                 set_reg_value(node);
191         }
192         DB((dbg, LEVEL_1, "\nstart processing\n"));
193
194         /* walk the block from last insn to the first */
195         current_node = sched_last(block);
196         for ( ; !sched_is_begin(current_node);
197                         current_node = sched_prev(current_node)) {
198                 ir_op             *op;
199                 peephole_opt_func  peephole_node;
200
201                 assert(!is_Bad(current_node));
202                 if (is_Phi(current_node))
203                         break;
204
205                 clear_defs(current_node);
206                 set_uses(current_node);
207
208                 op            = get_irn_op(current_node);
209                 peephole_node = (peephole_opt_func)op->ops.generic;
210                 if (peephole_node == NULL)
211                         continue;
212
213                 DB((dbg, LEVEL_2, "optimize %+F\n", current_node));
214                 peephole_node(current_node);
215                 assert(!is_Bad(current_node));
216         }
217 }
218
219 /**
220  * Check whether the node has only one user.  Explicitly ignore the anchor.
221  */
222 bool be_has_only_one_user(ir_node *node)
223 {
224         int n = get_irn_n_edges(node);
225         int n_users;
226
227         if (n <= 1)
228                 return 1;
229
230         n_users = 0;
231         foreach_out_edge(node, edge) {
232                 ir_node *src = get_edge_src_irn(edge);
233                 /* ignore anchor and keep-alive edges */
234                 if (is_Anchor(src) || is_End(src))
235                         continue;
236                 n_users++;
237         }
238
239         return n_users == 1;
240 }
241
242 static inline bool overlapping_regs(const arch_register_t *reg0,
243         const arch_register_req_t *req0, const arch_register_t *reg1,
244         const arch_register_req_t *req1)
245 {
246         if (reg0 == NULL || reg1 == NULL)
247                 return false;
248         return reg0->global_index < (unsigned)reg1->global_index + req1->width
249                 && reg1->global_index < (unsigned)reg0->global_index + req0->width;
250 }
251
252 bool be_can_move_down(ir_heights_t *heights, const ir_node *node,
253                       const ir_node *before)
254 {
255         assert(get_nodes_block(node) == get_nodes_block(before));
256         assert(sched_get_time_step(node) < sched_get_time_step(before));
257
258         int      node_arity = get_irn_arity(node);
259         ir_node *schedpoint = sched_next(node);
260
261         while (schedpoint != before) {
262                 /* schedpoint must not use our computed values */
263                 if (heights_reachable_in_block(heights, schedpoint, node))
264                         return false;
265
266                 /* schedpoint must not overwrite registers of our inputs */
267                 for (int i = 0; i < node_arity; ++i) {
268                         ir_node                   *in  = get_irn_n(node, i);
269                         const arch_register_t     *reg = arch_get_irn_register(in);
270                         if (reg == NULL)
271                                 continue;
272                         const arch_register_req_t *in_req
273                                 = arch_get_irn_register_req_in(node, i);
274                         be_foreach_out(schedpoint, o) {
275                                 const arch_register_t *outreg
276                                         = arch_get_irn_register_out(schedpoint, o);
277                                 const arch_register_req_t *outreq
278                                         = arch_get_irn_register_req_out(schedpoint, o);
279                                 if (overlapping_regs(reg, in_req, outreg, outreq))
280                                         return false;
281                         }
282                 }
283
284                 schedpoint = sched_next(schedpoint);
285         }
286         return true;
287 }
288
289 bool be_can_move_up(ir_heights_t *heights, const ir_node *node,
290                     const ir_node *after)
291 {
292         const ir_node *node_block  = get_nodes_block(node);
293         const ir_node *after_block = get_block_const(after);
294         const ir_node *schedpoint;
295         if (node_block != after_block) {
296                 /* currently we can move up exactly 1 block */
297                 assert(get_Block_cfgpred_block(node_block, 0) == after_block);
298                 ir_node *first = sched_first(node_block);
299
300                 /* do not move nodes changing memory */
301                 if (is_memop(node)) {
302                         ir_node *meminput = get_memop_mem(node);
303                         if (!is_NoMem(meminput))
304                                 return false;
305                 }
306
307                 /* make sure we can move to the beginning of the succ block */
308                 if (node != first && !be_can_move_up(heights, node, sched_prev(first)))
309                         return false;
310
311                 /* check if node overrides any of live-in values of other successors */
312                 ir_graph *irg = get_irn_irg(node);
313                 be_lv_t  *lv  = be_get_irg_liveness(irg);
314                 foreach_block_succ(after_block, edge) {
315                         ir_node *succ = get_edge_src_irn(edge);
316                         if (succ == node_block)
317                                 continue;
318
319                         be_lv_foreach(lv, succ, be_lv_state_in, live_node) {
320                                 const arch_register_t     *reg = arch_get_irn_register(live_node);
321                                 const arch_register_req_t *req = arch_get_irn_register_req(live_node);
322                                 be_foreach_out(node, o) {
323                                         const arch_register_t *outreg
324                                                 = arch_get_irn_register_out(node, o);
325                                         const arch_register_req_t *outreq
326                                                 = arch_get_irn_register_req_out(node, o);
327                                         if (overlapping_regs(outreg, outreq, reg, req))
328                                                 return false;
329                                 }
330                         }
331                         sched_foreach(succ, phi) {
332                                 if (!is_Phi(phi))
333                                         break;
334                                 const arch_register_t     *reg = arch_get_irn_register(phi);
335                                 const arch_register_req_t *req = arch_get_irn_register_req(phi);
336                                 be_foreach_out(node, o) {
337                                         const arch_register_t *outreg
338                                                 = arch_get_irn_register_out(node, o);
339                                         const arch_register_req_t *outreq
340                                                 = arch_get_irn_register_req_out(node, o);
341                                         if (overlapping_regs(outreg, outreq, reg, req))
342                                                 return false;
343                                 }
344                         }
345                 }
346                 schedpoint = sched_last(after_block);
347         } else {
348                 schedpoint = sched_prev(node);
349         }
350
351         /* move schedule upwards until we hit the "after" node */
352         while (schedpoint != after) {
353                 /* TODO: the following heights query only works for nodes in the same
354                  * block, otherwise we have to be conservative here */
355                 if (get_nodes_block(node) != get_nodes_block(schedpoint))
356                         return false;
357                 /* node must not depend on schedpoint */
358                 if (heights_reachable_in_block(heights, node, schedpoint))
359                         return false;
360
361                 /* node must not overwrite registers used by schedpoint */
362                 int arity = get_irn_arity(schedpoint);
363                 for (int i = 0; i < arity; ++i) {
364                         const arch_register_t *reg
365                                 = arch_get_irn_register_in(schedpoint, i);
366                         if (reg == NULL)
367                                 continue;
368                         const arch_register_req_t *in_req
369                                 = arch_get_irn_register_req_in(schedpoint, i);
370                         be_foreach_out(node, o) {
371                                 const arch_register_t *outreg
372                                         = arch_get_irn_register_out(node, o);
373                                 const arch_register_req_t *outreq
374                                         = arch_get_irn_register_req_out(node, o);
375                                 if (overlapping_regs(outreg, outreq, reg, in_req))
376                                         return false;
377                         }
378                 }
379
380                 schedpoint = sched_prev(schedpoint);
381         }
382         return true;
383 }
384
385 /*
386  * Tries to optimize a beIncSP node with its previous IncSP node.
387  * Must be run from a be_peephole_opt() context.
388  */
389 ir_node *be_peephole_IncSP_IncSP(ir_node *node)
390 {
391         int      pred_offs;
392         int      curr_offs;
393         int      offs;
394         ir_node *pred = be_get_IncSP_pred(node);
395
396         if (!be_is_IncSP(pred))
397                 return node;
398
399         if (!be_has_only_one_user(pred))
400                 return node;
401
402         pred_offs = be_get_IncSP_offset(pred);
403         curr_offs = be_get_IncSP_offset(node);
404         offs = curr_offs + pred_offs;
405
406         /* add node offset to pred and remove our IncSP */
407         be_set_IncSP_offset(pred, offs);
408
409         be_peephole_exchange(node, pred);
410         return pred;
411 }
412
413 void be_peephole_opt(ir_graph *irg)
414 {
415 #if 0
416         /* we sometimes find BadE nodes in float apps like optest_float.c or
417          * kahansum.c for example... */
418         be_invalidate_live_sets(irg);
419 #endif
420         be_assure_live_sets(irg);
421
422         arch_env = be_get_irg_arch_env(irg);
423         lv       = be_get_irg_liveness(irg);
424
425         register_values = XMALLOCN(ir_node*, arch_env->n_registers);
426
427         irg_block_walk_graph(irg, process_block, NULL, NULL);
428
429         xfree(register_values);
430 }
431
432 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_peephole)
433 void be_init_peephole(void)
434 {
435         FIRM_DBG_REGISTER(dbg, "firm.be.peephole");
436 }