documentation: Update (i.e. mostly delete) information regarding current_ir_graph.
[libfirm] / include / libfirm / ircgopt.h
1 /*
2  * Copyright (C) 1995-2011 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   Removal of unreachable methods.
23  * @author  Hubert Schmid
24  * @date    09.06.2002
25  * @brief
26  *  Removal of unreachable methods. The set of unreachable methods is computed
27  *  by the callgraph.
28  */
29 #ifndef FIRM_IR_ICGOPT_H
30 #define FIRM_IR_ICGOPT_H
31
32 #include <stddef.h>
33
34 #include "firm_types.h"
35 #include "begin.h"
36
37 /**
38  * Removes all methods which are not reachable from "keep_arr".
39  *
40  * Frees all interprocedural loop information.
41  */
42 FIRM_API void gc_irgs(size_t n_keep, ir_entity *keep_arr[]);
43
44 /**
45  * Creates an ir_prog pass for gc_irgs().
46  *
47  * @param name     the name of this pass or NULL
48  * @return  the newly created ir_graph pass
49  */
50 FIRM_API ir_prog_pass_t *gc_irgs_pass(const char *name);
51
52 #include "end.h"
53
54 #endif