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