more warning fixes

[libfirm] / ir / ana / rta.h

diff --git a/ir/ana/rta.h b/ir/ana/rta.h
index b25169e..bad8b04 100644 (file)
--- a/ir/ana/rta.h
+++ b/ir/ana/rta.h
@@ -1,28 +1,88 @@
 /* -*- c -*- */
 
+/*
+ * Project:     libFIRM
+ * File name:   ir/ana/rta.h
+ * Purpose:     Interprocedural analysis to improve the call graph estimate.
+ * Author:      Florian
+ * Modified by:
+ * Created:     09.06.2002
+ * CVS-ID:      $$
+ * Copyright:   (c) 1999-2004 Universität Karlsruhe
+ * Licence:     This file is protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
+
+/**
+ * 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 _RTA_H_
 #define _RTA_H_
 
 # include "entity.h"
 
-/* Initialise the RTA data structures and perform RTA */
-void rta_init(int, int);
-/* Delete all graphs that have been found to be dead */
+/**
+ * Initialise the RTA data structures and perform RTA.
+ *
+ * @param do_verbose If == 1, print statistics, if > 1, chatter about every detail
+ */
+void rta_init(int do_verbose);
+
+/**
+ * Delete all graphs that have been found to be dead.
+ */
 void rta_delete_dead_graphs (void);
-/* Clean up our data structures */
+
+/** Clean up our data structures.
+ * Finishes the RTA.
+ */
 void rta_cleanup(void);
 
-/* Inquire whether the given class is live */
-int rta_is_alive_class(type *clazz);
-/* Inquire whether the given graph is alive */
+/** Returns non-zero if the given class is alive. */
+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);
-/* dump our opinion */
+
+/** report for all graphs and types whether they are alive */
 void rta_report (void);
 
-#endif /* def _RTA_H_ */
+#endif /* not defined _RTA_H_ */
 
 /*
  * $Log$
+ * 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
+ *
+ * Revision 1.10  2004/09/24 13:59:04  beck
+ * fixed doxygen comments, removed initialization for description entities
+ *
+ * Revision 1.9  2004/08/19 16:51:02  goetz
+ * fixed some errors, pushed closer to inteded firm semantics
+ *
  * Revision 1.8  2004/06/18 17:34:31  liekweg
  * Removed field checks --flo
  *