- Remove stale comment.
[libfirm] / ir / be / beschednormal.c
1 /*
2  * Copyright (C) 1995-2007 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  * @brief   Use the strong normal form theorem (though it does not hold)
22  * @author  Christoph Mallon
23  * @version $Id$
24  */
25 #ifdef HAVE_CONFIG_H
26 #include "config.h"
27 #endif
28
29 #include <stdlib.h>
30
31 #include "besched_t.h"
32 #include "belistsched.h"
33 #include "belive_t.h"
34 #include "beutil.h"
35 #include "irtools.h"
36 #include "irgwalk.h"
37 #include "benode_t.h"
38
39
40 // XXX there is no one time init for schedulers
41 //#define NORMAL_DBG
42
43
44 static const arch_env_t *cur_arch_env;
45
46
47 static ir_node *normal_select(void *block_env, ir_nodeset_t *ready_set,
48                               ir_nodeset_t *live_set)
49 {
50         ir_nodeset_iterator_t iter;
51         ir_node*  block;
52         ir_node*  irn;
53         ir_node** sched;
54         int sched_count;
55
56         (void)block_env;
57         (void)live_set;
58
59         ir_nodeset_iterator_init(&iter, ready_set);
60         irn = ir_nodeset_iterator_next(&iter);
61         block = get_nodes_block(irn);
62         sched = get_irn_link(block);
63         sched_count = ARR_LEN(sched);
64         for (; sched_count-- != 0; ++sched) {
65                 ir_node* irn = *sched;
66                 if (ir_nodeset_contains(ready_set, irn) &&
67                                 !arch_irn_class_is(cur_arch_env, irn, branch)) {
68 #if defined NORMAL_DBG
69                         ir_fprintf(stderr, "scheduling %+F\n", irn);
70 #endif
71                         return irn;
72                 }
73         }
74
75         return irn;
76 }
77
78
79 typedef struct irn_cost_pair {
80         ir_node* irn;
81         int      cost;
82 } irn_cost_pair;
83
84
85 static int cost_cmp(const void* a, const void* b)
86 {
87         const irn_cost_pair* a1 = a;
88         const irn_cost_pair* b1 = b;
89         return b1->cost - a1->cost;
90 }
91
92
93 typedef struct flag_and_cost {
94         int no_root;
95         irn_cost_pair costs[];
96 } flag_and_cost;
97
98
99 static int count_result(const ir_node* irn)
100 {
101         const ir_mode* mode = get_irn_mode(irn);
102         return
103                 mode != mode_M &&
104                 mode != mode_X &&
105                 !arch_irn_is(cur_arch_env, irn, ignore);
106 }
107
108
109 static int normal_tree_cost(ir_node* irn)
110 {
111         flag_and_cost* fc    = get_irn_link(irn);
112         ir_node*       block = get_nodes_block(irn);
113         int            arity = get_irn_arity(irn);
114         int            cost_max  = 0;
115         int            count_max = 0;
116         int            n_res;
117         int            cost;
118         int            n_op_res = 0;
119         int            i;
120
121         if (fc == NULL) {
122                 irn_cost_pair* costs;
123                 int            i;
124
125                 fc = malloc(sizeof(*fc) + sizeof(*fc->costs) * arity);
126                 fc->no_root = 0;
127                 costs = fc->costs;
128
129                 for (i = 0; i < arity; ++i) {
130                         ir_node* pred = get_irn_n(irn, i);
131                         int cost;
132
133                         if (is_Phi(irn) || get_irn_mode(pred) == mode_M || is_Block(pred)) {
134                                 cost = 0;
135                         } else if (get_nodes_block(pred) != block) {
136                                 cost = 1;
137                         } else {
138                                 flag_and_cost* pred_fc;
139
140                                 cost = normal_tree_cost(pred);
141                                 if (be_is_Barrier(pred)) cost = 1; // XXX hack: the barrier causes all users to have a reguse of #regs
142                                 pred_fc = get_irn_link(pred);
143                                 pred_fc->no_root = 1;
144 #if defined NORMAL_DBG
145                                 ir_fprintf(stderr, "%+F says that %+F is no root\n", irn, pred);
146 #endif
147                         }
148
149                         costs[i].irn  = pred;
150                         costs[i].cost = cost;
151
152                         if (cost > cost_max) {
153                                 cost_max  = cost;
154                                 count_max = 1;
155                         } else if (cost == cost_max) {
156                                 ++count_max;
157                         }
158                 }
159
160                 qsort(costs, arity, sizeof(*costs), cost_cmp);
161                 set_irn_link(irn, fc);
162         } else {
163                 irn_cost_pair* costs = fc->costs;
164                 int            i;
165
166                 if (arity > 0) {
167                         cost_max = costs[0].cost;
168
169                         for (i = 0; i < arity; ++i) {
170                                 if (costs[i].cost < cost_max) break;
171                                 ++count_max;
172                         }
173                 }
174         }
175
176         cost = 0;
177         for (i = 0; i < arity; ++i) {
178                 if (get_irn_mode(fc->costs[i].irn) == mode_M) continue;
179                 if (arch_irn_is(cur_arch_env, fc->costs[i].irn, ignore)) continue;
180                 cost = MAX(fc->costs[i].cost + n_op_res, cost);
181                 ++n_op_res;
182         }
183         n_res = count_result(irn);
184         cost = MAX(n_res, cost);
185
186 #if defined NORMAL_DBG
187         ir_fprintf(stderr, "reguse of %+F is %d\n", irn, cost);
188 #endif
189
190         return cost;
191 }
192
193
194 static void normal_cost_walker(ir_node* irn, void* env)
195 {
196         (void)env;
197
198 #if defined NORMAL_DBG
199         ir_fprintf(stderr, "cost walking node %+F\n", irn);
200 #endif
201         if (is_Block(irn)) return;
202         normal_tree_cost(irn);
203 }
204
205
206 static void collect_roots(ir_node* irn, void* env)
207 {
208         flag_and_cost* fc;
209
210         (void)env;
211
212         if (is_Block(irn)) return;
213
214         fc = get_irn_link(irn);
215
216 #if defined NORMAL_DBG
217         ir_fprintf(stderr, "%+F is %sroot\n", irn, fc->no_root ? "no " : "");
218 #endif
219
220         if (!fc->no_root) {
221                 ir_node* block = get_nodes_block(irn);
222                 ir_node** roots = get_irn_link(block);
223                 if (roots == NULL) {
224                         roots = NEW_ARR_F(ir_node*, 0);
225                 }
226                 ARR_APP1(ir_node*, roots, irn);
227                 set_irn_link(block, roots);
228         }
229 }
230
231
232 static ir_node** sched_node(ir_node** sched, ir_node* irn)
233 {
234         ir_node*       block = get_nodes_block(irn);
235         flag_and_cost* fc    = get_irn_link(irn);
236         irn_cost_pair* irns  = fc->costs;
237         int            arity = get_irn_arity(irn);
238         int            i;
239
240         if (irn_visited(irn)) return sched;
241
242         if (is_End(irn)) return sched;
243
244         if (!is_Phi(irn)) {
245                 for (i = 0; i < arity; ++i) {
246                         ir_node* pred = irns[i].irn;
247                         if (get_nodes_block(pred) != block) continue;
248                         if (get_irn_mode(pred) == mode_M) continue;
249                         sched = sched_node(sched, pred);
250                 }
251         }
252
253         mark_irn_visited(irn);
254         ARR_APP1(ir_node*, sched, irn);
255         return sched;
256 }
257
258
259 static void normal_sched_block(ir_node* block, void* env)
260 {
261         ir_node** roots = get_irn_link(block);
262         int            root_count;
263         irn_cost_pair* root_costs;
264         int i;
265         ir_node**      sched;
266
267         (void)env;
268
269 #if defined NORMAL_DBG
270         ir_fprintf(stderr, "sched walking block %+F\n", block);
271 #endif
272
273         if (roots == NULL) {
274 #if defined NORMAL_DBG
275                 fprintf(stderr, "has no roots\n");
276 #endif
277                 return;
278         }
279
280         root_count = ARR_LEN(roots);
281         NEW_ARR_A(irn_cost_pair, root_costs, root_count);
282         for (i = 0; i < root_count; ++i) {
283                 root_costs[i].irn  = roots[i];
284                 root_costs[i].cost = normal_tree_cost(roots[i]);
285         }
286         qsort(root_costs, root_count, sizeof(*root_costs), cost_cmp);
287
288         sched = NEW_ARR_F(ir_node*, 0);
289         for (i = 0; i < root_count; ++i) {
290                 ir_node* irn = root_costs[i].irn;
291                 sched = sched_node(sched, irn);
292         }
293         set_irn_link(block, sched);
294         DEL_ARR_F(roots);
295
296 #if defined NORMAL_DBG
297         {
298                 int n = ARR_LEN(sched);
299                 int i;
300
301                 ir_fprintf(stderr, "Scheduling of %+F:\n", block);
302                 for (i = 0; i < n; ++i) {
303                         ir_fprintf(stderr, "  %+F\n", sched[i]);
304                 }
305                 fprintf(stderr, "\n");
306         }
307 #endif
308 }
309
310
311 static void *normal_init_graph(const list_sched_selector_t *vtab,
312                                const be_irg_t *birg)
313 {
314         ir_graph* irg = be_get_birg_irg(birg);
315
316         (void)vtab;
317
318         cur_arch_env = be_get_birg_arch_env(birg);
319
320         be_clear_links(irg);
321
322         irg_walk_graph(irg, normal_cost_walker,  NULL, NULL);
323         irg_walk_graph(irg, collect_roots, NULL, NULL);
324         inc_irg_visited(irg);
325         irg_block_walk_graph(irg, normal_sched_block, NULL, NULL);
326
327         return NULL;
328 }
329
330
331 static void *normal_init_block(void *graph_env, ir_node *block)
332 {
333         (void)graph_env;
334         (void)block;
335
336         return NULL;
337 }
338
339
340 const list_sched_selector_t normal_selector = {
341         normal_init_graph,
342         normal_init_block,
343         normal_select,
344         NULL,              /* to_appear_in_schedule */
345         NULL,              /* node_ready */
346         NULL,              /* node_selected */
347         NULL,              /* exectime */
348         NULL,              /* latency */
349         NULL,              /* finish_block */
350         NULL               /* finish_graph */
351 };