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