Fixed 'inline' lossage --flo

[libfirm] / ir / ir / irgopt.h

diff --git a/ir/ir/irgopt.h b/ir/ir/irgopt.h
index e61a3f9..e85fd4e 100644 (file)
--- a/ir/ir/irgopt.h
+++ b/ir/ir/irgopt.h
@@ -1,16 +1,22 @@
-/* Copyright (C) 1998 - 2001 by Universitaet Karlsruhe
-* All rights reserved.
-*/
+/*
+ * Project:     libFIRM
+ * File name:   ir/ir/irgopt.h
+ * Purpose:     Optimizations for a whole ir graph, i.e., a procedure.
+ * Author:      Christian Schaefer, Goetz Lindenmaier
+ * Modified by: Sebastian Felis
+ * Created:
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 1998-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
 
 /**
-* @file irgopt.h
-*
-* Optimizations for a whole ir graph, i.e., a procedure.
-*
-* @author Christian Schaefer, Goetz Lindenmaier
-*/
-
-/* $Id$ */
+ * @file irgopt.h
+ *
+ * Optimizations for a whole ir graph, i.e., a procedure.
+ *
+ * @author Christian Schaefer, Goetz Lindenmaier
+ */
 
 # ifndef _IRGOPT_H_
 # define _IRGOPT_H_
@@ -32,6 +38,8 @@ void local_optimize_graph (ir_graph *irg);
 
    Backedge information is conserved.
    Removes old attributes of nodes.  Sets link field to NULL.
+   Callee information must be freed (irg_callee_info_none).
+
    Attention: the numbers assigned to nodes if the library is compiled for
    development/debugging are not conserved by copying. */
 void dead_node_elimination(ir_graph *irg);
@@ -83,6 +91,27 @@ void inline_method(ir_node *call, ir_graph *called_graph);
    combination as control flow operation.  */
 void inline_small_irgs(ir_graph *irg, int size);
 
+
+/** Inlineing with a different heuristic than inline_small_irgs.
+ *
+ *  Inlines leave functions.  If inlinening creates new leave
+ *  function inlines these, too. (If g calls f, and f calls leave h,
+ *  h is first inlined in f and then f in g.)
+ *
+ *  Then inlines all small functions (this is not recursive).
+ *
+ *  For a heuristic this inlineing uses firm node counts.  It does
+ *  not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
+ *
+ *  maxsize   Do not inline any calls if a method has more than
+ *            maxsize firm nodes.  It may reach this limit by
+ *            inlineing.
+ *  leavesize Inline leave functions if they have less than leavesize
+ *            nodes.
+ *  size      Inline all function smaller than size.
+ */
+void inline_leave_functions(int maxsize, int leavesize, int size);
+
 /** Code Placement.  Pinns all floating nodes to a block where they
    will be executed only if needed.   Depends on the flag opt_global_cse.
    Graph may not be in phase_building.  Does not schedule control dead
@@ -114,12 +143,15 @@ void place_code(ir_graph *irg);
  */
 void optimize_cf(ir_graph *irg);
 
+
 /** Places an empty basic block on critical control flow edges thereby
    removing them.
-
    A critical control flow edge is an edge from a block with several
    control exits to a block with several control entries (See Muchnic
-   p. 407).  */
+   p. 407).
+   Is only executed if flag set_opt_critical_edges() is set.
+   @param irg IR Graph
+*/
 void remove_critical_cf_edges(ir_graph *irg);
 
 # endif /* _IRGOPT_H_ */