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