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