2 * Copyright (C) 1995-2008 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"
34 #include "irphase_t.h"
35 #include "irphases_t.h"
40 typedef unsigned int sched_timestep_t;
42 extern size_t sched_irn_data_offset;
45 * The schedule structure which is present at each ir node.
47 * Currently, only basic blocks are scheduled. The list head of
48 * every block schedule list is the Block list.
50 typedef struct _sched_info_t {
51 struct list_head list; /**< The list head to list the nodes in a schedule. */
52 unsigned idx; /**< The node index of the nodes this schedule info belongs to. */
53 sched_timestep_t time_step; /**< If a is after b in a schedule, its time step is larger than b's. */
54 unsigned scheduled : 1; /**< 1, if the node is in the schedule of the block, 0 else. */
57 #define _sched_entry(list_head) (list_entry(list_head, sched_info_t, list))
58 #define get_irn_sched_info(irn) ((sched_info_t *) get_or_set_irn_phase_info(skip_Proj_const(irn), PHASE_BE_SCHED))
59 #define get_sched_info_irn(irg, sched_info) get_idx_irn((irg), (sched_info)->idx)
62 * Returns non-zero if schedule information is available
64 * @param irg The graph.
66 static INLINE int _have_sched_info(const ir_graph *irg)
68 return get_irg_phase(irg, PHASE_BE_SCHED) != NULL;
72 * Check, if the node is scheduled.
73 * @param irn The node.
74 * @return 1, if the node is scheduled, 0 if not.
76 static INLINE int _sched_is_scheduled(const ir_node *irn)
78 return get_irn_sched_info(irn)->scheduled;
82 * Get the time step of an irn in a schedule.
83 * @param irn The node.
84 * @return The time step in the schedule.
86 static INLINE int _sched_get_time_step(const ir_node *irn)
88 assert(_sched_is_scheduled(irn));
89 return get_irn_sched_info(irn)->time_step;
93 * Checks, if a node is to appear in a schedule. Such nodes either
94 * consume real data (mode datab) or produce such.
95 * @param irn The node to check for.
96 * @return 1, if the node consumes/produces data, false if not.
98 static INLINE int to_appear_in_schedule(const ir_node *irn)
100 switch(get_irn_opcode(irn)) {
108 return is_data_node(irn);
113 * Check, if an ir_node has a scheduling successor.
114 * @param irn The ir node.
115 * @return 1, if the node has a scheduling successor, 0 if not.
117 static INLINE int _sched_has_next(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.next != &block_info->list;
126 * Check, if an ir_node has a scheduling predecessor.
127 * @param irn The ir node.
128 * @return 1, if the node has a scheduling predecessor, 0 if not.
130 static INLINE int _sched_has_prev(const ir_node *irn)
132 const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
133 const sched_info_t *info = get_irn_sched_info(irn);
134 const sched_info_t *block_info = get_irn_sched_info(block);
135 return info->list.prev != &block_info->list;
139 * Get the scheduling successor of a node.
140 * @param irn The node.
141 * @return The next ir node in the schedule or the block, if the node has no next node.
143 static INLINE ir_node *_sched_next(const ir_node *irn)
145 const sched_info_t *info = get_irn_sched_info(irn);
146 return get_sched_info_irn(get_irn_irg(irn), _sched_entry(info->list.next));
150 * Get the scheduling predecessor of a node.
151 * @param irn The node.
152 * @return The next ir node in the schedule or the block, if the node has no predecessor.
155 static INLINE ir_node *_sched_prev(const ir_node *irn)
157 const sched_info_t *info = get_irn_sched_info(irn);
158 return get_sched_info_irn(get_irn_irg(irn), _sched_entry(info->list.prev));
162 * Get the first node in a block schedule.
163 * @param block The block of which to get the schedule.
164 * @return The first node in the schedule or the block itself
165 * if there is no node in the schedule.
167 static INLINE ir_node *_sched_first(const ir_node *block)
169 assert(is_Block(block) && "Need a block here");
170 return _sched_next(block);
174 * Get the last node in a schedule.
175 * @param block The block to get the schedule for.
176 * @return The last ir node in a schedule, or the block itself
177 * if there is no node in the schedule.
179 static INLINE ir_node *_sched_last(const ir_node *block)
181 assert(is_Block(block) && "Need a block here");
182 return _sched_prev(block);
186 * Reassign the time steps in the schedule.
187 * @param block The schedule to update.
189 void sched_renumber(const ir_node *block);
191 static INLINE void _sched_set_time_stamp(const ir_node *irn)
193 sched_info_t *inf = get_irn_sched_info(irn);
194 sched_timestep_t before_ts = _sched_entry(inf->list.prev)->time_step;
195 sched_timestep_t after_ts = _sched_entry(inf->list.next)->time_step;
198 * If we are the last, we can give us a big time step,
199 * else we have to compute our time step from our
202 if(before_ts >= after_ts)
203 inf->time_step = before_ts + SCHED_INITIAL_GRANULARITY;
205 sched_timestep_t ts = (before_ts + after_ts) / 2;
208 * If the resolution went out, we have to renumber
211 if(ts == before_ts || ts == after_ts)
212 sched_renumber(get_nodes_block(irn));
219 * Add a node to a block schedule.
220 * @param block The block to whose schedule the node shall be added to.
221 * @param irn The node to add.
222 * @return The given node.
224 static INLINE void _sched_add_before(const ir_node *before, const ir_node *irn)
226 sched_info_t *info = get_irn_sched_info(irn);
227 assert(_sched_is_scheduled(before));
228 assert(!_sched_is_scheduled(irn));
229 assert(!is_Proj(irn));
230 list_add_tail(&info->list, &get_irn_sched_info(before)->list);
231 _sched_set_time_stamp(irn);
236 * Add a node to a block schedule.
237 * @param block The block to whose schedule the node shall be added to.
238 * @param irn The node to add.
239 * @return The given node.
241 static INLINE void _sched_add_after(const ir_node *after, const ir_node *irn)
243 sched_info_t *info = get_irn_sched_info(irn);
244 assert(_sched_is_scheduled(after));
245 assert(!_sched_is_scheduled(irn));
246 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(const 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(const 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(const ir_node *irn)
272 sched_info_t *info = get_irn_sched_info(irn);
273 list_del(&info->list);
274 INIT_LIST_HEAD(&info->list);
279 * Compare two nodes according to their position in the schedule.
280 * @param a The first node.
281 * @param b The second node.
282 * @return A number smaller, equals to or larger than 0, if a is
283 * before, the same, or after b in the schedule.
285 static INLINE int _sched_cmp(const ir_node *a, const ir_node *b)
287 assert(_sched_is_scheduled(a) && _sched_is_scheduled(b));
288 assert(get_nodes_block(a) == get_nodes_block(b));
290 return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
294 * Checks, if one node is scheduled before another.
296 * @param n2 Another node.
297 * @return 1, if n1 is in front of n2 in the schedule, 0 else.
298 * @note Both nodes must be in the same block.
300 static INLINE int _sched_comes_after(const ir_node *n1, const ir_node *n2)
302 assert(_sched_is_scheduled(n1));
303 assert(_sched_is_scheduled(n2));
304 assert(get_nodes_block(n1) == get_nodes_block(n2));
305 return _sched_get_time_step(n1) < _sched_get_time_step(n2);
309 * A predicate for a node.
310 * @param irn The node.
311 * @param data The custom data.
312 * @return 1 if irn should be skipped. Else 0.
314 typedef int (sched_predicator_t)(const ir_node *irn, void *data);
317 * Predicate for sched_skip(), returns non-zero if irn is a control flow changing node.
319 * @param irn the node to evaluate
320 * @param data an arch_env_t * used to determine if irn is a cf
321 * node for the given architecture
323 int sched_skip_cf_predicator(const ir_node *irn, void *data);
326 * Predicate for sched_skip(), returns non-zero if irn is a Phi node.
328 * Used with sched_skip().
330 * @param irn the node to evaluate
333 int sched_skip_phi_predicator(const ir_node *irn, void *data);
336 * Skip nodes in a schedule.
337 * @param from The node to start from.
338 * @param forward The direction (1 for forward, 0 for backward).
339 * @param predicator The predicator function which decides what is skipped.
340 * @param data context parameter for the predicator.
342 * @return The first node not rejected by the predicator or the block
343 * itself if all nodes were rejected.
345 ir_node *sched_skip(ir_node *from, int forward, sched_predicator_t *predicator, void *data);
347 #define have_sched_info(irg) _have_sched_info(irg)
348 #define sched_get_time_step(irn) _sched_get_time_step(irn)
349 #define sched_has_next(irn) _sched_has_next(irn)
350 #define sched_has_prev(irn) _sched_has_prev(irn)
351 #define sched_next(irn) _sched_next(irn)
352 #define sched_prev(irn) _sched_prev(irn)
353 #define sched_first(irn) _sched_first(irn)
354 #define sched_last(irn) _sched_last(irn)
355 #define sched_add_before(before, irn) _sched_add_before(before, irn)
356 #define sched_add_after(after, irn) _sched_add_after(after, irn)
357 #define sched_remove(irn) _sched_remove(irn)
358 #define sched_is_scheduled(irn) _sched_is_scheduled(irn)
359 #define sched_comes_after(n1, n2) _sched_comes_after(n1, n2)
360 #define sched_cmp(a, b) _sched_cmp(a, b)
362 #endif /* FIRM_BE_BESCHED_T_H */