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 4389 2006-01-30 16:25:20Z 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     if ((v)->flags & INMEMORY) { \
 153         COUNT_SPILLS; \
 154         i386_mov_membase_reg(cd, REG_SP, (v)->regoff * 4, tempnr); \
 155         regnr = tempnr; \
 156     } else { \
 157         regnr = (v)->regoff; \
 158     }
 159
 160
 161
 162 #define var_to_reg_flt(regnr,v,tempnr) \
 163     if ((v)->type == TYPE_FLT) { \
 164         if ((v)->flags & INMEMORY) { \
 165             COUNT_SPILLS; \
 166             i386_flds_membase(cd, REG_SP, (v)->regoff * 4); \
 167             fpu_st_offset++; \
 168             regnr = tempnr; \
 169         } else { \
 170             i386_fld_reg(cd, (v)->regoff + fpu_st_offset); \
 171             fpu_st_offset++; \
 172             regnr = (v)->regoff; \
 173         } \
 174     } else { \
 175         if ((v)->flags & INMEMORY) { \
 176             COUNT_SPILLS; \
 177             i386_fldl_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     }
 186
 187 #define NEW_var_to_reg_flt(regnr,v,tempnr) \
 188     if ((v)->type == TYPE_FLT) { \
 189        if ((v)->flags & INMEMORY) { \
 190             COUNT_SPILLS; \
 191             i386_flds_membase(cd, REG_SP, (v)->regoff * 4); \
 192             fpu_st_offset++; \
 193             regnr = tempnr; \
 194         } else { \
 195             regnr = (v)->regoff; \
 196         } \
 197     } else { \
 198         if ((v)->flags & INMEMORY) { \
 199             COUNT_SPILLS; \
 200             i386_fldl_membase(cd, REG_SP, (v)->regoff * 4); \
 201             fpu_st_offset++; \
 202             regnr = tempnr; \
 203         } else { \
 204             regnr = (v)->regoff; \
 205         } \
 206     }
 207
 208
 209 /* store_reg_to_var_xxx:
 210     This function generates the code to store the result of an operation
 211     back into a spilled pseudo-variable.
 212     If the pseudo-variable has not been spilled in the first place, this
 213     function will generate nothing.
 214
 215     v ............ Pseudovariable
 216     tempregnum ... Number of the temporary registers as returned by
 217                    reg_of_var.
 218 */
 219
 220 #define store_reg_to_var_int(sptr, tempregnum) \
 221     if ((sptr)->flags & INMEMORY) { \
 222         COUNT_SPILLS; \
 223         i386_mov_reg_membase(cd, tempregnum, REG_SP, (sptr)->regoff * 4); \
 224     }
 225
 226
 227 #define store_reg_to_var_flt(sptr, tempregnum) \
 228     if ((sptr)->type == TYPE_FLT) { \
 229         if ((sptr)->flags & INMEMORY) { \
 230              COUNT_SPILLS; \
 231              i386_fstps_membase(cd, REG_SP, (sptr)->regoff * 4); \
 232              fpu_st_offset--; \
 233         } else { \
 234 /*                  i386_fxch_reg((sptr)->regoff);*/ \
 235              i386_fstp_reg(cd, (sptr)->regoff + fpu_st_offset); \
 236              fpu_st_offset--; \
 237         } \
 238     } else { \
 239         if ((sptr)->flags & INMEMORY) { \
 240             COUNT_SPILLS; \
 241             i386_fstpl_membase(cd, REG_SP, (sptr)->regoff * 4); \
 242             fpu_st_offset--; \
 243         } else { \
 244 /*                  i386_fxch_reg((sptr)->regoff);*/ \
 245             i386_fstp_reg(cd, (sptr)->regoff + fpu_st_offset); \
 246             fpu_st_offset--; \
 247         } \
 248     }
 249
 250
 251 #define M_COPY(from,to) \
 252     d = reg_of_var(rd, to, REG_ITMP1); \
 253         if ((from->regoff != to->regoff) || \
 254             ((from->flags ^ to->flags) & INMEMORY)) { \
 255                 if (IS_FLT_DBL_TYPE(from->type)) { \
 256                         var_to_reg_flt(s1, from, d); \
 257                         /*M_FLTMOVE(s1, d);*/ \
 258                         store_reg_to_var_flt(to, d); \
 259                 } else { \
 260             if (!IS_2_WORD_TYPE(from->type)) { \
 261                 if (to->flags & INMEMORY) { \
 262                      if (from->flags & INMEMORY) { \
 263                          i386_mov_membase_reg(cd, REG_SP, from->regoff * 4, REG_ITMP1); \
 264                          i386_mov_reg_membase(cd, REG_ITMP1, REG_SP, to->regoff * 4); \
 265                      } else { \
 266                          i386_mov_reg_membase(cd, from->regoff, REG_SP, to->regoff * 4); \
 267                      } \
 268                 } else { \
 269                      if (from->flags & INMEMORY) { \
 270                          i386_mov_membase_reg(cd, REG_SP, from->regoff * 4, to->regoff); \
 271                      } else { \
 272                          i386_mov_reg_reg(cd, from->regoff, to->regoff); \
 273                      } \
 274                 } \
 275             } else { \
 276                 M_LNGMEMMOVE(from->regoff, to->regoff); \
 277             } \
 278                 } \
 279         }
 280
 281 /* macros to create code ******************************************************/
 282
 283 typedef enum {
 284     REG_AL = 0,
 285     REG_CL = 1,
 286     REG_DL = 2,
 287     REG_BL = 3,
 288     REG_AH = 4,
 289     REG_CH = 5,
 290     REG_DH = 6,
 291     REG_BH = 7,
 292     REG_NREGB
 293 } I386_RegB_No;
 294
 295
 296 /* opcodes for alu instructions */
 297
 298 typedef enum {
 299     ALU_ADD = 0,
 300     ALU_OR  = 1,
 301     ALU_ADC = 2,
 302     ALU_SBB = 3,
 303     ALU_AND = 4,
 304     ALU_SUB = 5,
 305     ALU_XOR = 6,
 306     ALU_CMP = 7,
 307     ALU_NALU
 308 } I386_ALU_Opcode;
 309
 310 typedef enum {
 311     I386_ROL = 0,
 312     I386_ROR = 1,
 313     I386_RCL = 2,
 314     I386_RCR = 3,
 315     I386_SHL = 4,
 316     I386_SHR = 5,
 317     I386_SAR = 7,
 318     I386_NSHIFT = 8
 319 } I386_Shift_Opcode;
 320
 321 typedef enum {
 322     I386_CC_O = 0,
 323     I386_CC_NO = 1,
 324     I386_CC_B = 2, I386_CC_C = 2, I386_CC_NAE = 2,
 325     I386_CC_BE = 6, I386_CC_NA = 6,
 326     I386_CC_AE = 3, I386_CC_NB = 3, I386_CC_NC = 3,
 327     I386_CC_E = 4, I386_CC_Z = 4,
 328     I386_CC_NE = 5, I386_CC_NZ = 5,
 329     I386_CC_A = 7, I386_CC_NBE = 7,
 330     I386_CC_S = 8, I386_CC_LZ = 8,
 331     I386_CC_NS = 9, I386_CC_GEZ = 9,
 332     I386_CC_P = 0x0a, I386_CC_PE = 0x0a,
 333     I386_CC_NP = 0x0b, I386_CC_PO = 0x0b,
 334     I386_CC_L = 0x0c, I386_CC_NGE = 0x0c,
 335     I386_CC_GE = 0x0d, I386_CC_NL = 0x0d,
 336     I386_CC_LE = 0x0e, I386_CC_NG = 0x0e,
 337     I386_CC_G = 0x0f, I386_CC_NLE = 0x0f,
 338     I386_NCC
 339 } I386_CC;
 340
 341
 342 /* modrm and stuff */
 343
 344 #define i386_address_byte(mod,reg,rm) \
 345     *(cd->mcodeptr++) = ((((mod) & 0x03) << 6) | (((reg) & 0x07) << 3) | (((rm) & 0x07)));
 346
 347
 348 #define i386_emit_reg(reg,rm) \
 349     i386_address_byte(3,(reg),(rm));
 350
 351
 352 #define i386_is_imm8(imm) \
 353     (((int)(imm) >= -128 && (int)(imm) <= 127))
 354
 355
 356 #define i386_emit_imm8(imm) \
 357     *(cd->mcodeptr++) = (u1) ((imm) & 0xff);
 358
 359
 360 #define i386_emit_imm16(imm) \
 361     do { \
 362         imm_union imb; \
 363         imb.i = (int) (imm); \
 364         *(cd->mcodeptr++) = imb.b[0]; \
 365         *(cd->mcodeptr++) = imb.b[1]; \
 366     } while (0)
 367
 368
 369 #define i386_emit_imm32(imm) \
 370     do { \
 371         imm_union imb; \
 372         imb.i = (int) (imm); \
 373         *(cd->mcodeptr++) = imb.b[0]; \
 374         *(cd->mcodeptr++) = imb.b[1]; \
 375         *(cd->mcodeptr++) = imb.b[2]; \
 376         *(cd->mcodeptr++) = imb.b[3]; \
 377     } while (0)
 378
 379
 380 #define i386_emit_mem(r,mem) \
 381     do { \
 382         i386_address_byte(0,(r),5); \
 383         i386_emit_imm32((mem)); \
 384     } while (0)
 385
 386
 387 #define i386_emit_membase(basereg,disp,dreg) \
 388     do { \
 389         if ((basereg) == ESP) { \
 390             if ((disp) == 0) { \
 391                 i386_address_byte(0, (dreg), ESP); \
 392                 i386_address_byte(0, ESP, ESP); \
 393             } else if (i386_is_imm8((disp))) { \
 394                 i386_address_byte(1, (dreg), ESP); \
 395                 i386_address_byte(0, ESP, ESP); \
 396                 i386_emit_imm8((disp)); \
 397             } else { \
 398                 i386_address_byte(2, (dreg), ESP); \
 399                 i386_address_byte(0, ESP, ESP); \
 400                 i386_emit_imm32((disp)); \
 401             } \
 402             break; \
 403         } \
 404         \
 405         if ((disp) == 0 && (basereg) != EBP) { \
 406             i386_address_byte(0, (dreg), (basereg)); \
 407             break; \
 408         } \
 409         \
 410         if (i386_is_imm8((disp))) { \
 411             i386_address_byte(1, (dreg), (basereg)); \
 412             i386_emit_imm8((disp)); \
 413         } else { \
 414             i386_address_byte(2, (dreg), (basereg)); \
 415             i386_emit_imm32((disp)); \
 416         } \
 417     } while (0)
 418
 419
 420 #define i386_emit_membase32(basereg,disp,dreg) \
 421     do { \
 422         if ((basereg) == ESP) { \
 423             i386_address_byte(2, (dreg), ESP); \
 424             i386_address_byte(0, ESP, ESP); \
 425             i386_emit_imm32((disp)); \
 426         } else { \
 427             i386_address_byte(2, (dreg), (basereg)); \
 428             i386_emit_imm32((disp)); \
 429         } \
 430     } while (0)
 431
 432
 433 #define i386_emit_memindex(reg,disp,basereg,indexreg,scale) \
 434     do { \
 435         if ((basereg) == -1) { \
 436             i386_address_byte(0, (reg), 4); \
 437             i386_address_byte((scale), (indexreg), 5); \
 438             i386_emit_imm32((disp)); \
 439         \
 440         } else if ((disp) == 0 && (basereg) != EBP) { \
 441             i386_address_byte(0, (reg), 4); \
 442             i386_address_byte((scale), (indexreg), (basereg)); \
 443         \
 444         } else if (i386_is_imm8((disp))) { \
 445             i386_address_byte(1, (reg), 4); \
 446             i386_address_byte((scale), (indexreg), (basereg)); \
 447             i386_emit_imm8 ((disp)); \
 448         \
 449         } else { \
 450             i386_address_byte(2, (reg), 4); \
 451             i386_address_byte((scale), (indexreg), (basereg)); \
 452             i386_emit_imm32((disp)); \
 453         }    \
 454      } while (0)
 455
 456
 457 /* macros to create code ******************************************************/
 458
 459 #define M_ILD(a,b,disp)         i386_mov_membase_reg(cd, (b), (disp), (a))
 460 #define M_ALD(a,b,disp)         M_ILD(a,b,disp)
 461
 462 #define M_IST(a,b,disp)         i386_mov_reg_membase(cd, (a), (b), (disp))
 463 #define M_IST_IMM(a,b,disp)     i386_mov_imm_membase(cd, (a), (b), (disp))
 464 #define M_AST(a,b,disp)         M_IST(a,b,disp)
 465 #define M_AST_IMM(a,b,disp)     M_IST_IMM(a,b,disp)
 466
 467 #define M_IADD_IMM(a,b)         i386_alu_imm_reg(cd, ALU_ADD, (a), (b))
 468 #define M_IADD_IMM32(a,b)       i386_alu_imm32_reg(cd, ALU_ADD, (a), (b))
 469 #define M_ISUB_IMM(a,b)         i386_alu_imm_reg(cd, ALU_SUB, (a), (b))
 470
 471 #define M_IADD_IMM_MEMBASE(a,b,c) i386_alu_imm_membase(cd, ALU_ADD, (a), (b), (c))
 472
 473 #define M_AADD_IMM(a,b)         M_IADD_IMM(a,b)
 474 #define M_AADD_IMM32(a,b)       M_IADD_IMM32(a,b)
 475 #define M_ASUB_IMM(a,b)         M_ISUB_IMM(a,b)
 476
 477 #define M_OR_MEMBASE(a,b,c)     i386_alu_membase_reg(cd, ALU_OR, (a), (b), (c))
 478 #define M_XOR(a,b)              i386_alu_reg_reg(cd, ALU_XOR, (a), (b))
 479 #define M_CLR(a)                M_XOR(a,a)
 480
 481 #define M_PUSH(a)               i386_push_reg(cd, (a))
 482 #define M_PUSH_IMM(a)           i386_push_imm(cd, (a))
 483 #define M_POP(a)                i386_pop_reg(cd, (a))
 484
 485 #define M_MOV(a,b)              i386_mov_reg_reg(cd, (a), (b))
 486 #define M_MOV_IMM(a,b)          i386_mov_imm_reg(cd, (a), (b))
 487
 488 #define M_TEST(a)               i386_test_reg_reg(cd, (a), (a))
 489
 490 #define M_CALL(a)               i386_call_reg(cd, (a))
 491 #define M_CALL_IMM(a)           i386_call_imm(cd, (a))
 492 #define M_RET                   i386_ret(cd)
 493
 494 #define M_BEQ(a)                i386_jcc(cd, I386_CC_E, (a))
 495 #define M_BNE(a)                i386_jcc(cd, I386_CC_NE, (a))
 496 #define M_BLT(a)                i386_jcc(cd, I386_CC_L, (a))
 497 #define M_BLE(a)                i386_jcc(cd, I386_CC_LE, (a))
 498 #define M_BGE(a)                i386_jcc(cd, I386_CC_GE, (a))
 499 #define M_BGT(a)                i386_jcc(cd, I386_CC_G, (a))
 500
 501 #define M_BBE(a)                i386_jcc(cd, I386_CC_BE, (a))
 502 #define M_BAE(a)                i386_jcc(cd, I386_CC_AE, (a))
 503
 504 #define M_JMP(a)                i386_jmp_reg(cd, (a))
 505 #define M_JMP_IMM(a)            i386_jmp_imm(cd, (a))
 506
 507 #define M_NOP                   i386_nop(cd)
 508
 509
 510 /* function gen_resolvebranch **************************************************
 511
 512     backpatches a branch instruction
 513
 514     parameters: ip ... pointer to instruction after branch (void*)
 515                 so ... offset of instruction after branch  (s4)
 516                 to ... offset of branch target             (s4)
 517
 518 *******************************************************************************/
 519
 520 #define gen_resolvebranch(ip,so,to) \
 521     *((void **) ((ip) - 4)) = (void **) ((to) - (so));
 522
 523
 524 #endif /* _CODEGEN_H */
 525
 526
 527 /*
 528  * These are local overrides for various environment variables in Emacs.
 529  * Please do not remove this and leave it at the end of the file, where
 530  * Emacs will automagically detect them.
 531  * ---------------------------------------------------------------------
 532  * Local variables:
 533  * mode: c
 534  * indent-tabs-mode: t
 535  * c-basic-offset: 4
 536  * tab-width: 4
 537  * End:
 538  */