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

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