Add ALLOCAN() and ALLOCANZ().
[libfirm] / ir / be / besched_t.h
index 0334342..cf7b7d2 100644 (file)
@@ -1,13 +1,38 @@
-/* $Id$ */
+/*
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
 
-#ifndef _BESCHED_T_H
-#define _BESCHED_T_H
+/**
+ * @file
+ * @brief       Scheduling utilities for nodes in Blocks and Blocks.
+ * @author      Sebastian Hack
+ * @version     $Id$
+ */
+#ifndef FIRM_BE_BESCHED_T_H
+#define FIRM_BE_BESCHED_T_H
 
 #define SCHED_INITIAL_GRANULARITY (1 << 14)
 
 #include "list.h"
 #include "irnode_t.h"
 #include "irgraph_t.h"
+#include "irphase_t.h"
+#include "irphases_t.h"
 
 #include "beutil.h"
 #include "besched.h"
@@ -24,24 +49,33 @@ extern size_t sched_irn_data_offset;
  */
 typedef struct _sched_info_t {
        struct list_head list;         /**< The list head to list the nodes in a schedule. */
-       sched_timestep_t time_step;    /**< If a is after b in a schedule, its time step is
-                                        larger than b's. */
+       unsigned idx;                  /**< The node index of the nodes this schedule info belongs to. */
+       sched_timestep_t time_step;    /**< If a is after b in a schedule, its time step is larger than b's. */
        unsigned scheduled : 1;        /**< 1, if the node is in the schedule of the block, 0 else. */
 } sched_info_t;
 
-#define _sched_entry(list_head) (list_entry(list_head, sched_info_t, list))
+#define _sched_entry(list_head)             (list_entry(list_head, sched_info_t, list))
+#define get_irn_sched_info(irn)             ((sched_info_t *) get_or_set_irn_phase_info(skip_Proj_const(irn), PHASE_BE_SCHED))
+#define get_sched_info_irn(irg, sched_info) get_idx_irn((irg), (sched_info)->idx)
 
-#define get_irn_sched_info(irn) get_irn_data(irn, sched_info_t, sched_irn_data_offset)
-#define get_sched_info_irn(sched_info) get_irn_data_base(sched_info, sched_irn_data_offset)
+/**
+ * Returns non-zero if schedule information is available
+ * for a given graph.
+ * @param irg  The graph.
+ */
+static inline int _have_sched_info(const ir_graph *irg)
+{
+       return get_irg_phase(irg, PHASE_BE_SCHED) != NULL;
+}
 
 /**
  * Check, if the node is scheduled.
  * @param irn The node.
  * @return 1, if the node is scheduled, 0 if not.
  */
-static INLINE int _sched_is_scheduled(const ir_node *irn)
+static inline int _sched_is_scheduled(const ir_node *irn)
 {
-  return get_irn_sched_info(irn)->scheduled;
+       return get_irn_sched_info(irn)->scheduled;
 }
 
 /**
@@ -49,7 +83,7 @@ static INLINE int _sched_is_scheduled(const ir_node *irn)
  * @param irn The node.
  * @return The time step in the schedule.
  */
-static INLINE int _sched_get_time_step(const ir_node *irn)
+static inline int _sched_get_time_step(const ir_node *irn)
 {
        assert(_sched_is_scheduled(irn));
        return get_irn_sched_info(irn)->time_step;
@@ -61,13 +95,15 @@ static INLINE int _sched_get_time_step(const ir_node *irn)
  * @param irn The node to check for.
  * @return 1, if the node consumes/produces data, false if not.
  */
-static INLINE int to_appear_in_schedule(const ir_node *irn)
+static inline int to_appear_in_schedule(const ir_node *irn)
 {
        switch(get_irn_opcode(irn)) {
                case iro_Start:
                case iro_Jmp:
                case iro_Break:
                        return 1;
+               case iro_Proj:
+                       return 0;
                default:
                        return is_data_node(irn);
        }
@@ -78,7 +114,7 @@ static INLINE int to_appear_in_schedule(const ir_node *irn)
  * @param irn The ir node.
  * @return 1, if the node has a scheduling successor, 0 if not.
  */
-static INLINE int _sched_has_next(const ir_node *irn)
+static inline int _sched_has_next(const ir_node *irn)
 {
        const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
        const sched_info_t *info = get_irn_sched_info(irn);
@@ -91,7 +127,7 @@ static INLINE int _sched_has_next(const ir_node *irn)
  * @param irn The ir node.
  * @return 1, if the node has a scheduling predecessor, 0 if not.
  */
-static INLINE int _sched_has_prev(const ir_node *irn)
+static inline int _sched_has_prev(const ir_node *irn)
 {
        const ir_node *block = is_Block(irn) ? irn : get_nodes_block(irn);
        const sched_info_t *info = get_irn_sched_info(irn);
@@ -104,10 +140,10 @@ static INLINE int _sched_has_prev(const ir_node *irn)
  * @param irn The node.
  * @return The next ir node in the schedule or the block, if the node has no next node.
  */
-static INLINE ir_node *_sched_next(const ir_node *irn)
+static inline ir_node *_sched_next(const ir_node *irn)
 {
        const sched_info_t *info = get_irn_sched_info(irn);
-       return get_sched_info_irn(_sched_entry(info->list.next));
+       return get_sched_info_irn(get_irn_irg(irn), _sched_entry(info->list.next));
 }
 
 /**
@@ -116,10 +152,10 @@ static INLINE ir_node *_sched_next(const ir_node *irn)
  * @return The next ir node in the schedule or the block, if the node has no predecessor.
  * predecessor.
  */
-static INLINE ir_node *_sched_prev(const ir_node *irn)
+static inline ir_node *_sched_prev(const ir_node *irn)
 {
        const sched_info_t *info = get_irn_sched_info(irn);
-       return get_sched_info_irn(_sched_entry(info->list.prev));
+       return get_sched_info_irn(get_irn_irg(irn), _sched_entry(info->list.prev));
 }
 
 /**
@@ -128,7 +164,7 @@ static INLINE ir_node *_sched_prev(const ir_node *irn)
  * @return The first node in the schedule or the block itself
  *         if there is no node in the schedule.
  */
-static INLINE ir_node *_sched_first(const ir_node *block)
+static inline ir_node *_sched_first(const ir_node *block)
 {
        assert(is_Block(block) && "Need a block here");
        return _sched_next(block);
@@ -140,7 +176,7 @@ static INLINE ir_node *_sched_first(const ir_node *block)
  * @return The last ir node in a schedule, or the block itself
  *         if there is no node in the schedule.
  */
-static INLINE ir_node *_sched_last(const ir_node *block)
+static inline ir_node *_sched_last(const ir_node *block)
 {
        assert(is_Block(block) && "Need a block here");
        return _sched_prev(block);
@@ -152,7 +188,7 @@ static INLINE ir_node *_sched_last(const ir_node *block)
  */
 void sched_renumber(const ir_node *block);
 
-static INLINE void _sched_set_time_stamp(ir_node *irn)
+static inline void _sched_set_time_stamp(const ir_node *irn)
 {
        sched_info_t *inf = get_irn_sched_info(irn);
        sched_timestep_t before_ts = _sched_entry(inf->list.prev)->time_step;
@@ -185,14 +221,15 @@ static INLINE void _sched_set_time_stamp(ir_node *irn)
  * @param irn The node to add.
  * @return The given node.
  */
-static INLINE ir_node *_sched_add_before(ir_node *before, ir_node *irn)
+static inline void _sched_add_before(const ir_node *before, const ir_node *irn)
 {
        sched_info_t *info = get_irn_sched_info(irn);
-       assert(_sched_is_scheduled(before) && !_sched_is_scheduled(irn));
+       assert(_sched_is_scheduled(before));
+       assert(!_sched_is_scheduled(irn));
+       assert(!is_Proj(irn));
        list_add_tail(&info->list, &get_irn_sched_info(before)->list);
        _sched_set_time_stamp(irn);
        info->scheduled = 1;
-       return irn;
 }
 
 /**
@@ -201,17 +238,18 @@ static INLINE ir_node *_sched_add_before(ir_node *before, ir_node *irn)
  * @param irn The node to add.
  * @return The given node.
  */
-static INLINE ir_node *_sched_add_after(ir_node *after, ir_node *irn)
+static inline void _sched_add_after(const ir_node *after, const ir_node *irn)
 {
        sched_info_t *info = get_irn_sched_info(irn);
-       assert(_sched_is_scheduled(after) && !_sched_is_scheduled(irn));
+       assert(_sched_is_scheduled(after));
+       assert(!_sched_is_scheduled(irn));
+       assert(!is_Proj(irn));
        list_add(&info->list, &get_irn_sched_info(after)->list);
        _sched_set_time_stamp(irn);
        info->scheduled = 1;
-       return irn;
 }
 
-static INLINE void _sched_init_block(ir_node *block)
+static inline void _sched_init_block(const ir_node *block)
 {
        sched_info_t *info = get_irn_sched_info(block);
        assert(info->scheduled == 0 && info->time_step == 0);
@@ -219,7 +257,7 @@ static INLINE void _sched_init_block(ir_node *block)
        info->scheduled = 1;
 }
 
-static INLINE void _sched_reset(ir_node *node)
+static inline void _sched_reset(const ir_node *node)
 {
        sched_info_t *info = get_irn_sched_info(node);
        info->scheduled = 0;
@@ -229,12 +267,12 @@ static INLINE void _sched_reset(ir_node *node)
  * Remove a node from the scheduled.
  * @param irn The node.
  */
-static INLINE void _sched_remove(ir_node *irn)
+static inline void _sched_remove(const ir_node *irn)
 {
-  sched_info_t *info = get_irn_sched_info(irn);
-  list_del(&info->list);
+       sched_info_t *info = get_irn_sched_info(irn);
+       list_del(&info->list);
        INIT_LIST_HEAD(&info->list);
-  info->scheduled = 0;
+       info->scheduled = 0;
 }
 
 /**
@@ -244,12 +282,12 @@ static INLINE void _sched_remove(ir_node *irn)
  * @return A number smaller, equals to or larger than 0, if a is
  *         before, the same, or after b in the schedule.
  */
-static INLINE int _sched_cmp(const ir_node *a, const ir_node *b)
+static inline int _sched_cmp(const ir_node *a, const ir_node *b)
 {
-  assert(_sched_is_scheduled(a) && _sched_is_scheduled(b));
-  assert(get_nodes_block(a) == get_nodes_block(b));
+       assert(_sched_is_scheduled(a) && _sched_is_scheduled(b));
+       assert(get_nodes_block(a) == get_nodes_block(b));
 
-  return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
+       return get_irn_sched_info(a)->time_step - get_irn_sched_info(b)->time_step;
 }
 
 /**
@@ -259,11 +297,11 @@ static INLINE int _sched_cmp(const ir_node *a, const ir_node *b)
  * @return     1, if n1 is in front of n2 in the schedule, 0 else.
  * @note       Both nodes must be in the same block.
  */
-static INLINE int _sched_comes_after(const ir_node *n1, const ir_node *n2)
+static inline int _sched_comes_after(const ir_node *n1, const ir_node *n2)
 {
        assert(_sched_is_scheduled(n1));
        assert(_sched_is_scheduled(n2));
-       assert(get_nodes_block(n1) == get_nodes_block(n2));
+       assert((is_Block(n1) ? n1 : get_nodes_block(n1)) == (is_Block(n2) ? n2 : get_nodes_block(n2)));
        return _sched_get_time_step(n1) < _sched_get_time_step(n2);
 }
 
@@ -279,8 +317,7 @@ typedef int (sched_predicator_t)(const ir_node *irn, void *data);
  * Predicate for sched_skip(), returns non-zero if irn is a control flow changing node.
  *
  * @param irn   the node to evaluate
- * @param data  an arch_env_t * used to determine if irn is a cf
- *              node for the given architecture
+ * @param data  unused
  */
 int sched_skip_cf_predicator(const ir_node *irn, void *data);
 
@@ -304,9 +341,9 @@ int sched_skip_phi_predicator(const ir_node *irn, void *data);
  * @return The first node not rejected by the predicator or the block
  *         itself if all nodes were rejected.
  */
-ir_node *sched_skip(ir_node *from, int forward,
-    sched_predicator_t *predicator, void *data);
+ir_node *sched_skip(ir_node *from, int forward, sched_predicator_t *predicator, void *data);
 
+#define have_sched_info(irg)            _have_sched_info(irg)
 #define sched_get_time_step(irn)        _sched_get_time_step(irn)
 #define sched_has_next(irn)             _sched_has_next(irn)
 #define sched_has_prev(irn)             _sched_has_prev(irn)
@@ -321,4 +358,4 @@ ir_node *sched_skip(ir_node *from, int forward,
 #define sched_comes_after(n1, n2)       _sched_comes_after(n1, n2)
 #define sched_cmp(a, b)                 _sched_cmp(a, b)
 
-#endif
+#endif /* FIRM_BE_BESCHED_T_H */