nsz Git - libfirm/blob - include/libfirm/iredges.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   Public header for the automatically updating outs.
  23  * @author  Sebastian Hack
  24  * @date    3.2.2005
  25  * @version $Id$
  26  */
  27 #ifndef FIRM_IR_IREDGES_H
  28 #define FIRM_IR_IREDGES_H
  29
  30 #include "firm_types.h"
  31 #include "iredgekinds.h"
  32
  33 /**
  34  * Get the first edge pointing to some node.
  35  * @note There is no order on out edges. First in this context only
  36  * means, that you get some starting point into the list of edges.
  37  * @param irn The node.
  38  * @param kind The kind of the edge.
  39  * @return The first out edge that points to this node.
  40  */
  41 const ir_edge_t *get_irn_out_edge_first_kind(const ir_node *irn, ir_edge_kind_t kind);
  42
  43 /**
  44  * Get the next edge in the out list of some node.
  45  * @param irn The node.
  46  * @param last The last out edge you have seen.
  47  * @return The next out edge in @p irn 's out list after @p last.
  48  */
  49 const ir_edge_t *get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last);
  50
  51 /**
  52  * A convenience iteration macro over all out edges of a node.
  53  * @param irn  The node.
  54  * @param kind The edge's kind.
  55  * @param edge An ir_edge_t pointer which shall be set to the current
  56  * edge.
  57  */
  58 #define foreach_out_edge_kind(irn, edge, kind) \
  59         for(edge = get_irn_out_edge_first_kind(irn, kind); edge; edge = get_irn_out_edge_next(irn, edge))
  60
  61 /**
  62  * A convenience iteration macro over all out edges of a node, which is safe
  63  * against alteration of the current edge.
  64  *
  65  * @param irn  The node.
  66  * @param edge An ir_edge_t pointer which shall be set to the current edge.
  67  * @param ne   The next edge, enables alteration safe edge processing.
  68  * @param kind The kind of the edge.
  69  */
  70 #define foreach_out_edge_kind_safe(irn, edge, ne, kind) \
  71         for((edge) = (get_irn_out_edge_first_kind(irn, kind)), (ne) = ((edge) ? (get_irn_out_edge_next(irn, edge)) : NULL); \
  72                 edge; (edge) = (ne), (ne) = ((edge) ? (get_irn_out_edge_next(irn, edge)) : NULL))
  73
  74 /**
  75  * Convenience macro for normal out edges.
  76  */
  77 #define foreach_out_edge(irn, edge)            foreach_out_edge_kind(irn, edge, EDGE_KIND_NORMAL)
  78
  79 /**
  80  * Convenience macro for normal out edges.
  81  */
  82 #define foreach_out_edge_safe(irn, edge, tmp)  foreach_out_edge_kind_safe(irn, edge, tmp, EDGE_KIND_NORMAL)
  83
  84 /**
  85  * A convenience iteration macro for all control flow edges.
  86  */
  87 #define foreach_block_succ(bl, edge)           foreach_out_edge_kind(bl, edge, EDGE_KIND_BLOCK)
  88
  89 /*
  90  * Get the source node of an edge.
  91  * @param edge The edge.
  92  * @return The source node of that edge.
  93  */
  94 ir_node *get_edge_src_irn(const ir_edge_t *edge);
  95
  96 /**
  97  * Get the position of an edge.
  98  * @param edge The edge.
  99  * @return The position in the in array of that edges source.
 100  */
 101 int get_edge_src_pos(const ir_edge_t *edge);
 102
 103 /**
 104  * Get the edge object of an outgoing edge at a node.
 105  * @param  irg  The graph, the node is in.
 106  * @param  irn  The node at which the edge originates.
 107  * @param  pos  The position of the edge.
 108  * @param  kind The kind of the edge.
 109  * @return      The corresponding edge object or NULL,
 110  *              if no such edge exists.
 111  */
 112 const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *irn, int pos, ir_edge_kind_t kind);
 113
 114 /**
 115  * Get the number of registered out edges for a specific kind.
 116  * @param irn The node.
 117  * @param kind The kind.
 118  */
 119 int get_irn_n_edges_kind(const ir_node *irn, ir_edge_kind_t kind);
 120
 121 /**
 122  * Check, if the out edges are activated.
 123  *
 124  * @param irg   The graph.
 125  * @param kind  The edge kind.
 126  *
 127  * @return 1, if the edges are present for the given irg, 0 if not.
 128  */
 129 int edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind);
 130
 131 /**
 132  * Activate the edges for an irg.
 133  *
 134  * @param irg   The graph to activate the edges for.
 135  * @param kind  The edge kind.
 136  */
 137 void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind);
 138
 139 /**
 140  * Deactivate the edges for an irg.
 141  *
 142  * @param irg   The graph.
 143  * @param kind  The edge kind.
 144  */
 145 void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind);
 146
 147 /**
 148  * Reroute edges of a specified kind from an old node to
 149  * a new one.
 150  *
 151  * @param old   the old node
 152  * @param nw    the new node
 153  * @param kind  the edge kind
 154  * @param irg   the graph on which the rerouting occurs
 155  */
 156 void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind, ir_graph *irg);
 157
 158 /**
 159  * Verifies the out edges of graph @p irg.
 160  * @return 1 if a problem was found, 0 otherwise
 161  */
 162 int edges_verify(ir_graph *irg);
 163
 164 /**
 165  * veriy a certrain kind of out edges of graph @p irg.
 166  * @returns 1 if a problem was found, 0 otherwise
 167  */
 168 int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind);
 169
 170 /**
 171  * Set edge verification flag.
 172  */
 173 void edges_init_dbg(int do_dbg);
 174
 175 /**
 176  * Creates an ir_graph pass for edges_verify().
 177  *
 178  * @param name                the name of this pass or NULL
 179  * @param assert_on_problem   assert if problems were found
 180  *
 181  * @return  the newly created ir_graph pass
 182  */
 183 ir_graph_pass_t *irg_verify_edges_pass(const char *name, unsigned assert_on_problem);
 184
 185 /************************************************************************/
 186 /* Begin Old Interface                                                  */
 187 /************************************************************************/
 188
 189 const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos);
 190
 191 #define edges_reroute(old, nw, irg)                     edges_reroute_kind(old, nw, EDGE_KIND_NORMAL, irg)
 192 #define edges_activated(irg)                            (edges_activated_kind(irg, EDGE_KIND_NORMAL) && edges_activated_kind(irg, EDGE_KIND_BLOCK))
 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 /**
 211  * Activates data and block edges for an irg.
 212  * If the irg phase is phase_backend, Dependence edges are
 213  * additionally activated.
 214  *
 215  * @param irg  The graph to activate the edges for.
 216  */
 217 void edges_activate(ir_graph *irg);
 218
 219 /**
 220  * Deactivate data and block edges for an irg.
 221  * If the irg phase is phase_backend, Dependence edges are
 222  * additionally deactivated.
 223  * @param irg  The graph.
 224  */
 225 void edges_deactivate(ir_graph *irg);
 226
 227 /**
 228  * Ensure that edges are activated.
 229  *
 230  * @param irg  the IR graph
 231  *
 232  * @return 0 if edges was deactivated before the call, 1 else
 233  */
 234 int edges_assure(ir_graph *irg);
 235
 236 /**
 237  * Ensure that edges of a given kind are activated.
 238  *
 239  * @param irg   the IR graph
 240  * @param kind  the edge kind
 241  *
 242  * @return 0 if edges was deactivated before the call, 1 else
 243  */
 244 int edges_assure_kind(ir_graph *irg, ir_edge_kind_t kind);
 245
 246 void edges_node_deleted(ir_node *irn, ir_graph *irg);
 247
 248 /**
 249  * Notify normal and block edges.
 250  */
 251 void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_graph *irg);
 252
 253 /**
 254  * Walks only over Block nodes in the graph. Uses the block visited
 255  * flag, so that it can be interleaved with another walker.
 256  *
 257  * @param block  the start block
 258  * @param pre    the pre visit function
 259  * @param post   the post visit function
 260  * @param env    the environment for the walker
 261  */
 262 void irg_block_edges_walk(ir_node *block, irg_walk_func *pre, irg_walk_func *post, void *env);
 263
 264 /**
 265  * Reset the user's private data at offset 'offset'
 266  * The user has to remember his offset and the size of his data!
 267  * Caution: Using wrong values here can destroy other users private data!
 268  *
 269  * @param irg     the IR graph to operate on
 270  * @param offset  offset of the private data inside the edge
 271  * @param size    length of the private data inside the edge
 272  */
 273 void edges_reset_private_data(ir_graph *irg, int offset, unsigned size);
 274
 275 /************************************************************************/
 276 /* End Old Interface                                                    */
 277 /************************************************************************/
 278
 279 #endif