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 R. Grafl, A. Krall, C. Kruegel, C. Oates,
   4    R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
   5    C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
   6    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., 59 Temple Place - Suite 330, Boston, MA
  23    02111-1307, USA.
  24
  25    Contact: cacao@complang.tuwien.ac.at
  26
  27    Authors: Andreas Krall
  28             Christian Thalinger
  29
  30    Changes:
  31
  32    $Id: codegen.h 2971 2005-07-10 15:33:54Z twisti $
  33
  34 */
  35
  36
  37 #ifndef _CODEGEN_H
  38 #define _CODEGEN_H
  39
  40 #include <ucontext.h>
  41
  42 #ifdef LSRA
  43 /* let LSRA allocate reserved registers (REG_ITMP[1|2|3]) */
  44 #define LSRA_USES_REG_RES
  45 #endif
  46
  47 /* additional functions and macros to generate code ***************************/
  48
  49 #define BlockPtrOfPC(pc)  ((basicblock *) iptr->target)
  50
  51
  52 #ifdef STATISTICS
  53 #define COUNT_SPILLS count_spills++
  54 #else
  55 #define COUNT_SPILLS
  56 #endif
  57
  58
  59 #define CALCOFFSETBYTES(var, reg, val) \
  60     if ((s4) (val) < -128 || (s4) (val) > 127) (var) += 4; \
  61     else if ((s4) (val) != 0) (var) += 1; \
  62     else if ((reg) == EBP) (var) += 1;
  63
  64
  65 #define CALCIMMEDIATEBYTES(var, val) \
  66     if ((s4) (val) < -128 || (s4) (val) > 127) (var) += 4; \
  67     else (var) += 1;
  68
  69
  70 /* gen_nullptr_check(objreg) */
  71
  72 #define gen_nullptr_check(objreg) \
  73         if (checknull) { \
  74         i386_test_reg_reg(cd, (objreg), (objreg)); \
  75         i386_jcc(cd, I386_CC_E, 0); \
  76             codegen_addxnullrefs(cd, cd->mcodeptr); \
  77         }
  78
  79 #define gen_bound_check \
  80     if (checkbounds) { \
  81         i386_alu_membase_reg(cd, ALU_CMP, s1, OFFSET(java_arrayheader, size), s2); \
  82         i386_jcc(cd, I386_CC_AE, 0); \
  83         codegen_addxboundrefs(cd, cd->mcodeptr, s2); \
  84     }
  85
  86 #define gen_div_check(v) \
  87     if (checknull) { \
  88         if ((v)->flags & INMEMORY) { \
  89             i386_alu_imm_membase(cd, ALU_CMP, 0, REG_SP, src->regoff * 4); \
  90         } else { \
  91             i386_test_reg_reg(cd, src->regoff, src->regoff); \
  92         } \
  93         i386_jcc(cd, I386_CC_E, 0); \
  94         codegen_addxdivrefs(cd, cd->mcodeptr); \
  95     }
  96
  97
  98 /* MCODECHECK(icnt) */
  99
 100 #define MCODECHECK(icnt) \
 101         if ((cd->mcodeptr + (icnt)) > (u1 *) cd->mcodeend) \
 102         cd->mcodeptr = (u1 *) codegen_increase(cd, cd->mcodeptr)
 103
 104
 105 /* M_INTMOVE:
 106      generates an integer-move from register a to b.
 107      if a and b are the same int-register, no code will be generated.
 108 */
 109
 110 #define M_INTMOVE(reg,dreg) \
 111     if ((reg) != (dreg)) { \
 112         i386_mov_reg_reg(cd, (reg),(dreg)); \
 113     }
 114
 115
 116 /* M_FLTMOVE:
 117     generates a floating-point-move from register a to b.
 118     if a and b are the same float-register, no code will be generated
 119 */
 120
 121 #define M_FLTMOVE(reg,dreg) \
 122     do { \
 123         log_text("M_FLTMOVE"); \
 124         assert(0); \
 125     } while (0)
 126
 127
 128 #define M_LNGMEMMOVE(reg,dreg) \
 129     do { \
 130         i386_mov_membase_reg(cd, REG_SP, (reg) * 4, REG_ITMP1); \
 131         i386_mov_reg_membase(cd, REG_ITMP1, REG_SP, (dreg) * 4); \
 132         i386_mov_membase_reg(cd, REG_SP, (reg) * 4 + 4, REG_ITMP1); \
 133         i386_mov_reg_membase(cd, REG_ITMP1, REG_SP, (dreg) * 4 + 4); \
 134     } while (0)
 135
 136
 137 /* var_to_reg_xxx:
 138     this function generates code to fetch data from a pseudo-register
 139     into a real register.
 140     If the pseudo-register has actually been assigned to a real
 141     register, no code will be emitted, since following operations
 142     can use this register directly.
 143
 144     v: pseudoregister to be fetched from
 145     tempregnum: temporary register to be used if v is actually spilled to ram
 146
 147     return: the register number, where the operand can be found after
 148             fetching (this wil be either tempregnum or the register
 149             number allready given to v)
 150 */
 151
 152 #define var_to_reg_int(regnr,v,tempnr) \
 153     if ((v)->flags & INMEMORY) { \
 154         COUNT_SPILLS; \
 155         i386_mov_membase_reg(cd, REG_SP, (v)->regoff * 4, tempnr); \
 156         regnr = tempnr; \
 157     } else { \
 158         regnr = (v)->regoff; \
 159     }
 160
 161
 162
 163 #define var_to_reg_flt(regnr,v,tempnr) \
 164     if ((v)->type == TYPE_FLT) { \
 165         if ((v)->flags & INMEMORY) { \
 166             COUNT_SPILLS; \
 167             i386_flds_membase(cd, REG_SP, (v)->regoff * 4); \
 168             fpu_st_offset++; \
 169             regnr = tempnr; \
 170         } else { \
 171             i386_fld_reg(cd, (v)->regoff + fpu_st_offset); \
 172             fpu_st_offset++; \
 173             regnr = (v)->regoff; \
 174         } \
 175     } else { \
 176         if ((v)->flags & INMEMORY) { \
 177             COUNT_SPILLS; \
 178             i386_fldl_membase(cd, REG_SP, (v)->regoff * 4); \
 179             fpu_st_offset++; \
 180             regnr = tempnr; \
 181         } else { \
 182             i386_fld_reg(cd, (v)->regoff + fpu_st_offset); \
 183             fpu_st_offset++; \
 184             regnr = (v)->regoff; \
 185         } \
 186     }
 187
 188 #define NEW_var_to_reg_flt(regnr,v,tempnr) \
 189     if ((v)->type == TYPE_FLT) { \
 190        if ((v)->flags & INMEMORY) { \
 191             COUNT_SPILLS; \
 192             i386_flds_membase(cd, REG_SP, (v)->regoff * 4); \
 193             fpu_st_offset++; \
 194             regnr = tempnr; \
 195         } else { \
 196             regnr = (v)->regoff; \
 197         } \
 198     } else { \
 199         if ((v)->flags & INMEMORY) { \
 200             COUNT_SPILLS; \
 201             i386_fldl_membase(cd, REG_SP, (v)->regoff * 4); \
 202             fpu_st_offset++; \
 203             regnr = tempnr; \
 204         } else { \
 205             regnr = (v)->regoff; \
 206         } \
 207     }
 208
 209
 210 /* store_reg_to_var_xxx:
 211     This function generates the code to store the result of an operation
 212     back into a spilled pseudo-variable.
 213     If the pseudo-variable has not been spilled in the first place, this
 214     function will generate nothing.
 215
 216     v ............ Pseudovariable
 217     tempregnum ... Number of the temporary registers as returned by
 218                    reg_of_var.
 219 */
 220
 221 #define store_reg_to_var_int(sptr, tempregnum) \
 222     if ((sptr)->flags & INMEMORY) { \
 223         COUNT_SPILLS; \
 224         i386_mov_reg_membase(cd, tempregnum, REG_SP, (sptr)->regoff * 4); \
 225     }
 226
 227
 228 #define store_reg_to_var_flt(sptr, tempregnum) \
 229     if ((sptr)->type == TYPE_FLT) { \
 230         if ((sptr)->flags & INMEMORY) { \
 231              COUNT_SPILLS; \
 232              i386_fstps_membase(cd, REG_SP, (sptr)->regoff * 4); \
 233              fpu_st_offset--; \
 234         } else { \
 235 /*                  i386_fxch_reg((sptr)->regoff);*/ \
 236              i386_fstp_reg(cd, (sptr)->regoff + fpu_st_offset); \
 237              fpu_st_offset--; \
 238         } \
 239     } else { \
 240         if ((sptr)->flags & INMEMORY) { \
 241             COUNT_SPILLS; \
 242             i386_fstpl_membase(cd, REG_SP, (sptr)->regoff * 4); \
 243             fpu_st_offset--; \
 244         } else { \
 245 /*                  i386_fxch_reg((sptr)->regoff);*/ \
 246             i386_fstp_reg(cd, (sptr)->regoff + fpu_st_offset); \
 247             fpu_st_offset--; \
 248         } \
 249     }
 250
 251
 252 #define M_COPY(from,to) \
 253     d = reg_of_var(rd, to, REG_ITMP1); \
 254         if ((from->regoff != to->regoff) || \
 255             ((from->flags ^ to->flags) & INMEMORY)) { \
 256                 if (IS_FLT_DBL_TYPE(from->type)) { \
 257                         var_to_reg_flt(s1, from, d); \
 258                         /*M_FLTMOVE(s1, d);*/ \
 259                         store_reg_to_var_flt(to, d); \
 260                 } else { \
 261             if (!IS_2_WORD_TYPE(from->type)) { \
 262                 if (to->flags & INMEMORY) { \
 263                      if (from->flags & INMEMORY) { \
 264                          i386_mov_membase_reg(cd, REG_SP, from->regoff * 4, REG_ITMP1); \
 265                          i386_mov_reg_membase(cd, REG_ITMP1, REG_SP, to->regoff * 4); \
 266                      } else { \
 267                          i386_mov_reg_membase(cd, from->regoff, REG_SP, to->regoff * 4); \
 268                      } \
 269                 } else { \
 270                      if (from->flags & INMEMORY) { \
 271                          i386_mov_membase_reg(cd, REG_SP, from->regoff * 4, to->regoff); \
 272                      } else { \
 273                          i386_mov_reg_reg(cd, from->regoff, to->regoff); \
 274                      } \
 275                 } \
 276             } else { \
 277                 M_LNGMEMMOVE(from->regoff, to->regoff); \
 278             } \
 279                 } \
 280         }
 281
 282 /* macros to create code ******************************************************/
 283
 284 typedef enum {
 285     REG_AL = 0,
 286     REG_CL = 1,
 287     REG_DL = 2,
 288     REG_BL = 3,
 289     REG_AH = 4,
 290     REG_CH = 5,
 291     REG_DH = 6,
 292     REG_BH = 7,
 293     REG_NREGB
 294 } I386_RegB_No;
 295
 296
 297 /* opcodes for alu instructions */
 298
 299 typedef enum {
 300     ALU_ADD = 0,
 301     ALU_OR  = 1,
 302     ALU_ADC = 2,
 303     ALU_SBB = 3,
 304     ALU_AND = 4,
 305     ALU_SUB = 5,
 306     ALU_XOR = 6,
 307     ALU_CMP = 7,
 308     ALU_NALU
 309 } I386_ALU_Opcode;
 310
 311 typedef enum {
 312     I386_ROL = 0,
 313     I386_ROR = 1,
 314     I386_RCL = 2,
 315     I386_RCR = 3,
 316     I386_SHL = 4,
 317     I386_SHR = 5,
 318     I386_SAR = 7,
 319     I386_NSHIFT = 8
 320 } I386_Shift_Opcode;
 321
 322 typedef enum {
 323     I386_CC_O = 0,
 324     I386_CC_NO = 1,
 325     I386_CC_B = 2, I386_CC_C = 2, I386_CC_NAE = 2,
 326     I386_CC_BE = 6, I386_CC_NA = 6,
 327     I386_CC_AE = 3, I386_CC_NB = 3, I386_CC_NC = 3,
 328     I386_CC_E = 4, I386_CC_Z = 4,
 329     I386_CC_NE = 5, I386_CC_NZ = 5,
 330     I386_CC_A = 7, I386_CC_NBE = 7,
 331     I386_CC_S = 8, I386_CC_LZ = 8,
 332     I386_CC_NS = 9, I386_CC_GEZ = 9,
 333     I386_CC_P = 0x0a, I386_CC_PE = 0x0a,
 334     I386_CC_NP = 0x0b, I386_CC_PO = 0x0b,
 335     I386_CC_L = 0x0c, I386_CC_NGE = 0x0c,
 336     I386_CC_GE = 0x0d, I386_CC_NL = 0x0d,
 337     I386_CC_LE = 0x0e, I386_CC_NG = 0x0e,
 338     I386_CC_G = 0x0f, I386_CC_NLE = 0x0f,
 339     I386_NCC
 340 } I386_CC;
 341
 342
 343 /* modrm and stuff */
 344
 345 #define i386_address_byte(mod,reg,rm) \
 346     *(cd->mcodeptr++) = ((((mod) & 0x03) << 6) | (((reg) & 0x07) << 3) | (((rm) & 0x07)));
 347
 348
 349 #define i386_emit_reg(reg,rm) \
 350     i386_address_byte(3,(reg),(rm));
 351
 352
 353 #define i386_is_imm8(imm) \
 354     (((int)(imm) >= -128 && (int)(imm) <= 127))
 355
 356
 357 #define i386_emit_imm8(imm) \
 358     *(cd->mcodeptr++) = (u1) ((imm) & 0xff);
 359
 360
 361 #define i386_emit_imm16(imm) \
 362     do { \
 363         imm_union imb; \
 364         imb.i = (int) (imm); \
 365         *(cd->mcodeptr++) = imb.b[0]; \
 366         *(cd->mcodeptr++) = imb.b[1]; \
 367     } while (0)
 368
 369
 370 #define i386_emit_imm32(imm) \
 371     do { \
 372         imm_union imb; \
 373         imb.i = (int) (imm); \
 374         *(cd->mcodeptr++) = imb.b[0]; \
 375         *(cd->mcodeptr++) = imb.b[1]; \
 376         *(cd->mcodeptr++) = imb.b[2]; \
 377         *(cd->mcodeptr++) = imb.b[3]; \
 378     } while (0)
 379
 380
 381 #define i386_emit_mem(r,mem) \
 382     do { \
 383         i386_address_byte(0,(r),5); \
 384         i386_emit_imm32((mem)); \
 385     } while (0)
 386
 387
 388 #define i386_emit_membase(basereg,disp,dreg) \
 389     do { \
 390         if ((basereg) == ESP) { \
 391             if ((disp) == 0) { \
 392                 i386_address_byte(0, (dreg), ESP); \
 393                 i386_address_byte(0, ESP, ESP); \
 394             } else if (i386_is_imm8((disp))) { \
 395                 i386_address_byte(1, (dreg), ESP); \
 396                 i386_address_byte(0, ESP, ESP); \
 397                 i386_emit_imm8((disp)); \
 398             } else { \
 399                 i386_address_byte(2, (dreg), ESP); \
 400                 i386_address_byte(0, ESP, ESP); \
 401                 i386_emit_imm32((disp)); \
 402             } \
 403             break; \
 404         } \
 405         \
 406         if ((disp) == 0 && (basereg) != EBP) { \
 407             i386_address_byte(0, (dreg), (basereg)); \
 408             break; \
 409         } \
 410         \
 411         if (i386_is_imm8((disp))) { \
 412             i386_address_byte(1, (dreg), (basereg)); \
 413             i386_emit_imm8((disp)); \
 414         } else { \
 415             i386_address_byte(2, (dreg), (basereg)); \
 416             i386_emit_imm32((disp)); \
 417         } \
 418     } while (0)
 419
 420
 421 #define i386_emit_membase32(basereg,disp,dreg) \
 422     do { \
 423         if ((basereg) == ESP) { \
 424             i386_address_byte(2, (dreg), ESP); \
 425             i386_address_byte(0, ESP, ESP); \
 426             i386_emit_imm32((disp)); \
 427         } else { \
 428             i386_address_byte(2, (dreg), (basereg)); \
 429             i386_emit_imm32((disp)); \
 430         } \
 431     } while (0)
 432
 433
 434 #define i386_emit_memindex(reg,disp,basereg,indexreg,scale) \
 435     do { \
 436         if ((basereg) == -1) { \
 437             i386_address_byte(0, (reg), 4); \
 438             i386_address_byte((scale), (indexreg), 5); \
 439             i386_emit_imm32((disp)); \
 440         \
 441         } else if ((disp) == 0 && (basereg) != EBP) { \
 442             i386_address_byte(0, (reg), 4); \
 443             i386_address_byte((scale), (indexreg), (basereg)); \
 444         \
 445         } else if (i386_is_imm8((disp))) { \
 446             i386_address_byte(1, (reg), 4); \
 447             i386_address_byte((scale), (indexreg), (basereg)); \
 448             i386_emit_imm8 ((disp)); \
 449         \
 450         } else { \
 451             i386_address_byte(2, (reg), 4); \
 452             i386_address_byte((scale), (indexreg), (basereg)); \
 453             i386_emit_imm32((disp)); \
 454         }    \
 455      } while (0)
 456
 457
 458 /* macros to create code ******************************************************/
 459
 460 #define M_ILD(a,b,disp)         i386_mov_membase_reg(cd, (b), (disp), (a))
 461 #define M_ALD(a,b,disp)         M_ILD(a,b,disp)
 462
 463 #define M_IST(a,b,disp)         i386_mov_reg_membase(cd, (a), (b), (disp))
 464 #define M_IST_IMM(a,b,disp)     i386_mov_imm_membase(cd, (a), (b), (disp))
 465 #define M_AST(a,b,disp)         M_IST(a,b,disp)
 466 #define M_AST_IMM(a,b,disp)     M_IST_IMM(a,b,disp)
 467
 468 #define M_IADD_IMM(a,b)         i386_alu_imm_reg(cd, ALU_ADD, (a), (b))
 469 #define M_IADD_IMM32(a,b)       i386_alu_imm32_reg(cd, ALU_ADD, (a), (b))
 470 #define M_ISUB_IMM(a,b)         i386_alu_imm_reg(cd, ALU_SUB, (a), (b))
 471
 472 #define M_AADD_IMM(a,b)         M_IADD_IMM(a,b)
 473 #define M_AADD_IMM32(a,b)       M_IADD_IMM32(a,b)
 474 #define M_ASUB_IMM(a,b)         M_ISUB_IMM(a,b)
 475
 476 #define M_OR_MEMBASE(a,b,c)     i386_alu_membase_reg(cd, ALU_OR, (a), (b), (c))
 477
 478 #define M_PUSH(a)               i386_push_reg(cd, (a))
 479 #define M_PUSH_IMM(a)           i386_push_imm(cd, (a))
 480 #define M_POP(a)                i386_pop_reg(cd, (a))
 481
 482 #define M_MOV(a,b)              i386_mov_reg_reg(cd, (a), (b))
 483 #define M_MOV_IMM(a,b)          i386_mov_imm_reg(cd, (a), (b))
 484
 485 #define M_TEST(a)               i386_test_reg_reg(cd, (a), (a))
 486
 487 #define M_CALL(a)               i386_call_reg(cd, (a))
 488 #define M_RET                   i386_ret(cd)
 489
 490 #define M_BEQ(a)                i386_jcc(cd, I386_CC_E, (a))
 491
 492 #define M_JMP(a)                i386_jmp_reg(cd, (a))
 493 #define M_JMP_IMM(a)            i386_jmp_imm(cd, (a))
 494
 495 #define M_NOP                   i386_nop(cd)
 496
 497
 498 /* function gen_resolvebranch **************************************************
 499
 500     backpatches a branch instruction
 501
 502     parameters: ip ... pointer to instruction after branch (void*)
 503                 so ... offset of instruction after branch  (s4)
 504                 to ... offset of branch target             (s4)
 505
 506 *******************************************************************************/
 507
 508 #define gen_resolvebranch(ip,so,to) \
 509     *((void **) ((ip) - 4)) = (void **) ((to) - (so));
 510
 511
 512 /* function prototypes */
 513
 514 void thread_restartcriticalsection(ucontext_t *);
 515
 516 #endif /* _CODEGEN_H */
 517
 518
 519 /*
 520  * These are local overrides for various environment variables in Emacs.
 521  * Please do not remove this and leave it at the end of the file, where
 522  * Emacs will automagically detect them.
 523  * ---------------------------------------------------------------------
 524  * Local variables:
 525  * mode: c
 526  * indent-tabs-mode: t
 527  * c-basic-offset: 4
 528  * tab-width: 4
 529  * End:
 530  */