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  * @version  $Id$
  26  */
  27 #ifndef FIRM_ANA_IROUTS_H
  28 #define FIRM_ANA_IROUTS_H
  29
  30 #include "firm_types.h"
  31 #include "begin.h"
  32
  33 /** returns the number of successors of the node: */
  34 FIRM_API int get_irn_n_outs(const ir_node *node);
  35
  36 /** Get the User of a node from the Def-Use edge at position pos. */
  37 FIRM_API ir_node *get_irn_out(const ir_node *def, int pos);
  38
  39 /**
  40  * Get the User and its input position from the Def-Use edge of def
  41  * at position pos.
  42  */
  43 FIRM_API ir_node *get_irn_out_ex(const ir_node *def, int pos, int *in_pos);
  44
  45 /**
  46  * Set the User at position pos.
  47  *
  48  * @param def     the Def node
  49  * @param pos     the number of the Def-Use edge tat is modified
  50  * @param use     the Use node
  51  * @param in_pos  the number of the corresponding Use-Def edge in the use node in array
  52  */
  53 FIRM_API void set_irn_out(ir_node *def, int pos, ir_node *use, int in_pos);
  54
  55 /** Return the number of control flow successors, ignore keep-alives. */
  56 FIRM_API int get_Block_n_cfg_outs(const ir_node *node);
  57
  58 /** Return the number of control flow successors, honor keep-alives. */
  59 FIRM_API int get_Block_n_cfg_outs_ka(const ir_node *node);
  60
  61 /** Access predecessor n, ignore keep-alives. */
  62 FIRM_API ir_node *get_Block_cfg_out(const ir_node *node, int pos);
  63
  64 /** Access predecessor n, honor keep-alives. */
  65 FIRM_API ir_node *get_Block_cfg_out_ka(const ir_node *node, int pos);
  66
  67 /**
  68  * Walks over the graph starting at node.  Walks also if graph is in state
  69  * "outs_inconsistent".  Assumes current_ir_graph is set properly.
  70  */
  71 FIRM_API void irg_out_walk(ir_node *node, irg_walk_func *pre,
  72                            irg_walk_func *post, void *env);
  73
  74 /**
  75  * Walks only over Block nodes in the graph.  Has its own visited
  76  * flag, so that it can be interleaved with the other walker.
  77  * node must be either op_Block or mode_X.
  78  */
  79 FIRM_API void irg_out_block_walk(ir_node *node, irg_walk_func *pre,
  80                                  irg_walk_func *post, void *env);
  81
  82 /**
  83  * returns 1 if outs have been computed for a node, 0 otherwise.
  84  *
  85  * this is useful to detect newly created nodes that have no outs set yet
  86  */
  87 FIRM_API int get_irn_outs_computed(const ir_node *node);
  88
  89 /**
  90  * Computes the out edges.  Sets a flag in irg to "outs_consistent".  If the
  91  * graph is changed this flag must be set to "outs_inconsistent".  Computes
  92  * out edges from block to floating nodes even if graph is in state
  93  * "op_pin_state_floats".   Optimizes Tuple nodes.
  94  */
  95 FIRM_API void compute_irg_outs(ir_graph *irg);
  96 FIRM_API void compute_irp_outs(void);
  97
  98 FIRM_API void assure_irg_outs(ir_graph *irg);
  99
 100 FIRM_API void free_irg_outs(ir_graph *irg);
 101 FIRM_API void free_irp_outs(void);
 102
 103 #include "end.h"
 104
 105 #endif