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 #ifndef SCHEDULE_PROJS
  58 #define get_irn_sched_info(irn) get_irn_data(skip_Proj_const(irn), sched_info_t, sched_irn_data_offset)
  59 #else
  60 #define get_irn_sched_info(irn) get_irn_data(irn, sched_info_t, sched_irn_data_offset)
  61 #endif
  62
  63 #define get_sched_info_irn(sched_info) get_irn_data_base(sched_info, sched_irn_data_offset)
  64
  65 /**
  66  * Check, if the node is scheduled.
  67  * @param irn The node.
  68  * @return 1, if the node is scheduled, 0 if not.
  69  */
  70 static INLINE int _sched_is_scheduled(const ir_node *irn)
  71 {
  72   return get_irn_sched_info(irn)->scheduled;
  73 }
  74
  75 /**
  76  * Get the time step of an irn in a schedule.
  77  * @param irn The node.
  78  * @return The time step in the schedule.
  79  */
  80 static INLINE int _sched_get_time_step(const ir_node *irn)
  81 {
  82         assert(_sched_is_scheduled(irn));
  83         return get_irn_sched_info(irn)->time_step;
  84 }
  85
  86 /**
  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.
  91  */
  92 static INLINE int to_appear_in_schedule(const ir_node *irn)
  93 {
  94         switch(get_irn_opcode(irn)) {
  95                 case iro_Start:
  96                 case iro_Jmp:
  97                 case iro_Break:
  98                         return 1;
  99 #ifndef SCHEDULE_PROJS
 100                 case iro_Proj:
 101                         return 0;
 102 #endif
 103                 default:
 104                         return is_data_node(irn);
 105         }
 106 }
 107
 108 /**
 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.
 112  */
 113 static INLINE int _sched_has_next(const ir_node *irn)
 114 {
 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;
 119 }
 120
 121 /**
 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.
 125  */
 126 static INLINE int _sched_has_prev(const ir_node *irn)
 127 {
 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;
 132 }
 133
 134 /**
 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.
 138  */
 139 static INLINE ir_node *_sched_next(const ir_node *irn)
 140 {
 141         const sched_info_t *info = get_irn_sched_info(irn);
 142         return get_sched_info_irn(_sched_entry(info->list.next));
 143 }
 144
 145 /**
 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.
 149  * predecessor.
 150  */
 151 static INLINE ir_node *_sched_prev(const ir_node *irn)
 152 {
 153         const sched_info_t *info = get_irn_sched_info(irn);
 154         return get_sched_info_irn(_sched_entry(info->list.prev));
 155 }
 156
 157 /**
 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.
 162  */
 163 static INLINE ir_node *_sched_first(const ir_node *block)
 164 {
 165         assert(is_Block(block) && "Need a block here");
 166         return _sched_next(block);
 167 }
 168
 169 /**
 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.
 174  */
 175 static INLINE ir_node *_sched_last(const ir_node *block)
 176 {
 177         assert(is_Block(block) && "Need a block here");
 178         return _sched_prev(block);
 179 }
 180
 181 /**
 182  * Reassign the time steps in the schedule.
 183  * @param block The schedule to update.
 184  */
 185 void sched_renumber(const ir_node *block);
 186
 187 static INLINE void _sched_set_time_stamp(ir_node *irn)
 188 {
 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;
 192
 193         /*
 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
 196          * neighbours.
 197          */
 198         if(before_ts >= after_ts)
 199                 inf->time_step = before_ts + SCHED_INITIAL_GRANULARITY;
 200         else {
 201                 sched_timestep_t ts = (before_ts + after_ts) / 2;
 202
 203                 /*
 204                  * If the resolution went out, we have to renumber
 205                  * this block.
 206                  */
 207                 if(ts == before_ts || ts == after_ts)
 208                         sched_renumber(get_nodes_block(irn));
 209                 else
 210                         inf->time_step = ts;
 211         }
 212 }
 213
 214 /**
 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.
 219  */
 220 static INLINE void _sched_add_before(ir_node *before, ir_node *irn)
 221 {
 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));
 227 #endif
 228         list_add_tail(&info->list, &get_irn_sched_info(before)->list);
 229         _sched_set_time_stamp(irn);
 230         info->scheduled = 1;
 231 }
 232
 233 /**
 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.
 238  */
 239 static INLINE void _sched_add_after(ir_node *after, ir_node *irn)
 240 {
 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));
 246 #endif
 247         list_add(&info->list, &get_irn_sched_info(after)->list);
 248         _sched_set_time_stamp(irn);
 249         info->scheduled = 1;
 250 }
 251
 252 static INLINE void _sched_init_block(ir_node *block)
 253 {
 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);
 257         info->scheduled = 1;
 258 }
 259
 260 static INLINE void _sched_reset(ir_node *node)
 261 {
 262         sched_info_t *info = get_irn_sched_info(node);
 263         info->scheduled = 0;
 264 }
 265
 266 /**
 267  * Remove a node from the scheduled.
 268  * @param irn The node.
 269  */
 270 static INLINE void _sched_remove(ir_node *irn)
 271 {
 272         sched_info_t *info;
 273 #ifndef SCHEDULE_PROJ
 274         assert(!is_Proj(irn));
 275 #endif
 276         info = get_irn_sched_info(irn);
 277         list_del(&info->list);
 278         INIT_LIST_HEAD(&info->list);
 279         info->scheduled = 0;
 280 }
 281
 282 /**
 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.
 288  */
 289 static INLINE int _sched_cmp(const ir_node *a, const ir_node *b)
 290 {
 291         assert(_sched_is_scheduled(a) && _sched_is_scheduled(b));
 292         assert(get_nodes_block(a) == get_nodes_block(b));
 293
 294         return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
 295 }
 296
 297 /**
 298  * Checks, if one node is scheduled before another.
 299  * @param n1   A node.
 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.
 303  */
 304 static INLINE int _sched_comes_after(const ir_node *n1, const ir_node *n2)
 305 {
 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);
 310 }
 311
 312 /**
 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.
 317  */
 318 typedef int (sched_predicator_t)(const ir_node *irn, void *data);
 319
 320 /**
 321  * Predicate for sched_skip(), returns non-zero if irn is a control flow changing node.
 322  *
 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
 326  */
 327 int sched_skip_cf_predicator(const ir_node *irn, void *data);
 328
 329 /**
 330  * Predicate for sched_skip(), returns non-zero if irn is a Phi node.
 331  *
 332  * Used with sched_skip().
 333  *
 334  * @param irn  the node to evaluate
 335  * @param data unused
 336  */
 337 int sched_skip_phi_predicator(const ir_node *irn, void *data);
 338
 339 /**
 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.
 345  *
 346  * @return The first node not rejected by the predicator or the block
 347  *         itself if all nodes were rejected.
 348  */
 349 ir_node *sched_skip(ir_node *from, int forward,
 350     sched_predicator_t *predicator, void *data);
 351
 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)
 365
 366 #endif /* FIRM_BE_BESCHED_T_H */