unified main comments
[libfirm] / ir / be / ia32 / bearch_ia32_t.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       This is the main ia32 firm backend driver.
23  * @author      Christian Wuerdig
24  * @version     $Id$
25  */
26 #ifndef FIRM_BE_IA32_BEARCH_IA32_T_H
27 #define FIRM_BE_IA32_BEARCH_IA32_T_H
28
29 #include "firm_config.h"
30
31 #include "pmap.h"
32 #include "debug.h"
33 #include "ia32_nodes_attr.h"
34 #include "set.h"
35 #include "pdeq.h"
36
37 #include "../be.h"
38 #include "../bemachine.h"
39 #include "../beemitter.h"
40
41 #ifdef NDEBUG
42 #define SET_IA32_ORIG_NODE(n, o)
43 #else  /* ! NDEBUG */
44 #define SET_IA32_ORIG_NODE(n, o) set_ia32_orig_node(n, o);
45 #endif /* NDEBUG */
46
47 /* some typedefs */
48
49 /**
50  * Bitmask for the backend optimization settings.
51  */
52 typedef enum _ia32_optimize_t {
53         IA32_OPT_INCDEC    = 1,   /**< optimize add/sub 1/-1 to inc/dec */
54         IA32_OPT_DOAM      = 2,   /**< do address mode optimizations */
55         IA32_OPT_LEA       = 4,   /**< optimize address calculations into LEAs */
56         IA32_OPT_PLACECNST = 8,   /**< place constants in the blocks where they are used */
57         IA32_OPT_IMMOPS    = 16,  /**< create operations with immediate operands */
58         IA32_OPT_PUSHARGS  = 32,  /**< create pushs for function argument passing */
59 } ia32_optimize_t;
60
61 /**
62  * Architectures. Clustered for easier macro implementation,
63  * do not change.
64  */
65 typedef enum cpu_support {
66         arch_i386,          /**< i386 */
67         arch_i486,          /**< i486 */
68         arch_pentium,       /**< Pentium */
69         arch_pentium_pro,   /**< Pentium Pro */
70         arch_pentium_mmx,   /**< Pentium MMX */
71         arch_pentium_2,     /**< Pentium II */
72         arch_pentium_3,     /**< Pentium III */
73         arch_pentium_4,     /**< Pentium IV */
74         arch_pentium_m,     /**< Pentium M */
75         arch_core,          /**< Core */
76         arch_k6,            /**< K6 */
77         arch_athlon,        /**< Athlon */
78         arch_athlon_64,     /**< Athlon64 */
79         arch_opteron,       /**< Opteron */
80 } cpu_support;
81
82 /** checks for l <= x <= h */
83 #define _IN_RANGE(x, l, h)  ((unsigned)((x) - (l)) <= (unsigned)((h) - (l)))
84
85 /** returns true if it's Intel architecture */
86 #define ARCH_INTEL(x)       _IN_RANGE((x), arch_i386, arch_core)
87
88 /** returns true if it's AMD architecture */
89 #define ARCH_AMD(x)         _IN_RANGE((x), arch_k6, arch_opteron)
90
91 #define IS_P6_ARCH(x)       (_IN_RANGE((x), arch_pentium_pro, arch_core) || \
92                              _IN_RANGE((x), arch_athlon, arch_opteron))
93
94 /** floating point support */
95 typedef enum fp_support {
96         fp_none,  /**< no floating point instructions are used */
97         fp_x87,   /**< use x87 instructions */
98         fp_sse2   /**< use SSE2 instructions */
99 } fp_support;
100
101 /** Sets the used flag to the current floating point architecture. */
102 #define FP_USED(cg)  ((cg)->used_fp = (cg)->fp_kind)
103
104 /** Returns non-zero if the current floating point architecture is SSE2. */
105 #define USE_SSE2(cg) ((cg)->fp_kind == fp_sse2)
106
107 /** Returns non-zero if the current floating point architecture is x87. */
108 #define USE_x87(cg)  ((cg)->fp_kind == fp_x87)
109
110 /** Sets the flag to enforce x87 simulation. */
111 #define FORCE_x87(cg) ((cg)->force_sim = 1)
112
113 typedef struct _ia32_isa_t ia32_isa_t;
114
115 /**
116  * IA32 code generator
117  */
118 typedef struct _ia32_code_gen_t {
119         const arch_code_generator_if_t *impl;          /**< implementation */
120         ir_graph                       *irg;           /**< current irg */
121         const arch_env_t               *arch_env;      /**< the arch env */
122         set                            *reg_set;       /**< set to memorize registers for non-ia32 nodes (e.g. phi nodes) */
123         ia32_isa_t                     *isa;           /**< for fast access to the isa object */
124         be_irg_t                       *birg;          /**< The be-irg (contains additional information about the irg) */
125         ir_node                        **blk_sched;    /**< an array containing the scheduled blocks */
126         ia32_optimize_t                opt;            /**< contains optimization information */
127         int                            arch;           /**< instruction architecture */
128         int                            opt_arch;       /**< optimize for architecture */
129         char                           fp_kind;        /**< floating point kind */
130         char                           used_fp;        /**< which floating point unit used in this graph */
131         char                           force_sim;      /**< set to 1 if x87 simulation should be enforced */
132         char                           dump;           /**< set to 1 if graphs should be dumped */
133         ir_node                       *unknown_gp;     /**< unique Unknown_GP node */
134         ir_node                       *unknown_vfp;    /**< unique Unknown_VFP node */
135         ir_node                       *unknown_xmm;    /**< unique Unknown_XMM node */
136         ir_node                       *noreg_gp;       /**< unique NoReg_GP node */
137         ir_node                       *noreg_vfp;      /**< unique NoReg_VFP node */
138         ir_node                       *noreg_xmm;      /**< unique NoReg_XMM node */
139
140         ir_node                       *fpu_trunc_mode; /**< truncate fpu mode */
141
142         struct obstack                *obst;
143 } ia32_code_gen_t;
144
145 /**
146  * IA32 ISA object
147  */
148 struct _ia32_isa_t {
149         arch_isa_t            arch_isa;       /**< must be derived from arch_isa_t */
150         be_emit_env_t          emit;
151         pmap                  *regs_16bit;    /**< Contains the 16bits names of the gp registers */
152         pmap                  *regs_8bit;     /**< Contains the 8bits names of the gp registers */
153         pmap                  *types;         /**< A map of modes to primitive types */
154         pmap                  *tv_ent;        /**< A map of entities that store const tarvals */
155         ia32_optimize_t       opt;            /**< contains optimization information */
156         int                   arch;           /**< instruction architecture */
157         int                   opt_arch;       /**< optimize for architecture */
158         int                   fp_kind;        /**< floating point kind */
159         ia32_code_gen_t       *cg;            /**< the current code generator */
160         const be_machine_t    *cpu;           /**< the abstract machine */
161 #ifndef NDEBUG
162         struct obstack        *name_obst;     /**< holds the original node names (for debugging) */
163 #endif /* NDEBUG */
164 };
165
166 typedef struct _ia32_irn_ops_t {
167         const arch_irn_ops_if_t *impl;
168         ia32_code_gen_t         *cg;
169 } ia32_irn_ops_t;
170
171 typedef struct _ia32_intrinsic_env_t {
172         ir_graph  *irg;           /**< the irg, these entities belong to */
173         ir_entity *ll_div_op1;    /**< entity for first div operand (move into FPU) */
174         ir_entity *ll_div_op2;    /**< entity for second div operand (move into FPU) */
175         ir_entity *ll_d_conv;     /**< entity for converts ll -> d */
176         ir_entity *d_ll_conv;     /**< entity for converts d -> ll */
177 } ia32_intrinsic_env_t;
178
179 /** mode for the floating point control word */
180 extern ir_mode *mode_fpcw;
181
182 /**
183  * Returns the unique per irg GP NoReg node.
184  */
185 ir_node *ia32_new_NoReg_gp(ia32_code_gen_t *cg);
186 ir_node *ia32_new_NoReg_xmm(ia32_code_gen_t *cg);
187 ir_node *ia32_new_NoReg_vfp(ia32_code_gen_t *cg);
188
189 /**
190  * Returns the uniqure per irg GP Unknown node.
191  * (warning: cse has to be activated)
192  */
193 ir_node *ia32_new_Unknown_gp(ia32_code_gen_t *cg);
194 ir_node *ia32_new_Unknown_xmm(ia32_code_gen_t *cg);
195 ir_node *ia32_new_Unknown_vfp(ia32_code_gen_t *cg);
196
197 /**
198  * Returns the unique per irg FP NoReg node.
199  */
200 ir_node *ia32_new_NoReg_fp(ia32_code_gen_t *cg);
201
202 /**
203  * Returns the uniqure per irg FPU truncation mode node.
204  */
205 ir_node *ia32_new_Fpu_truncate(ia32_code_gen_t *cg);
206
207 /**
208  * Returns gp_noreg or fp_noreg, depending on input requirements.
209  */
210 ir_node *ia32_get_admissible_noreg(ia32_code_gen_t *cg, ir_node *irn, int pos);
211
212 /**
213  * Maps all intrinsic calls that the backend support
214  * and map all instructions the backend did not support
215  * to runtime calls.
216  */
217 void ia32_handle_intrinsics(void);
218
219 /**
220  * Ia32 implementation.
221  *
222  * @param method   the method type of the emulation function entity
223  * @param op       the emulated ir_op
224  * @param imode    the input mode of the emulated opcode
225  * @param omode    the output mode of the emulated opcode
226  * @param context  the context parameter
227  */
228 ir_entity *ia32_create_intrinsic_fkt(ir_type *method, const ir_op *op,
229                                      const ir_mode *imode, const ir_mode *omode,
230                                      void *context);
231
232 #endif /* FIRM_BE_IA32_BEARCH_IA32_T_H */