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