Restructured a bit
[libfirm] / ir / ana / irouts.h
index c0d3eda..200a854 100644 (file)
@@ -1,24 +1,33 @@
-/* Copyright (C) 2002 by Universitaet Karlsruhe
-* All rights reserved.
-*/
+/*
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
 
 /**
-* @file irouts.h
-*
-* Implements Def-Use edges, also called outedges.
-*
-* @author Goetz Lindenmaier
-*
-* @todo eventually add reverse conrtol flow graph. (If needed.)
-*/
+ * @file
+ * @brief    Compute and access out edges (also called def-use edges).
+ * @author   Goetz Lindenmaier, Michael Beck
+ * @date     1.2002
+ * @version  $Id$
+ */
+#ifndef FIRM_ANA_IROUTS_H
+#define FIRM_ANA_IROUTS_H
 
-/* $Id$ */
-
-# ifndef _IROUTS_H_
-# define _IROUTS_H_
-
-# include "irgraph.h"
-# include "irnode.h"
+#include "firm_types.h"
 
 /*------------------------------------------------------------------*/
 /* Accessing the out datastructures.                                */
 
 /** To iterate through the successors iterate from 0 to i < get_irn_outs(). No
    order of successors guaranteed.  Will return edges from block to floating
-   nodes even if irgraph is in state "floats". */
+   nodes even if irgraph is in state "op_pin_state_floats". */
 /* returns the number of successors of the node: */
-int             get_irn_n_outs (ir_node *node);
+int      get_irn_n_outs(ir_node *node);
 
 /** Get predecessor n */
-INLINE ir_node *get_irn_out  (ir_node *node, int pos);
+ir_node *get_irn_out(ir_node *node, int pos);
 
 /** Set predecessor n */
-INLINE void     set_irn_out  (ir_node *node, int pos, ir_node *out);
+void     set_irn_out(ir_node *node, int pos, ir_node *out);
 
 /* Methods to iterate through the control flow graph. Iterate from 0 to
    i < get_Block_cfg_outs(block). No order of successors guaranteed. */
-int             get_Block_n_cfg_outs (ir_node *node);
 
-/** Access predecessor n. */
-INLINE ir_node *get_Block_cfg_out  (ir_node *node, int pos);
+/** Return the number of control flow successors, ignore keep-alives. */
+int      get_Block_n_cfg_outs(ir_node *node);
 
-#ifndef _IRG_WALK_FUNC_TYPEDEF_
-#define _IRG_WALK_FUNC_TYPEDEF_
-/** The type of the walk function */
-typedef void irg_walk_func(ir_node *, void *);
-#endif
+/** Return the number of control flow successors, honor keep-alives. */
+int      get_Block_n_cfg_outs_ka(ir_node *node);
+
+/** Access predecessor n, ignore keep-alives. */
+ir_node *get_Block_cfg_out(ir_node *node, int pos);
+
+/** Access predecessor n, honor keep-alives. */
+ir_node *get_Block_cfg_out_ka(ir_node *node, int pos);
 
 /** Walks over the graph starting at node.  Walks also if graph is in state
    "outs_inconsistent".  Assumes current_ir_graph is set properly. */
 void irg_out_walk(ir_node *node,
-                 irg_walk_func *pre, irg_walk_func *post,
-                 void *env);
+                  irg_walk_func *pre, irg_walk_func *post,
+                  void *env);
 
 /** Walks only over Block nodes in the graph.  Has it's own visited
    flag, so that it can be interleaved with the other walker.
    node must be either op_Block or mode_X.  */
 void irg_out_block_walk(ir_node *node,
-                       irg_walk_func *pre, irg_walk_func *post,
-                       void *env);
+                        irg_walk_func *pre, irg_walk_func *post,
+                        void *env);
 
 /*------------------------------------------------------------------*/
-/* Building and Removing the out datasturcture                      */
+/* Building and Removing the out datastructure                      */
 /*------------------------------------------------------------------*/
 
 /** Computes the out edges.  Sets a flag in irg to "outs_consistent".  If the
-   graph is changed this flag must be set to "outs_inconsistent".  Computes
-   out edges from block to floating nodes even if graph is in state
-   "floats".   Optimizes Tuple nodes. */
-void compute_outs(ir_graph *irg);
-/** Frees the out datastructures.  Sets the flag in irg to "no_outs". */
-void free_outs(ir_graph *irg);
-
-#endif /* _IROUTS_H_ */
+    graph is changed this flag must be set to "outs_inconsistent".  Computes
+    out edges from block to floating nodes even if graph is in state
+   "op_pin_state_floats".   Optimizes Tuple nodes. */
+void compute_irg_outs(ir_graph *irg);
+void compute_irp_outs(void);
+
+void assure_irg_outs(ir_graph *irg);
+
+/** Computes the out edges in interprocedural view */
+void compute_ip_outs(void);
+/** Frees the out datastructures.  Sets the flag in irg to "outs_none". */
+void free_ip_outs(void);
+void free_irg_outs(ir_graph *irg);
+void free_irp_outs(void);
+
+#endif