beflags: move be_Keep logic out of is_modify_flags function where it didn't really...
[libfirm] / ir / be / beflags.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       modifies schedule so flags dependencies are respected.
23  * @author      Matthias Braun, Christoph Mallon
24  * @version     $Id: besched.h 14693 2007-06-21 15:35:49Z beck $
25  *
26  * Fixup schedule to respect flag constraints by moving and rematerialisation of
27  * nodes.
28  *
29  * Flags are modeled as register classes with ignore registers. However to avoid
30  * bloating the graph, only flag-consumer -> producer dependencies are
31  * explicitely modeled in the graph. Nodes that just change the flags are only
32  * marked with the arch_irn_flags_modify_flags flag.
33  *
34  * Flags are usually a limited resource that can't (or at least shouldn't) be
35  * spilled. So in some situations (for example 2 adc-nodes that use the flags of
36  * a single add node on x86) operations have to be repeated to work correctly.
37  */
38 #include "config.h"
39
40 #include <stdbool.h>
41
42 #include "irgwalk.h"
43 #include "irnode_t.h"
44 #include "irtools.h"
45 #include "ircons.h"
46 #include "iredges_t.h"
47 #include "irprintf.h"
48 #include "error.h"
49
50 #include "beflags.h"
51 #include "bearch.h"
52 #include "beirg.h"
53 #include "besched.h"
54 #include "benode.h"
55 #include "belive.h"
56
57 static const arch_register_class_t *flag_class = NULL;
58 static const arch_register_t       *flags_reg  = NULL;
59 static func_rematerialize           remat      = NULL;
60 static int                          changed;
61
62 static ir_node *default_remat(ir_node *node, ir_node *after)
63 {
64         ir_node *block, *copy;
65         if (is_Block(after))
66                 block = after;
67         else
68                 block = get_nodes_block(after);
69
70         copy = exact_copy(node);
71         set_nodes_block(copy, block);
72         sched_add_after(after, copy);
73
74         return copy;
75 }
76
77 /**
78  * tests whether we can legally move node node after node after
79  * (only works for nodes in same block)
80  */
81 static bool can_move(ir_node *node, ir_node *after)
82 {
83         const ir_edge_t *edge;
84         assert(get_nodes_block(node) == get_nodes_block(after));
85
86         /* TODO respect dep edges */
87         assert(get_irn_n_edges_kind(node, EDGE_KIND_DEP) == 0);
88
89         /** all users have to be after the after node */
90         foreach_out_edge(node, edge) {
91                 ir_node *out = get_edge_src_irn(edge);
92                 if (is_Proj(out)) {
93                         const ir_edge_t *edge2;
94                         assert(get_irn_n_edges_kind(out, EDGE_KIND_DEP) == 0);
95                         foreach_out_edge(out, edge2) {
96                                 ir_node *out2 = get_edge_src_irn(edge2);
97                                 /* Phi or End represents a usage at block end. */
98                                 if (is_Phi(out2) || is_End(out2))
99                                         continue;
100                                 if (is_Sync(out2)) {
101                                         const ir_edge_t *edge3;
102                                         foreach_out_edge(out2, edge3) {
103                                                 ir_node *out3 = get_edge_src_irn(edge3);
104                                                 /* Phi or End represents a usage at block end. */
105                                                 if (is_Phi(out3) || is_End(out3))
106                                                         continue;
107                                                 assert(!is_Sync(out3));
108                                                 if (sched_get_time_step(out3) <= sched_get_time_step(after)) {
109                                                         return false;
110                                                 }
111                                         }
112                                 } else if (sched_get_time_step(out2) <= sched_get_time_step(after)) {
113                                         return false;
114                                 }
115                         }
116                 } else {
117                         /* phi represents a usage at block end */
118                         if (is_Phi(out))
119                                 continue;
120                         if (sched_get_time_step(out) <= sched_get_time_step(after)) {
121                                 return false;
122                         }
123                 }
124         }
125
126         return true;
127 }
128
129 static void rematerialize_or_move(ir_node *flags_needed, ir_node *node,
130                                   ir_node *flag_consumers, int pn, be_lv_t *lv)
131 {
132         ir_node *n;
133         ir_node *copy;
134         ir_node *value;
135
136         if (!is_Block(node) &&
137                         get_nodes_block(flags_needed) == get_nodes_block(node) &&
138                         can_move(flags_needed, node)) {
139                 /* move it */
140                 sched_remove(flags_needed);
141                 sched_add_after(node, flags_needed);
142                 /* No need to update liveness, because the node stays in the same block */
143                 return;
144         }
145
146         changed = 1;
147         copy    = remat(flags_needed, node);
148
149         if (get_irn_mode(copy) == mode_T) {
150                 ir_mode *mode = flag_class->mode;
151                 value = new_rd_Proj(NULL, copy, mode, pn);
152         } else {
153                 value = copy;
154         }
155
156         n = flag_consumers;
157         do {
158                 int i;
159                 int arity = get_irn_arity(n);
160                 for (i = 0; i < arity; ++i) {
161                         ir_node *in = get_irn_n(n, i);
162                         in = skip_Proj(in);
163                         if (in == flags_needed) {
164                                 set_irn_n(n, i, value);
165                                 break;
166                         }
167                 }
168                 n = get_irn_link(n);
169         } while (n != NULL);
170
171         /* No need to introduce the copy, because it only lives in this block, but
172          * we have to update the liveness of all operands */
173         if (is_Block(node) ||
174                         get_nodes_block(node) != get_nodes_block(flags_needed)) {
175                 int i;
176
177                 if (lv != NULL) {
178                         for (i = get_irn_arity(copy) - 1; i >= 0; --i) {
179                                 be_liveness_update(lv, get_irn_n(copy, i));
180                         }
181                 }
182         }
183 }
184
185 static bool is_modify_flags(ir_node *node)
186 {
187         return arch_irn_is(node, modify_flags);
188 }
189
190 /**
191  * walks up the schedule and makes sure there are no flag-destroying nodes
192  * between a flag-consumer -> flag-producer chain. Fixes problematic situations
193  * by moving and/or rematerialisation of the flag-producers.
194  * (This can be extended in the future to do some register allocation on targets
195  *  like ppc32 where we conceptually have 8 flag registers)
196  */
197 static void fix_flags_walker(ir_node *block, void *env)
198 {
199         ir_node *node;
200         ir_node *flags_needed   = NULL;
201         ir_node *flag_consumers = NULL;
202         int      pn = -1;
203
204         sched_foreach_reverse(block, node) {
205                 int i, arity;
206                 ir_node *new_flags_needed = NULL;
207                 ir_node *test;
208
209                 if (is_Phi(node))
210                         break;
211
212                 if (node == flags_needed) {
213                         /* all ok */
214                         flags_needed   = NULL;
215                         flag_consumers = NULL;
216                 }
217
218                 /* test whether node destroys the flags */
219                 test = node;
220                 if (be_is_Keep(test))
221                         test = sched_prev(test);
222
223                 if (flags_needed != NULL && is_modify_flags(test)) {
224                         /* rematerialize */
225                         rematerialize_or_move(flags_needed, node, flag_consumers, pn, env);
226                         flags_needed   = NULL;
227                         flag_consumers = NULL;
228                 }
229
230                 /* test whether the current node needs flags */
231                 arity = get_irn_arity(node);
232                 for (i = 0; i < arity; ++i) {
233                         const arch_register_class_t *cls = arch_get_irn_reg_class(node, i);
234                         if (cls == flag_class) {
235                                 assert(new_flags_needed == NULL);
236                                 new_flags_needed = get_irn_n(node, i);
237                         }
238                 }
239
240                 if (new_flags_needed == NULL)
241                         continue;
242
243                 /* spiller can't (correctly) remat flag consumers at the moment */
244                 assert(!arch_irn_is(node, rematerializable));
245
246                 if (skip_Proj(new_flags_needed) != flags_needed) {
247                         if (flags_needed != NULL) {
248                                 /* rematerialize node */
249                                 rematerialize_or_move(flags_needed, node, flag_consumers, pn, env);
250                                 flags_needed   = NULL;
251                                 flag_consumers = NULL;
252                         }
253
254                         flags_needed = new_flags_needed;
255                         arch_set_irn_register(flags_needed, flags_reg);
256                         if (is_Proj(flags_needed)) {
257                                 pn           = get_Proj_proj(flags_needed);
258                                 flags_needed = get_Proj_pred(flags_needed);
259                         }
260                         flag_consumers = node;
261                         set_irn_link(flag_consumers, NULL);
262                         assert(arch_irn_is(flags_needed, rematerializable));
263                 } else {
264                         /* link all consumers in a list */
265                         set_irn_link(node, flag_consumers);
266                         flag_consumers = node;
267                 }
268         }
269
270         if (flags_needed != NULL) {
271                 assert(get_nodes_block(flags_needed) != block);
272                 rematerialize_or_move(flags_needed, node, flag_consumers, pn, env);
273                 flags_needed   = NULL;
274                 flag_consumers = NULL;
275         }
276
277         assert(flags_needed   == NULL);
278         assert(flag_consumers == NULL);
279 }
280
281 void be_sched_fix_flags(ir_graph *irg, const arch_register_class_t *flag_cls,
282                         func_rematerialize remat_func)
283 {
284         flag_class = flag_cls;
285         flags_reg  = & flag_class->regs[0];
286         remat      = remat_func;
287         changed    = 0;
288         if (remat == NULL)
289                 remat = &default_remat;
290
291         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
292         irg_block_walk_graph(irg, fix_flags_walker, NULL, be_get_irg_liveness(irg));
293         ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
294
295         if (changed) {
296                 be_remove_dead_nodes_from_schedule(irg);
297         }
298 }