X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;ds=sidebyside;f=include%2Flibfirm%2Firedges.h;h=d50d57b3f330ae826013016976b734f937dc4e9c;hb=747f4d2922e2407f56f1426901bc2b6c310a8a9f;hp=a13b58bb81923368786e75c80080bd87c99c1812;hpb=74d5a9023b48f346eead323a74e28297659e34b7;p=libfirm diff --git a/include/libfirm/iredges.h b/include/libfirm/iredges.h index a13b58bb8..d50d57b3f 100644 --- a/include/libfirm/iredges.h +++ b/include/libfirm/iredges.h @@ -22,7 +22,6 @@ * @brief Public header for the automatically updating outs. * @author Sebastian Hack * @date 3.2.2005 - * @version $Id$ */ #ifndef FIRM_IR_IREDGES_H #define FIRM_IR_IREDGES_H @@ -32,7 +31,13 @@ #include "begin.h" /** - * Get the first edge pointing to some node. + * @ingroup irana + * @defgroup iredges Dynamic Reverse Edges + * @{ + */ + +/** + * Returns the first edge pointing to some node. * @note There is no order on out edges. First in this context only * means, that you get some starting point into the list of edges. * @param irn The node. @@ -43,7 +48,7 @@ FIRM_API const ir_edge_t *get_irn_out_edge_first_kind(const ir_node *irn, ir_edge_kind_t kind); /** - * Get the next edge in the out list of some node. + * Returns the next edge in the out list of some node. * @param irn The node. * @param last The last out edge you have seen. * @return The next out edge in @p irn 's out list after @p last. @@ -59,7 +64,7 @@ FIRM_API const ir_edge_t *get_irn_out_edge_next(const ir_node *irn, * edge. */ #define foreach_out_edge_kind(irn, edge, kind) \ - for(edge = get_irn_out_edge_first_kind(irn, kind); edge; edge = get_irn_out_edge_next(irn, edge)) + for (ir_edge_t const *edge = get_irn_out_edge_first_kind(irn, kind); edge; edge = get_irn_out_edge_next(irn, edge)) /** * A convenience iteration macro over all out edges of a node, which is safe @@ -67,63 +72,51 @@ FIRM_API const ir_edge_t *get_irn_out_edge_next(const ir_node *irn, * * @param irn The node. * @param edge An ir_edge_t pointer which shall be set to the current edge. - * @param ne The next edge, enables alteration safe edge processing. * @param kind The kind of the edge. */ -#define foreach_out_edge_kind_safe(irn, edge, ne, kind) \ - for((edge) = (get_irn_out_edge_first_kind(irn, kind)), (ne) = ((edge) ? (get_irn_out_edge_next(irn, edge)) : NULL); \ - edge; (edge) = (ne), (ne) = ((edge) ? (get_irn_out_edge_next(irn, edge)) : NULL)) +#define foreach_out_edge_kind_safe(irn, edge, kind) \ + for (ir_edge_t const *edge = get_irn_out_edge_first_kind((irn), (kind)), *edge##__next; \ + edge ? edge##__next = get_irn_out_edge_next((irn), edge), 1 : (edge##__next = NULL, 0); \ + edge = edge##__next) /** * Convenience macro for normal out edges. */ -#define foreach_out_edge(irn, edge) foreach_out_edge_kind(irn, edge, EDGE_KIND_NORMAL) +#define foreach_out_edge(irn, edge) foreach_out_edge_kind(irn, edge, EDGE_KIND_NORMAL) /** * Convenience macro for normal out edges. */ -#define foreach_out_edge_safe(irn, edge, tmp) foreach_out_edge_kind_safe(irn, edge, tmp, EDGE_KIND_NORMAL) +#define foreach_out_edge_safe(irn, edge) foreach_out_edge_kind_safe(irn, edge, EDGE_KIND_NORMAL) /** * A convenience iteration macro for all control flow edges. */ -#define foreach_block_succ(bl, edge) foreach_out_edge_kind(bl, edge, EDGE_KIND_BLOCK) +#define foreach_block_succ(bl, edge) foreach_out_edge_kind(bl, edge, EDGE_KIND_BLOCK) -/* - * Get the source node of an edge. +/** + * Returns the source node of an edge. * @param edge The edge. * @return The source node of that edge. */ FIRM_API ir_node *get_edge_src_irn(const ir_edge_t *edge); /** - * Get the position of an edge. + * Returns the position of an edge. * @param edge The edge. * @return The position in the in array of that edges source. */ FIRM_API int get_edge_src_pos(const ir_edge_t *edge); /** - * Get the edge object of an outgoing edge at a node. - * @param irg The graph, the node is in. - * @param irn The node at which the edge originates. - * @param pos The position of the edge. - * @param kind The kind of the edge. - * @return The corresponding edge object or NULL, - * if no such edge exists. - */ -FIRM_API const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *irn, - int pos, ir_edge_kind_t kind); - -/** - * Get the number of registered out edges for a specific kind. + * Returns the number of registered out edges for a specific kind. * @param irn The node. * @param kind The kind. */ FIRM_API int get_irn_n_edges_kind(const ir_node *irn, ir_edge_kind_t kind); /** - * Check, if the out edges are activated. + * Checks if the out edges are activated. * * @param irg The graph. * @param kind The edge kind. @@ -133,7 +126,7 @@ FIRM_API int get_irn_n_edges_kind(const ir_node *irn, ir_edge_kind_t kind); FIRM_API int edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind); /** - * Activate the edges for an irg. + * Activates the edges for an irg. * * @param irg The graph to activate the edges for. * @param kind The edge kind. @@ -141,7 +134,7 @@ FIRM_API int edges_activated_kind(const ir_graph *irg, ir_edge_kind_t kind); FIRM_API void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind); /** - * Deactivate the edges for an irg. + * Deactivates the edges for an irg. * * @param irg The graph. * @param kind The edge kind. @@ -149,16 +142,20 @@ FIRM_API void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind); FIRM_API void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind); /** - * Reroute edges of a specified kind from an old node to - * a new one. + * Reroutes edges of a specified kind from an old node to a new one. * * @param old the old node * @param nw the new node * @param kind the edge kind - * @param irg the graph on which the rerouting occurs */ -FIRM_API void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind, - ir_graph *irg); +FIRM_API void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind); + +/** + * reroutes (normal) edges from an old node to a new node, except for the + * @p exception which keeps its input even if it is old. + */ +FIRM_API void edges_reroute_except(ir_node *old, ir_node *nw, + ir_node *exception); /** * Verifies the out edges of graph @p irg. @@ -167,13 +164,13 @@ FIRM_API void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind, FIRM_API int edges_verify(ir_graph *irg); /** - * veriy a certrain kind of out edges of graph @p irg. + * Verifies a certrain kind of out edges of graph @p irg. * @returns 1 if a problem was found, 0 otherwise */ FIRM_API int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind); /** - * Set edge verification flag. + * Sets edge verification flag. */ FIRM_API void edges_init_dbg(int do_dbg); @@ -188,25 +185,28 @@ FIRM_API void edges_init_dbg(int do_dbg); FIRM_API ir_graph_pass_t *irg_verify_edges_pass(const char *name, unsigned assert_on_problem); -FIRM_API const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, - int pos); - -#define edges_reroute(old, nw, irg) edges_reroute_kind(old, nw, EDGE_KIND_NORMAL, irg) +/** Convenience version of edges_reroute_kind() with #EDGE_KIND_NORMAL */ +#define edges_reroute(old, nw) edges_reroute_kind(old, nw, EDGE_KIND_NORMAL) +/** Conventience version of edges_activated_kind() for #EDGE_KIND_NORMAL and #EDGE_KIND_BLOCK */ #define edges_activated(irg) (edges_activated_kind(irg, EDGE_KIND_NORMAL) && edges_activated_kind(irg, EDGE_KIND_BLOCK)) #ifndef get_irn_n_edges +/** Conventience version of get_irn_n_edges_kind() with #EDGE_KIND_NORMAL. */ #define get_irn_n_edges(irn) get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL) #endif #ifndef get_irn_out_edge_first +/** Convenience version of get_irn_out_edge_first_kind() with #EDGE_KIND_NORMAL */ #define get_irn_out_edge_first(irn) get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL) #endif #ifndef get_block_succ_first +/** Convenience version of get_irn_out_edge_first_kind() with #EDGE_KIND_BLOCK */ #define get_block_succ_first(irn) get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK) #endif #ifndef get_block_succ_next +/** Convenience version of get_irn_out_edge_next() with #EDGE_KIND_BLOCK */ #define get_block_succ_next(irn, last) get_irn_out_edge_next(irn, last) #endif @@ -220,7 +220,7 @@ FIRM_API const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, FIRM_API void edges_activate(ir_graph *irg); /** - * Deactivate data and block edges for an irg. + * Deactivates data and block edges for an irg. * If the irg phase is phase_backend, Dependence edges are * additionally deactivated. * @param irg The graph. @@ -228,31 +228,19 @@ FIRM_API void edges_activate(ir_graph *irg); FIRM_API void edges_deactivate(ir_graph *irg); /** - * Ensure that edges are activated. + * Ensures that edges are activated. * * @param irg the IR graph - * - * @return 0 if edges was deactivated before the call, 1 else */ -FIRM_API int edges_assure(ir_graph *irg); +FIRM_API void assure_edges(ir_graph *irg); /** - * Ensure that edges of a given kind are activated. + * Ensures that edges of a given kind are activated. * * @param irg the IR graph * @param kind the edge kind - * - * @return 0 if edges was deactivated before the call, 1 else */ -FIRM_API int edges_assure_kind(ir_graph *irg, ir_edge_kind_t kind); - -FIRM_API void edges_node_deleted(ir_node *irn, ir_graph *irg); - -/** - * Notify normal and block edges. - */ -FIRM_API void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, - ir_node *old_tgt, ir_graph *irg); +FIRM_API void assure_edges_kind(ir_graph *irg, ir_edge_kind_t kind); /** * Walks only over Block nodes in the graph. Uses the block visited @@ -266,17 +254,11 @@ FIRM_API void edges_notify_edge(ir_node *src, int pos, ir_node *tgt, FIRM_API void irg_block_edges_walk(ir_node *block, irg_walk_func *pre, irg_walk_func *post, void *env); -/** - * Reset the user's private data at offset 'offset' - * The user has to remember his offset and the size of his data! - * Caution: Using wrong values here can destroy other users private data! - * - * @param irg the IR graph to operate on - * @param offset offset of the private data inside the edge - * @param size length of the private data inside the edge - */ -FIRM_API void edges_reset_private_data(ir_graph *irg, int offset, - unsigned size); +/** Graph walker following #EDGE_KIND_NORMAL edges. */ +FIRM_API void irg_walk_edges(ir_node *start, irg_walk_func *pre, + irg_walk_func *post, void *env); + +/** @} */ #include "end.h"