d23ce3a8dccfce3e3509dd557302d8097d20aa12
[libfirm] / ir / be / besched_t.h
1 /* $Id: */
2
3 #ifndef _BESCHED_T_H
4 #define _BESCHED_T_H
5
6 #define SCHED_INITIAL_GRANULARITY (1 << 14)
7
8 #include "list.h"
9 #include "irnode_t.h"
10 #include "irgraph_t.h"
11
12 #include "beutil.h"
13 #include "besched.h"
14
15 typedef unsigned int sched_timestep_t;
16
17 extern size_t sched_irn_data_offset;
18
19 /**
20  * The schedule structure which is present at each ir node.
21  *
22  * Currently, only basic blocks are scheduled. The list head of
23  * every block schedule list is the Block list.
24  */
25 typedef struct _sched_info_t {
26         struct list_head list;         /**< The list head to list the nodes in a schedule. */
27         sched_timestep_t time_step;    /**< If a is after b in a schedule, its time step is
28                                         larger than b's. */
29         unsigned scheduled : 1;        /**< 1, if the node is in the schedule of the block, 0 else. */
30 } sched_info_t;
31
32 #define _sched_entry(list_head) (list_entry(list_head, sched_info_t, list))
33
34 #define get_irn_sched_info(irn) get_irn_data(irn, sched_info_t, sched_irn_data_offset)
35 #define get_sched_info_irn(sched_info) get_irn_data_base(sched_info, sched_irn_data_offset)
36
37 /**
38  * Init the scheduling stuff.
39  * To be called from the central backend initialization routine.
40  */
41 void be_sched_init(void);
42
43 /**
44  * Check, if the node is scheduled.
45  * @param irn The node.
46  * @return 1, if the node is scheduled, 0 if not.
47  */
48 static INLINE int _sched_is_scheduled(const ir_node *irn)
49 {
50   return get_irn_sched_info(irn)->scheduled;
51 }
52
53 /**
54  * Get the time step of an irn in a schedule.
55  * @param irn The node.
56  * @return The time step in the schedule.
57  */
58 static INLINE int _sched_get_time_step(const ir_node *irn)
59 {
60         assert(_sched_is_scheduled(irn));
61         return get_irn_sched_info(irn)->time_step;
62 }
63
64 /**
65  * Checks, if a node is to appear in a schedule. Such nodes either
66  * consume real data (mode datab) or produce such.
67  * @param irn The node to check for.
68  * @return 1, if the node consumes/produces data, false if not.
69  */
70 static INLINE int to_appear_in_schedule(const ir_node *irn)
71 {
72         switch(get_irn_opcode(irn)) {
73                 case iro_Start:
74                 case iro_Jmp:
75                 case iro_Break:
76                         return 1;
77                 default:
78                         return is_data_node(irn);
79         }
80 }
81
82 /**
83  * Check, if an ir_node has a scheduling successor.
84  * @param irn The ir node.
85  * @return 1, if the node has a scheduling successor, 0 if not.
86  */
87 static INLINE int _sched_has_next(const ir_node *irn)
88 {
89         const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
90         const sched_info_t *info = get_irn_sched_info(irn);
91         const sched_info_t *block_info = get_irn_sched_info(block);
92         return info->list.next != &block_info->list;
93 }
94
95 /**
96  * Check, if an ir_node has a scheduling predecessor.
97  * @param irn The ir node.
98  * @return 1, if the node has a scheduling predecessor, 0 if not.
99  */
100 static INLINE int _sched_has_prev(const ir_node *irn)
101 {
102         const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
103         const sched_info_t *info = get_irn_sched_info(irn);
104         const sched_info_t *block_info = get_irn_sched_info(block);
105         return info->list.prev != &block_info->list;
106 }
107
108 /**
109  * Get the scheduling successor of a node.
110  * @param irn The node.
111  * @return The next ir node in the schedule or the block, if the node has no next node.
112  */
113 static INLINE ir_node *_sched_next(const ir_node *irn)
114 {
115         const sched_info_t *info = get_irn_sched_info(irn);
116         return get_sched_info_irn(_sched_entry(info->list.next));
117 }
118
119 /**
120  * Get the scheduling predecessor of a node.
121  * @param irn The node.
122  * @return The next ir node in the schedule or the block, if the node has no predecessor.
123  * predecessor.
124  */
125 static INLINE ir_node *_sched_prev(const ir_node *irn)
126 {
127         const sched_info_t *info = get_irn_sched_info(irn);
128         return get_sched_info_irn(_sched_entry(info->list.prev));
129 }
130
131 /**
132  * Get the first node in a block schedule.
133  * @param block The block of which to get the schedule.
134  * @return The first node in the schedule or the block itself
135  *         if there is no node in the schedule.
136  */
137 static INLINE ir_node *_sched_first(const ir_node *block)
138 {
139         assert(is_Block(block) && "Need a block here");
140         return _sched_next(block);
141 }
142
143 /**
144  * Get the last node in a schedule.
145  * @param  block The block to get the schedule for.
146  * @return The last ir node in a schedule, or the block itself
147  *         if there is no node in the schedule.
148  */
149 static INLINE ir_node *_sched_last(const ir_node *block)
150 {
151         assert(is_Block(block) && "Need a block here");
152         return _sched_prev(block);
153 }
154
155 /**
156  * Reassign the time steps in the schedule.
157  * @param block The schedule to update.
158  */
159 void sched_renumber(const ir_node *block);
160
161 static INLINE void _sched_set_time_stamp(ir_node *irn)
162 {
163         sched_info_t *inf = get_irn_sched_info(irn);
164         sched_timestep_t before_ts = _sched_entry(inf->list.prev)->time_step;
165         sched_timestep_t after_ts = _sched_entry(inf->list.next)->time_step;
166
167         /*
168          * If we are the last, we can give us a big time step,
169          * else we have to compute our time step from our
170          * neighbours.
171          */
172         if(before_ts >= after_ts)
173                 inf->time_step = before_ts + SCHED_INITIAL_GRANULARITY;
174         else {
175                 sched_timestep_t ts = (before_ts + after_ts) / 2;
176
177                 /*
178                  * If the resolution went out, we have to renumber
179                  * this block.
180                  */
181                 if(ts == before_ts || ts == after_ts)
182                         sched_renumber(get_nodes_block(irn));
183                 else
184                         inf->time_step = ts;
185         }
186 }
187
188 /**
189  * Add a node to a block schedule.
190  * @param block The block to whose schedule the node shall be added to.
191  * @param irn The node to add.
192  * @return The given node.
193  */
194 static INLINE ir_node *_sched_add_before(ir_node *before, ir_node *irn)
195 {
196         sched_info_t *info = get_irn_sched_info(irn);
197         assert(_sched_is_scheduled(before) && !_sched_is_scheduled(irn));
198         list_add_tail(&info->list, &get_irn_sched_info(before)->list);
199         _sched_set_time_stamp(irn);
200         info->scheduled = 1;
201         return irn;
202 }
203
204 /**
205  * Add a node to a block schedule.
206  * @param block The block to whose schedule the node shall be added to.
207  * @param irn The node to add.
208  * @return The given node.
209  */
210 static INLINE ir_node *_sched_add_after(ir_node *after, ir_node *irn)
211 {
212         sched_info_t *info = get_irn_sched_info(irn);
213         assert(_sched_is_scheduled(after) && !_sched_is_scheduled(irn));
214         list_add(&info->list, &get_irn_sched_info(after)->list);
215         _sched_set_time_stamp(irn);
216         info->scheduled = 1;
217         return irn;
218 }
219
220 static INLINE void _sched_init_block(ir_node *block)
221 {
222         sched_info_t *info = get_irn_sched_info(block);
223         assert(info->scheduled == 0 && info->time_step == 0);
224         INIT_LIST_HEAD(&info->list);
225         info->scheduled = 1;
226 }
227
228 static INLINE void _sched_reset(ir_node *node)
229 {
230         sched_info_t *info = get_irn_sched_info(node);
231         info->scheduled = 0;
232 }
233
234 /**
235  * Remove a node from the scheduled.
236  * @param irn The node.
237  */
238 static INLINE void _sched_remove(ir_node *irn)
239 {
240   sched_info_t *info = get_irn_sched_info(irn);
241   list_del(&info->list);
242         INIT_LIST_HEAD(&info->list);
243   info->scheduled = 0;
244 }
245
246 /**
247  * Compare two nodes according to their position in the schedule.
248  * @param a The first node.
249  * @param b The second node.
250  * @return A number smaller, equals to or larger than 0, if a is
251  *         before, the same, or after b in the schedule.
252  */
253 static INLINE int _sched_cmp(const ir_node *a, const ir_node *b)
254 {
255   assert(_sched_is_scheduled(a) && _sched_is_scheduled(b));
256   assert(get_nodes_block(a) == get_nodes_block(b));
257
258   return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
259 }
260
261 /**
262  * Verify a schedule.
263  * @param block The block whose schedule to verify.
264  * @return      1, if the schedule is proper, 0 if not.
265  */
266 extern int sched_verify(const ir_node *block);
267
268 /**
269  * Verify the schedules in all blocks of the irg.
270  * @param irg The program graph.
271  * @return    1, if all schedules were right, 0 if not.
272  */
273 extern int sched_verify_irg(ir_graph *irg);
274
275 /**
276  * Checks, if one node is scheduled before another.
277  * @param n1   A node.
278  * @param n2   Another node.
279  * @return     1, if n1 is in front of n2 in the schedule, 0 else.
280  * @note       Both nodes must be in the same block.
281  */
282 static INLINE int _sched_comes_after(const ir_node *n1, const ir_node *n2)
283 {
284         assert(_sched_is_scheduled(n1));
285         assert(_sched_is_scheduled(n2));
286         assert(get_nodes_block(n1) == get_nodes_block(n2));
287         return _sched_get_time_step(n1) < _sched_get_time_step(n2);
288 }
289
290 /**
291  * A predicate for a node.
292  * @param irn The node.
293  * @param data The custom data.
294  * @return 1 if irn should be skipped. Else 0.
295  */
296 typedef int (sched_predicator_t)(const ir_node *irn, void *data);
297
298
299 int sched_skip_cf_predicator(const ir_node *irn, void *data);
300 int sched_skip_phi_predicator(const ir_node *irn, void *data);
301
302 /**
303  * Skip nodes in a schedule.
304  * @param from The node to start from.
305  * @param forward The direction (1 for forward, 0 for backward).
306  * @param predicator The one who decides what is skipped.
307  * @param data Food for the predicator.
308  * @return The first node rejected by the predicator or the block
309  * itself if none was rejected.
310  */
311 extern ir_node *sched_skip(ir_node *from, int forward,
312     sched_predicator_t *predicator, void *data);
313
314 #define sched_get_time_step(irn)        _sched_get_time_step(irn)
315 #define sched_has_next(irn)             _sched_has_next(irn)
316 #define sched_has_prev(irn)             _sched_has_prev(irn)
317 #define sched_next(irn)                 _sched_next(irn)
318 #define sched_prev(irn)                 _sched_prev(irn)
319 #define sched_first(irn)                _sched_first(irn)
320 #define sched_last(irn)                 _sched_last(irn)
321 #define sched_add_before(before, irn)   _sched_add_before(before, irn)
322 #define sched_add_after(after, irn)     _sched_add_after(after, irn)
323 #define sched_remove(irn)               _sched_remove(irn)
324 #define sched_is_scheduled(irn)         _sched_is_scheduled(irn)
325 #define sched_comes_after(n1, n2)       _sched_comes_after(n1, n2)
326 #define sched_cmp(a, b)                 _sched_cmp(a, b)
327
328 #endif