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  irn  The node at which the edge originates.
 109  * @param  pos  The position of the edge.
 110  * @param  kind The kind of the edge.
 111  * @return      The corresponding edge object or NULL,
 112  *              if no such edge exists.
 113  */
 114 FIRM_API const ir_edge_t *get_irn_edge_kind(const ir_node *irn,
 115                                             int pos, ir_edge_kind_t kind);
 116
 117 /**
 118  * Get the number of registered out edges for a specific kind.
 119  * @param irn The node.
 120  * @param kind The kind.
 121  */
 122 FIRM_API int get_irn_n_edges_kind(const ir_node *irn, ir_edge_kind_t kind);
 123
 124 /**
 125  * Check, if the out edges are activated.
 126  *
 127  * @param irg   The graph.
 128  * @param kind  The edge kind.
 129  *
 130  * @return 1, if the edges are present for the given irg, 0 if not.
 131  */
 132 FIRM_API int edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind);
 133
 134 /**
 135  * Activate the edges for an irg.
 136  *
 137  * @param irg   The graph to activate the edges for.
 138  * @param kind  The edge kind.
 139  */
 140 FIRM_API void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind);
 141
 142 /**
 143  * Deactivate the edges for an irg.
 144  *
 145  * @param irg   The graph.
 146  * @param kind  The edge kind.
 147  */
 148 FIRM_API void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind);
 149
 150 /**
 151  * Reroute edges of a specified kind from an old node to
 152  * a new one.
 153  *
 154  * @param old   the old node
 155  * @param nw    the new node
 156  * @param kind  the edge kind
 157  */
 158 FIRM_API void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind);
 159
 160 /**
 161  * Verifies the out edges of graph @p irg.
 162  * @return 1 if a problem was found, 0 otherwise
 163  */
 164 FIRM_API int edges_verify(ir_graph *irg);
 165
 166 /**
 167  * veriy a certrain kind of out edges of graph @p irg.
 168  * @returns 1 if a problem was found, 0 otherwise
 169  */
 170 FIRM_API int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind);
 171
 172 /**
 173  * Set edge verification flag.
 174  */
 175 FIRM_API void edges_init_dbg(int do_dbg);
 176
 177 /**
 178  * Creates an ir_graph pass for edges_verify().
 179  *
 180  * @param name                the name of this pass or NULL
 181  * @param assert_on_problem   assert if problems were found
 182  *
 183  * @return  the newly created ir_graph pass
 184  */
 185 FIRM_API ir_graph_pass_t *irg_verify_edges_pass(const char *name,
 186                                                 unsigned assert_on_problem);
 187
 188 #define edges_reroute(old, nw)                      edges_reroute_kind(old, nw, EDGE_KIND_NORMAL)
 189 #define edges_activated(irg)                            (edges_activated_kind(irg, EDGE_KIND_NORMAL) && edges_activated_kind(irg, EDGE_KIND_BLOCK))
 190
 191 #ifndef get_irn_n_edges
 192 #define get_irn_n_edges(irn)                            get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
 193 #endif
 194
 195 #ifndef get_irn_out_edge_first
 196 #define get_irn_out_edge_first(irn)                     get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
 197 #endif
 198
 199 #ifndef get_block_succ_first
 200 #define get_block_succ_first(irn)                       get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
 201 #endif
 202
 203 #ifndef get_block_succ_next
 204 #define get_block_succ_next(irn, last)                  get_irn_out_edge_next(irn, last)
 205 #endif
 206
 207 /**
 208  * Activates data and block edges for an irg.
 209  * If the irg phase is phase_backend, Dependence edges are
 210  * additionally activated.
 211  *
 212  * @param irg  The graph to activate the edges for.
 213  */
 214 FIRM_API void edges_activate(ir_graph *irg);
 215
 216 /**
 217  * Deactivate data and block edges for an irg.
 218  * If the irg phase is phase_backend, Dependence edges are
 219  * additionally deactivated.
 220  * @param irg  The graph.
 221  */
 222 FIRM_API void edges_deactivate(ir_graph *irg);
 223
 224 /**
 225  * Ensure that edges are activated.
 226  *
 227  * @param irg  the IR graph
 228  *
 229  * @return 0 if edges was deactivated before the call, 1 else
 230  */
 231 FIRM_API int edges_assure(ir_graph *irg);
 232
 233 /**
 234  * Ensure that edges of a given kind are activated.
 235  *
 236  * @param irg   the IR graph
 237  * @param kind  the edge kind
 238  *
 239  * @return 0 if edges was deactivated before the call, 1 else
 240  */
 241 FIRM_API int edges_assure_kind(ir_graph *irg, ir_edge_kind_t kind);
 242
 243 FIRM_API void edges_node_deleted(ir_node *irn);
 244
 245 /**
 246  * Walks only over Block nodes in the graph. Uses the block visited
 247  * flag, so that it can be interleaved with another walker.
 248  *
 249  * @param block  the start block
 250  * @param pre    the pre visit function
 251  * @param post   the post visit function
 252  * @param env    the environment for the walker
 253  */
 254 FIRM_API void irg_block_edges_walk(ir_node *block, irg_walk_func *pre,
 255                                    irg_walk_func *post, void *env);
 256
 257 FIRM_API void irg_walk_edges(ir_node *start, irg_walk_func *pre,
 258                              irg_walk_func *post, void *env);
 259
 260 /**
 261  * Reset the user's private data at offset 'offset'
 262  * The user has to remember his offset and the size of his data!
 263  * Caution: Using wrong values here can destroy other users private data!
 264  *
 265  * @param irg     the IR graph to operate on
 266  * @param offset  offset of the private data inside the edge
 267  * @param size    length of the private data inside the edge
 268  */
 269 FIRM_API void edges_reset_private_data(ir_graph *irg, int offset,
 270                                        unsigned size);
 271
 272 #include "end.h"
 273
 274 #endif