2 * Copyright (C) 1995-2010 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Scheduling utilities for nodes in Blocks and Blocks.
23 * @author Sebastian Hack
26 #ifndef FIRM_BE_BESCHED_H
27 #define FIRM_BE_BESCHED_H
37 void be_sched_dump(FILE *f, ir_graph *irg);
40 * returns the time step of a node. Each node in a block has a timestep
41 * unique to that block. a node schedule before another node has a lower
42 * timestep than this node.
44 int sched_get_time_step(const ir_node *irn);
45 int sched_has_next(const ir_node *irn);
46 int sched_has_prev(const ir_node *irn);
47 int sched_is_scheduled(const ir_node *irn);
48 ir_node *sched_next(const ir_node *irn);
49 ir_node *sched_prev(const ir_node *irn);
50 ir_node *sched_first(const ir_node *block);
51 ir_node *sched_last(const ir_node *block);
52 void sched_add_before(ir_node *before, ir_node *irn);
53 void sched_add_after(ir_node *after, ir_node *irn);
54 void sched_init_block(ir_node *block);
55 void sched_reset(ir_node *node);
56 int sched_comes_after(const ir_node *n1, const ir_node *n2);
57 void sched_remove(ir_node *irn);
59 #define sched_is_end(irn) is_Block(irn)
60 #define sched_is_begin(irn) is_Block(irn)
62 #define sched_foreach_from(from, irn) \
63 for(irn = from; !sched_is_end(irn); irn = sched_next(irn))
65 #define sched_foreach_reverse_from(from, irn) \
66 for(irn = from; !sched_is_begin(irn); irn = sched_prev(irn))
69 * A shorthand macro for iterating over a schedule.
70 * @param block The block.
71 * @param irn A ir node pointer used as an iterator.
73 #define sched_foreach(block,irn) \
74 sched_foreach_from(sched_first(block), irn)
77 * A shorthand macro for reversely iterating over a schedule.
78 * @param block The block.
79 * @param irn A ir node pointer used as an iterator.
81 #define sched_foreach_reverse(block,irn) \
82 sched_foreach_reverse_from(sched_last(block), irn)
85 * A shorthand macro for iterating over all Phi nodes of a schedule.
86 * @param block The block.
87 * @param phi A ir node pointer used as an iterator.
89 #define sched_foreach_Phi(block,phi) \
90 for (phi = sched_first(block); is_Phi(phi); phi = sched_next(phi))
93 * Removes dead nodes from schedule
94 * @param irg the graph
96 void be_remove_dead_nodes_from_schedule(ir_graph *irg);
98 #define SCHED_INITIAL_GRANULARITY (1 << 14)
99 #define get_irn_sched_info(irn) (&be_get_info(skip_Proj_const(irn))->sched_info)
102 * Check, if the node is scheduled.
103 * @param irn The node.
104 * @return 1, if the node is scheduled, 0 if not.
106 static inline int _sched_is_scheduled(const ir_node *irn)
108 return get_irn_sched_info(irn)->next != NULL;
112 * Get the time step of an irn in a schedule.
113 * @param irn The node.
114 * @return The time step in the schedule.
116 static inline int _sched_get_time_step(const ir_node *irn)
118 assert(_sched_is_scheduled(irn));
119 return get_irn_sched_info(irn)->time_step;
123 * Checks, if a node is to appear in a schedule. Such nodes either
124 * consume real data (mode datab) or produce such.
125 * @param irn The node to check for.
126 * @return 1, if the node consumes/produces data, false if not.
128 static inline int to_appear_in_schedule(const ir_node *irn)
130 switch(get_irn_opcode(irn)) {
135 return is_data_node(irn);
140 * Check, if an ir_node has a scheduling successor.
141 * @param irn The ir node.
142 * @return 1, if the node has a scheduling successor, 0 if not.
144 static inline int _sched_has_next(const ir_node *irn)
146 const sched_info_t *info = get_irn_sched_info(irn);
147 const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
148 return info->next != block;
152 * Check, if an ir_node has a scheduling predecessor.
153 * @param irn The ir node.
154 * @return 1, if the node has a scheduling predecessor, 0 if not.
156 static inline int _sched_has_prev(const ir_node *irn)
158 const sched_info_t *info = get_irn_sched_info(irn);
159 const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
160 return info->prev != block;
164 * Get the scheduling successor of a node.
165 * @param irn The node.
166 * @return The next ir node in the schedule or the block, if the node has no next node.
168 static inline ir_node *_sched_next(const ir_node *irn)
170 const sched_info_t *info = get_irn_sched_info(irn);
175 * Get the scheduling predecessor of a node.
176 * @param irn The node.
177 * @return The next ir node in the schedule or the block, if the node has no predecessor.
180 static inline ir_node *_sched_prev(const ir_node *irn)
182 const sched_info_t *info = get_irn_sched_info(irn);
187 * Get the first node in a block schedule.
188 * @param block The block of which to get the schedule.
189 * @return The first node in the schedule or the block itself
190 * if there is no node in the schedule.
192 static inline ir_node *_sched_first(const ir_node *block)
194 assert(is_Block(block) && "Need a block here");
195 return _sched_next(block);
199 * Get the last node in a schedule.
200 * @param block The block to get the schedule for.
201 * @return The last ir node in a schedule, or the block itself
202 * if there is no node in the schedule.
204 static inline ir_node *_sched_last(const ir_node *block)
206 assert(is_Block(block) && "Need a block here");
207 return _sched_prev(block);
211 * Reassign the time steps in the schedule.
212 * @param block The schedule to update.
214 void sched_renumber(const ir_node *block);
216 static inline void _sched_set_time_stamp(const ir_node *irn)
218 sched_info_t *info = get_irn_sched_info(irn);
219 const sched_info_t *prev_info = get_irn_sched_info(info->prev);
220 const sched_info_t *next_info = get_irn_sched_info(info->next);
221 sched_timestep_t before_ts = prev_info->time_step;
222 sched_timestep_t after_ts = next_info->time_step;
225 * If we are the last, we can give us a big time step,
226 * else we have to compute our time step from our
229 if(before_ts >= after_ts) {
230 info->time_step = before_ts + SCHED_INITIAL_GRANULARITY;
232 if (info->time_step <= before_ts) {
233 sched_renumber(get_nodes_block(irn));
236 sched_timestep_t ts = (before_ts + after_ts) / 2;
239 * If the resolution went out, we have to renumber
242 if(ts == before_ts || ts == after_ts)
243 sched_renumber(get_nodes_block(irn));
245 info->time_step = ts;
250 * Add a node to a block schedule.
251 * @param block The block to whose schedule the node shall be added to.
252 * @param irn The node to add.
253 * @return The given node.
255 static inline void _sched_add_before(ir_node *before, ir_node *irn)
257 sched_info_t *info = get_irn_sched_info(irn);
258 ir_node *next = before;
259 sched_info_t *next_info = get_irn_sched_info(next);
260 ir_node *prev = next_info->prev;
261 sched_info_t *prev_info = get_irn_sched_info(prev);
262 assert(_sched_is_scheduled(before));
263 assert(!_sched_is_scheduled(irn));
264 assert(!is_Proj(before));
265 assert(!is_Proj(irn));
269 prev_info->next = irn;
270 next_info->prev = irn;
271 _sched_set_time_stamp(irn);
275 * Add a node to a block schedule.
276 * @param block The block to whose schedule the node shall be added to.
277 * @param irn The node to add.
278 * @return The given node.
280 static inline void _sched_add_after(ir_node *after, ir_node *irn)
282 sched_info_t *info = get_irn_sched_info(irn);
283 ir_node *prev = after;
284 sched_info_t *prev_info = get_irn_sched_info(prev);
285 ir_node *next = prev_info->next;
286 sched_info_t *next_info = get_irn_sched_info(next);
287 assert(_sched_is_scheduled(after));
288 assert(!_sched_is_scheduled(irn));
289 assert(!is_Proj(after));
290 assert(!is_Proj(irn));
294 prev_info->next = irn;
295 next_info->prev = irn;
296 _sched_set_time_stamp(irn);
299 static inline void _sched_init_block(ir_node *block)
301 sched_info_t *info = get_irn_sched_info(block);
302 assert(info->next == NULL && info->time_step == 0);
307 static inline void _sched_reset(ir_node *node)
309 sched_info_t *info = get_irn_sched_info(node);
315 * Remove a node from the scheduled.
316 * @param irn The node.
318 static inline void _sched_remove(ir_node *irn)
320 sched_info_t *info = get_irn_sched_info(irn);
321 ir_node *prev = info->prev;
322 ir_node *next = info->next;
323 sched_info_t *prev_info = get_irn_sched_info(prev);
324 sched_info_t *next_info = get_irn_sched_info(next);
325 assert(_sched_is_scheduled(irn));
327 prev_info->next = next;
328 next_info->prev = prev;
334 * Compare two nodes according to their position in the schedule.
335 * @param a The first node.
336 * @param b The second node.
337 * @return A number smaller, equals to or larger than 0, if a is
338 * before, the same, or after b in the schedule.
340 static inline int _sched_cmp(const ir_node *a, const ir_node *b)
342 assert(_sched_is_scheduled(a) && _sched_is_scheduled(b));
343 assert(get_nodes_block(a) == get_nodes_block(b));
345 return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
349 * Checks, if one node is scheduled before another.
351 * @param n2 Another node.
352 * @return 1, if n1 is in front of n2 in the schedule, 0 else.
353 * @note Both nodes must be in the same block.
355 static inline int _sched_comes_after(const ir_node *n1, const ir_node *n2)
357 assert(_sched_is_scheduled(n1));
358 assert(_sched_is_scheduled(n2));
359 assert((is_Block(n1) ? n1 : get_nodes_block(n1)) == (is_Block(n2) ? n2 : get_nodes_block(n2)));
360 return _sched_get_time_step(n1) < _sched_get_time_step(n2);
364 * A predicate for a node.
365 * @param irn The node.
366 * @param data The custom data.
367 * @return 1 if irn should be skipped. Else 0.
369 typedef int (sched_predicator_t)(const ir_node *irn, void *data);
372 * Predicate for sched_skip(), returns non-zero if irn is a control flow changing node.
374 * @param irn the node to evaluate
377 int sched_skip_cf_predicator(const ir_node *irn, void *data);
380 * Predicate for sched_skip(), returns non-zero if irn is a Phi node.
382 * Used with sched_skip().
384 * @param irn the node to evaluate
387 int sched_skip_phi_predicator(const ir_node *irn, void *data);
390 * Skip nodes in a schedule.
391 * @param from The node to start from.
392 * @param forward The direction (1 for forward, 0 for backward).
393 * @param predicator The predicator function which decides what is skipped.
394 * @param data context parameter for the predicator.
396 * @return The first node not rejected by the predicator or the block
397 * itself if all nodes were rejected.
399 ir_node *sched_skip(ir_node *from, int forward, sched_predicator_t *predicator, void *data);
401 #define sched_get_time_step(irn) _sched_get_time_step(irn)
402 #define sched_has_next(irn) _sched_has_next(irn)
403 #define sched_has_prev(irn) _sched_has_prev(irn)
404 #define sched_next(irn) _sched_next(irn)
405 #define sched_prev(irn) _sched_prev(irn)
406 #define sched_first(irn) _sched_first(irn)
407 #define sched_last(irn) _sched_last(irn)
408 #define sched_add_before(before, irn) _sched_add_before(before, irn)
409 #define sched_add_after(after, irn) _sched_add_after(after, irn)
410 #define sched_remove(irn) _sched_remove(irn)
411 #define sched_is_scheduled(irn) _sched_is_scheduled(irn)
412 #define sched_comes_after(n1, n2) _sched_comes_after(n1, n2)
413 #define sched_cmp(a, b) _sched_cmp(a, b)