nsz Git - libfirm/blob - include/libfirm/irgopt.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   Optimizations for a whole ir graph, i.e., a procedure.
  23  * @author  Christian Schaefer, Goetz Lindenmaier, Sebastian Felis
  24  * @version $Id$
  25  */
  26 #ifndef FIRM_IR_IRGOPT_H
  27 #define FIRM_IR_IRGOPT_H
  28
  29 #include "firm_types.h"
  30 #include "begin.h"
  31
  32 /** Applies local optimizations (see iropt.h) to all nodes reachable from node
  33  * @p n.
  34  *
  35  * @param n The node to be optimized.
  36  */
  37 FIRM_API void local_optimize_node(ir_node *n);
  38
  39 /** Applies local optimizations (see iropt.h) to all nodes in the graph.
  40  *
  41  * @param irg  The graph to be optimized.
  42  *
  43  * After applying local_optimize_graph() to a IR-graph, Bad nodes
  44  * only occur as predecessor of Block and Phi nodes.
  45  */
  46 FIRM_API void local_optimize_graph(ir_graph *irg);
  47
  48 /** Applies local optimizations (see iropt.h) to all nodes in the graph.
  49  *
  50  * After applying optimize_graph_df() to a IR-graph, Bad nodes
  51  * only occur as predecessor of Block and Phi nodes.
  52  *
  53  * This version uses fixpoint iteration.
  54  *
  55  * @param irg  The graph to be optimized.
  56  *
  57  * @return non-zero if the optimization could be applied, 0 else
  58  */
  59 FIRM_API void local_opts(ir_graph *irg);
  60
  61 /** Same functionality as local_opts above, but without framework wrapper
  62  * @deprecated
  63  */
  64 FIRM_API int optimize_graph_df(ir_graph *irg);
  65
  66 /**
  67  * Eliminates (obviously) unreachable code
  68  */
  69 FIRM_API void remove_unreachable_code(ir_graph *irg);
  70
  71 /**
  72  * Removes all Bad nodes from a graph.
  73  *
  74  * @param irg  The graph to be optimized.
  75  *
  76  * @return non-zero if at least one Bad was removed, otherwise 0
  77  */
  78 FIRM_API int remove_bads(ir_graph *irg);
  79
  80 /**
  81  * Removes all Tuple nodes from a graph.
  82  *
  83  * @param irg  The graph to be optimized.
  84  *
  85  * @return non-zero if at least one Tuple was removed, otherwise 0
  86  */
  87 FIRM_API int remove_tuples(ir_graph *irg);
  88
  89 /**
  90  * Creates an ir_graph pass for optimize_graph_df().
  91  *
  92  * @param name     the name of this pass or NULL
  93  *
  94  * @return  the newly created ir_graph pass
  95  */
  96 FIRM_API ir_graph_pass_t *optimize_graph_df_pass(const char *name);
  97
  98 /** Places an empty basic block on critical control flow edges thereby
  99  * removing them.
 100  *
 101  * A critical control flow edge is an edge from a block with several
 102  * control exits to a block with several control entries (See Muchnic
 103  * p. 407). Exception edges are always ignored.
 104  *
 105  * @param irg  IR Graph
 106  */
 107 FIRM_API void remove_critical_cf_edges(ir_graph *irg);
 108
 109 /** Places an empty basic block on critical control flow edges thereby
 110  * removing them.
 111  *
 112  * A critical control flow edge is an edge from a block with several
 113  * control exits to a block with several control entries (See Muchnic
 114  * p. 407).
 115  *
 116  * @param irg                     IR Graph
 117  * @param ignore_exception_edges  if non-zero, exception edges will be ignored
 118  */
 119 FIRM_API void remove_critical_cf_edges_ex(ir_graph *irg,
 120                                           int ignore_exception_edges);
 121
 122 #include "end.h"
 123
 124 #endif