Restructured a bit

[libfirm] / ir / ana / rta.h

diff --git a/ir/ana/rta.h b/ir/ana/rta.h
index 47c9701..7c9eb65 100644 (file)
--- a/ir/ana/rta.h
+++ b/ir/ana/rta.h
@@ -1,9 +1,50 @@
-/* -*- c -*- */
+/*
+ * 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.
+ */
 
-#ifndef _RTA_H_
-#define _RTA_H_
+/**
+ * @file
+ * @brief    Interprocedural analysis to improve the call graph estimate.
+ * @author   Florian
+ * @date     09.06.2002
+ * @version  $Id$
+ * @summary
+ * (TODO translate to english)
+ * Intraprozedurale Analyse zur Abschätzung der Aufrufrelation. Es wird
+ * die Menge der instantiierten Klassen bestimmt, und daraus eine Abschätzung
+ * der aufgerufenen Methoden.
+ *
+ * Voraussetzung ist, dass das Programm keine Methodenzeiger handhaben kann.
+ * In diesem Fall koennten Methoden verloren gehen.  Oder wir muessen nach
+ * allen "freien" Methoden suchen (siehe cgana).
+ *
+ * @@@ Die Analyse sollte wissen, von welchen Klassen Instanzen ausserhalb
+ * der Uebersetzungseinheit alloziert werden koennen.  Diese muessen in
+ * die initiale Menge allozierter Klassen aufgenommern werden.
+ *
+ * Nach: David F. Bacon and Peter F. Sweeney,
+ *       Fast static analysis of C++ virtual function calls
+ *       OOPSLA 1996
+ */
+#ifndef FIRM_ANA_RTA_H
+#define FIRM_ANA_RTA_H
 
-# include "entity.h"
+#include "firm_types.h"
 
 /**
  * Initialise the RTA data structures and perform RTA.
@@ -23,18 +64,30 @@ void rta_delete_dead_graphs (void);
 void rta_cleanup(void);
 
 /** Returns non-zero if the given class is alive. */
-int rta_is_alive_class(type *clazz);
+int rta_is_alive_class(ir_type *clazz);
 
 /** Returns non-zero if the given graph is alive. */
 int rta_is_alive_graph(ir_graph *graph);
 
-/** report for all graphs and types wheater they are alive */
-void rta_report (void);
+/** report for all graphs and types whether they are alive */
+void rta_report(void);
 
-#endif /* not defined _RTA_H_ */
+#endif
 
 /*
  * $Log$
+ * Revision 1.15  2006/12/18 16:02:21  beck
+ * removed useles include
+ *
+ * Revision 1.14  2006/01/13 21:52:00  beck
+ * renamed all types 'type' to 'ir_type'
+ *
+ * Revision 1.13  2004/10/21 07:23:34  goetz
+ * comments
+ *
+ * Revision 1.12  2004/10/20 14:59:27  liekweg
+ * Removed ecg
+ *
  * Revision 1.11  2004/10/18 12:47:46  liekweg
  * minor fix
  *