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