82cc3e7362d5a4713122339563dc83e6226d8143
[libfirm] / ir / be / besched.c
1 /* $Id$ */
2
3 #ifdef HAVE_CONFIG_H
4 # include "config.h"
5 #endif
6
7 #ifdef HAVE_STDLIB_H
8 # include <stdlib.h>
9 #endif
10
11 #include "impl.h"
12 #include "irprintf.h"
13 #include "irgwalk.h"
14 #include "irnode_t.h"
15 #include "irgraph_t.h"
16 #include "iredges_t.h"
17 #include "ircons.h"
18 #include "debug.h"
19
20 #include "bearch.h"
21 #include "besched_t.h"
22 #include "beutil.h"
23 #include "belistsched.h"
24
25 FIRM_IMPL1(sched_get_time_step, int, const ir_node *)
26 FIRM_IMPL1(sched_has_next, int, const ir_node *)
27 FIRM_IMPL1(sched_has_prev, int, const ir_node *)
28 FIRM_IMPL1(sched_next, ir_node *, const ir_node *)
29 FIRM_IMPL1(sched_prev, ir_node *, const ir_node *)
30 FIRM_IMPL1(sched_first, ir_node *, const ir_node *)
31 FIRM_IMPL1(sched_last, ir_node *, const ir_node *)
32 FIRM_IMPL2(sched_add_after, ir_node *, ir_node *, ir_node *)
33 FIRM_IMPL2(sched_add_before, ir_node *, ir_node *, ir_node *)
34 FIRM_IMPL2(sched_comes_after, int, const ir_node *, const ir_node *)
35 FIRM_IMPL1_VOID(sched_remove, ir_node *)
36
37 size_t sched_irn_data_offset = 0;
38
39 static void block_sched_dumper(ir_node *block, void *env)
40 {
41         FILE *f = env;
42         const ir_node *curr;
43
44         ir_fprintf(f, "%+F:\n", block);
45         sched_foreach(block, curr) {
46     sched_info_t *info = get_irn_sched_info(curr);
47                 ir_fprintf(f, "\t%6d: %+F\n", info->time_step, curr);
48         }
49 }
50
51 void be_sched_dump(FILE *f, ir_graph *irg)
52 {
53         irg_block_walk_graph(irg, block_sched_dumper, NULL, f);
54 }
55
56 /* Init the scheduling stuff. */
57 void be_sched_init(void)
58 {
59         sched_irn_data_offset = register_additional_node_data(sizeof(sched_info_t));
60 }
61
62 void sched_renumber(const ir_node *block)
63 {
64         ir_node *irn;
65         sched_info_t *inf;
66         sched_timestep_t step = SCHED_INITIAL_GRANULARITY;
67
68         sched_foreach(block, irn) {
69                 inf = get_irn_sched_info(irn);
70                 inf->time_step = step;
71                 step += SCHED_INITIAL_GRANULARITY;
72         }
73 }
74
75 /* Verify a schedule. */
76 int sched_verify(const ir_node *block)
77 {
78         int res = 1;
79         const ir_node *irn;
80         int i, n;
81         int *save_time_step;
82         const ir_node **save_nodes;
83         const ir_edge_t *edge;
84         pset *scheduled_nodes = pset_new_ptr_default();
85         FIRM_DBG_REGISTER(firm_dbg_module_t *dbg_sched, "firm.be.sched");
86
87         /* Count the number of nodes in the schedule. */
88         n = 0;
89         sched_foreach(block, irn)
90                 n++;
91
92         if(n <= 0)
93                 return 1;
94
95         save_time_step = xmalloc(n * sizeof(save_time_step[0]));
96         save_nodes = xmalloc(n * sizeof(save_nodes[0]));
97
98         i = 0;
99         sched_foreach(block, irn) {
100                 sched_info_t *info = get_irn_sched_info(irn);
101                 save_time_step[i] = info->time_step;
102                 save_nodes[i] = (ir_node *)irn;
103                 info->time_step = i;
104                 pset_insert_ptr(scheduled_nodes, irn);
105
106                 i += 1;
107         }
108
109         /*
110          * Check if each relevant operand of a node is scheduled before
111          * the node itself.
112          */
113         sched_foreach(block, irn) {
114                 int i, n;
115                 int step = sched_get_time_step(irn);
116
117                 for(i = 0, n = get_irn_arity(irn); i < n; i++) {
118                         ir_node *op = get_irn_n(irn, i);
119
120                         if(to_appear_in_schedule(op)
121                                 && !is_Phi(irn)
122                                 && get_nodes_block(op) == block
123                                 && sched_get_time_step(op) > step) {
124
125                                 DBG((dbg_sched, LEVEL_DEFAULT,
126                                         "%+F: %+F is operand of %+F but scheduled after\n", block, op, irn));
127                                 res = 0;
128                         }
129                 }
130         }
131
132         /* Check, if the time steps are correct */
133         for(i = 1; i < n; ++i) {
134                 if(save_time_step[i] - save_time_step[i - 1] <= 0) {
135                         DBG((dbg_sched, LEVEL_DEFAULT,
136                                 "%+F from %+F(%d) -> %+F(%d) step shrinks from %d -> %d\n",
137                                 block, save_nodes[i - 1], i - 1, save_nodes[i], i,
138                                 save_time_step[i - 1], save_time_step[i]));
139                         res = 0;
140                 }
141         }
142
143         /* Restore the old time steps */
144         i = 0;
145         sched_foreach(block, irn) {
146                 sched_info_t *info = get_irn_sched_info(irn);
147                 info->time_step = save_time_step[i++];
148         }
149
150         /* Check for all nodes in the block if they are scheduled. */
151         foreach_out_edge(block, edge) {
152                 ir_node *irn = get_edge_src_irn(edge);
153                 if(to_appear_in_schedule(irn) && !pset_find_ptr(scheduled_nodes, irn)) {
154                         DBG((dbg_sched, LEVEL_DEFAULT,
155                                 "%+F: %+F is in block but not scheduled\n", block, irn));
156                         res = 0;
157                 }
158         }
159
160         del_pset(scheduled_nodes);
161         free(save_time_step);
162         free((void *) save_nodes);
163         return res;
164 }
165
166 /**
167  * Block-Walker: verify the current block and update the status
168  */
169 static void sched_verify_walker(ir_node *block, void *data)
170 {
171         int *res = data;
172         *res &= sched_verify(block);
173 }
174
175 /* Verify the schedules in all blocks of the irg. */
176 int sched_verify_irg(ir_graph *irg)
177 {
178         int res = 1;
179         irg_block_walk_graph(irg, sched_verify_walker, NULL, &res);
180
181         return res;
182 }
183
184 int sched_skip_cf_predicator(const ir_node *irn, void *data) {
185         arch_env_t *ae = data;
186         return arch_irn_classify(ae, irn) == arch_irn_class_branch;
187 }
188
189 int sched_skip_phi_predicator(const ir_node *irn, void *data) {
190         return is_Phi(irn);
191 }
192
193 /* Skip nodes in a schedule. */
194 ir_node *sched_skip(ir_node *from, int forward, sched_predicator_t *predicator, void *data)
195 {
196         const ir_node *bl = get_block(from);
197         ir_node *curr;
198
199         if (is_Block(from))
200                 from = forward ? sched_next(from) : sched_prev(from);
201
202         for(curr = from; curr != bl && predicator(curr, data); curr = forward ? sched_next(curr) : sched_prev(curr));
203
204         return curr;
205 }
206
207 /** A simple forward single linked list. */
208 typedef struct {
209         ir_node *start;   /**< start of the list */
210         ir_node *end;     /**< last block in the list */
211         unsigned n_blks;  /**< number of blocks in the list */
212 } anchor;
213
214 /**
215  * Ext-Block walker: create a block schedule
216  */
217 static void create_block_list(ir_extblk *blk, void *env) {
218         anchor *list = env;
219         int i, n;
220
221         for (i = 0, n = get_extbb_n_blocks(blk); i < n; ++i) {
222                 ir_node *block = get_extbb_block(blk, i);
223
224                 set_irn_link(block, NULL);
225                 if (list->start)
226                         set_irn_link(list->end, block);
227                 else
228                         list->start = block;
229
230                 list->end = block;
231                 ++list->n_blks;
232         }
233 }
234
235 /*
236  * Calculates a block schedule. The schedule is stored as a linked
237  * list starting at the start_block of the irg.
238  */
239 ir_node **sched_create_block_schedule(ir_graph *irg)
240 {
241         anchor list;
242         ir_node **blk_list, *b, *n;
243         unsigned i;
244
245         /* schedule extended basic blocks */
246         compute_extbb(irg);
247
248         list.start  = NULL;
249         list.end    = NULL;
250         list.n_blks = 0;
251         irg_extblock_walk_graph(irg, NULL, create_block_list, &list);
252
253         /** create an array, so we can go forward and backward */
254         blk_list = NEW_ARR_D(ir_node *, irg->obst,list.n_blks);
255
256         for (i = 0, b = list.start; b; b = n, ++i) {
257                 n = get_irn_link(b);
258                 set_irn_link(b, INT_TO_PTR(i));
259
260                 blk_list[i] = b;
261         }
262         return blk_list;
263 }
264
265 typedef struct remove_dead_nodes_env_t_ {
266         ir_graph *irg;
267         bitset_t *reachable;
268 } remove_dead_nodes_env_t;
269
270 static void mark_dead_nodes_walker(ir_node *node, void *data)
271 {
272         remove_dead_nodes_env_t *env = (remove_dead_nodes_env_t*) data;
273         bitset_set(env->reachable, get_irn_idx(node));
274 }
275
276 static void remove_dead_nodes_walker(ir_node *block, void *data)
277 {
278         remove_dead_nodes_env_t *env = (remove_dead_nodes_env_t*) data;
279         ir_node *node, *next;
280
281         for(node = sched_first(block); !sched_is_end(node); node = next) {
282                 int i, arity;
283
284                 // get next node now, as after calling sched_remove it will be invalid
285                 next = sched_next(node);
286
287                 if(bitset_is_set(env->reachable, get_irn_idx(node)))
288                         continue;
289
290                 arity = get_irn_arity(node);
291                 for(i = 0; i < arity; ++i)
292                         set_irn_n(node, i, new_r_Bad(env->irg));
293
294                 sched_remove(node);
295         }
296 }
297
298 void be_remove_dead_nodes_from_schedule(ir_graph *irg)
299 {
300         remove_dead_nodes_env_t env;
301         env.irg = irg;
302         env.reachable = bitset_alloca(get_irg_last_idx(irg));
303
304         // mark all reachable nodes
305         irg_walk_graph(irg, mark_dead_nodes_walker, NULL, &env);
306
307         // walk schedule and remove non-marked nodes
308         irg_block_walk_graph(irg, remove_dead_nodes_walker, NULL, &env);
309 }