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
  35 #include "beutil.h"
  36 #include "besched.h"
  37
  38 typedef unsigned int sched_timestep_t;
  39
  40 extern size_t sched_irn_data_offset;
  41
  42 /**
  43  * The schedule structure which is present at each ir node.
  44  *
  45  * Currently, only basic blocks are scheduled. The list head of
  46  * every block schedule list is the Block list.
  47  */
  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
  51                                         larger than b's. */
  52         unsigned scheduled : 1;        /**< 1, if the node is in the schedule of the block, 0 else. */
  53 } sched_info_t;
  54
  55 #define _sched_entry(list_head) (list_entry(list_head, sched_info_t, list))
  56
  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)
  59
  60 /**
  61  * Check, if the node is scheduled.
  62  * @param irn The node.
  63  * @return 1, if the node is scheduled, 0 if not.
  64  */
  65 static INLINE int _sched_is_scheduled(const ir_node *irn)
  66 {
  67   return get_irn_sched_info(irn)->scheduled;
  68 }
  69
  70 /**
  71  * Get the time step of an irn in a schedule.
  72  * @param irn The node.
  73  * @return The time step in the schedule.
  74  */
  75 static INLINE int _sched_get_time_step(const ir_node *irn)
  76 {
  77         assert(_sched_is_scheduled(irn));
  78         return get_irn_sched_info(irn)->time_step;
  79 }
  80
  81 /**
  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.
  86  */
  87 static INLINE int to_appear_in_schedule(const ir_node *irn)
  88 {
  89         switch(get_irn_opcode(irn)) {
  90                 case iro_Start:
  91                 case iro_Jmp:
  92                 case iro_Break:
  93                         return 1;
  94                 default:
  95                         return is_data_node(irn);
  96         }
  97 }
  98
  99 /**
 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.
 103  */
 104 static INLINE int _sched_has_next(const ir_node *irn)
 105 {
 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;
 110 }
 111
 112 /**
 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.
 116  */
 117 static INLINE int _sched_has_prev(const ir_node *irn)
 118 {
 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;
 123 }
 124
 125 /**
 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.
 129  */
 130 static INLINE ir_node *_sched_next(const ir_node *irn)
 131 {
 132         const sched_info_t *info = get_irn_sched_info(irn);
 133         return get_sched_info_irn(_sched_entry(info->list.next));
 134 }
 135
 136 /**
 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.
 140  * predecessor.
 141  */
 142 static INLINE ir_node *_sched_prev(const ir_node *irn)
 143 {
 144         const sched_info_t *info = get_irn_sched_info(irn);
 145         return get_sched_info_irn(_sched_entry(info->list.prev));
 146 }
 147
 148 /**
 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.
 153  */
 154 static INLINE ir_node *_sched_first(const ir_node *block)
 155 {
 156         assert(is_Block(block) && "Need a block here");
 157         return _sched_next(block);
 158 }
 159
 160 /**
 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.
 165  */
 166 static INLINE ir_node *_sched_last(const ir_node *block)
 167 {
 168         assert(is_Block(block) && "Need a block here");
 169         return _sched_prev(block);
 170 }
 171
 172 /**
 173  * Reassign the time steps in the schedule.
 174  * @param block The schedule to update.
 175  */
 176 void sched_renumber(const ir_node *block);
 177
 178 static INLINE void _sched_set_time_stamp(ir_node *irn)
 179 {
 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;
 183
 184         /*
 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
 187          * neighbours.
 188          */
 189         if(before_ts >= after_ts)
 190                 inf->time_step = before_ts + SCHED_INITIAL_GRANULARITY;
 191         else {
 192                 sched_timestep_t ts = (before_ts + after_ts) / 2;
 193
 194                 /*
 195                  * If the resolution went out, we have to renumber
 196                  * this block.
 197                  */
 198                 if(ts == before_ts || ts == after_ts)
 199                         sched_renumber(get_nodes_block(irn));
 200                 else
 201                         inf->time_step = ts;
 202         }
 203 }
 204
 205 /**
 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.
 210  */
 211 static INLINE ir_node *_sched_add_before(ir_node *before, ir_node *irn)
 212 {
 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);
 217         info->scheduled = 1;
 218         return irn;
 219 }
 220
 221 /**
 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.
 226  */
 227 static INLINE ir_node *_sched_add_after(ir_node *after, ir_node *irn)
 228 {
 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);
 233         info->scheduled = 1;
 234         return irn;
 235 }
 236
 237 static INLINE void _sched_init_block(ir_node *block)
 238 {
 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);
 242         info->scheduled = 1;
 243 }
 244
 245 static INLINE void _sched_reset(ir_node *node)
 246 {
 247         sched_info_t *info = get_irn_sched_info(node);
 248         info->scheduled = 0;
 249 }
 250
 251 /**
 252  * Remove a node from the scheduled.
 253  * @param irn The node.
 254  */
 255 static INLINE void _sched_remove(ir_node *irn)
 256 {
 257   sched_info_t *info = get_irn_sched_info(irn);
 258   list_del(&info->list);
 259         INIT_LIST_HEAD(&info->list);
 260   info->scheduled = 0;
 261 }
 262
 263 /**
 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.
 269  */
 270 static INLINE int _sched_cmp(const ir_node *a, const ir_node *b)
 271 {
 272   assert(_sched_is_scheduled(a) && _sched_is_scheduled(b));
 273   assert(get_nodes_block(a) == get_nodes_block(b));
 274
 275   return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
 276 }
 277
 278 /**
 279  * Checks, if one node is scheduled before another.
 280  * @param n1   A node.
 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.
 284  */
 285 static INLINE int _sched_comes_after(const ir_node *n1, const ir_node *n2)
 286 {
 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);
 291 }
 292
 293 /**
 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.
 298  */
 299 typedef int (sched_predicator_t)(const ir_node *irn, void *data);
 300
 301 /**
 302  * Predicate for sched_skip(), returns non-zero if irn is a control flow changing node.
 303  *
 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
 307  */
 308 int sched_skip_cf_predicator(const ir_node *irn, void *data);
 309
 310 /**
 311  * Predicate for sched_skip(), returns non-zero if irn is a Phi node.
 312  *
 313  * Used with sched_skip().
 314  *
 315  * @param irn  the node to evaluate
 316  * @param data unused
 317  */
 318 int sched_skip_phi_predicator(const ir_node *irn, void *data);
 319
 320 /**
 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.
 326  *
 327  * @return The first node not rejected by the predicator or the block
 328  *         itself if all nodes were rejected.
 329  */
 330 ir_node *sched_skip(ir_node *from, int forward,
 331     sched_predicator_t *predicator, void *data);
 332
 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)
 346
 347 #endif /* FIRM_BE_BESCHED_T_H */