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