nsz Git - libfirm/blob - ir/ir/iredges_t.h

   1 /*
   2  * Copyright (C) 1995-2008 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   Everlasting outs -- private header.
  23  * @author  Sebastian Hack, Andreas Schoesser
  24  * @date    15.01.2005
  25  * @version $Id$
  26  */
  27 #ifndef FIRM_IR_EDGES_T_H
  28 #define FIRM_IR_EDGES_T_H
  29
  30 #include "debug.h"
  31
  32 #include "set.h"
  33 #include "list.h"
  34
  35 #include "irnode_t.h"
  36 #include "irgraph_t.h"
  37
  38 #include "iredgekinds.h"
  39 #include "iredges.h"
  40
  41 #define DBG_EDGES  "firm.ir.edges"
  42
  43 /**
  44  * An edge.
  45  */
  46 struct _ir_edge_t {
  47   ir_node  *src;          /**< The source node of the edge. */
  48   int      pos;           /**< The position of the edge at @p src. */
  49   unsigned invalid : 1;   /**< edges that are removed are marked invalid. */
  50   unsigned present : 1;   /**< Used by the verifier. Don't rely on its content. */
  51   unsigned kind    : 4;   /**< The kind of the edge. */
  52   struct list_head list;  /**< The list head to queue all out edges at a node. */
  53 #ifdef DEBUG_libfirm
  54   long src_nr;            /**< The node number of the source node. */
  55   long edge_nr;           /**< A unique number identifying the edge. */
  56 #endif
  57 };
  58
  59
  60 /** Accessor for private irn info. */
  61 #define _get_irn_edge_info(irn, kind) (&(((irn)->edge_info)[kind]))
  62
  63 /** Accessor for private irg info. */
  64 #define _get_irg_edge_info(irg, kind) (&(((irg)->edge_info)[kind]))
  65
  66 /**
  67 * Convenience macro to get the outs_head from a irn_edge_info_t
  68 * struct.
  69 */
  70 #define _get_irn_outs_head(irn, kind) (&_get_irn_edge_info(irn, kind)->outs_head)
  71
  72 /**
  73 * Get the first edge pointing to some node.
  74 * @note There is no order on out edges. First in this context only
  75 * means, that you get some starting point into the list of edges.
  76 * @param irn The node.
  77 * @return The first out edge that points to this node.
  78 */
  79 static inline const ir_edge_t *_get_irn_out_edge_first_kind(const ir_node *irn, ir_edge_kind_t kind)
  80 {
  81         const struct list_head *head = _get_irn_outs_head(irn, kind);
  82         return list_empty(head) ? NULL : list_entry(head->next, ir_edge_t, list);
  83 }
  84
  85 /**
  86 * Get the next edge in the out list of some node.
  87 * @param irn The node.
  88 * @param last The last out edge you have seen.
  89 * @return The next out edge in @p irn 's out list after @p last.
  90 */
  91 static inline const ir_edge_t *_get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last)
  92 {
  93         struct list_head *next = last->list.next;
  94         return next == _get_irn_outs_head(irn, last->kind) ? NULL : list_entry(next, ir_edge_t, list);
  95 }
  96
  97 /**
  98 * Get the number of edges pointing to a node.
  99 * @param irn The node.
 100 * @return The number of edges pointing to this node.
 101 */
 102 static inline int _get_irn_n_edges_kind(const ir_node *irn, int kind)
 103 {
 104         /* Perhaps out_count was buggy. This code does it more safely. */
 105 #if 0
 106         int res = 0;
 107         const struct list_head *pos, *head = _get_irn_outs_head(irn, kind);
 108         list_for_each(pos, head)
 109                 res++;
 110         return res;
 111 #else
 112         return _get_irn_edge_info(irn, kind)->out_count;
 113 #endif
 114 }
 115
 116 static inline int _edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind)
 117 {
 118         return _get_irg_edge_info(irg, kind)->activated;
 119 }
 120
 121 /**
 122 * Assure, that the edges information is present for a certain graph.
 123 * @param irg The graph.
 124 */
 125 static inline void _edges_assure_kind(ir_graph *irg, int kind)
 126 {
 127         if(!_edges_activated_kind(irg, kind))
 128                 edges_activate_kind(irg, kind);
 129 }
 130
 131 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind);
 132
 133 /**
 134 * Notify of a edge change.
 135 * The edge from (src, pos) -> old_tgt is redirected to tgt
 136 */
 137 void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_edge_kind_t kind, ir_graph *irg);
 138
 139 /**
 140 * A node is deleted.
 141 */
 142 void edges_node_deleted(ir_node *old, ir_graph *irg);
 143
 144 void edges_invalidate_kind(ir_node *irn, ir_edge_kind_t kind, ir_graph *irg);
 145
 146 /**
 147 * Register additional memory in an edge.
 148 * This must be called before Firm is initialized.
 149 * @param  n Number of bytes you need.
 150 * @return A number you have to keep and to pass
 151 *         edges_get_private_data()
 152 *         to get a pointer to your data.
 153 */
 154 int edges_register_private_data(size_t n);
 155
 156 /**
 157 * Get a pointer to the private data you registered.
 158 * @param  edge The edge.
 159 * @param  ofs  The number, you obtained with
 160 *              edges_register_private_data().
 161 * @return A pointer to the private data.
 162 */
 163 static inline void *_get_edge_private_data(const ir_edge_t *edge, int ofs)
 164 {
 165         return (void *) ((char *) edge + sizeof(edge[0]) + ofs);
 166 }
 167
 168 static inline ir_node *_get_edge_src_irn(const ir_edge_t *edge)
 169 {
 170         return edge->src;
 171 }
 172
 173 static inline int _get_edge_src_pos(const ir_edge_t *edge)
 174 {
 175         return edge->pos;
 176 }
 177
 178 /**
 179 * Initialize the out edges.
 180 * This must be called before firm is initialized.
 181 */
 182 extern void init_edges(void);
 183
 184 /**
 185  * Set dbg information for edges.
 186  */
 187 void edges_init_dbg(int do_dbg);
 188
 189 void edges_invalidate_all(ir_node *irn, ir_graph *irg);
 190
 191 #define get_irn_n_edges_kind(irn, kind)   _get_irn_n_edges_kind(irn, kind)
 192 #define get_edge_src_irn(edge)            _get_edge_src_irn(edge)
 193 #define get_edge_src_pos(edge)            _get_edge_src_pos(edge)
 194 #define get_edge_private_data(edge, ofs)  _get_edge_private_data(edge,ofs)
 195 #define get_irn_out_edge_next(irn, last)  _get_irn_out_edge_next(irn, last)
 196
 197 #ifndef get_irn_n_edges
 198 #define get_irn_n_edges(irn)              _get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
 199 #endif
 200
 201 #ifndef get_irn_out_edge_first
 202 #define get_irn_out_edge_first(irn)       _get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
 203 #endif
 204
 205 #ifndef get_block_succ_first
 206 #define get_block_succ_first(irn)         _get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
 207 #endif
 208
 209 #ifndef get_block_succ_next
 210 #define get_block_succ_next(irn, last)    _get_irn_out_edge_next(irn, last)
 211 #endif
 212
 213 #endif