05018e9936be744e5c5974095044fe15f3df03a9
[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