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