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 #ifndef SCHEDULE_PROJS
58 #define get_irn_sched_info(irn) get_irn_data(skip_Proj_const(irn), sched_info_t, sched_irn_data_offset)
60 #define get_irn_sched_info(irn) get_irn_data(irn, sched_info_t, sched_irn_data_offset)
63 #define get_sched_info_irn(sched_info) get_irn_data_base(sched_info, sched_irn_data_offset)
66 * Check, if the node is scheduled.
67 * @param irn The node.
68 * @return 1, if the node is scheduled, 0 if not.
70 static INLINE int _sched_is_scheduled(const ir_node *irn)
72 return get_irn_sched_info(irn)->scheduled;
76 * Get the time step of an irn in a schedule.
77 * @param irn The node.
78 * @return The time step in the schedule.
80 static INLINE int _sched_get_time_step(const ir_node *irn)
82 assert(_sched_is_scheduled(irn));
83 return get_irn_sched_info(irn)->time_step;
87 * Checks, if a node is to appear in a schedule. Such nodes either
88 * consume real data (mode datab) or produce such.
89 * @param irn The node to check for.
90 * @return 1, if the node consumes/produces data, false if not.
92 static INLINE int to_appear_in_schedule(const ir_node *irn)
94 switch(get_irn_opcode(irn)) {
99 #ifndef SCHEDULE_PROJS
104 return is_data_node(irn);
109 * Check, if an ir_node has a scheduling successor.
110 * @param irn The ir node.
111 * @return 1, if the node has a scheduling successor, 0 if not.
113 static INLINE int _sched_has_next(const ir_node *irn)
115 const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
116 const sched_info_t *info = get_irn_sched_info(irn);
117 const sched_info_t *block_info = get_irn_sched_info(block);
118 return info->list.next != &block_info->list;
122 * Check, if an ir_node has a scheduling predecessor.
123 * @param irn The ir node.
124 * @return 1, if the node has a scheduling predecessor, 0 if not.
126 static INLINE int _sched_has_prev(const ir_node *irn)
128 const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
129 const sched_info_t *info = get_irn_sched_info(irn);
130 const sched_info_t *block_info = get_irn_sched_info(block);
131 return info->list.prev != &block_info->list;
135 * Get the scheduling successor of a node.
136 * @param irn The node.
137 * @return The next ir node in the schedule or the block, if the node has no next node.
139 static INLINE ir_node *_sched_next(const ir_node *irn)
141 const sched_info_t *info = get_irn_sched_info(irn);
142 return get_sched_info_irn(_sched_entry(info->list.next));
146 * Get the scheduling predecessor of a node.
147 * @param irn The node.
148 * @return The next ir node in the schedule or the block, if the node has no predecessor.
151 static INLINE ir_node *_sched_prev(const ir_node *irn)
153 const sched_info_t *info = get_irn_sched_info(irn);
154 return get_sched_info_irn(_sched_entry(info->list.prev));
158 * Get the first node in a block schedule.
159 * @param block The block of which to get the schedule.
160 * @return The first node in the schedule or the block itself
161 * if there is no node in the schedule.
163 static INLINE ir_node *_sched_first(const ir_node *block)
165 assert(is_Block(block) && "Need a block here");
166 return _sched_next(block);
170 * Get the last node in a schedule.
171 * @param block The block to get the schedule for.
172 * @return The last ir node in a schedule, or the block itself
173 * if there is no node in the schedule.
175 static INLINE ir_node *_sched_last(const ir_node *block)
177 assert(is_Block(block) && "Need a block here");
178 return _sched_prev(block);
182 * Reassign the time steps in the schedule.
183 * @param block The schedule to update.
185 void sched_renumber(const ir_node *block);
187 static INLINE void _sched_set_time_stamp(ir_node *irn)
189 sched_info_t *inf = get_irn_sched_info(irn);
190 sched_timestep_t before_ts = _sched_entry(inf->list.prev)->time_step;
191 sched_timestep_t after_ts = _sched_entry(inf->list.next)->time_step;
194 * If we are the last, we can give us a big time step,
195 * else we have to compute our time step from our
198 if(before_ts >= after_ts)
199 inf->time_step = before_ts + SCHED_INITIAL_GRANULARITY;
201 sched_timestep_t ts = (before_ts + after_ts) / 2;
204 * If the resolution went out, we have to renumber
207 if(ts == before_ts || ts == after_ts)
208 sched_renumber(get_nodes_block(irn));
215 * Add a node to a block schedule.
216 * @param block The block to whose schedule the node shall be added to.
217 * @param irn The node to add.
218 * @return The given node.
220 static INLINE void _sched_add_before(ir_node *before, ir_node *irn)
222 sched_info_t *info = get_irn_sched_info(irn);
223 assert(_sched_is_scheduled(before));
224 assert(!_sched_is_scheduled(irn));
225 #ifndef SCHEDULE_PROJS
226 assert(!is_Proj(irn));
228 list_add_tail(&info->list, &get_irn_sched_info(before)->list);
229 _sched_set_time_stamp(irn);
234 * Add a node to a block schedule.
235 * @param block The block to whose schedule the node shall be added to.
236 * @param irn The node to add.
237 * @return The given node.
239 static INLINE void _sched_add_after(ir_node *after, ir_node *irn)
241 sched_info_t *info = get_irn_sched_info(irn);
242 assert(_sched_is_scheduled(after));
243 assert(!_sched_is_scheduled(irn));
244 #ifndef SCHEDULE_PROJS
245 assert(!is_Proj(irn));
247 list_add(&info->list, &get_irn_sched_info(after)->list);
248 _sched_set_time_stamp(irn);
252 static INLINE void _sched_init_block(ir_node *block)
254 sched_info_t *info = get_irn_sched_info(block);
255 assert(info->scheduled == 0 && info->time_step == 0);
256 INIT_LIST_HEAD(&info->list);
260 static INLINE void _sched_reset(ir_node *node)
262 sched_info_t *info = get_irn_sched_info(node);
267 * Remove a node from the scheduled.
268 * @param irn The node.
270 static INLINE void _sched_remove(ir_node *irn)
273 #ifndef SCHEDULE_PROJ
274 assert(!is_Proj(irn));
276 info = get_irn_sched_info(irn);
277 list_del(&info->list);
278 INIT_LIST_HEAD(&info->list);
283 * Compare two nodes according to their position in the schedule.
284 * @param a The first node.
285 * @param b The second node.
286 * @return A number smaller, equals to or larger than 0, if a is
287 * before, the same, or after b in the schedule.
289 static INLINE int _sched_cmp(const ir_node *a, const ir_node *b)
291 assert(_sched_is_scheduled(a) && _sched_is_scheduled(b));
292 assert(get_nodes_block(a) == get_nodes_block(b));
294 return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
298 * Checks, if one node is scheduled before another.
300 * @param n2 Another node.
301 * @return 1, if n1 is in front of n2 in the schedule, 0 else.
302 * @note Both nodes must be in the same block.
304 static INLINE int _sched_comes_after(const ir_node *n1, const ir_node *n2)
306 assert(_sched_is_scheduled(n1));
307 assert(_sched_is_scheduled(n2));
308 assert(get_nodes_block(n1) == get_nodes_block(n2));
309 return _sched_get_time_step(n1) < _sched_get_time_step(n2);
313 * A predicate for a node.
314 * @param irn The node.
315 * @param data The custom data.
316 * @return 1 if irn should be skipped. Else 0.
318 typedef int (sched_predicator_t)(const ir_node *irn, void *data);
321 * Predicate for sched_skip(), returns non-zero if irn is a control flow changing node.
323 * @param irn the node to evaluate
324 * @param data an arch_env_t * used to determine if irn is a cf
325 * node for the given architecture
327 int sched_skip_cf_predicator(const ir_node *irn, void *data);
330 * Predicate for sched_skip(), returns non-zero if irn is a Phi node.
332 * Used with sched_skip().
334 * @param irn the node to evaluate
337 int sched_skip_phi_predicator(const ir_node *irn, void *data);
340 * Skip nodes in a schedule.
341 * @param from The node to start from.
342 * @param forward The direction (1 for forward, 0 for backward).
343 * @param predicator The predicator function which decides what is skipped.
344 * @param data context parameter for the predicator.
346 * @return The first node not rejected by the predicator or the block
347 * itself if all nodes were rejected.
349 ir_node *sched_skip(ir_node *from, int forward,
350 sched_predicator_t *predicator, void *data);
352 #define sched_get_time_step(irn) _sched_get_time_step(irn)
353 #define sched_has_next(irn) _sched_has_next(irn)
354 #define sched_has_prev(irn) _sched_has_prev(irn)
355 #define sched_next(irn) _sched_next(irn)
356 #define sched_prev(irn) _sched_prev(irn)
357 #define sched_first(irn) _sched_first(irn)
358 #define sched_last(irn) _sched_last(irn)
359 #define sched_add_before(before, irn) _sched_add_before(before, irn)
360 #define sched_add_after(after, irn) _sched_add_after(after, irn)
361 #define sched_remove(irn) _sched_remove(irn)
362 #define sched_is_scheduled(irn) _sched_is_scheduled(irn)
363 #define sched_comes_after(n1, n2) _sched_comes_after(n1, n2)
364 #define sched_cmp(a, b) _sched_cmp(a, b)
366 #endif /* FIRM_BE_BESCHED_T_H */