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