e353d32cff8e2f504fc086e7dc553a1820f97493
[libfirm] / ir / opt / opt_confirms.h
1 /*
2  * Copyright (C) 1995-2007 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   Optimizations regarding Confirm nodes.
23  * @author  Michael Beck
24  * @version $Id$
25  */
26 #ifndef FIRM_OPT_CONFIRMS_H
27 #define FIRM_OPT_CONFIRMS_H
28
29 #include "firm_types.h"
30
31 /**a
32  * @file opt_confirms.h
33  *
34  * Optimizations regarding Confirm nodes.
35  * These optimizations are not means to be run from
36  * frontends, they are called from iropt.
37  */
38
39 /**
40  * Check, if the value of a node is != 0.
41  *
42  * This is a often needed case, so we handle here Confirm
43  * nodes too.
44  *
45  * @param n        a node representing the value
46  * @param confirm  if n is confirmed to be != 0, returns
47  *                 the the Confirm-node, else NULL
48  */
49 int value_not_zero(ir_node *n, ir_node **confirm);
50
51 /**
52  * Check, if the value of a node cannot represent a NULL pointer.
53  *
54  * - If sel_based_null_check_elim is enabled, all
55  *   Sel nodes can be skipped.
56  * - A SymConst(entity) is NEVER a NULL pointer
57  * - A Const != NULL is NEVER a NULL pointer
58  * - Confirms are evaluated
59  *
60  * @param n        a node representing the value
61  * @param confirm  if n is confirmed to be != NULL, returns
62  *                 the the Confirm-node, else NULL
63  */
64 int value_not_null(ir_node *n, ir_node **confirm);
65
66 /**
67  * Possible return values of value_classify().
68  */
69 typedef enum _value_classify_sign {
70   value_classified_unknown  = 0,   /**< could not classify */
71   value_classified_positive = 1,   /**< value is positive, i.e. >= 0 */
72   value_classified_negative = -1   /**< value is negative, i.e. <= 0 if
73                                         no signed zero exists or < 0 else */
74 } value_classify_sign;
75
76 /**
77  * Check, if the value of a node can be confirmed >= 0 or <= 0,
78  * If the mode of the value did not honor signed zeros, else
79  * check for >= 0 or < 0.
80  *
81  * @param n  a node representing the value
82  */
83 value_classify_sign classify_value_sign(ir_node *n);
84
85 /**
86  * Return the value of a Cmp if one or both predecessors
87  * are Confirm nodes.
88  *
89  * @param cmp    the compare node that will be evaluated
90  * @param left   the left operand of the Cmp
91  * @param right  the right operand of the Cmp
92  * @param pnc    the compare relation
93  */
94 tarval *computed_value_Cmp_Confirm(ir_node *cmp, ir_node *left, ir_node *right, pn_Cmp pnc);
95
96 #endif /* FIRM_OPT_CONFIRMS_H */