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  */
  26 #ifndef FIRM_IR_IREDGES_H
  27 #define FIRM_IR_IREDGES_H
  28
  29 #include "firm_types.h"
  30 #include "iredgekinds.h"
  31 #include "begin.h"
  32
  33 /**
  34  * @ingroup irana
  35  * @defgroup iredges Dynamic Reverse Edges
  36  * @{
  37  */
  38
  39 /**
  40  * Returns the first edge pointing to some node.
  41  * @note There is no order on out edges. First in this context only
  42  * means, that you get some starting point into the list of edges.
  43  * @param irn The node.
  44  * @param kind The kind of the edge.
  45  * @return The first out edge that points to this node.
  46  */
  47 FIRM_API const ir_edge_t *get_irn_out_edge_first_kind(const ir_node *irn,
  48                                                       ir_edge_kind_t kind);
  49
  50 /**
  51  * Returns the first edge pointing to some node.
  52  * @note There is no order on out edges. First in this context only
  53  * means, that you get some starting point into the list of edges.
  54  * @param irn The node.
  55  * @return The first out edge that points to this node.
  56  */
  57 FIRM_API const ir_edge_t *get_irn_out_edge_first(const ir_node *irn);
  58
  59 /**
  60  * Returns the first edge pointing to a successor block.
  61  *
  62  * You can navigate the list with the usual get_irn_out_edge_next().
  63  * @param block  the Block
  64  * @return first block successor edge
  65  */
  66 FIRM_API const ir_edge_t *get_block_succ_first(const ir_node *block);
  67
  68 /**
  69  * Returns the next edge in the out list of some node.
  70  * @param irn The node.
  71  * @param last The last out edge you have seen.
  72  * @return The next out edge in @p irn 's out list after @p last.
  73  */
  74 FIRM_API const ir_edge_t *get_irn_out_edge_next(const ir_node *irn,
  75                                                 const ir_edge_t *last,
  76                                                 ir_edge_kind_t kind);
  77
  78 /**
  79  * A convenience iteration macro over all out edges of a node.
  80  * @param irn  The node.
  81  * @param kind The edge's kind.
  82  * @param edge An ir_edge_t pointer which shall be set to the current
  83  * edge.
  84  */
  85 #define foreach_out_edge_kind(irn, edge, kind) \
  86         for (ir_edge_t const *edge = get_irn_out_edge_first_kind(irn, kind); edge; edge = get_irn_out_edge_next(irn, edge, kind))
  87
  88 /**
  89  * A convenience iteration macro over all out edges of a node, which is safe
  90  * against alteration of the current edge.
  91  *
  92  * @param irn  The node.
  93  * @param edge An ir_edge_t pointer which shall be set to the current edge.
  94  * @param kind The kind of the edge.
  95  */
  96 #define foreach_out_edge_kind_safe(irn, edge, kind) \
  97         for (ir_edge_t const *edge = get_irn_out_edge_first_kind((irn), (kind)), *edge##__next; \
  98              edge ? edge##__next = get_irn_out_edge_next((irn), edge, (kind)), 1 : (edge##__next = NULL, 0); \
  99              edge = edge##__next)
 100
 101 /**
 102  * Convenience macro for normal out edges.
 103  */
 104 #define foreach_out_edge(irn, edge)       foreach_out_edge_kind(irn, edge, EDGE_KIND_NORMAL)
 105
 106 /**
 107  * Convenience macro for normal out edges.
 108  */
 109 #define foreach_out_edge_safe(irn, edge)  foreach_out_edge_kind_safe(irn, edge, EDGE_KIND_NORMAL)
 110
 111 /**
 112  * A convenience iteration macro for all control flow edges.
 113  */
 114 #define foreach_block_succ(bl, edge)      foreach_out_edge_kind(bl, edge, EDGE_KIND_BLOCK)
 115
 116 /**
 117  * Returns the source node of an edge.
 118  * @param edge The edge.
 119  * @return The source node of that edge.
 120  */
 121 FIRM_API ir_node *get_edge_src_irn(const ir_edge_t *edge);
 122
 123 /**
 124  * Returns the position of an edge.
 125  * @param edge The edge.
 126  * @return The position in the in array of that edges source.
 127  */
 128 FIRM_API int get_edge_src_pos(const ir_edge_t *edge);
 129
 130 /**
 131  * Returns the number of registered out edges for a specific kind.
 132  * @param irn The node.
 133  * @param kind The kind.
 134  */
 135 FIRM_API int get_irn_n_edges_kind(const ir_node *irn, ir_edge_kind_t kind);
 136
 137 /**
 138  * Returns the number of registered out edges with EDGE_KIND_NORMAL
 139  * @param irn The node.
 140  */
 141 FIRM_API int get_irn_n_edges(const ir_node *irn);
 142
 143 /**
 144  * Checks if the out edges are activated.
 145  *
 146  * @param irg   The graph.
 147  * @param kind  The edge kind.
 148  *
 149  * @return 1, if the edges are present for the given irg, 0 if not.
 150  */
 151 FIRM_API int edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind);
 152
 153 /**
 154  * Checks if out edges with EDG_KIND_NORMAL and EDGE_KIND_BLOCK are activated.
 155  * @param irg   The graph.
 156  * @return 1, if the edges are present for the given irg, 0 if not.
 157  */
 158 FIRM_API int edges_activated(const ir_graph *irg);
 159
 160 /**
 161  * Activates the edges for an irg.
 162  *
 163  * @param irg   The graph to activate the edges for.
 164  * @param kind  The edge kind.
 165  */
 166 FIRM_API void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind);
 167
 168 /**
 169  * Deactivates the edges for an irg.
 170  *
 171  * @param irg   The graph.
 172  * @param kind  The edge kind.
 173  */
 174 FIRM_API void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind);
 175
 176 /**
 177  * Reroutes edges of a specified kind from an old node to a new one.
 178  *
 179  * @param old   the old node
 180  * @param nw    the new node
 181  * @param kind  the edge kind
 182  */
 183 FIRM_API void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind);
 184
 185 /**
 186  * Reroutes edges of EDGE_KIND_NORMAL from an old node to a new one.
 187  *
 188  * @param old   the old node
 189  * @param nw    the new node
 190  */
 191 FIRM_API void edges_reroute(ir_node *old, ir_node *nw);
 192
 193 /**
 194  * reroutes (normal) edges from an old node to a new node, except for the
 195  * @p exception which keeps its input even if it is old.
 196  */
 197 FIRM_API void edges_reroute_except(ir_node *old, ir_node *nw,
 198                                    ir_node *exception);
 199
 200 /**
 201  * Verifies the out edges of graph @p irg.
 202  * @return 1 if a problem was found, 0 otherwise
 203  */
 204 FIRM_API int edges_verify(ir_graph *irg);
 205
 206 /**
 207  * Verifies a certrain kind of out edges of graph @p irg.
 208  * @returns 1 if a problem was found, 0 otherwise
 209  */
 210 FIRM_API int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind);
 211
 212 /**
 213  * Sets edge verification flag.
 214  */
 215 FIRM_API void edges_init_dbg(int do_dbg);
 216
 217 /**
 218  * Creates an ir_graph pass for edges_verify().
 219  *
 220  * @param name                the name of this pass or NULL
 221  * @param assert_on_problem   assert if problems were found
 222  *
 223  * @return  the newly created ir_graph pass
 224  */
 225 FIRM_API ir_graph_pass_t *irg_verify_edges_pass(const char *name,
 226                                                 unsigned assert_on_problem);
 227
 228 /**
 229  * Activates data and block edges for an irg.
 230  * If the irg phase is phase_backend, Dependence edges are
 231  * additionally activated.
 232  *
 233  * @param irg  The graph to activate the edges for.
 234  */
 235 FIRM_API void edges_activate(ir_graph *irg);
 236
 237 /**
 238  * Deactivates data and block edges for an irg.
 239  * If the irg phase is phase_backend, Dependence edges are
 240  * additionally deactivated.
 241  * @param irg  The graph.
 242  */
 243 FIRM_API void edges_deactivate(ir_graph *irg);
 244
 245 /**
 246  * Ensures that edges are activated.
 247  *
 248  * @param irg  the IR graph
 249  */
 250 FIRM_API void assure_edges(ir_graph *irg);
 251
 252 /**
 253  * Ensures that edges of a given kind are activated.
 254  *
 255  * @param irg   the IR graph
 256  * @param kind  the edge kind
 257  */
 258 FIRM_API void assure_edges_kind(ir_graph *irg, ir_edge_kind_t kind);
 259
 260 /**
 261  * Walks only over Block nodes in the graph. Uses the block visited
 262  * flag, so that it can be interleaved with another walker.
 263  *
 264  * @param block  the start block
 265  * @param pre    the pre visit function
 266  * @param post   the post visit function
 267  * @param env    the environment for the walker
 268  */
 269 FIRM_API void irg_block_edges_walk(ir_node *block, irg_walk_func *pre,
 270                                    irg_walk_func *post, void *env);
 271
 272 /** Graph walker following #EDGE_KIND_NORMAL edges. */
 273 FIRM_API void irg_walk_edges(ir_node *start, irg_walk_func *pre,
 274                              irg_walk_func *post, void *env);
 275
 276 /** @} */
 277
 278 #include "end.h"
 279
 280 #endif