nsz Git - libfirm/blob - ir/be/besched_t.h

   1 /*
   2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   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.
  10  *
  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.
  14  *
  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
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief       Scheduling utilities for nodes in Blocks and Blocks.
  23  * @author      Sebastian Hack
  24  * @version     $Id$
  25  */
  26 #ifndef FIRM_BE_BESCHED_T_H
  27 #define FIRM_BE_BESCHED_T_H
  28
  29 #define SCHED_INITIAL_GRANULARITY (1 << 14)
  30
  31 #include "list.h"
  32 #include "irnode_t.h"
  33 #include "irgraph_t.h"
  34 #include "irphase_t.h"
  35 #include "irphases_t.h"
  36
  37 #include "beutil.h"
  38 #include "besched.h"
  39
  40 typedef unsigned int sched_timestep_t;
  41
  42 extern size_t sched_irn_data_offset;
  43
  44 /**
  45  * The schedule structure which is present at each ir node.
  46  *
  47  * Currently, only basic blocks are scheduled. The list head of
  48  * every block schedule list is the Block list.
  49  */
  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. */
  55 } sched_info_t;
  56
  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)
  60
  61 /**
  62  * Check, if the node is scheduled.
  63  * @param irn The node.
  64  * @return 1, if the node is scheduled, 0 if not.
  65  */
  66 static INLINE int _sched_is_scheduled(const ir_node *irn)
  67 {
  68   return get_irn_sched_info(irn)->scheduled;
  69 }
  70
  71 /**
  72  * Get the time step of an irn in a schedule.
  73  * @param irn The node.
  74  * @return The time step in the schedule.
  75  */
  76 static INLINE int _sched_get_time_step(const ir_node *irn)
  77 {
  78         assert(_sched_is_scheduled(irn));
  79         return get_irn_sched_info(irn)->time_step;
  80 }
  81
  82 /**
  83  * Checks, if a node is to appear in a schedule. Such nodes either
  84  * consume real data (mode datab) or produce such.
  85  * @param irn The node to check for.
  86  * @return 1, if the node consumes/produces data, false if not.
  87  */
  88 static INLINE int to_appear_in_schedule(const ir_node *irn)
  89 {
  90         switch(get_irn_opcode(irn)) {
  91                 case iro_Start:
  92                 case iro_Jmp:
  93                 case iro_Break:
  94                         return 1;
  95                 case iro_Proj:
  96                         return 0;
  97                 default:
  98                         return is_data_node(irn);
  99         }
 100 }
 101
 102 /**
 103  * Check, if an ir_node has a scheduling successor.
 104  * @param irn The ir node.
 105  * @return 1, if the node has a scheduling successor, 0 if not.
 106  */
 107 static INLINE int _sched_has_next(const ir_node *irn)
 108 {
 109         const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
 110         const sched_info_t *info = get_irn_sched_info(irn);
 111         const sched_info_t *block_info = get_irn_sched_info(block);
 112         return info->list.next != &block_info->list;
 113 }
 114
 115 /**
 116  * Check, if an ir_node has a scheduling predecessor.
 117  * @param irn The ir node.
 118  * @return 1, if the node has a scheduling predecessor, 0 if not.
 119  */
 120 static INLINE int _sched_has_prev(const ir_node *irn)
 121 {
 122         const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
 123         const sched_info_t *info = get_irn_sched_info(irn);
 124         const sched_info_t *block_info = get_irn_sched_info(block);
 125         return info->list.prev != &block_info->list;
 126 }
 127
 128 /**
 129  * Get the scheduling successor of a node.
 130  * @param irn The node.
 131  * @return The next ir node in the schedule or the block, if the node has no next node.
 132  */
 133 static INLINE ir_node *_sched_next(const ir_node *irn)
 134 {
 135         const sched_info_t *info = get_irn_sched_info(irn);
 136         return get_sched_info_irn(get_irn_irg(irn), _sched_entry(info->list.next));
 137 }
 138
 139 /**
 140  * Get the scheduling predecessor of a node.
 141  * @param irn The node.
 142  * @return The next ir node in the schedule or the block, if the node has no predecessor.
 143  * predecessor.
 144  */
 145 static INLINE ir_node *_sched_prev(const ir_node *irn)
 146 {
 147         const sched_info_t *info = get_irn_sched_info(irn);
 148         return get_sched_info_irn(get_irn_irg(irn), _sched_entry(info->list.prev));
 149 }
 150
 151 /**
 152  * Get the first node in a block schedule.
 153  * @param block The block of which to get the schedule.
 154  * @return The first node in the schedule or the block itself
 155  *         if there is no node in the schedule.
 156  */
 157 static INLINE ir_node *_sched_first(const ir_node *block)
 158 {
 159         assert(is_Block(block) && "Need a block here");
 160         return _sched_next(block);
 161 }
 162
 163 /**
 164  * Get the last node in a schedule.
 165  * @param  block The block to get the schedule for.
 166  * @return The last ir node in a schedule, or the block itself
 167  *         if there is no node in the schedule.
 168  */
 169 static INLINE ir_node *_sched_last(const ir_node *block)
 170 {
 171         assert(is_Block(block) && "Need a block here");
 172         return _sched_prev(block);
 173 }
 174
 175 /**
 176  * Reassign the time steps in the schedule.
 177  * @param block The schedule to update.
 178  */
 179 void sched_renumber(const ir_node *block);
 180
 181 static INLINE void _sched_set_time_stamp(const ir_node *irn)
 182 {
 183         sched_info_t *inf = get_irn_sched_info(irn);
 184         sched_timestep_t before_ts = _sched_entry(inf->list.prev)->time_step;
 185         sched_timestep_t after_ts = _sched_entry(inf->list.next)->time_step;
 186
 187         /*
 188          * If we are the last, we can give us a big time step,
 189          * else we have to compute our time step from our
 190          * neighbours.
 191          */
 192         if(before_ts >= after_ts)
 193                 inf->time_step = before_ts + SCHED_INITIAL_GRANULARITY;
 194         else {
 195                 sched_timestep_t ts = (before_ts + after_ts) / 2;
 196
 197                 /*
 198                  * If the resolution went out, we have to renumber
 199                  * this block.
 200                  */
 201                 if(ts == before_ts || ts == after_ts)
 202                         sched_renumber(get_nodes_block(irn));
 203                 else
 204                         inf->time_step = ts;
 205         }
 206 }
 207
 208 /**
 209  * Add a node to a block schedule.
 210  * @param block The block to whose schedule the node shall be added to.
 211  * @param irn The node to add.
 212  * @return The given node.
 213  */
 214 static INLINE void _sched_add_before(const ir_node *before, const ir_node *irn)
 215 {
 216         sched_info_t *info = get_irn_sched_info(irn);
 217         assert(_sched_is_scheduled(before));
 218         assert(!_sched_is_scheduled(irn));
 219         assert(!is_Proj(irn));
 220         list_add_tail(&info->list, &get_irn_sched_info(before)->list);
 221         _sched_set_time_stamp(irn);
 222         info->scheduled = 1;
 223 }
 224
 225 /**
 226  * Add a node to a block schedule.
 227  * @param block The block to whose schedule the node shall be added to.
 228  * @param irn The node to add.
 229  * @return The given node.
 230  */
 231 static INLINE void _sched_add_after(const ir_node *after, const ir_node *irn)
 232 {
 233         sched_info_t *info = get_irn_sched_info(irn);
 234         assert(_sched_is_scheduled(after));
 235         assert(!_sched_is_scheduled(irn));
 236         assert(!is_Proj(irn));
 237         list_add(&info->list, &get_irn_sched_info(after)->list);
 238         _sched_set_time_stamp(irn);
 239         info->scheduled = 1;
 240 }
 241
 242 static INLINE void _sched_init_block(const ir_node *block)
 243 {
 244         sched_info_t *info = get_irn_sched_info(block);
 245         assert(info->scheduled == 0 && info->time_step == 0);
 246         INIT_LIST_HEAD(&info->list);
 247         info->scheduled = 1;
 248 }
 249
 250 static INLINE void _sched_reset(const ir_node *node)
 251 {
 252         sched_info_t *info = get_irn_sched_info(node);
 253         info->scheduled = 0;
 254 }
 255
 256 /**
 257  * Remove a node from the scheduled.
 258  * @param irn The node.
 259  */
 260 static INLINE void _sched_remove(const ir_node *irn)
 261 {
 262         sched_info_t *info;
 263 #ifndef SCHEDULE_PROJ
 264         assert(!is_Proj(irn));
 265 #endif
 266         info = get_irn_sched_info(irn);
 267         list_del(&info->list);
 268         INIT_LIST_HEAD(&info->list);
 269         info->scheduled = 0;
 270 }
 271
 272 /**
 273  * Compare two nodes according to their position in the schedule.
 274  * @param a The first node.
 275  * @param b The second node.
 276  * @return A number smaller, equals to or larger than 0, if a is
 277  *         before, the same, or after b in the schedule.
 278  */
 279 static INLINE int _sched_cmp(const ir_node *a, const ir_node *b)
 280 {
 281         assert(_sched_is_scheduled(a) && _sched_is_scheduled(b));
 282         assert(get_nodes_block(a) == get_nodes_block(b));
 283
 284         return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
 285 }
 286
 287 /**
 288  * Checks, if one node is scheduled before another.
 289  * @param n1   A node.
 290  * @param n2   Another node.
 291  * @return     1, if n1 is in front of n2 in the schedule, 0 else.
 292  * @note       Both nodes must be in the same block.
 293  */
 294 static INLINE int _sched_comes_after(const ir_node *n1, const ir_node *n2)
 295 {
 296         assert(_sched_is_scheduled(n1));
 297         assert(_sched_is_scheduled(n2));
 298         assert(get_nodes_block(n1) == get_nodes_block(n2));
 299         return _sched_get_time_step(n1) < _sched_get_time_step(n2);
 300 }
 301
 302 /**
 303  * A predicate for a node.
 304  * @param irn The node.
 305  * @param data The custom data.
 306  * @return 1 if irn should be skipped. Else 0.
 307  */
 308 typedef int (sched_predicator_t)(const ir_node *irn, void *data);
 309
 310 /**
 311  * Predicate for sched_skip(), returns non-zero if irn is a control flow changing node.
 312  *
 313  * @param irn   the node to evaluate
 314  * @param data  an arch_env_t * used to determine if irn is a cf
 315  *              node for the given architecture
 316  */
 317 int sched_skip_cf_predicator(const ir_node *irn, void *data);
 318
 319 /**
 320  * Predicate for sched_skip(), returns non-zero if irn is a Phi node.
 321  *
 322  * Used with sched_skip().
 323  *
 324  * @param irn  the node to evaluate
 325  * @param data unused
 326  */
 327 int sched_skip_phi_predicator(const ir_node *irn, void *data);
 328
 329 /**
 330  * Skip nodes in a schedule.
 331  * @param from        The node to start from.
 332  * @param forward     The direction (1 for forward, 0 for backward).
 333  * @param predicator  The predicator function which decides what is skipped.
 334  * @param data        context parameter for the predicator.
 335  *
 336  * @return The first node not rejected by the predicator or the block
 337  *         itself if all nodes were rejected.
 338  */
 339 ir_node *sched_skip(ir_node *from, int forward, sched_predicator_t *predicator, void *data);
 340
 341 #define sched_get_time_step(irn)        _sched_get_time_step(irn)
 342 #define sched_has_next(irn)             _sched_has_next(irn)
 343 #define sched_has_prev(irn)             _sched_has_prev(irn)
 344 #define sched_next(irn)                 _sched_next(irn)
 345 #define sched_prev(irn)                 _sched_prev(irn)
 346 #define sched_first(irn)                _sched_first(irn)
 347 #define sched_last(irn)                 _sched_last(irn)
 348 #define sched_add_before(before, irn)   _sched_add_before(before, irn)
 349 #define sched_add_after(after, irn)     _sched_add_after(after, irn)
 350 #define sched_remove(irn)               _sched_remove(irn)
 351 #define sched_is_scheduled(irn)         _sched_is_scheduled(irn)
 352 #define sched_comes_after(n1, n2)       _sched_comes_after(n1, n2)
 353 #define sched_cmp(a, b)                 _sched_cmp(a, b)
 354
 355 #endif /* FIRM_BE_BESCHED_T_H */