* src/vm/jit/alpha/codegen.h (BRANCH_NOPS): Defined.
[cacao.git] / src / vm / jit / i386 / codegen.h
1 /* src/vm/jit/i386/codegen.h - code generation macros and definitions for i386
2
3    Copyright (C) 1996-2005, 2006 R. Grafl, A. Krall, C. Kruegel,
4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
6    J. Wenninger, Institut f. Computersprachen - TU Wien
7
8    This file is part of CACAO.
9
10    This program is free software; you can redistribute it and/or
11    modify it under the terms of the GNU General Public License as
12    published by the Free Software Foundation; either version 2, or (at
13    your option) any later version.
14
15    This program is distributed in the hope that it will be useful, but
16    WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18    General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23    02110-1301, USA.
24
25    Contact: cacao@cacaojvm.org
26
27    Authors: Andreas Krall
28             Christian Thalinger
29
30    $Id: codegen.h 6078 2006-11-28 22:19:16Z twisti $
31
32 */
33
34
35 #ifndef _CODEGEN_H
36 #define _CODEGEN_H
37
38 #include "config.h"
39 #include "vm/types.h"
40
41 #include "vm/jit/jit.h"
42
43
44 #if defined(ENABLE_LSRA)
45 /* let LSRA allocate reserved registers (REG_ITMP[1|2|3]) */
46 # define LSRA_USES_REG_RES
47 #endif
48
49
50 /* additional functions and macros to generate code ***************************/
51
52 #define CALCOFFSETBYTES(var, reg, val) \
53     if ((s4) (val) < -128 || (s4) (val) > 127) (var) += 4; \
54     else if ((s4) (val) != 0) (var) += 1; \
55     else if ((reg) == EBP) (var) += 1;
56
57
58 #define CALCIMMEDIATEBYTES(var, val) \
59     if ((s4) (val) < -128 || (s4) (val) > 127) (var) += 4; \
60     else (var) += 1;
61
62
63 #define ALIGNCODENOP \
64     do { \
65         for (s1 = 0; s1 < (s4) (((ptrint) cd->mcodeptr) & 7); s1++) \
66             M_NOP; \
67     } while (0)
68
69
70 /* gen_nullptr_check(objreg) */
71
72 #define gen_nullptr_check(objreg) \
73     if (checknull) { \
74         M_TEST(objreg); \
75         M_BEQ(0); \
76             codegen_add_nullpointerexception_ref(cd); \
77     }
78
79 #define gen_bound_check \
80     if (checkbounds) { \
81         M_ILD(REG_ITMP3, s1, OFFSET(java_arrayheader, size)); \
82         M_CMP(REG_ITMP3, s2); \
83         M_BAE(0); \
84         codegen_add_arrayindexoutofboundsexception_ref(cd, s2); \
85     }
86
87
88 /* MCODECHECK(icnt) */
89
90 #define MCODECHECK(icnt) \
91     do { \
92         if ((cd->mcodeptr + (icnt)) > (u1 *) cd->mcodeend) \
93             codegen_increase(cd); \
94     } while (0)
95
96
97 /* M_INTMOVE:
98      generates an integer-move from register a to b.
99      if a and b are the same int-register, no code will be generated.
100 */ 
101
102 #define M_INTMOVE(a,b) \
103     do { \
104         if ((a) != (b)) \
105             M_MOV(a, b); \
106     } while (0)
107
108 #define M_LNGMOVE(a,b) \
109     do { \
110         if (GET_HIGH_REG(a) == GET_LOW_REG(b)) { \
111             assert((GET_LOW_REG(a) != GET_HIGH_REG(b))); \
112             M_INTMOVE(GET_HIGH_REG(a), GET_HIGH_REG(b)); \
113             M_INTMOVE(GET_LOW_REG(a), GET_LOW_REG(b)); \
114         } else { \
115             M_INTMOVE(GET_LOW_REG(a), GET_LOW_REG(b)); \
116             M_INTMOVE(GET_HIGH_REG(a), GET_HIGH_REG(b)); \
117         } \
118     } while (0)
119
120
121 /* M_FLTMOVE:
122     generates a floating-point-move from register a to b.
123     if a and b are the same float-register, no code will be generated
124 */
125
126 #define M_FLTMOVE(reg,dreg)                                          \
127     do {                                                             \
128         if ((reg) != (dreg)) {                                       \
129             log_text("M_FLTMOVE");                                   \
130             assert(0);                                               \
131         }                                                            \
132     } while (0)
133
134
135 #define ICONST(d,c) \
136     do { \
137         if ((c) == 0) \
138             M_CLR(d); \
139         else \
140             M_MOV_IMM((c), d); \
141     } while (0)
142
143
144 #define LCONST(d,c) \
145     do { \
146         if ((c) == 0) { \
147             M_CLR(GET_LOW_REG(d)); \
148             M_CLR(GET_HIGH_REG(d)); \
149         } else { \
150             M_MOV_IMM((c), GET_LOW_REG(d)); \
151             M_MOV_IMM((c) >> 32, GET_HIGH_REG(d)); \
152         } \
153     } while (0)
154
155
156 /* branch defines *************************************************************/
157
158 #define BRANCH_NOPS \
159     do { \
160         M_NOP; \
161         M_NOP; \
162         M_NOP; \
163         M_NOP; \
164         M_NOP; \
165     } while (0)
166
167
168 /* patcher defines ************************************************************/
169
170 #define PATCHER_CALL_SIZE    5          /* size in bytes of a patcher call    */
171
172 #define PATCHER_NOPS \
173     do { \
174         M_NOP; \
175         M_NOP; \
176         M_NOP; \
177         M_NOP; \
178         M_NOP; \
179     } while (0)
180
181
182 /* macros to create code ******************************************************/
183
184 #define M_ILD(a,b,disp)         emit_mov_membase_reg(cd, (b), (disp), (a))
185 #define M_ILD32(a,b,disp)       emit_mov_membase32_reg(cd, (b), (disp), (a))
186
187 #define M_ALD(a,b,disp)         M_ILD(a,b,disp)
188 #define M_ALD32(a,b,disp)       M_ILD32(a,b,disp)
189
190 #define M_LLD(a,b,disp) \
191     do { \
192         M_ILD(GET_LOW_REG(a),b,disp); \
193         M_ILD(GET_HIGH_REG(a),b,disp + 4); \
194     } while (0)
195
196 #define M_LLD32(a,b,disp) \
197     do { \
198         M_ILD32(GET_LOW_REG(a),b,disp); \
199         M_ILD32(GET_HIGH_REG(a),b,disp + 4); \
200     } while (0)
201
202 #define M_IST(a,b,disp)         emit_mov_reg_membase(cd, (a), (b), (disp))
203 #define M_IST_IMM(a,b,disp)     emit_mov_imm_membase(cd, (u4) (a), (b), (disp))
204 #define M_AST(a,b,disp)         M_IST(a,b,disp)
205 #define M_AST_IMM(a,b,disp)     M_IST_IMM(a,b,disp)
206
207 #define M_IST32(a,b,disp)       emit_mov_reg_membase32(cd, (a), (b), (disp))
208 #define M_IST32_IMM(a,b,disp)   emit_mov_imm_membase32(cd, (u4) (a), (b), (disp))
209
210 #define M_LST(a,b,disp) \
211     do { \
212         M_IST(GET_LOW_REG(a),b,disp); \
213         M_IST(GET_HIGH_REG(a),b,disp + 4); \
214     } while (0)
215
216 #define M_LST32(a,b,disp) \
217     do { \
218         M_IST32(GET_LOW_REG(a),b,disp); \
219         M_IST32(GET_HIGH_REG(a),b,disp + 4); \
220     } while (0)
221
222 #define M_LST_IMM(a,b,disp) \
223     do { \
224         M_IST_IMM(a,b,disp); \
225         M_IST_IMM(a >> 32,b,disp + 4); \
226     } while (0)
227
228 #define M_LST32_IMM(a,b,disp) \
229     do { \
230         M_IST32_IMM(a,b,disp); \
231         M_IST32_IMM(a >> 32,b,disp + 4); \
232     } while (0)
233
234 #define M_IADD(a,b)             emit_alu_reg_reg(cd, ALU_ADD, (a), (b))
235 #define M_ISUB(a,b)             emit_alu_reg_reg(cd, ALU_SUB, (a), (b))
236 #define M_IMUL(a,b)             emit_imul_reg_reg(cd, (a), (b))
237 #define M_IDIV(a)               emit_idiv_reg(cd, (a))
238
239 #define M_MUL(a)                emit_mul_reg(cd, (a))
240
241 #define M_IADD_IMM(a,b)         emit_alu_imm_reg(cd, ALU_ADD, (a), (b))
242 #define M_ISUB_IMM(a,b)         emit_alu_imm_reg(cd, ALU_SUB, (a), (b))
243 #define M_IMUL_IMM(a,b,c)       emit_imul_imm_reg_reg(cd, (b), (a), (c))
244
245 #define M_IADD_IMM32(a,b)       emit_alu_imm32_reg(cd, ALU_ADD, (a), (b))
246 #define M_ISUB_IMM32(a,b)       emit_alu_imm32_reg(cd, ALU_SUB, (a), (b))
247
248 #define M_IADD_IMM_MEMBASE(a,b,c) emit_alu_imm_membase(cd, ALU_ADD, (a), (b), (c))
249
250 #define M_ISUB_IMM_MEMABS(a,b)  emit_alu_imm_memabs(cd, ALU_SUB, (a), (b))
251
252 #define M_IADDC(a,b)            emit_alu_reg_reg(cd, ALU_ADC, (a), (b))
253 #define M_ISUBB(a,b)            emit_alu_reg_reg(cd, ALU_SBB, (a), (b))
254
255 #define M_IADDC_IMM(a,b)        emit_alu_imm_reg(cd, ALU_ADC, (a), (b))
256 #define M_ISUBB_IMM(a,b)        emit_alu_imm_reg(cd, ALU_SBB, (a), (b))
257
258 #define M_AADD_IMM(a,b)         M_IADD_IMM(a,b)
259 #define M_AADD_IMM32(a,b)       M_IADD_IMM32(a,b)
260 #define M_ASUB_IMM(a,b)         M_ISUB_IMM(a,b)
261
262 #define M_NEG(a)                emit_neg_reg(cd, (a))
263
264 #define M_AND(a,b)              emit_alu_reg_reg(cd, ALU_AND, (a), (b))
265 #define M_OR(a,b)               emit_alu_reg_reg(cd, ALU_OR, (a), (b))
266 #define M_XOR(a,b)              emit_alu_reg_reg(cd, ALU_XOR, (a), (b))
267
268 #define M_AND_IMM(a,b)          emit_alu_imm_reg(cd, ALU_AND, (a), (b))
269 #define M_OR_IMM(a,b)           emit_alu_imm_reg(cd, ALU_OR, (a), (b))
270 #define M_XOR_IMM(a,b)          emit_alu_imm_reg(cd, ALU_XOR, (a), (b))
271
272 #define M_AND_IMM32(a,b)        emit_alu_imm32_reg(cd, ALU_AND, (a), (b))
273
274 #define M_CLR(a)                M_XOR(a,a)
275
276 #define M_PUSH(a)               emit_push_reg(cd, (a))
277 #define M_PUSH_IMM(a)           emit_push_imm(cd, (s4) (a))
278 #define M_POP(a)                emit_pop_reg(cd, (a))
279
280 #define M_MOV(a,b)              emit_mov_reg_reg(cd, (a), (b))
281 #define M_MOV_IMM(a,b)          emit_mov_imm_reg(cd, (u4) (a), (b))
282
283 #define M_TEST(a)               emit_test_reg_reg(cd, (a), (a))
284 #define M_TEST_IMM(a,b)         emit_test_imm_reg(cd, (a), (b))
285
286 #define M_CMP(a,b)              emit_alu_reg_reg(cd, ALU_CMP, (a), (b))
287 #define M_CMP_MEMBASE(a,b,c)    emit_alu_membase_reg(cd, ALU_CMP, (a), (b), (c))
288
289 #define M_CMP_IMM(a,b)          emit_alu_imm_reg(cd, ALU_CMP, (a), (b))
290 #define M_CMP_IMM_MEMBASE(a,b,c) emit_alu_imm_membase(cd, ALU_CMP, (a), (b), (c))
291
292 #define M_CMP_IMM32(a,b)        emit_alu_imm32_reg(cd, ALU_CMP, (a), (b))
293
294 #define M_BSEXT(a,b)            /* XXX does not work, because of nibbles */
295 #define M_SSEXT(a,b)            emit_movswl_reg_reg(cd, (a), (b))
296
297 #define M_CZEXT(a,b)            emit_movzwl_reg_reg(cd, (a), (b))
298
299 #define M_CLTD                  emit_cltd(cd)
300
301 #define M_SLL(a)                emit_shift_reg(cd, SHIFT_SHL, (a))
302 #define M_SRA(a)                emit_shift_reg(cd, SHIFT_SAR, (a))
303 #define M_SRL(a)                emit_shift_reg(cd, SHIFT_SHR, (a))
304
305 #define M_SLL_IMM(a,b)          emit_shift_imm_reg(cd, SHIFT_SHL, (a), (b))
306 #define M_SRA_IMM(a,b)          emit_shift_imm_reg(cd, SHIFT_SAR, (a), (b))
307 #define M_SRL_IMM(a,b)          emit_shift_imm_reg(cd, SHIFT_SHR, (a), (b))
308
309 #define M_SLLD(a,b)             emit_shld_reg_reg(cd, (a), (b))
310 #define M_SRLD(a,b)             emit_shrd_reg_reg(cd, (a), (b))
311
312 #define M_SLLD_IMM(a,b,c)       emit_shld_imm_reg_reg(cd, (a), (b), (c))
313 #define M_SRLD_IMM(a,b,c)       emit_shrd_imm_reg_reg(cd, (a), (b), (c))
314
315 #define M_CALL(a)               emit_call_reg(cd, (a))
316 #define M_CALL_IMM(a)           emit_call_imm(cd, (a))
317 #define M_RET                   emit_ret(cd)
318
319 #define M_BEQ(a)                emit_jcc(cd, CC_E, (a))
320 #define M_BNE(a)                emit_jcc(cd, CC_NE, (a))
321 #define M_BLT(a)                emit_jcc(cd, CC_L, (a))
322 #define M_BLE(a)                emit_jcc(cd, CC_LE, (a))
323 #define M_BGE(a)                emit_jcc(cd, CC_GE, (a))
324 #define M_BGT(a)                emit_jcc(cd, CC_G, (a))
325
326 #define M_BB(a)                 emit_jcc(cd, CC_B, (a))
327 #define M_BBE(a)                emit_jcc(cd, CC_BE, (a))
328 #define M_BAE(a)                emit_jcc(cd, CC_AE, (a))
329 #define M_BA(a)                 emit_jcc(cd, CC_A, (a))
330 #define M_BNS(a)                emit_jcc(cd, CC_NS, (a))
331
332 #define M_JMP(a)                emit_jmp_reg(cd, (a))
333 #define M_JMP_IMM(a)            emit_jmp_imm(cd, (a))
334
335 #define M_NOP                   emit_nop(cd)
336
337
338 #define M_FLD(a,b,disp)         emit_flds_membase(cd, (b), (disp))
339 #define M_DLD(a,b,disp)         emit_fldl_membase(cd, (b), (disp))
340
341 #define M_FLD32(a,b,disp)       emit_flds_membase32(cd, (b), (disp))
342 #define M_DLD32(a,b,disp)       emit_fldl_membase32(cd, (b), (disp))
343
344 #define M_FST(a,b,disp)         emit_fstps_membase(cd, (b), (disp))
345 #define M_DST(a,b,disp)         emit_fstpl_membase(cd, (b), (disp))
346
347 #define M_FSTNP(a,b,disp)       emit_fsts_membase(cd, (b), (disp))
348 #define M_DSTNP(a,b,disp)       emit_fstl_membase(cd, (b), (disp))
349
350 #endif /* _CODEGEN_H */
351
352
353 /*
354  * These are local overrides for various environment variables in Emacs.
355  * Please do not remove this and leave it at the end of the file, where
356  * Emacs will automagically detect them.
357  * ---------------------------------------------------------------------
358  * Local variables:
359  * mode: c
360  * indent-tabs-mode: t
361  * c-basic-offset: 4
362  * tab-width: 4
363  * End:
364  */