X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firedges.h;h=8847378cb240f22d5c6f3e3b83d2f6dc60433b72;hb=cdcd17c48e951c6e0201c58b94aaf52a8769703c;hp=2a824b0e61ade345e14d01b883687575f853b677;hpb=1ce363f80e6a204d4011f85813362d9bd1d0e7e4;p=libfirm diff --git a/include/libfirm/iredges.h b/include/libfirm/iredges.h index 2a824b0e6..8847378cb 100644 --- a/include/libfirm/iredges.h +++ b/include/libfirm/iredges.h @@ -22,31 +22,39 @@ * @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 #include "firm_types.h" #include "iredgekinds.h" +#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. * @param kind The kind of the edge. * @return The first out edge that points to this node. */ -const ir_edge_t *get_irn_out_edge_first_kind(const ir_node *irn, ir_edge_kind_t kind); +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. */ -const ir_edge_t *get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last); +FIRM_API const ir_edge_t *get_irn_out_edge_next(const ir_node *irn, + const ir_edge_t *last); /** * A convenience iteration macro over all out edges of a node. @@ -65,6 +73,7 @@ const ir_edge_t *get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last * @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); \ @@ -85,141 +94,195 @@ const ir_edge_t *get_irn_out_edge_next(const ir_node *irn, const ir_edge_t *last */ #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. */ -ir_node *get_edge_src_irn(const ir_edge_t *edge); - -/** - * Get the number of edges pointing to a node. - * @param irn The node. - * @return The number of edges pointing to this node. - */ -int get_irn_n_edges(const ir_node *irn); +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. */ -extern int get_edge_src_pos(const ir_edge_t *edge); +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. + * Returns the edge object of an outgoing edge at a node. + * @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. */ -const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *irn, int pos, ir_edge_kind_t kind); +FIRM_API const ir_edge_t *get_irn_edge_kind(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. */ -extern int get_irn_n_edges_kind(const ir_node *irn, ir_edge_kind_t 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. - * @param irg The graph. - * @param kind The edge kind. + * Checks if the out edges are activated. + * + * @param irg The graph. + * @param kind The edge kind. + * * @return 1, if the edges are present for the given irg, 0 if not. */ -extern int edges_activated_kind(const ir_graph *irg, 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. - * @param irg The graph to activate the edges for. - * @param kind The edge kind. + * Activates the edges for an irg. + * + * @param irg The graph to activate the edges for. + * @param kind The edge kind. */ -extern void edges_activate_kind(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. - * @param irg The graph. - * @param kind The edge kind. + * Deactivates the edges for an irg. + * + * @param irg The graph. + * @param kind The edge kind. + */ +FIRM_API void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind); + +/** + * 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 */ -extern void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind); +FIRM_API void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind); -extern void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind, ir_graph *irg); +/** + * 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. * @return 1 if a problem was found, 0 otherwise */ -int edges_verify(ir_graph *irg); +FIRM_API int edges_verify(ir_graph *irg); /** - * Set edge verification flag. + * Verifies a certrain kind of out edges of graph @p irg. + * @returns 1 if a problem was found, 0 otherwise */ -void edges_init_dbg(int do_dbg); +FIRM_API int edges_verify_kind(ir_graph *irg, ir_edge_kind_t kind); -/************************************************************************/ -/* Begin Old Interface */ -/************************************************************************/ +/** + * Sets edge verification flag. + */ +FIRM_API void edges_init_dbg(int do_dbg); -const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos); +/** + * Creates an ir_graph pass for edges_verify(). + * + * @param name the name of this pass or NULL + * @param assert_on_problem assert if problems were found + * + * @return the newly created ir_graph pass + */ +FIRM_API ir_graph_pass_t *irg_verify_edges_pass(const char *name, + unsigned assert_on_problem); -#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 /** - * Activate all the edges for an irg. - * @param irg The graph to activate the edges for. + * Activates data and block edges for an irg. + * If the irg phase is phase_backend, Dependence edges are + * additionally activated. + * + * @param irg The graph to activate the edges for. */ -extern void edges_activate(ir_graph *irg); +FIRM_API void edges_activate(ir_graph *irg); /** - * Deactivate all the edges for an irg. - * @param irg The graph. + * Deactivates data and block edges for an irg. + * If the irg phase is phase_backend, Dependence edges are + * additionally deactivated. + * @param irg The graph. */ -extern void edges_deactivate(ir_graph *irg); - -extern int edges_assure(ir_graph *irg); +FIRM_API void edges_deactivate(ir_graph *irg); -extern void edges_node_deleted(ir_node *irn, ir_graph *irg); +/** + * Ensures that edges are activated. + * + * @param irg the IR graph + */ +FIRM_API void assure_edges(ir_graph *irg); /** - * Notify normal and block edges. + * Ensures that edges of a given kind are activated. + * + * @param irg the IR graph + * @param kind the edge kind */ -extern 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. Has it's own visited - * flag, so that it can be interleaved with the other walker. + * Walks only over Block nodes in the graph. Uses the block visited + * flag, so that it can be interleaved with another walker. * * @param block the start block * @param pre the pre visit function * @param post the post visit function * @param env the environment for the walker */ -void irg_block_edges_walk(ir_node *block, irg_walk_func *pre, irg_walk_func *post, void *env); +FIRM_API void irg_block_edges_walk(ir_node *block, irg_walk_func *pre, + irg_walk_func *post, void *env); + +/** 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); + +/** + * 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); -void edges_reset_private_data(ir_graph *irg, int offset, size_t size); +/** @} */ -/************************************************************************/ -/* End Old Interface */ -/************************************************************************/ +#include "end.h" #endif