6515cc9a16f77eb2cbe9dcae47316819b1793923
[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    Changes:
31
32    $Id: codegen.h 5352 2006-09-05 22:51:48Z christian $
33
34 */
35
36
37 #ifndef _CODEGEN_H
38 #define _CODEGEN_H
39
40 #include "config.h"
41 #include "vm/types.h"
42
43 #include "vm/jit/jit.h"
44
45
46 #if defined(ENABLE_LSRA)
47 /* let LSRA allocate reserved registers (REG_ITMP[1|2|3]) */
48 # define LSRA_USES_REG_RES
49 #endif
50
51 /* some defines ***************************************************************/
52
53 #define PATCHER_CALL_SIZE    5          /* size in bytes of a patcher call    */
54
55
56 /* additional functions and macros to generate code ***************************/
57
58 #define CALCOFFSETBYTES(var, reg, val) \
59     if ((s4) (val) < -128 || (s4) (val) > 127) (var) += 4; \
60     else if ((s4) (val) != 0) (var) += 1; \
61     else if ((reg) == EBP) (var) += 1;
62
63
64 #define CALCIMMEDIATEBYTES(var, val) \
65     if ((s4) (val) < -128 || (s4) (val) > 127) (var) += 4; \
66     else (var) += 1;
67
68
69 #define ALIGNCODENOP \
70     do { \
71         for (s1 = 0; s1 < (s4) (((ptrint) cd->mcodeptr) & 7); s1++) \
72             M_NOP; \
73     } while (0)
74
75
76 /* gen_nullptr_check(objreg) */
77
78 #define gen_nullptr_check(objreg) \
79     if (checknull) { \
80         M_TEST(objreg); \
81         M_BEQ(0); \
82             codegen_add_nullpointerexception_ref(cd); \
83     }
84
85 #define gen_bound_check \
86     if (checkbounds) { \
87         M_ILD(REG_ITMP3, s1, OFFSET(java_arrayheader, size)); \
88         M_CMP(REG_ITMP3, s2); \
89         M_BAE(0); \
90         codegen_add_arrayindexoutofboundsexception_ref(cd, s2); \
91     }
92
93
94 /* MCODECHECK(icnt) */
95
96 #define MCODECHECK(icnt) \
97     do { \
98         if ((cd->mcodeptr + (icnt)) > (u1 *) cd->mcodeend) \
99             codegen_increase(cd); \
100     } while (0)
101
102
103 /* M_INTMOVE:
104      generates an integer-move from register a to b.
105      if a and b are the same int-register, no code will be generated.
106 */ 
107
108 #define M_INTMOVE(a,b) \
109     do { \
110         if ((a) != (b)) \
111             M_MOV(a, b); \
112     } while (0)
113
114 #define M_LNGMOVE(a,b) \
115     do { \
116         if (GET_HIGH_REG(a) == GET_LOW_REG(b)) { \
117             assert((GET_LOW_REG(a) != GET_HIGH_REG(b))); \
118             M_INTMOVE(GET_HIGH_REG(a), GET_HIGH_REG(b)); \
119             M_INTMOVE(GET_LOW_REG(a), GET_LOW_REG(b)); \
120         } else { \
121             M_INTMOVE(GET_LOW_REG(a), GET_LOW_REG(b)); \
122             M_INTMOVE(GET_HIGH_REG(a), GET_HIGH_REG(b)); \
123         } \
124     } while (0)
125
126
127 /* M_FLTMOVE:
128     generates a floating-point-move from register a to b.
129     if a and b are the same float-register, no code will be generated
130 */
131
132 #define M_FLTMOVE(reg,dreg) \
133     do { \
134         log_text("M_FLTMOVE"); \
135         assert(0); \
136     } while (0)
137
138
139 #if defined(ENABLE_SSA)
140 #define M_COPY(from,to)                                                   \
141         { \
142         if ((ls==NULL) || (to->varkind != TEMPVAR) || \
143                 (ls->lifetime[-to->varnum-1].type != -1)) \
144                         { _M_COPY((from),(to));     } }
145 #else
146 #define M_COPY(from,to) _M_COPY((from),(to));
147 #endif
148
149 #define _M_COPY(s,d)                     emit_copy(jd, iptr, (s), (d))
150
151 #define ICONST(d,c) \
152     do { \
153         if ((c) == 0) \
154             M_CLR(d); \
155         else \
156             M_MOV_IMM((c), d); \
157     } while (0)
158
159
160 #define LCONST(d,c) \
161     do { \
162         if ((c) == 0) { \
163             M_CLR(GET_LOW_REG(d)); \
164             M_CLR(GET_HIGH_REG(d)); \
165         } else { \
166             M_MOV_IMM((c), GET_LOW_REG(d)); \
167             M_MOV_IMM((c) >> 32, GET_HIGH_REG(d)); \
168         } \
169     } while (0)
170
171
172 /* macros to create code ******************************************************/
173
174 #define M_ILD(a,b,disp)         emit_mov_membase_reg(cd, (b), (disp), (a))
175 #define M_ILD32(a,b,disp)       emit_mov_membase32_reg(cd, (b), (disp), (a))
176
177 #define M_ALD(a,b,disp)         M_ILD(a,b,disp)
178 #define M_ALD32(a,b,disp)       M_ILD32(a,b,disp)
179
180 #define M_LLD(a,b,disp) \
181     do { \
182         M_ILD(GET_LOW_REG(a),b,disp); \
183         M_ILD(GET_HIGH_REG(a),b,disp + 4); \
184     } while (0)
185
186 #define M_LLD32(a,b,disp) \
187     do { \
188         M_ILD32(GET_LOW_REG(a),b,disp); \
189         M_ILD32(GET_HIGH_REG(a),b,disp + 4); \
190     } while (0)
191
192 #define M_IST(a,b,disp)         emit_mov_reg_membase(cd, (a), (b), (disp))
193 #define M_IST_IMM(a,b,disp)     emit_mov_imm_membase(cd, (u4) (a), (b), (disp))
194 #define M_AST(a,b,disp)         M_IST(a,b,disp)
195 #define M_AST_IMM(a,b,disp)     M_IST_IMM(a,b,disp)
196
197 #define M_IST32(a,b,disp)       emit_mov_reg_membase32(cd, (a), (b), (disp))
198 #define M_IST32_IMM(a,b,disp)   emit_mov_imm_membase32(cd, (u4) (a), (b), (disp))
199
200 #define M_LST(a,b,disp) \
201     do { \
202         M_IST(GET_LOW_REG(a),b,disp); \
203         M_IST(GET_HIGH_REG(a),b,disp + 4); \
204     } while (0)
205
206 #define M_LST32(a,b,disp) \
207     do { \
208         M_IST32(GET_LOW_REG(a),b,disp); \
209         M_IST32(GET_HIGH_REG(a),b,disp + 4); \
210     } while (0)
211
212 #define M_LST_IMM(a,b,disp) \
213     do { \
214         M_IST_IMM(a,b,disp); \
215         M_IST_IMM(a >> 32,b,disp + 4); \
216     } while (0)
217
218 #define M_LST32_IMM(a,b,disp) \
219     do { \
220         M_IST32_IMM(a,b,disp); \
221         M_IST32_IMM(a >> 32,b,disp + 4); \
222     } while (0)
223
224 #define M_IADD(a,b)             emit_alu_reg_reg(cd, ALU_ADD, (a), (b))
225 #define M_ISUB(a,b)             emit_alu_reg_reg(cd, ALU_SUB, (a), (b))
226 #define M_IMUL(a,b)             emit_imul_reg_reg(cd, (a), (b))
227 #define M_IDIV(a)               emit_idiv_reg(cd, (a))
228
229 #define M_MUL(a)                emit_mul_reg(cd, (a))
230
231 #define M_IADD_IMM(a,b)         emit_alu_imm_reg(cd, ALU_ADD, (a), (b))
232 #define M_ISUB_IMM(a,b)         emit_alu_imm_reg(cd, ALU_SUB, (a), (b))
233 #define M_IMUL_IMM(a,b,c)       emit_imul_imm_reg_reg(cd, (b), (a), (c))
234
235 #define M_IADD_IMM32(a,b)       emit_alu_imm32_reg(cd, ALU_ADD, (a), (b))
236 #define M_ISUB_IMM32(a,b)       emit_alu_imm32_reg(cd, ALU_SUB, (a), (b))
237
238 #define M_IADD_IMM_MEMBASE(a,b,c) emit_alu_imm_membase(cd, ALU_ADD, (a), (b), (c))
239
240 #define M_IADDC(a,b)            emit_alu_reg_reg(cd, ALU_ADC, (a), (b))
241 #define M_ISUBB(a,b)            emit_alu_reg_reg(cd, ALU_SBB, (a), (b))
242
243 #define M_IADDC_IMM(a,b)        emit_alu_imm_reg(cd, ALU_ADC, (a), (b))
244 #define M_ISUBB_IMM(a,b)        emit_alu_imm_reg(cd, ALU_SBB, (a), (b))
245
246 #define M_AADD_IMM(a,b)         M_IADD_IMM(a,b)
247 #define M_AADD_IMM32(a,b)       M_IADD_IMM32(a,b)
248 #define M_ASUB_IMM(a,b)         M_ISUB_IMM(a,b)
249
250 #define M_NEG(a)                emit_neg_reg(cd, (a))
251
252 #define M_AND(a,b)              emit_alu_reg_reg(cd, ALU_AND, (a), (b))
253 #define M_OR(a,b)               emit_alu_reg_reg(cd, ALU_OR, (a), (b))
254 #define M_XOR(a,b)              emit_alu_reg_reg(cd, ALU_XOR, (a), (b))
255
256 #define M_AND_IMM(a,b)          emit_alu_imm_reg(cd, ALU_AND, (a), (b))
257 #define M_OR_IMM(a,b)           emit_alu_imm_reg(cd, ALU_OR, (a), (b))
258 #define M_XOR_IMM(a,b)          emit_alu_imm_reg(cd, ALU_XOR, (a), (b))
259
260 #define M_AND_IMM32(a,b)        emit_alu_imm32_reg(cd, ALU_AND, (a), (b))
261
262 #define M_CLR(a)                M_XOR(a,a)
263
264 #define M_PUSH(a)               emit_push_reg(cd, (a))
265 #define M_PUSH_IMM(a)           emit_push_imm(cd, (s4) (a))
266 #define M_POP(a)                emit_pop_reg(cd, (a))
267
268 #define M_MOV(a,b)              emit_mov_reg_reg(cd, (a), (b))
269 #define M_MOV_IMM(a,b)          emit_mov_imm_reg(cd, (u4) (a), (b))
270
271 #define M_TEST(a)               emit_test_reg_reg(cd, (a), (a))
272 #define M_TEST_IMM(a,b)         emit_test_imm_reg(cd, (a), (b))
273
274 #define M_CMP(a,b)              emit_alu_reg_reg(cd, ALU_CMP, (a), (b))
275 #define M_CMP_MEMBASE(a,b,c)    emit_alu_membase_reg(cd, ALU_CMP, (a), (b), (c))
276
277 #define M_CMP_IMM(a,b)          emit_alu_imm_reg(cd, ALU_CMP, (a), (b))
278 #define M_CMP_IMM_MEMBASE(a,b,c) emit_alu_imm_membase(cd, ALU_CMP, (a), (b), (c))
279
280 #define M_CMP_IMM32(a,b)        emit_alu_imm32_reg(cd, ALU_CMP, (a), (b))
281
282 #define M_BSEXT(a,b)            /* XXX does not work, because of nibbles */
283 #define M_SSEXT(a,b)            emit_movswl_reg_reg(cd, (a), (b))
284
285 #define M_CZEXT(a,b)            emit_movzwl_reg_reg(cd, (a), (b))
286
287 #define M_CLTD                  emit_cltd(cd)
288
289 #define M_SLL(a)                emit_shift_reg(cd, SHIFT_SHL, (a))
290 #define M_SRA(a)                emit_shift_reg(cd, SHIFT_SAR, (a))
291 #define M_SRL(a)                emit_shift_reg(cd, SHIFT_SHR, (a))
292
293 #define M_SLL_IMM(a,b)          emit_shift_imm_reg(cd, SHIFT_SHL, (a), (b))
294 #define M_SRA_IMM(a,b)          emit_shift_imm_reg(cd, SHIFT_SAR, (a), (b))
295 #define M_SRL_IMM(a,b)          emit_shift_imm_reg(cd, SHIFT_SHR, (a), (b))
296
297 #define M_SLLD(a,b)             emit_shld_reg_reg(cd, (a), (b))
298 #define M_SRLD(a,b)             emit_shrd_reg_reg(cd, (a), (b))
299
300 #define M_SLLD_IMM(a,b,c)       emit_shld_imm_reg_reg(cd, (a), (b), (c))
301 #define M_SRLD_IMM(a,b,c)       emit_shrd_imm_reg_reg(cd, (a), (b), (c))
302
303 #define M_CALL(a)               emit_call_reg(cd, (a))
304 #define M_CALL_IMM(a)           emit_call_imm(cd, (a))
305 #define M_RET                   emit_ret(cd)
306
307 #define M_BEQ(a)                emit_jcc(cd, CC_E, (a))
308 #define M_BNE(a)                emit_jcc(cd, CC_NE, (a))
309 #define M_BLT(a)                emit_jcc(cd, CC_L, (a))
310 #define M_BLE(a)                emit_jcc(cd, CC_LE, (a))
311 #define M_BGE(a)                emit_jcc(cd, CC_GE, (a))
312 #define M_BGT(a)                emit_jcc(cd, CC_G, (a))
313
314 #define M_BB(a)                 emit_jcc(cd, CC_B, (a))
315 #define M_BBE(a)                emit_jcc(cd, CC_BE, (a))
316 #define M_BAE(a)                emit_jcc(cd, CC_AE, (a))
317 #define M_BA(a)                 emit_jcc(cd, CC_A, (a))
318 #define M_BNS(a)                emit_jcc(cd, CC_NS, (a))
319
320 #define M_JMP(a)                emit_jmp_reg(cd, (a))
321 #define M_JMP_IMM(a)            emit_jmp_imm(cd, (a))
322
323 #define M_NOP                   emit_nop(cd)
324
325
326 #define M_FLD(a,b,disp)         emit_flds_membase(cd, (b), (disp))
327 #define M_DLD(a,b,disp)         emit_fldl_membase(cd, (b), (disp))
328
329 #define M_FLD32(a,b,disp)       emit_flds_membase32(cd, (b), (disp))
330 #define M_DLD32(a,b,disp)       emit_fldl_membase32(cd, (b), (disp))
331
332 #define M_FST(a,b,disp)         emit_fstps_membase(cd, (b), (disp))
333 #define M_DST(a,b,disp)         emit_fstpl_membase(cd, (b), (disp))
334
335 #define M_FSTNP(a,b,disp)       emit_fsts_membase(cd, (b), (disp))
336 #define M_DSTNP(a,b,disp)       emit_fstl_membase(cd, (b), (disp))
337
338
339 /* function gen_resolvebranch **************************************************
340
341     backpatches a branch instruction
342
343     parameters: ip ... pointer to instruction after branch (void*)
344                 so ... offset of instruction after branch  (s4)
345                 to ... offset of branch target             (s4)
346
347 *******************************************************************************/
348
349 #define gen_resolvebranch(ip,so,to) \
350     *((void **) ((ip) - 4)) = (void **) ((to) - (so));
351
352
353 #endif /* _CODEGEN_H */
354
355
356 /*
357  * These are local overrides for various environment variables in Emacs.
358  * Please do not remove this and leave it at the end of the file, where
359  * Emacs will automagically detect them.
360  * ---------------------------------------------------------------------
361  * Local variables:
362  * mode: c
363  * indent-tabs-mode: t
364  * c-basic-offset: 4
365  * tab-width: 4
366  * End:
367  */