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