nsz Git - libfirm/blob - include/libfirm/irouts.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    Compute and access out edges (also called def-use edges).
  23  * @author   Goetz Lindenmaier, Michael Beck
  24  * @date     1.2002
  25  */
  26 #ifndef FIRM_ANA_IROUTS_H
  27 #define FIRM_ANA_IROUTS_H
  28
  29 #include "firm_types.h"
  30 #include "begin.h"
  31
  32 /**
  33  * @ingroup irana
  34  * @defgroup irout Reverse Edges
  35  * Out-Edges are the reverse of the edges in a firm graph (also called def-use
  36  * edges)
  37  * @{
  38  */
  39
  40 /** Returns the number of successors of the node: */
  41 FIRM_API int get_irn_n_outs(const ir_node *node);
  42
  43 /** Returns the User of a node from the Def-Use edge at position pos. */
  44 FIRM_API ir_node *get_irn_out(const ir_node *def, int pos);
  45
  46 /**
  47  * Returns the User and its input position from the Def-Use edge of def
  48  * at position pos.
  49  */
  50 FIRM_API ir_node *get_irn_out_ex(const ir_node *def, int pos, int *in_pos);
  51
  52 /**
  53  * Sets the User at position pos.
  54  *
  55  * @param def     the Def node
  56  * @param pos     the number of the Def-Use edge tat is modified
  57  * @param use     the Use node
  58  * @param in_pos  the number of the corresponding Use-Def edge in the use node in array
  59  */
  60 FIRM_API void set_irn_out(ir_node *def, int pos, ir_node *use, int in_pos);
  61
  62 /** Returns the number of control flow successors, ignore keep-alives. */
  63 FIRM_API int get_Block_n_cfg_outs(const ir_node *node);
  64
  65 /** Returns the number of control flow successors, honor keep-alives. */
  66 FIRM_API int get_Block_n_cfg_outs_ka(const ir_node *node);
  67
  68 /** Access predecessor n, ignore keep-alives. */
  69 FIRM_API ir_node *get_Block_cfg_out(const ir_node *node, int pos);
  70
  71 /** Access predecessor n, honor keep-alives. */
  72 FIRM_API ir_node *get_Block_cfg_out_ka(const ir_node *node, int pos);
  73
  74 /**
  75  * Walks over the graph starting at node.  Walks also if graph is in state
  76  * "outs_inconsistent".  Assumes current_ir_graph is set properly.
  77  */
  78 FIRM_API void irg_out_walk(ir_node *node, irg_walk_func *pre,
  79                            irg_walk_func *post, void *env);
  80
  81 /**
  82  * Walks only over Block nodes in the graph.  Has its own visited
  83  * flag, so that it can be interleaved with the other walker.
  84  * node must be either op_Block or mode_X.
  85  */
  86 FIRM_API void irg_out_block_walk(ir_node *node, irg_walk_func *pre,
  87                                  irg_walk_func *post, void *env);
  88
  89 /**
  90  * Returns 1 if outs have been computed for a node, 0 otherwise.
  91  *
  92  * this is useful to detect newly created nodes that have no outs set yet
  93  */
  94 FIRM_API int get_irn_outs_computed(const ir_node *node);
  95
  96 /**
  97  * Computes the out edges.  Sets a flag in irg to "outs_consistent".  If the
  98  * graph is changed this flag must be set to "outs_inconsistent".  Computes
  99  * out edges from block to floating nodes even if graph is in state
 100  * "op_pin_state_floats".   Optimizes Tuple nodes.
 101  */
 102 FIRM_API void compute_irg_outs(ir_graph *irg);
 103 /** Recomputes out edges for each graph where it is necessary */
 104 FIRM_API void compute_irp_outs(void);
 105
 106 /** Recomputes out edges if necessary */
 107 FIRM_API void assure_irg_outs(ir_graph *irg);
 108
 109 /** Frees memory occupied by out edges datastructures */
 110 FIRM_API void free_irg_outs(ir_graph *irg);
 111 /** Frees memory occupied by out edges datastructures in the whole program */
 112 FIRM_API void free_irp_outs(void);
 113
 114 /** @} */
 115
 116 #include "end.h"
 117
 118 #endif