X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fana%2Fcgana.h;h=3f90b4c0035f4ff0b8bc0dd1e5684e417ded0070;hb=6d3cc33efb41b34b6d392c489921855f32c9baf5;hp=141e0a15db195ad1e517764566ec01ed030545ad;hpb=382defb529c86fac61baacb80ce2d6ce3d5f88a9;p=libfirm

diff --git a/ir/ana/cgana.h b/ir/ana/cgana.h
index 141e0a15d..3f90b4c00 100644
--- a/ir/ana/cgana.h
+++ b/ir/ana/cgana.h
@@ -1,56 +1,73 @@
-/* -------------------------------------------------------------------
- * $Id$
- * -------------------------------------------------------------------
+/*
+ * Project:     libFIRM
+ * File name:   ir/ana/cgana.h
+ * Purpose:     Intraprozedural analyses to estimate the call graph.
+ * Author:      Hubert Schmid
+ * Modified by:
+ * Created:     09.06.2002
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 1999-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
+
+/**
  * Intraprozedurale Analyse zur Abschätzung der Aufrulrelation. Es
  * wird eine Menge von freien Methoden und anschließend die an den
  * Call-Operationen aufrufbaren Methoden bestimmt.
  *
- * Erstellt: Hubert Schmid, 09.06.2002
- * ---------------------------------------------------------------- */
-
+ */
 
 #ifndef _CGANA_H_
 #define _CGANA_H_
 
-
 #include "entity.h"
 
-
 /* Methoden sind "frei", wenn ihr Funktionszeiger (potentiell)
- *"explizit" bekannt ist, d.h.:
+ * "explizit" bekannt ist, d.h.:
  *
- * - die Methode ist von außen sichtbar (external_visible).
+ * - die Methode ist von aussen sichtbar (external_visible).
  *
  * - ihr Funktionszeiger ist "frei", d.h. der Funktionszeiger wurde
- *   nicht ausschließlich an den entsprechenden Eingang eines
+ *   nicht ausschliesslich an den entsprechenden Eingang eines
  *   Call-Knotens weitergegeben, sondern z.B. in den Speicher
- *   geschrieben, als Parameter übergeben, ...
+ *   geschrieben, als Parameter uebergeben, ...
  *
  * Die main-Methode ist immer in der Menge enthalten.
  *
- * Die Links an den "ir_node"s werden gelöscht. */
-
-
+ * Die Links an den "ir_node"s werden geloescht. */
 
-/* Analyses a rough estimation of the possible call graph.
- * Bestimmt für 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 zurück, die vom Aufrufer wieder freigegeben
- * werden muss (free).
- * 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 */
-/* @@@ I assume this can not be called via JNI :-( */
+/** Analyses a rough estimation of the possible call graph.
+ *
+ *  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 */
+/*  @@@ 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 ?! */