2 * Copyright (C) 1995-2007 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_T_H
27 #define FIRM_BE_BESCHED_T_H
29 #define SCHED_INITIAL_GRANULARITY (1 << 14)
33 #include "irgraph_t.h"
38 typedef unsigned int sched_timestep_t;
40 extern size_t sched_irn_data_offset;
43 * The schedule structure which is present at each ir node.
45 * Currently, only basic blocks are scheduled. The list head of
46 * every block schedule list is the Block list.
48 typedef struct _sched_info_t {
49 struct list_head list; /**< The list head to list the nodes in a schedule. */
50 sched_timestep_t time_step; /**< If a is after b in a schedule, its time step is
52 unsigned scheduled : 1; /**< 1, if the node is in the schedule of the block, 0 else. */
55 #define _sched_entry(list_head) (list_entry(list_head, sched_info_t, list))
57 #define get_irn_sched_info(irn) get_irn_data(irn, sched_info_t, sched_irn_data_offset)
58 #define get_sched_info_irn(sched_info) get_irn_data_base(sched_info, sched_irn_data_offset)
61 * Check, if the node is scheduled.
62 * @param irn The node.
63 * @return 1, if the node is scheduled, 0 if not.
65 static INLINE int _sched_is_scheduled(const ir_node *irn)
67 return get_irn_sched_info(irn)->scheduled;
71 * Get the time step of an irn in a schedule.
72 * @param irn The node.
73 * @return The time step in the schedule.
75 static INLINE int _sched_get_time_step(const ir_node *irn)
77 assert(_sched_is_scheduled(irn));
78 return get_irn_sched_info(irn)->time_step;
82 * Checks, if a node is to appear in a schedule. Such nodes either
83 * consume real data (mode datab) or produce such.
84 * @param irn The node to check for.
85 * @return 1, if the node consumes/produces data, false if not.
87 static INLINE int to_appear_in_schedule(const ir_node *irn)
89 switch(get_irn_opcode(irn)) {
95 return is_data_node(irn);
100 * Check, if an ir_node has a scheduling successor.
101 * @param irn The ir node.
102 * @return 1, if the node has a scheduling successor, 0 if not.
104 static INLINE int _sched_has_next(const ir_node *irn)
106 const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
107 const sched_info_t *info = get_irn_sched_info(irn);
108 const sched_info_t *block_info = get_irn_sched_info(block);
109 return info->list.next != &block_info->list;
113 * Check, if an ir_node has a scheduling predecessor.
114 * @param irn The ir node.
115 * @return 1, if the node has a scheduling predecessor, 0 if not.
117 static INLINE int _sched_has_prev(const ir_node *irn)
119 const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
120 const sched_info_t *info = get_irn_sched_info(irn);
121 const sched_info_t *block_info = get_irn_sched_info(block);
122 return info->list.prev != &block_info->list;
126 * Get the scheduling successor of a node.
127 * @param irn The node.
128 * @return The next ir node in the schedule or the block, if the node has no next node.
130 static INLINE ir_node *_sched_next(const ir_node *irn)
132 const sched_info_t *info = get_irn_sched_info(irn);
133 return get_sched_info_irn(_sched_entry(info->list.next));
137 * Get the scheduling predecessor of a node.
138 * @param irn The node.
139 * @return The next ir node in the schedule or the block, if the node has no predecessor.
142 static INLINE ir_node *_sched_prev(const ir_node *irn)
144 const sched_info_t *info = get_irn_sched_info(irn);
145 return get_sched_info_irn(_sched_entry(info->list.prev));
149 * Get the first node in a block schedule.
150 * @param block The block of which to get the schedule.
151 * @return The first node in the schedule or the block itself
152 * if there is no node in the schedule.
154 static INLINE ir_node *_sched_first(const ir_node *block)
156 assert(is_Block(block) && "Need a block here");
157 return _sched_next(block);
161 * Get the last node in a schedule.
162 * @param block The block to get the schedule for.
163 * @return The last ir node in a schedule, or the block itself
164 * if there is no node in the schedule.
166 static INLINE ir_node *_sched_last(const ir_node *block)
168 assert(is_Block(block) && "Need a block here");
169 return _sched_prev(block);
173 * Reassign the time steps in the schedule.
174 * @param block The schedule to update.
176 void sched_renumber(const ir_node *block);
178 static INLINE void _sched_set_time_stamp(ir_node *irn)
180 sched_info_t *inf = get_irn_sched_info(irn);
181 sched_timestep_t before_ts = _sched_entry(inf->list.prev)->time_step;
182 sched_timestep_t after_ts = _sched_entry(inf->list.next)->time_step;
185 * If we are the last, we can give us a big time step,
186 * else we have to compute our time step from our
189 if(before_ts >= after_ts)
190 inf->time_step = before_ts + SCHED_INITIAL_GRANULARITY;
192 sched_timestep_t ts = (before_ts + after_ts) / 2;
195 * If the resolution went out, we have to renumber
198 if(ts == before_ts || ts == after_ts)
199 sched_renumber(get_nodes_block(irn));
206 * Add a node to a block schedule.
207 * @param block The block to whose schedule the node shall be added to.
208 * @param irn The node to add.
209 * @return The given node.
211 static INLINE ir_node *_sched_add_before(ir_node *before, ir_node *irn)
213 sched_info_t *info = get_irn_sched_info(irn);
214 assert(_sched_is_scheduled(before) && !_sched_is_scheduled(irn));
215 list_add_tail(&info->list, &get_irn_sched_info(before)->list);
216 _sched_set_time_stamp(irn);
222 * Add a node to a block schedule.
223 * @param block The block to whose schedule the node shall be added to.
224 * @param irn The node to add.
225 * @return The given node.
227 static INLINE ir_node *_sched_add_after(ir_node *after, ir_node *irn)
229 sched_info_t *info = get_irn_sched_info(irn);
230 assert(_sched_is_scheduled(after) && !_sched_is_scheduled(irn));
231 list_add(&info->list, &get_irn_sched_info(after)->list);
232 _sched_set_time_stamp(irn);
237 static INLINE void _sched_init_block(ir_node *block)
239 sched_info_t *info = get_irn_sched_info(block);
240 assert(info->scheduled == 0 && info->time_step == 0);
241 INIT_LIST_HEAD(&info->list);
245 static INLINE void _sched_reset(ir_node *node)
247 sched_info_t *info = get_irn_sched_info(node);
252 * Remove a node from the scheduled.
253 * @param irn The node.
255 static INLINE void _sched_remove(ir_node *irn)
257 sched_info_t *info = get_irn_sched_info(irn);
258 list_del(&info->list);
259 INIT_LIST_HEAD(&info->list);
264 * Compare two nodes according to their position in the schedule.
265 * @param a The first node.
266 * @param b The second node.
267 * @return A number smaller, equals to or larger than 0, if a is
268 * before, the same, or after b in the schedule.
270 static INLINE int _sched_cmp(const ir_node *a, const ir_node *b)
272 assert(_sched_is_scheduled(a) && _sched_is_scheduled(b));
273 assert(get_nodes_block(a) == get_nodes_block(b));
275 return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
279 * Checks, if one node is scheduled before another.
281 * @param n2 Another node.
282 * @return 1, if n1 is in front of n2 in the schedule, 0 else.
283 * @note Both nodes must be in the same block.
285 static INLINE int _sched_comes_after(const ir_node *n1, const ir_node *n2)
287 assert(_sched_is_scheduled(n1));
288 assert(_sched_is_scheduled(n2));
289 assert(get_nodes_block(n1) == get_nodes_block(n2));
290 return _sched_get_time_step(n1) < _sched_get_time_step(n2);
294 * A predicate for a node.
295 * @param irn The node.
296 * @param data The custom data.
297 * @return 1 if irn should be skipped. Else 0.
299 typedef int (sched_predicator_t)(const ir_node *irn, void *data);
302 * Predicate for sched_skip(), returns non-zero if irn is a control flow changing node.
304 * @param irn the node to evaluate
305 * @param data an arch_env_t * used to determine if irn is a cf
306 * node for the given architecture
308 int sched_skip_cf_predicator(const ir_node *irn, void *data);
311 * Predicate for sched_skip(), returns non-zero if irn is a Phi node.
313 * Used with sched_skip().
315 * @param irn the node to evaluate
318 int sched_skip_phi_predicator(const ir_node *irn, void *data);
321 * Skip nodes in a schedule.
322 * @param from The node to start from.
323 * @param forward The direction (1 for forward, 0 for backward).
324 * @param predicator The predicator function which decides what is skipped.
325 * @param data context parameter for the predicator.
327 * @return The first node not rejected by the predicator or the block
328 * itself if all nodes were rejected.
330 ir_node *sched_skip(ir_node *from, int forward,
331 sched_predicator_t *predicator, void *data);
333 #define sched_get_time_step(irn) _sched_get_time_step(irn)
334 #define sched_has_next(irn) _sched_has_next(irn)
335 #define sched_has_prev(irn) _sched_has_prev(irn)
336 #define sched_next(irn) _sched_next(irn)
337 #define sched_prev(irn) _sched_prev(irn)
338 #define sched_first(irn) _sched_first(irn)
339 #define sched_last(irn) _sched_last(irn)
340 #define sched_add_before(before, irn) _sched_add_before(before, irn)
341 #define sched_add_after(after, irn) _sched_add_after(after, irn)
342 #define sched_remove(irn) _sched_remove(irn)
343 #define sched_is_scheduled(irn) _sched_is_scheduled(irn)
344 #define sched_comes_after(n1, n2) _sched_comes_after(n1, n2)
345 #define sched_cmp(a, b) _sched_cmp(a, b)
347 #endif /* FIRM_BE_BESCHED_T_H */