More doxygen comments, typos fixed, clear some code

[libfirm] / ir / ana / cgana.h

diff --git a/ir/ana/cgana.h b/ir/ana/cgana.h
index 6be446f..c64b87b 100644 (file)
--- a/ir/ana/cgana.h
+++ b/ir/ana/cgana.h
@@ -38,27 +38,47 @@
 
 /** Analyses a rough estimation of the possible call graph.
  *
- *  Bestimmt fuer jede Call-Operation die Menge der aufrufbaren Methode
- *  und speichert das Ergebnis in der Call-Operation. (siehe
- *  "set_Call_callee"). Die Methode gibt die Menge der
- *  "freien" Methoden zurueck, die vom Aufrufer wieder freigegeben
- *  werden muss (free).
+ *  Determines for each Call node the set of possibly called methods.
+ *  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 NULL. @@@ the array should contain a
+ *  special entity 'unknown'. (See "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.
+ *
+ *  cgana sets the callee_info_state of each graph to consistent.
+ *
  *  The algorithm implements roughly Static Class Hierarchy Analysis
  *  as described in "Optimization of Object-Oriented Programs Using
  *  Static Class Hierarchy Analysis" by Jeffrey Dean and David Grove
  *  and Craig Chambers.
  *
  *  Performs some optimizations possible by the analysed information:
- *    - Replace SymConst nodes by Const nodes if possible,
- *    - Replace (Sel-method(Alloc)) by Const method,
- *    - Replaces unreachable Sel nodes by Bad  (@@@ was genau meint unreachable?)
- *    - Replaces Sel-method by Const if the Method is never overwritten */
+ *    - 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.  (@@@ was genau meint unreachable?)
+ *    - 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!
+ */
 /*  @@@ I assume this can not be called via JNI :-( -- how to obtain the array pointer? */
 void cgana(int *len, entity ***free_methods);
 
+/** Free callee information.
+ *
+ *  Sets callee_info_state of the graph passed to none.
+ */
+void free_callee_info(ir_graph *irg);
+
 /* Optimize the address expressions passed to call nodes.
  * Performs only the optimizations done by cgana. */
 /* @@@ move to irgopt ?! */
 /* @@@ not fully implemented as buggy !!!  */
 void opt_call_addrs(void);
+
+
 #endif /* _CGANA_H_ */