X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;ds=sidebyside;f=ir%2Fana%2Fcgana.h;h=0af3cce378aa2cf0a3c5d718b49e69dd9ddbeed6;hb=f616f878aa0ea06ad96e9c92a58c75d4fe5b3162;hp=c64b87bed7b78f5aca672e769e0886e4a4bdcca1;hpb=5c749a5eaac783cf648c750dac823d8d5634e861;p=libfirm

diff --git a/ir/ana/cgana.h b/ir/ana/cgana.h
index c64b87bed..0af3cce37 100644
--- a/ir/ana/cgana.h
+++ b/ir/ana/cgana.h
@@ -1,24 +1,39 @@
 /*
- * 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.
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
 /**
- * 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.
+ * @file
+ * @brief       Intraprozedural analyses to estimate the call graph.
+ * @author      Hubert Schmid
+ * @date        09.06.2002
+ * @version     $Id$
+ * @summary
+ * @summary
+ *  Interprocedural analysis to estimate the calling relation.
  *
+ *  This analysis computes all entities representing methods that
+ *  can be called at a Call node.  Further it computes a set of
+ *  methods that are 'free', i.e., their adress is handled by
+ *  the program directly, or they are visible external.
  */
-
-#ifndef _CGANA_H_
-#define _CGANA_H_
+#ifndef FIRM_ANA_CGANA_H
+#define FIRM_ANA_CGANA_H
 
 #include "entity.h"
 
@@ -34,20 +49,22 @@
  *
  * Die main-Methode ist immer in der Menge enthalten.
  *
- * Die Links an den "ir_node"s werden geloescht. */
+ * Die Links an den "ir_node"s werden geloescht.
+ */
 
 /** 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.
+ *  variable, the array contains the unknown_entity. (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.
+ *  cgana sets the callee_info_state of each graph and the program to
+ *  consistent.
  *
  *  The algorithm implements roughly Static Class Hierarchy Analysis
  *  as described in "Optimization of Object-Oriented Programs Using
@@ -58,27 +75,27 @@
  *    - 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?)
+ *         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!
  */
-/*  @@@ I assume this can not be called via JNI :-( -- how to obtain the array pointer? */
-void cgana(int *len, entity ***free_methods);
+void cgana(int *len, ir_entity ***free_methods);
 
 /** Free callee information.
  *
- *  Sets callee_info_state of the graph passed to none.
+ *  Sets callee_info_state of the graph passed to none.  Sets callee field
+ *  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);
 
 /* 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_ */
+#endif