add generic architecture
[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 #define IS_P6_ARCH(x)       (_IN_RANGE((x), arch_pentium_pro, arch_core) || \
96                              _IN_RANGE((x), arch_athlon, arch_opteron))
97
98 /** floating point support */
99 enum fp_support {
100         fp_none,  /**< no floating point instructions are used */
101         fp_x87,   /**< use x87 instructions */
102         fp_sse2   /**< use SSE2 instructions */
103 };
104
105 /** Returns non-zero if the current floating point architecture is SSE2. */
106 #define USE_SSE2(cg) ((cg)->fp_kind == fp_sse2)
107
108 /** Returns non-zero if the current floating point architecture is x87. */
109 #define USE_x87(cg)  ((cg)->fp_kind == fp_x87)
110
111 typedef struct ia32_isa_t            ia32_isa_t;
112 typedef struct ia32_code_gen_t       ia32_code_gen_t;
113 typedef struct ia32_irn_ops_t        ia32_irn_ops_t;
114 typedef struct ia32_intrinsic_env_t  ia32_intrinsic_env_t;
115
116 /**
117  * IA32 code generator
118  */
119 struct ia32_code_gen_t {
120         const arch_code_generator_if_t *impl;          /**< implementation */
121         ir_graph                       *irg;           /**< current irg */
122         const arch_env_t               *arch_env;      /**< the arch env */
123         set                            *reg_set;       /**< set to memorize registers for non-ia32 nodes (e.g. phi nodes) */
124         ia32_isa_t                     *isa;           /**< for fast access to the isa object */
125         be_irg_t                       *birg;          /**< The be-irg (contains additional information about the irg) */
126         ir_node                        **blk_sched;    /**< an array containing the scheduled blocks */
127         ia32_optimize_t                opt;            /**< contains optimization information */
128         int                            arch;           /**< instruction architecture */
129         int                            opt_arch;       /**< optimize for architecture */
130         char                           fp_kind;        /**< floating point kind */
131         char                           do_x87_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 };
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                  *regs_8bit_high; /**< contains the hight part of the 8 bit names of the gp registers */
154         pmap                  *types;         /**< A map of modes to primitive types */
155         pmap                  *tv_ent;        /**< A map of entities that store const tarvals */
156         ia32_optimize_t       opt;            /**< contains optimization information */
157         int                   arch;           /**< instruction architecture */
158         int                   opt_arch;       /**< optimize for architecture */
159         int                   fp_kind;        /**< floating point kind */
160         ia32_code_gen_t       *cg;            /**< the current code generator */
161         const be_machine_t    *cpu;           /**< the abstract machine */
162 #ifndef NDEBUG
163         struct obstack        *name_obst;     /**< holds the original node names (for debugging) */
164 #endif /* NDEBUG */
165 };
166
167 struct ia32_irn_ops_t {
168         const arch_irn_ops_if_t *impl;
169         ia32_code_gen_t         *cg;
170 };
171
172 /**
173  * A helper type collecting needed info for IA32 intrinsic lowering.
174  */
175 struct ia32_intrinsic_env_t {
176         ir_graph  *irg;           /**< the irg, these entities belong to */
177         ir_entity *ll_div_op1;    /**< entity for first div operand (move into FPU) */
178         ir_entity *ll_div_op2;    /**< entity for second div operand (move into FPU) */
179         ir_entity *ll_d_conv;     /**< entity for converts ll -> d */
180         ir_entity *d_ll_conv;     /**< entity for converts d -> ll */
181         ir_entity *divdi3;        /**< entity for __divdi3 library call */
182         ir_entity *moddi3;        /**< entity for __moddi3 library call */
183         ir_entity *udivdi3;       /**< entity for __udivdi3 library call */
184         ir_entity *umoddi3;       /**< entity for __umoddi3 library call */
185 };
186
187 /** The mode for the floating point control word. */
188 extern ir_mode *mode_fpcw;
189
190 /** The current code generator. */
191 extern ia32_code_gen_t *ia32_current_cg;
192
193 /**
194  * Returns the unique per irg GP NoReg node.
195  */
196 ir_node *ia32_new_NoReg_gp(ia32_code_gen_t *cg);
197 ir_node *ia32_new_NoReg_xmm(ia32_code_gen_t *cg);
198 ir_node *ia32_new_NoReg_vfp(ia32_code_gen_t *cg);
199
200 /**
201  * Returns the uniqure per irg GP Unknown node.
202  * (warning: cse has to be activated)
203  */
204 ir_node *ia32_new_Unknown_gp(ia32_code_gen_t *cg);
205 ir_node *ia32_new_Unknown_xmm(ia32_code_gen_t *cg);
206 ir_node *ia32_new_Unknown_vfp(ia32_code_gen_t *cg);
207
208 /**
209  * Returns the unique per irg FP NoReg node.
210  */
211 ir_node *ia32_new_NoReg_fp(ia32_code_gen_t *cg);
212
213 /**
214  * Returns the uniqure per irg FPU truncation mode node.
215  */
216 ir_node *ia32_new_Fpu_truncate(ia32_code_gen_t *cg);
217
218 /**
219  * Returns gp_noreg or fp_noreg, depending on input requirements.
220  */
221 ir_node *ia32_get_admissible_noreg(ia32_code_gen_t *cg, ir_node *irn, int pos);
222
223 /**
224  * Maps all intrinsic calls that the backend support
225  * and map all instructions the backend did not support
226  * to runtime calls.
227  */
228 void ia32_handle_intrinsics(void);
229
230 /**
231  * Ia32 implementation.
232  *
233  * @param method   the method type of the emulation function entity
234  * @param op       the emulated ir_op
235  * @param imode    the input mode of the emulated opcode
236  * @param omode    the output mode of the emulated opcode
237  * @param context  the context parameter
238  */
239 ir_entity *ia32_create_intrinsic_fkt(ir_type *method, const ir_op *op,
240                                      const ir_mode *imode, const ir_mode *omode,
241                                      void *context);
242
243 #endif