/*
- * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
*
* This file is part of libFirm.
*
* @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);
+
+/**
+ * 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.
+ * @return The first out edge that points to this node.
+ */
+FIRM_API const ir_edge_t *get_irn_out_edge_first(const ir_node *irn);
+
+/**
+ * Returns the first edge pointing to a successor block.
+ *
+ * You can navigate the list with the usual get_irn_out_edge_next().
+ * @param block the Block
+ * @return first block successor edge
+ */
+FIRM_API const ir_edge_t *get_block_succ_first(const ir_node *block);
/**
- * 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.
+ * @param kind the kind of edge that are iterated
* @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,
+ ir_edge_kind_t kind);
/**
* A convenience iteration macro over all out edges of a node.
* 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, kind))
/**
* A convenience iteration macro over all out edges of a node, which is safe
*
* @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 = edge##__next) \
+ if (edge##__next = get_irn_out_edge_next((irn), edge, (kind)), 0) {} else
/**
* 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.
*/
-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.
- * @return The corresponding edge object or NULL,
- * if no such edge exists.
+ * Returns the number of registered out edges for a specific kind.
+ * @param irn The node.
+ * @param kind The kind.
*/
-const ir_edge_t *get_irn_edge_kind(ir_graph *irg, const ir_node *irn, int pos, ir_edge_kind_t kind);
+FIRM_API int get_irn_n_edges_kind(const ir_node *irn, ir_edge_kind_t kind);
/**
- * Get the number of registered out edges for a specific kind.
+ * Returns the number of registered out edges with EDGE_KIND_NORMAL
* @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(const ir_node *irn);
/**
- * 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.
+ * Checks if out edges with EDG_KIND_NORMAL and EDGE_KIND_BLOCK are activated.
+ * @param irg The graph.
+ * @return 1, if the edges are present for the given irg, 0 if not.
*/
-extern void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind);
+FIRM_API int edges_activated(const ir_graph *irg);
/**
- * Deactivate the edges for an irg.
- * @param irg The graph.
- * @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_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind);
-
-extern void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind, ir_graph *irg);
+FIRM_API void edges_activate_kind(ir_graph *irg, ir_edge_kind_t kind);
/**
- * Verifies the out edges of graph @p irg.
- * @return 1 if a problem was found, 0 otherwise
+ * Deactivates the edges for an irg.
+ *
+ * @param irg The graph.
+ * @param kind The edge kind.
*/
-int edges_verify(ir_graph *irg);
+FIRM_API void edges_deactivate_kind(ir_graph *irg, ir_edge_kind_t kind);
/**
- * Set edge verification flag.
+ * 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
*/
-void edges_init_dbg(int do_dbg);
-
-/************************************************************************/
-/* Begin Old Interface */
-/************************************************************************/
-
-const ir_edge_t *get_irn_edge(ir_graph *irg, const ir_node *src, int pos);
+FIRM_API void edges_reroute_kind(ir_node *old, ir_node *nw, ir_edge_kind_t kind);
-#define edges_reroute(old, nw, irg) edges_reroute_kind(old, nw, EDGE_KIND_NORMAL, irg)
-#define edges_activated(irg) (edges_activated_kind(irg, EDGE_KIND_NORMAL) && edges_activated_kind(irg, EDGE_KIND_BLOCK))
+/**
+ * Reroutes edges of EDGE_KIND_NORMAL from an old node to a new one.
+ *
+ * @param old the old node
+ * @param nw the new node
+ */
+FIRM_API void edges_reroute(ir_node *old, ir_node *nw);
-#ifndef get_irn_n_edges
-#define get_irn_n_edges(irn) get_irn_n_edges_kind(irn, EDGE_KIND_NORMAL)
-#endif
+/**
+ * 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);
-#ifndef get_irn_out_edge_first
-#define get_irn_out_edge_first(irn) get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL)
-#endif
+/**
+ * Verifies the out edges of graph @p irg.
+ * @return 1 if a problem was found, 0 otherwise
+ */
+FIRM_API int edges_verify(ir_graph *irg);
-#ifndef get_block_succ_first
-#define get_block_succ_first(irn) get_irn_out_edge_first_kind(irn, EDGE_KIND_BLOCK)
-#endif
+/**
+ * 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);
-#ifndef get_block_succ_next
-#define get_block_succ_next(irn, last) get_irn_out_edge_next(irn, last)
-#endif
+/**
+ * Sets edge verification flag.
+ */
+FIRM_API void edges_init_dbg(int do_dbg);
/**
- * Activate all the edges for an irg.
- * @param irg The graph to activate the edges for.
+ * 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
*/
-extern void edges_activate(ir_graph *irg);
+FIRM_API ir_graph_pass_t *irg_verify_edges_pass(const char *name,
+ unsigned assert_on_problem);
/**
- * Deactivate all the edges for an irg.
- * @param irg The graph.
+ * 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_deactivate(ir_graph *irg);
+FIRM_API void edges_activate(ir_graph *irg);
-extern int edges_assure(ir_graph *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.
+ */
+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);
-void edges_reset_private_data(ir_graph *irg, int offset, size_t size);
+/** @} */
-/************************************************************************/
-/* End Old Interface */
-/************************************************************************/
+#include "end.h"
#endif
projects / libfirm / blobdiff