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;
  82         assert(edges_activated_kind(get_irn_irg(irn), kind));
  83         head = _get_irn_outs_head(irn, kind);
  84         return list_empty(head) ? NULL : list_entry(head->next, ir_edge_t, list);
  85 }
  86
  87 /**
  88 * Get the next edge in the out list of some node.
  89 * @param irn The node.
  90 * @param last The last out edge you have seen.
  91 * @return The next out edge in @p irn 's out list after @p last.
  92 */
  93 static inline const ir_edge_t *_get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last)
  94 {
  95         struct list_head *next = last->list.next;
  96         return next == _get_irn_outs_head(irn, last->kind) ? NULL : list_entry(next, ir_edge_t, list);
  97 }
  98
  99 /**
 100 * Get the number of edges pointing to a node.
 101 * @param irn The node.
 102 * @return The number of edges pointing to this node.
 103 */
 104 static inline int _get_irn_n_edges_kind(const ir_node *irn, int kind)
 105 {
 106         /* Perhaps out_count was buggy. This code does it more safely. */
 107 #if 0
 108         int res = 0;
 109         const struct list_head *pos, *head = _get_irn_outs_head(irn, kind);
 110         list_for_each(pos, head)
 111                 res++;
 112         return res;
 113 #else
 114         return _get_irn_edge_info(irn, kind)->out_count;
 115 #endif
 116 }
 117
 118 static inline int _edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind)
 119 {
 120         return _get_irg_edge_info(irg, kind)->activated;
 121 }
 122
 123 /**
 124 * Assure, that the edges information is present for a certain graph.
 125 * @param irg The graph.
 126 */
 127 static inline void _edges_assure_kind(ir_graph *irg, ir_edge_kind_t kind)
 128 {
 129         if(!_edges_activated_kind(irg, kind))
 130                 edges_activate_kind(irg, kind);
 131 }
 132
 133 void edges_init_graph_kind(ir_graph *irg, ir_edge_kind_t kind);
 134
 135 /**
 136  * A node might be revivaled by CSE.
 137  */
 138 void edges_node_revival(ir_node *node, ir_graph *irg);
 139
 140 void edges_invalidate_kind(ir_node *irn, ir_edge_kind_t kind, ir_graph *irg);
 141
 142 /**
 143 * Register additional memory in an edge.
 144 * This must be called before Firm is initialized.
 145 * @param  n Number of bytes you need.
 146 * @return A number you have to keep and to pass
 147 *         edges_get_private_data()
 148 *         to get a pointer to your data.
 149 */
 150 int edges_register_private_data(size_t n);
 151
 152 /**
 153 * Get a pointer to the private data you registered.
 154 * @param  edge The edge.
 155 * @param  ofs  The number, you obtained with
 156 *              edges_register_private_data().
 157 * @return A pointer to the private data.
 158 */
 159 static inline void *_get_edge_private_data(const ir_edge_t *edge, int ofs)
 160 {
 161         return (void *) ((char *) edge + sizeof(edge[0]) + ofs);
 162 }
 163
 164 static inline ir_node *_get_edge_src_irn(const ir_edge_t *edge)
 165 {
 166         return edge->src;
 167 }
 168
 169 static inline int _get_edge_src_pos(const ir_edge_t *edge)
 170 {
 171         return edge->pos;
 172 }
 173
 174 /**
 175 * Initialize the out edges.
 176 * This must be called before firm is initialized.
 177 */
 178 extern void init_edges(void);
 179
 180 void edges_invalidate_all(ir_node *irn, ir_graph *irg);
 181
 182 /**
 183  * Helper function to dump the edge set of a graph,
 184  * unused in normal code.
 185  */
 186 void edges_dump_kind(ir_graph *irg, ir_edge_kind_t kind);
 187
 188 #define get_irn_n_edges_kind(irn, kind)   _get_irn_n_edges_kind(irn, kind)
 189 #define get_edge_src_irn(edge)            _get_edge_src_irn(edge)
 190 #define get_edge_src_pos(edge)            _get_edge_src_pos(edge)
 191 #define get_edge_private_data(edge, ofs)  _get_edge_private_data(edge,ofs)
 192 #define get_irn_out_edge_next(irn, last)  _get_irn_out_edge_next(irn, last)
 193
 194 #ifndef get_irn_n_edges
 195 #define get_irn_n_edges(irn)              _get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
 196 #endif
 197
 198 #ifndef get_irn_out_edge_first
 199 #define get_irn_out_edge_first(irn)       _get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
 200 #endif
 201
 202 #ifndef get_block_succ_first
 203 #define get_block_succ_first(irn)         _get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
 204 #endif
 205
 206 #ifndef get_block_succ_next
 207 #define get_block_succ_next(irn, last)    _get_irn_out_edge_next(irn, last)
 208 #endif
 209
 210 #endif