no need for an explicit lower_mode_b pass, it should only be invoked by the backend
[libfirm] / include / libfirm / cgana.h
index d784be6..5ea5058 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -23,8 +23,7 @@
  * @author      Hubert Schmid
  * @date        09.06.2002
  * @version     $Id$
- * @summary
- * @summary
+ * @brief
  *  Interprocedural analysis to estimate the calling relation.
  *
  *  This analysis computes all entities representing methods that
@@ -36,6 +35,7 @@
 #define FIRM_ANA_CGANA_H
 
 #include "firm_types.h"
+#include "begin.h"
 
 /* Methoden sind "frei", wenn ihr Funktionszeiger (potentiell)
  * "explizit" bekannt ist, d.h.:
  *  Stores the result in the field 'callees' of the Call node.  If the
  *  address can not be analysed, e.g. because it is loaded from a
  *  variable, the array contains the unknown_entity. (See
- *  "set_Call_callee"). cgana returns the set of 'free' methods, i.e.,
+ *  set_Call_callee()). cgana() returns the set of 'free' methods, i.e.,
  *  the methods that can be called from external or via function
- *  pointers.  This datastructure must be freed with 'free()' by the
- *  caller of cgana.
+ *  pointers.  This datastructure must be freed with 'xfree()' by the
+ *  caller of cgana().
  *
- *  cgana sets the callee_info_state of each graph and the program to
+ *  cgana() sets the callee_info_state of each graph and the program to
  *  consistent.
  *
  *  The algorithm implements roughly Static Class Hierarchy Analysis
  *  Performs some optimizations possible by the analysed information:
  *    - Replace SymConst-name nodes by SymConst-entity nodes if possible.
  *    - Replace (Sel-method(Alloc)) by SymConst-entity.
- *    - Replaces Sel nodes by Bad if there is no implementation for the
- *         selected entity.
  *    - Replaces Sel-method by SymConst-entity if the method is never overwritten.
- *    - Replaces Calls by Tuple containing Bads if callee array is empty
- *         (there is no implementation to call)
- *
- *  Leaves Bad control predecessors in the graph!
  */
-void cgana(int *len, ir_entity ***free_methods);
+FIRM_API void cgana(int *len, ir_entity ***free_methods);
 
 /** Free callee information.
  *
@@ -90,12 +84,13 @@ void cgana(int *len, ir_entity ***free_methods);
  *  in all call nodes to NULL.  Else it happens that the field contains
  *  pointers to other than firm arrays.
  */
-void free_callee_info(ir_graph *irg);
-void free_irp_callee_info(void);
+FIRM_API void free_callee_info(ir_graph *irg);
+FIRM_API void free_irp_callee_info(void);
 
 /* Optimize the address expressions passed to call nodes.
  * Performs only the optimizations done by cgana. */
-void opt_call_addrs(void);
+FIRM_API void opt_call_addrs(void);
 
+#include "end.h"
 
 #endif