properly mark symbols in the public API to be exported. This allows us to use -fvisib...
[libfirm] / include / libfirm / irconsconfirm.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    Construction of Confirm nodes
23  * @author   Michael Beck
24  * @date     6.2005
25  * @version  $Id$
26  */
27 #ifndef FIRM_ANA_IRCONSCONFIRM_H
28 #define FIRM_ANA_IRCONSCONFIRM_H
29
30 #include "firm_types.h"
31 #include "begin.h"
32
33 /**
34  * Inject Confirm nodes into a graph.
35  *
36  * @param irg  the graph
37  *
38  * Confirm nodes carry confirmation information, such as
39  * a relation between a value a and another value (or a constant)
40  * b.
41  *
42  * These allows to do some range dependent optimizations for Cmp,
43  * Abs, Min, Max nodes as well as bounds checking deletion.
44  *
45  * The heap analysis might profit also. On the other side, Confirm
46  * nodes disturb local optimizations, because patterns are destroyed.
47  *
48  * It is possible to avoid this by skipping Confirm nodes, but this
49  * is not implemented and is not cheap. The same happens with Casts
50  * nodes too. The current solution is to remove Confirms at a later
51  * pass.
52  */
53 FIRM_DLL void construct_confirms(ir_graph *irg);
54
55 /**
56  * Creates an ir_graph pass for construct_confirms().
57  *
58  * @param name     the name of this pass or NULL
59  *
60  * @return  the newly created ir_graph pass
61  */
62 FIRM_DLL ir_graph_pass_t *construct_confirms_pass(const char *name);
63
64 /**
65  * Remove all Confirm nodes from a graph.
66  *
67  * Note that local_optimize() can handle this if
68  * the remove Confirm node setting is on (set_opt_remove_Confirm(1)).
69  */
70 FIRM_DLL void remove_confirms(ir_graph *irg);
71
72 /**
73  * Creates an ir_graph pass for remove_confirms().
74  *
75  * @param name     the name of this pass or NULL
76  *
77  * @return  the newly created ir_graph pass
78  */
79 FIRM_DLL ir_graph_pass_t *remove_confirms_pass(const char *name);
80
81 #include "end.h"
82
83 #endif