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