Allow the first line to be a comment.
[libfirm] / ir / be / beschednormal.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  * @brief   Use the strong normal form theorem (though it does not hold)
22  * @author  Christoph Mallon
23  */
24 #include "config.h"
25
26 #include <stdlib.h>
27
28 #include "besched.h"
29 #include "belistsched.h"
30 #include "belive_t.h"
31 #include "beutil.h"
32 #include "heights.h"
33 #include "irgwalk.h"
34 #include "benode.h"
35 #include "bemodule.h"
36 #include "util.h"
37 #include "array_t.h"
38
39 // XXX there is no one time init for schedulers
40 //#define NORMAL_DBG
41 #include "irprintf.h"
42
43 /** An instance of the normal scheduler. */
44 typedef struct instance_t {
45         ir_graph*      irg;          /**< the IR graph of this instance */
46         struct obstack obst;         /**< obstack for temporary data */
47         ir_node*       curr_list;    /**< current block schedule list */
48 } instance_t;
49
50 static int must_be_scheduled(const ir_node* const irn)
51 {
52         return !is_Proj(irn) && !is_Sync(irn);
53 }
54
55
56 static ir_node *normal_select(void *block_env, ir_nodeset_t *ready_set)
57 {
58         instance_t* inst = (instance_t*)block_env;
59         ir_node*    irn;
60         ir_node*    next;
61         ir_node*    last = NULL;
62
63         for (irn = inst->curr_list; irn != NULL; last = irn, irn = next) {
64                 next = (ir_node*)get_irn_link(irn);
65                 if (ir_nodeset_contains(ready_set, irn)) {
66 #if defined NORMAL_DBG
67                         ir_fprintf(stderr, "scheduling %+F\n", irn);
68 #endif
69                         if (last == NULL)
70                                 inst->curr_list = next;
71                         else
72                                 set_irn_link(last, next);
73                         return irn;
74                 }
75         }
76
77         return ir_nodeset_first(ready_set);
78 }
79
80
81 typedef struct irn_cost_pair {
82         ir_node* irn;
83         int      cost;
84 } irn_cost_pair;
85
86 static int cost_cmp(const void* a, const void* b)
87 {
88         const irn_cost_pair* const a1 = (const irn_cost_pair*)a;
89         const irn_cost_pair* const b1 = (const irn_cost_pair*)b;
90         int ret = b1->cost - a1->cost;
91         if (ret == 0)
92                 ret = (int)get_irn_idx(a1->irn) - (int)get_irn_idx(b1->irn);
93 #if defined NORMAL_DBG
94         ir_fprintf(stderr, "cost %+F %s %+F\n", a1->irn, ret < 0 ? "<" : ret > 0 ? ">" : "=", b1->irn);
95 #endif
96         return ret;
97 }
98
99
100 typedef struct flag_and_cost {
101         int no_root;
102         irn_cost_pair costs[];
103 } flag_and_cost;
104
105 #define get_irn_fc(irn)     ((flag_and_cost*)get_irn_link(irn))
106 #define set_irn_fc(irn, fc) set_irn_link(irn, fc)
107
108
109 static int count_result(const ir_node* irn)
110 {
111         const ir_mode* mode = get_irn_mode(irn);
112
113         if (mode == mode_M || mode == mode_X)
114                 return 0;
115
116         if (mode == mode_T)
117                 return 1;
118
119         arch_register_req_t const *const req = arch_get_irn_register_req(irn);
120         if (arch_register_req_is(req, ignore))
121                 return 0;
122
123         return 1;
124 }
125
126
127 /* TODO high cost for store trees
128  */
129
130 static int normal_tree_cost(ir_node* irn, instance_t *inst)
131 {
132         flag_and_cost* fc;
133         int            arity;
134         ir_node*       last;
135         int            n_res;
136         int            cost;
137         int            n_op_res = 0;
138         int            i;
139
140         if (be_is_Keep(irn))
141                 return 0;
142
143         if (is_Proj(irn)) {
144                 return normal_tree_cost(get_Proj_pred(irn), inst);
145         }
146
147         arity = get_irn_arity(irn);
148         fc    = get_irn_fc(irn);
149
150         if (fc == NULL) {
151                 irn_cost_pair* costs;
152                 ir_node*       block = get_nodes_block(irn);
153
154                 fc = OALLOCF(&inst->obst, flag_and_cost, costs, arity);
155                 fc->no_root = 0;
156                 costs = fc->costs;
157
158                 for (i = 0; i < arity; ++i) {
159                         ir_node* pred = get_irn_n(irn, i);
160
161                         if (is_Phi(irn) || get_irn_mode(pred) == mode_M || is_Block(pred)) {
162                                 cost = 0;
163                         } else if (get_nodes_block(pred) != block) {
164                                 cost = 1;
165                         } else {
166                                 flag_and_cost* pred_fc;
167                                 ir_node*       real_pred;
168
169                                 cost = normal_tree_cost(pred, inst);
170                                 if (!arch_irn_is_ignore(pred)) {
171                                         real_pred = (is_Proj(pred) ? get_Proj_pred(pred) : pred);
172                                         pred_fc = get_irn_fc(real_pred);
173                                         pred_fc->no_root = 1;
174 #if defined NORMAL_DBG
175                                         ir_fprintf(stderr, "%+F says that %+F is no root\n", irn, real_pred);
176 #endif
177                                 }
178                         }
179
180                         costs[i].irn  = pred;
181                         costs[i].cost = cost;
182                 }
183
184                 qsort(costs, arity, sizeof(*costs), cost_cmp);
185                 set_irn_link(irn, fc);
186         }
187
188         cost = 0;
189         last = 0;
190         for (i = 0; i < arity; ++i) {
191                 ir_node* op = fc->costs[i].irn;
192                 ir_mode* mode;
193                 if (op == last)
194                         continue;
195                 mode = get_irn_mode(op);
196                 if (mode == mode_M)
197                         continue;
198                 if (mode != mode_T && arch_irn_is_ignore(op))
199                         continue;
200                 cost = MAX(fc->costs[i].cost + n_op_res, cost);
201                 last = op;
202                 ++n_op_res;
203         }
204         n_res = count_result(irn);
205         cost = MAX(n_res, cost);
206
207 #if defined NORMAL_DBG
208         ir_fprintf(stderr, "reguse of %+F is %d\n", irn, cost);
209 #endif
210
211         return cost;
212 }
213
214
215 static void normal_cost_walker(ir_node* irn, void* env)
216 {
217         instance_t *inst = (instance_t*)env;
218
219 #if defined NORMAL_DBG
220         ir_fprintf(stderr, "cost walking node %+F\n", irn);
221 #endif
222         if (is_Block(irn)) return;
223         if (!must_be_scheduled(irn)) return;
224         normal_tree_cost(irn, inst);
225 }
226
227
228 static void collect_roots(ir_node* irn, void* env)
229 {
230         int is_root;
231
232         (void)env;
233
234         if (is_Block(irn)) return;
235         if (!must_be_scheduled(irn)) return;
236
237         is_root = be_is_Keep(irn) || !get_irn_fc(irn)->no_root;
238
239 #if defined NORMAL_DBG
240         ir_fprintf(stderr, "%+F is %sroot\n", irn, is_root ? "" : "no ");
241 #endif
242
243         if (is_root) {
244                 ir_node* block = get_nodes_block(irn);
245                 ir_node** roots = (ir_node**)get_irn_link(block);
246                 if (roots == NULL) {
247                         roots = NEW_ARR_F(ir_node*, 0);
248                 }
249                 ARR_APP1(ir_node*, roots, irn);
250                 set_irn_link(block, roots);
251         }
252 }
253
254
255 static ir_node** sched_node(ir_node** sched, ir_node* irn)
256 {
257         if (irn_visited_else_mark(irn)) return sched;
258         if (is_End(irn))                return sched;
259
260         if (!is_Phi(irn) && !be_is_Keep(irn)) {
261                 ir_node*       block = get_nodes_block(irn);
262                 int            arity = get_irn_arity(irn);
263                 flag_and_cost* fc    = get_irn_fc(irn);
264                 irn_cost_pair* irns  = fc->costs;
265                 int            i;
266
267                 for (i = 0; i < arity; ++i) {
268                         ir_node* pred = irns[i].irn;
269                         if (get_nodes_block(pred) != block) continue;
270                         if (get_irn_mode(pred) == mode_M) continue;
271                         if (is_Proj(pred)) pred = get_Proj_pred(pred);
272                         sched = sched_node(sched, pred);
273                 }
274         }
275
276         ARR_APP1(ir_node*, sched, irn);
277         return sched;
278 }
279
280
281 static int root_cmp(const void* a, const void* b)
282 {
283         const irn_cost_pair* const a1 = (const irn_cost_pair*)a;
284         const irn_cost_pair* const b1 = (const irn_cost_pair*)b;
285         int ret;
286         if (is_irn_forking(a1->irn) && !is_irn_forking(b1->irn)) {
287                 ret = 1;
288         } else if (is_irn_forking(b1->irn) && !is_irn_forking(a1->irn)) {
289                 ret = -1;
290         } else {
291                 ret = b1->cost - a1->cost;
292                 if (ret == 0) {
293                         /* place live-out nodes later */
294                         ret = (count_result(a1->irn) != 0) - (count_result(b1->irn) != 0);
295                         if (ret == 0) {
296                                 /* compare node idx */
297                                 ret = get_irn_idx(a1->irn) - get_irn_idx(b1->irn);
298                         }
299                 }
300         }
301 #if defined NORMAL_DBG
302         ir_fprintf(stderr, "root %+F %s %+F\n", a1->irn, ret < 0 ? "<" : ret > 0 ? ">" : "=", b1->irn);
303 #endif
304         return ret;
305 }
306
307
308 static void normal_sched_block(ir_node* block, void* env)
309 {
310         ir_node**      roots = (ir_node**)get_irn_link(block);
311         ir_heights_t*  heights = (ir_heights_t*)env;
312         int            root_count;
313         irn_cost_pair* root_costs;
314         int i;
315         ir_node**      sched;
316
317 #if defined NORMAL_DBG
318         ir_fprintf(stderr, "sched walking block %+F\n", block);
319 #endif
320
321         if (roots == NULL) {
322 #if defined NORMAL_DBG
323                 fprintf(stderr, "has no roots\n");
324 #endif
325                 return;
326         }
327
328         root_count = ARR_LEN(roots);
329         NEW_ARR_A(irn_cost_pair, root_costs, root_count);
330         for (i = 0; i < root_count; ++i) {
331                 root_costs[i].irn  = roots[i];
332                 root_costs[i].cost = get_irn_height(heights, roots[i]);
333 #if defined NORMAL_DBG
334                 ir_fprintf(stderr, "height of %+F is %u\n", roots[i], root_costs[i].cost);
335 #endif
336         }
337         qsort(root_costs, root_count, sizeof(*root_costs), root_cmp);
338 #if defined NORMAL_DBG
339         {
340                 int n = root_count;
341                 int i;
342
343                 ir_fprintf(stderr, "Root Scheduling of %+F:\n", block);
344                 for (i = 0; i < n; ++i) {
345                         ir_fprintf(stderr, "  %+F\n", root_costs[i].irn);
346                 }
347                 fprintf(stderr, "\n");
348         }
349 #endif
350
351         sched = NEW_ARR_F(ir_node*, 0);
352         for (i = 0; i < root_count; ++i) {
353                 ir_node* irn = root_costs[i].irn;
354                 assert(must_be_scheduled(irn));
355                 sched = sched_node(sched, irn);
356         }
357         set_irn_link(block, sched);
358         DEL_ARR_F(roots);
359
360 #if defined NORMAL_DBG
361         {
362                 int n = ARR_LEN(sched);
363                 int i;
364
365                 ir_fprintf(stderr, "Scheduling of %+F:\n", block);
366                 for (i = 0; i < n; ++i) {
367                         ir_fprintf(stderr, "  %+F\n", sched[i]);
368                 }
369                 fprintf(stderr, "\n");
370         }
371 #endif
372 }
373
374
375 static void *normal_init_graph(ir_graph *irg)
376 {
377         instance_t   *inst = XMALLOC(instance_t);
378         ir_heights_t *heights;
379
380         be_clear_links(irg);
381
382         obstack_init(&inst->obst);
383         inst->irg         = irg;
384
385         heights = heights_new(irg);
386
387         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
388         irg_walk_graph(irg, normal_cost_walker,  NULL, inst);
389         irg_walk_graph(irg, collect_roots, NULL, NULL);
390         inc_irg_visited(irg);
391         ir_reserve_resources(irg, IR_RESOURCE_IRN_VISITED);
392         irg_block_walk_graph(irg, normal_sched_block, NULL, heights);
393         ir_free_resources(irg, IR_RESOURCE_IRN_VISITED);
394
395         heights_free(heights);
396
397         return inst;
398 }
399
400 static void *normal_init_block(void *graph_env, ir_node *block)
401 {
402         instance_t* inst  = (instance_t*)graph_env;
403         ir_node**   sched = (ir_node**)get_irn_link(block);
404         ir_node*    first = NULL;
405         int         i;
406
407         /* turn into a list, so we can easily remove nodes.
408            The link field is used anyway. */
409         for (i = ARR_LEN(sched) - 1; i >= 0; --i) {
410                 ir_node* irn = sched[i];
411                 if (!is_cfop(irn)) {
412                         set_irn_link(irn, first);
413                         first = irn;
414                 }
415         }
416         /* note: we can free sched here, there should be no attempt to schedule
417            a block twice */
418         DEL_ARR_F(sched);
419         set_irn_link(block, sched);
420         inst->curr_list = first;
421         return inst;
422 }
423
424 static void normal_finish_graph(void *env)
425 {
426         instance_t *inst = (instance_t*)env;
427
428         /* block uses the link field to store the schedule */
429         ir_free_resources(inst->irg, IR_RESOURCE_IRN_LINK);
430         obstack_free(&inst->obst, NULL);
431         xfree(inst);
432 }
433
434 static void sched_normal(ir_graph *irg)
435 {
436         static const list_sched_selector_t normal_selector = {
437                 normal_init_graph,
438                 normal_init_block,
439                 normal_select,
440                 NULL,              /* node_ready */
441                 NULL,              /* node_selected */
442                 NULL,              /* finish_block */
443                 normal_finish_graph
444         };
445         be_list_sched_graph(irg, &normal_selector);
446 }
447
448 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_sched_normal)
449 void be_init_sched_normal(void)
450 {
451         be_register_scheduler("normal", sched_normal);
452 }