* src/vm/jit/i386/codegen.c (GETFIELD, PUTFIELD, PUTFIELDCONST): Use
[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 4611 2006-03-15 11:18:30Z twisti $
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 /* gen_nullptr_check(objreg) */
70
71 #define gen_nullptr_check(objreg) \
72         if (checknull) { \
73         i386_test_reg_reg(cd, (objreg), (objreg)); \
74         i386_jcc(cd, I386_CC_E, 0); \
75             codegen_addxnullrefs(cd, cd->mcodeptr); \
76         }
77
78 #define gen_bound_check \
79     if (checkbounds) { \
80         i386_alu_membase_reg(cd, ALU_CMP, s1, OFFSET(java_arrayheader, size), s2); \
81         i386_jcc(cd, I386_CC_AE, 0); \
82         codegen_addxboundrefs(cd, cd->mcodeptr, s2); \
83     }
84
85 #define gen_div_check(v) \
86     if (checknull) { \
87         if ((v)->flags & INMEMORY) { \
88             i386_alu_imm_membase(cd, ALU_CMP, 0, REG_SP, src->regoff * 4); \
89         } else { \
90             i386_test_reg_reg(cd, src->regoff, src->regoff); \
91         } \
92         i386_jcc(cd, I386_CC_E, 0); \
93         codegen_addxdivrefs(cd, cd->mcodeptr); \
94     }
95
96
97 /* MCODECHECK(icnt) */
98
99 #define MCODECHECK(icnt) \
100         if ((cd->mcodeptr + (icnt)) > (u1 *) cd->mcodeend) \
101         cd->mcodeptr = (u1 *) codegen_increase(cd, cd->mcodeptr)
102
103
104 /* M_INTMOVE:
105      generates an integer-move from register a to b.
106      if a and b are the same int-register, no code will be generated.
107 */ 
108
109 #define M_INTMOVE(reg,dreg) \
110     if ((reg) != (dreg)) { \
111         i386_mov_reg_reg(cd, (reg),(dreg)); \
112     }
113
114
115 /* M_FLTMOVE:
116     generates a floating-point-move from register a to b.
117     if a and b are the same float-register, no code will be generated
118 */
119
120 #define M_FLTMOVE(reg,dreg) \
121     do { \
122         log_text("M_FLTMOVE"); \
123         assert(0); \
124     } while (0)
125
126
127 #define M_LNGMEMMOVE(reg,dreg) \
128     do { \
129         i386_mov_membase_reg(cd, REG_SP, (reg) * 4, REG_ITMP1); \
130         i386_mov_reg_membase(cd, REG_ITMP1, REG_SP, (dreg) * 4); \
131         i386_mov_membase_reg(cd, REG_SP, (reg) * 4 + 4, REG_ITMP1); \
132         i386_mov_reg_membase(cd, REG_ITMP1, REG_SP, (dreg) * 4 + 4); \
133     } while (0)
134
135
136 /* var_to_reg_xxx:
137     this function generates code to fetch data from a pseudo-register
138     into a real register. 
139     If the pseudo-register has actually been assigned to a real 
140     register, no code will be emitted, since following operations
141     can use this register directly.
142     
143     v: pseudoregister to be fetched from
144     tempregnum: temporary register to be used if v is actually spilled to ram
145
146     return: the register number, where the operand can be found after 
147             fetching (this wil be either tempregnum or the register
148             number allready given to v)
149 */
150
151 #define var_to_reg_int(regnr,v,tempnr) \
152     do { \
153         if ((v)->flags & INMEMORY) { \
154             COUNT_SPILLS; \
155             M_ILD(tempnr, REG_SP, (v)->regoff * 4); \
156             regnr = tempnr; \
157         } else { \
158             regnr = (v)->regoff; \
159         } \
160     } while (0)
161
162 #define var_to_reg_lng(regnr,v,tempnr) \
163     do { \
164         if ((v)->flags & INMEMORY) { \
165             COUNT_SPILLS; \
166             M_LLD(tempnr, REG_SP, (v)->regoff * 4); \
167             regnr = tempnr; \
168         } else { \
169             regnr = (v)->regoff; \
170         } \
171     } while (0)
172
173 #define var_to_reg_flt(regnr,v,tempnr) \
174     if ((v)->type == TYPE_FLT) { \
175         if ((v)->flags & INMEMORY) { \
176             COUNT_SPILLS; \
177             i386_flds_membase(cd, REG_SP, (v)->regoff * 4); \
178             fpu_st_offset++; \
179             regnr = tempnr; \
180         } else { \
181             i386_fld_reg(cd, (v)->regoff + fpu_st_offset); \
182             fpu_st_offset++; \
183             regnr = (v)->regoff; \
184         } \
185     } else { \
186         if ((v)->flags & INMEMORY) { \
187             COUNT_SPILLS; \
188             i386_fldl_membase(cd, REG_SP, (v)->regoff * 4); \
189             fpu_st_offset++; \
190             regnr = tempnr; \
191         } else { \
192             i386_fld_reg(cd, (v)->regoff + fpu_st_offset); \
193             fpu_st_offset++; \
194             regnr = (v)->regoff; \
195         } \
196     }
197
198 #define NEW_var_to_reg_flt(regnr,v,tempnr) \
199     if ((v)->type == TYPE_FLT) { \
200        if ((v)->flags & INMEMORY) { \
201             COUNT_SPILLS; \
202             i386_flds_membase(cd, REG_SP, (v)->regoff * 4); \
203             fpu_st_offset++; \
204             regnr = tempnr; \
205         } else { \
206             regnr = (v)->regoff; \
207         } \
208     } else { \
209         if ((v)->flags & INMEMORY) { \
210             COUNT_SPILLS; \
211             i386_fldl_membase(cd, REG_SP, (v)->regoff * 4); \
212             fpu_st_offset++; \
213             regnr = tempnr; \
214         } else { \
215             regnr = (v)->regoff; \
216         } \
217     }
218
219
220 /* store_reg_to_var_xxx:
221     This function generates the code to store the result of an operation
222     back into a spilled pseudo-variable.
223     If the pseudo-variable has not been spilled in the first place, this 
224     function will generate nothing.
225     
226     v ............ Pseudovariable
227     tempregnum ... Number of the temporary registers as returned by
228                    reg_of_var.
229 */      
230
231 #define store_reg_to_var_int(sptr, tempregnum) \
232     if ((sptr)->flags & INMEMORY) { \
233         COUNT_SPILLS; \
234         M_IST(tempregnum, REG_SP, (sptr)->regoff * 4); \
235     }
236
237
238 #define store_reg_to_var_lng(sptr, tempregnum) \
239     if ((sptr)->flags & INMEMORY) { \
240         COUNT_SPILLS; \
241         M_LST(tempregnum, REG_SP, (sptr)->regoff * 4); \
242     }
243
244
245 #define store_reg_to_var_flt(sptr, tempregnum) \
246     if ((sptr)->type == TYPE_FLT) { \
247         if ((sptr)->flags & INMEMORY) { \
248              COUNT_SPILLS; \
249              i386_fstps_membase(cd, REG_SP, (sptr)->regoff * 4); \
250              fpu_st_offset--; \
251         } else { \
252 /*                  i386_fxch_reg((sptr)->regoff);*/ \
253              i386_fstp_reg(cd, (sptr)->regoff + fpu_st_offset); \
254              fpu_st_offset--; \
255         } \
256     } else { \
257         if ((sptr)->flags & INMEMORY) { \
258             COUNT_SPILLS; \
259             i386_fstpl_membase(cd, REG_SP, (sptr)->regoff * 4); \
260             fpu_st_offset--; \
261         } else { \
262 /*                  i386_fxch_reg((sptr)->regoff);*/ \
263             i386_fstp_reg(cd, (sptr)->regoff + fpu_st_offset); \
264             fpu_st_offset--; \
265         } \
266     }
267
268
269 #define M_COPY(from,to) \
270     d = reg_of_var(rd, to, REG_ITMP1); \
271         if ((from->regoff != to->regoff) || \
272             ((from->flags ^ to->flags) & INMEMORY)) { \
273                 if (IS_FLT_DBL_TYPE(from->type)) { \
274                         var_to_reg_flt(s1, from, d); \
275                         /*M_FLTMOVE(s1, d);*/ \
276                         store_reg_to_var_flt(to, d); \
277                 } else { \
278             if (!IS_2_WORD_TYPE(from->type)) { \
279                 if (to->flags & INMEMORY) { \
280                      if (from->flags & INMEMORY) { \
281                          i386_mov_membase_reg(cd, REG_SP, from->regoff * 4, REG_ITMP1); \
282                          i386_mov_reg_membase(cd, REG_ITMP1, REG_SP, to->regoff * 4); \
283                      } else { \
284                          i386_mov_reg_membase(cd, from->regoff, REG_SP, to->regoff * 4); \
285                      } \
286                 } else { \
287                      if (from->flags & INMEMORY) { \
288                          i386_mov_membase_reg(cd, REG_SP, from->regoff * 4, to->regoff); \
289                      } else { \
290                          i386_mov_reg_reg(cd, from->regoff, to->regoff); \
291                      } \
292                 } \
293             } else { \
294                 M_LNGMEMMOVE(from->regoff, to->regoff); \
295             } \
296                 } \
297         }
298
299 /* macros to create code ******************************************************/
300
301 typedef enum {
302     REG_AL = 0,
303     REG_CL = 1,
304     REG_DL = 2,
305     REG_BL = 3,
306     REG_AH = 4,
307     REG_CH = 5,
308     REG_DH = 6,
309     REG_BH = 7,
310     REG_NREGB
311 } I386_RegB_No;
312
313
314 /* opcodes for alu instructions */
315
316 typedef enum {
317     ALU_ADD = 0,
318     ALU_OR  = 1,
319     ALU_ADC = 2,
320     ALU_SBB = 3,
321     ALU_AND = 4,
322     ALU_SUB = 5,
323     ALU_XOR = 6,
324     ALU_CMP = 7,
325     ALU_NALU
326 } I386_ALU_Opcode;
327
328 typedef enum {
329     I386_ROL = 0,
330     I386_ROR = 1,
331     I386_RCL = 2,
332     I386_RCR = 3,
333     I386_SHL = 4,
334     I386_SHR = 5,
335     I386_SAR = 7,
336     I386_NSHIFT = 8
337 } I386_Shift_Opcode;
338
339 typedef enum {
340     I386_CC_O = 0,
341     I386_CC_NO = 1,
342     I386_CC_B = 2, I386_CC_C = 2, I386_CC_NAE = 2,
343     I386_CC_BE = 6, I386_CC_NA = 6,
344     I386_CC_AE = 3, I386_CC_NB = 3, I386_CC_NC = 3,
345     I386_CC_E = 4, I386_CC_Z = 4,
346     I386_CC_NE = 5, I386_CC_NZ = 5,
347     I386_CC_A = 7, I386_CC_NBE = 7,
348     I386_CC_S = 8, I386_CC_LZ = 8,
349     I386_CC_NS = 9, I386_CC_GEZ = 9,
350     I386_CC_P = 0x0a, I386_CC_PE = 0x0a,
351     I386_CC_NP = 0x0b, I386_CC_PO = 0x0b,
352     I386_CC_L = 0x0c, I386_CC_NGE = 0x0c,
353     I386_CC_GE = 0x0d, I386_CC_NL = 0x0d,
354     I386_CC_LE = 0x0e, I386_CC_NG = 0x0e,
355     I386_CC_G = 0x0f, I386_CC_NLE = 0x0f,
356     I386_NCC
357 } I386_CC;
358
359
360 /* modrm and stuff */
361
362 #define i386_address_byte(mod,reg,rm) \
363     *(cd->mcodeptr++) = ((((mod) & 0x03) << 6) | (((reg) & 0x07) << 3) | (((rm) & 0x07)));
364
365
366 #define i386_emit_reg(reg,rm) \
367     i386_address_byte(3,(reg),(rm));
368
369
370 #define i386_is_imm8(imm) \
371     (((int)(imm) >= -128 && (int)(imm) <= 127))
372
373
374 #define i386_emit_imm8(imm) \
375     *(cd->mcodeptr++) = (u1) ((imm) & 0xff);
376
377
378 #define i386_emit_imm16(imm) \
379     do { \
380         imm_union imb; \
381         imb.i = (int) (imm); \
382         *(cd->mcodeptr++) = imb.b[0]; \
383         *(cd->mcodeptr++) = imb.b[1]; \
384     } while (0)
385
386
387 #define i386_emit_imm32(imm) \
388     do { \
389         imm_union imb; \
390         imb.i = (int) (imm); \
391         *(cd->mcodeptr++) = imb.b[0]; \
392         *(cd->mcodeptr++) = imb.b[1]; \
393         *(cd->mcodeptr++) = imb.b[2]; \
394         *(cd->mcodeptr++) = imb.b[3]; \
395     } while (0)
396
397
398 #define i386_emit_mem(r,mem) \
399     do { \
400         i386_address_byte(0,(r),5); \
401         i386_emit_imm32((mem)); \
402     } while (0)
403
404
405 #define i386_emit_membase(basereg,disp,dreg) \
406     do { \
407         if ((basereg) == ESP) { \
408             if ((disp) == 0) { \
409                 i386_address_byte(0, (dreg), ESP); \
410                 i386_address_byte(0, ESP, ESP); \
411             } else if (i386_is_imm8((disp))) { \
412                 i386_address_byte(1, (dreg), ESP); \
413                 i386_address_byte(0, ESP, ESP); \
414                 i386_emit_imm8((disp)); \
415             } else { \
416                 i386_address_byte(2, (dreg), ESP); \
417                 i386_address_byte(0, ESP, ESP); \
418                 i386_emit_imm32((disp)); \
419             } \
420             break; \
421         } \
422         \
423         if ((disp) == 0 && (basereg) != EBP) { \
424             i386_address_byte(0, (dreg), (basereg)); \
425             break; \
426         } \
427         \
428         if (i386_is_imm8((disp))) { \
429             i386_address_byte(1, (dreg), (basereg)); \
430             i386_emit_imm8((disp)); \
431         } else { \
432             i386_address_byte(2, (dreg), (basereg)); \
433             i386_emit_imm32((disp)); \
434         } \
435     } while (0)
436
437
438 #define i386_emit_membase32(basereg,disp,dreg) \
439     do { \
440         if ((basereg) == ESP) { \
441             i386_address_byte(2, (dreg), ESP); \
442             i386_address_byte(0, ESP, ESP); \
443             i386_emit_imm32((disp)); \
444         } else { \
445             i386_address_byte(2, (dreg), (basereg)); \
446             i386_emit_imm32((disp)); \
447         } \
448     } while (0)
449
450
451 #define i386_emit_memindex(reg,disp,basereg,indexreg,scale) \
452     do { \
453         if ((basereg) == -1) { \
454             i386_address_byte(0, (reg), 4); \
455             i386_address_byte((scale), (indexreg), 5); \
456             i386_emit_imm32((disp)); \
457         \
458         } else if ((disp) == 0 && (basereg) != EBP) { \
459             i386_address_byte(0, (reg), 4); \
460             i386_address_byte((scale), (indexreg), (basereg)); \
461         \
462         } else if (i386_is_imm8((disp))) { \
463             i386_address_byte(1, (reg), 4); \
464             i386_address_byte((scale), (indexreg), (basereg)); \
465             i386_emit_imm8 ((disp)); \
466         \
467         } else { \
468             i386_address_byte(2, (reg), 4); \
469             i386_address_byte((scale), (indexreg), (basereg)); \
470             i386_emit_imm32((disp)); \
471         }    \
472      } while (0)
473
474
475 /* macros to create code ******************************************************/
476
477 #define M_ILD(a,b,disp)         i386_mov_membase_reg(cd, (b), (disp), (a))
478 #define M_ALD(a,b,disp)         M_ILD(a,b,disp)
479
480 #define M_ILD32(a,b,disp)       i386_mov_membase32_reg(cd, (b), (disp), (a))
481
482 #define M_LLD(a,b,disp) \
483     do { \
484         M_ILD(GET_LOW_REG(a),b,disp); \
485         M_ILD(GET_HIGH_REG(a),b,disp + 4); \
486     } while (0)
487
488 #define M_LLD32(a,b,disp) \
489     do { \
490         M_ILD32(GET_LOW_REG(a),b,disp); \
491         M_ILD32(GET_HIGH_REG(a),b,disp + 4); \
492     } while (0)
493
494 #define M_IST(a,b,disp)         i386_mov_reg_membase(cd, (a), (b), (disp))
495 #define M_IST_IMM(a,b,disp)     i386_mov_imm_membase(cd, (a), (b), (disp))
496 #define M_AST(a,b,disp)         M_IST(a,b,disp)
497 #define M_AST_IMM(a,b,disp)     M_IST_IMM(a,b,disp)
498
499 #define M_IST32(a,b,disp)       i386_mov_reg_membase32(cd, (a), (b), (disp))
500 #define M_IST32_IMM(a,b,disp)   i386_mov_imm_membase32(cd, (a), (b), (disp))
501
502 #define M_LST(a,b,disp) \
503     do { \
504         M_IST(GET_LOW_REG(a),b,disp); \
505         M_IST(GET_HIGH_REG(a),b,disp + 4); \
506     } while (0)
507
508 #define M_LST32(a,b,disp) \
509     do { \
510         M_IST32(GET_LOW_REG(a),b,disp); \
511         M_IST32(GET_HIGH_REG(a),b,disp + 4); \
512     } while (0)
513
514 #define M_LST_IMM(a,b,disp) \
515     do { \
516         M_IST_IMM(a,b,disp); \
517         M_IST_IMM(a >> 32,b,disp + 4); \
518     } while (0)
519
520 #define M_LST32_IMM(a,b,disp) \
521     do { \
522         M_IST32_IMM(a,b,disp); \
523         M_IST32_IMM(a >> 32,b,disp + 4); \
524     } while (0)
525
526 #define M_IADD_IMM(a,b)         i386_alu_imm_reg(cd, ALU_ADD, (a), (b))
527 #define M_IADD_IMM32(a,b)       i386_alu_imm32_reg(cd, ALU_ADD, (a), (b))
528 #define M_ISUB_IMM(a,b)         i386_alu_imm_reg(cd, ALU_SUB, (a), (b))
529
530 #define M_IADD_IMM_MEMBASE(a,b,c) i386_alu_imm_membase(cd, ALU_ADD, (a), (b), (c))
531
532 #define M_AADD_IMM(a,b)         M_IADD_IMM(a,b)
533 #define M_AADD_IMM32(a,b)       M_IADD_IMM32(a,b)
534 #define M_ASUB_IMM(a,b)         M_ISUB_IMM(a,b)
535
536 #define M_OR_MEMBASE(a,b,c)     i386_alu_membase_reg(cd, ALU_OR, (a), (b), (c))
537 #define M_XOR(a,b)              i386_alu_reg_reg(cd, ALU_XOR, (a), (b))
538 #define M_CLR(a)                M_XOR(a,a)
539
540 #define M_PUSH(a)               i386_push_reg(cd, (a))
541 #define M_PUSH_IMM(a)           i386_push_imm(cd, (a))
542 #define M_POP(a)                i386_pop_reg(cd, (a))
543
544 #define M_MOV(a,b)              i386_mov_reg_reg(cd, (a), (b))
545 #define M_MOV_IMM(a,b)          i386_mov_imm_reg(cd, (a), (b))
546
547 #define M_TEST(a)               i386_test_reg_reg(cd, (a), (a))
548
549 #define M_CALL(a)               i386_call_reg(cd, (a))
550 #define M_CALL_IMM(a)           i386_call_imm(cd, (a))
551 #define M_RET                   i386_ret(cd)
552
553 #define M_BEQ(a)                i386_jcc(cd, I386_CC_E, (a))
554 #define M_BNE(a)                i386_jcc(cd, I386_CC_NE, (a))
555 #define M_BLT(a)                i386_jcc(cd, I386_CC_L, (a))
556 #define M_BLE(a)                i386_jcc(cd, I386_CC_LE, (a))
557 #define M_BGE(a)                i386_jcc(cd, I386_CC_GE, (a))
558 #define M_BGT(a)                i386_jcc(cd, I386_CC_G, (a))
559
560 #define M_BBE(a)                i386_jcc(cd, I386_CC_BE, (a))
561 #define M_BAE(a)                i386_jcc(cd, I386_CC_AE, (a))
562
563 #define M_JMP(a)                i386_jmp_reg(cd, (a))
564 #define M_JMP_IMM(a)            i386_jmp_imm(cd, (a))
565
566 #define M_NOP                   i386_nop(cd)
567
568
569 /* function gen_resolvebranch **************************************************
570
571     backpatches a branch instruction
572
573     parameters: ip ... pointer to instruction after branch (void*)
574                 so ... offset of instruction after branch  (s4)
575                 to ... offset of branch target             (s4)
576
577 *******************************************************************************/
578
579 #define gen_resolvebranch(ip,so,to) \
580     *((void **) ((ip) - 4)) = (void **) ((to) - (so));
581
582
583 #endif /* _CODEGEN_H */
584
585
586 /*
587  * These are local overrides for various environment variables in Emacs.
588  * Please do not remove this and leave it at the end of the file, where
589  * Emacs will automagically detect them.
590  * ---------------------------------------------------------------------
591  * Local variables:
592  * mode: c
593  * indent-tabs-mode: t
594  * c-basic-offset: 4
595  * tab-width: 4
596  * End:
597  */