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