11c106395a902fe69cbe2a93a931c71bbd7aa5ec
[libfirm] / include / libfirm / iropt.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   iropt --- optimizations of an ir node.
23  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
24  * @version $Id$
25  */
26 #ifndef FIRM_IR_IROPT_H
27 #define FIRM_IR_IROPT_H
28
29 #include "firm_types.h"
30 #include "begin.h"
31
32 /**
33  * The Floating point model.
34  *
35  * Several basic properties are defined:
36  * - fp_explicit_rounding
37  * - fp_strict_algebraic
38  * - fp_contradictions
39  * - fp_strict_eval_order
40  * - fp_exceptions
41  * - fp_environment_access
42  *
43  * From those basic properties three general models are defined,
44  * compatible to the VC8 compiler:
45  * - fp_model_precise:
46  *     Default mode. Associative and distributive law forbidden unless a transformation
47  *     is guaranteed to produce the same result.
48  *     No FPU environment access. No FP exception semantics.
49  * - fp_model_strict:
50  *     Slowest mode. Additionally to fp_model_precise allows correct handling of
51  *     FP exceptions and FPU environment access.
52  * - fp_model_fast:
53  *     Fastest mode. Associative and distributive law allowed at the expense
54  *     of floating point accuracy and correctness. Explicit rounding is disabled.
55  * - fp_no_float_fold:
56  *     Avoid floating point constant folding. Useful for frontends which do not
57  *     create arithmetic operations in the backends arithmetic mode.
58  */
59 typedef enum _fp_model_t {
60         fp_explicit_rounding  = (1u << 0),  /**< Explicit rounding at assignments, typecasts, return
61                                           and function calls. Conv nodes may NOT be removed, even
62                                           if they look useless. */
63         fp_strict_algebraic   = (1u << 1),  /**< Strict adherence to non-associative and non-distributive
64                                           algebra unless the same result is guaranteed. */
65         fp_contradictions     = (1u << 2),  /**< FP contradictions are enabled. Only for backend. */
66         fp_strict_eval_order  = (1u << 3),  /**< FP instructions must be strict evaluated in given order. */
67         fp_exceptions         = (1u << 4),  /**< FP exceptions are supported. No reordering that changes
68                                           the exception flow are allowed. Backends must generate
69                                           synchronized exception code. */
70         fp_environment_access = (1u << 5),  /**< FPU environment can be accessed. Even Constant folding
71                                           cannot be done. */
72         fp_no_float_fold      = (1u << 6),
73
74         /** Precise floating point model. Default. */
75         fp_model_precise = fp_explicit_rounding|fp_strict_algebraic|fp_contradictions,
76         /** Strict floating point model. */
77         fp_model_strict  = fp_explicit_rounding|fp_strict_algebraic|fp_strict_eval_order|
78                            fp_exceptions|fp_environment_access,
79         /** Fast floating point model. */
80         fp_model_fast    = fp_contradictions
81 } fp_model_t;
82
83 /** If the expression referenced can be evaluated statically
84  *  computed_value returns a tarval representing the result.
85  *  Else returns tarval_bad. */
86 FIRM_DLL tarval *computed_value(const ir_node *n);
87
88 /** Applies all optimizations to n that are expressible as a pattern
89  *  in Firm, i.e., they need not a walk of the graph.
90  *  Returns a better node for n.  Does not free n -- other nodes could
91  *  reference n.
92  *
93  *  An equivalent optimization is applied in the constructors defined in
94  *  ircons.ch.  There n is freed if a better node could be found.
95  */
96 FIRM_DLL ir_node *optimize_in_place(ir_node *n);
97
98 #include "end.h"
99
100 #endif