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