Summary is not a doxygen tag
[libfirm] / include / libfirm / rta.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Interprocedural analysis to improve the call graph estimate.
23  * @author   Florian
24  * @date     09.06.2002
25  * @version  $Id$
26  * @brief
27  * (TODO translate to english)
28  * Intraprozedurale Analyse zur Absch�tzung der Aufrufrelation. Es wird
29  * die Menge der instantiierten Klassen bestimmt, und daraus eine Absch�tzung
30  * der aufgerufenen Methoden.
31  *
32  * Voraussetzung ist, dass das Programm keine Methodenzeiger handhaben kann.
33  * In diesem Fall koennten Methoden verloren gehen.  Oder wir muessen nach
34  * allen "freien" Methoden suchen (siehe cgana).
35  *
36  * @@@ Die Analyse sollte wissen, von welchen Klassen Instanzen ausserhalb
37  * der Uebersetzungseinheit alloziert werden koennen.  Diese muessen in
38  * die initiale Menge allozierter Klassen aufgenommern werden.
39  *
40  * Nach: David F. Bacon and Peter F. Sweeney,
41  *       Fast static analysis of C++ virtual function calls
42  *       OOPSLA 1996
43  */
44 #ifndef FIRM_ANA_RTA_H
45 #define FIRM_ANA_RTA_H
46
47 #include "firm_types.h"
48
49 /**
50  * Initialise the RTA data structures and perform RTA.
51  * Expects that all allocations are done by Alloc nodes.
52  */
53 void rta_init(void);
54
55 /**
56  * Delete all graphs that have been found to be dead.
57  */
58 void rta_delete_dead_graphs (void);
59
60 /** Clean up our data structures.
61  * Finishes the RTA.
62  */
63 void rta_cleanup(void);
64
65 /** Returns non-zero if the given class is alive. */
66 int rta_is_alive_class(ir_type *clazz);
67
68 /** Returns non-zero if the given graph is alive. */
69 int rta_is_alive_graph(ir_graph *graph);
70
71 /** report for all graphs and types whether they are alive */
72 void rta_report(void);
73
74 #endif
75
76 /*
77  * $Log$
78  * Revision 1.15  2006/12/18 16:02:21  beck
79  * removed useles include
80  *
81  * Revision 1.14  2006/01/13 21:52:00  beck
82  * renamed all types 'type' to 'ir_type'
83  *
84  * Revision 1.13  2004/10/21 07:23:34  goetz
85  * comments
86  *
87  * Revision 1.12  2004/10/20 14:59:27  liekweg
88  * Removed ecg
89  *
90  * Revision 1.11  2004/10/18 12:47:46  liekweg
91  * minor fix
92  *
93  * Revision 1.10  2004/09/24 13:59:04  beck
94  * fixed doxygen comments, removed initialization for description entities
95  *
96  * Revision 1.9  2004/08/19 16:51:02  goetz
97  * fixed some errors, pushed closer to inteded firm semantics
98  *
99  * Revision 1.8  2004/06/18 17:34:31  liekweg
100  * Removed field checks --flo
101  *
102  * Revision 1.7  2004/06/18 13:12:43  liekweg
103  * final bug fix (calls via consts)
104  *
105  * Revision 1.6  2004/06/17 14:21:14  liekweg
106  * major bugfix
107  *
108  * Revision 1.5  2004/06/17 08:33:01  liekweg
109  * Added comments; added remove_irg
110  *
111  * Revision 1.4  2004/06/15 11:44:54  beck
112  * New inlining schema implemented:
113  *
114  * small functions that should be inlined in libFirm are implemented in _t.h files
115  * with a __ prefix.
116  * Preprocessor magic is used to automatically inline these functions whenever a _t.h
117  * file is included instead of a .h file.
118  * Note that this magic did not work outside libFirm without accessing _t.h files.
119  *
120  * Revision 1.3  2004/06/13 15:03:45  liekweg
121  * RTA auf Iterative RTA aufgebohrt --flo
122  *
123  * Revision 1.2  2004/06/12 17:09:46  liekweg
124  * RTA works, outedges breaks.  "Yay." --flo
125  *
126  * Revision 1.1  2004/06/11 18:24:18  liekweg
127  * Added RTA --flo
128  *
129  */