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