src/vm/jit/m68k/codegen.h

   1 /* src/vm/jit/m68k/codegen.h
   2
   3    Copyright (C) 1996-2005, 2006, 2007 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    $Id: arch.h 5330 2006-09-05 18:43:12Z edwin $
  26
  27 */
  28
  29
  30 #ifndef _CODEGEN_H
  31 #define _CODEGEN_H
  32
  33 #include "config.h"
  34
  35 #include <stdint.h>
  36
  37 #include "md-abi.h"
  38 #include "vm/jit/m68k/emit.h"
  39
  40
  41 #define MCODECHECK(icnt) \
  42     do { \
  43         if ((cd->mcodeptr + (icnt) * 4) > cd->mcodeend) \
  44             codegen_increase(cd); \
  45     } while (0)
  46
  47
  48 #define PATCHER_NOPS \
  49         do { M_TPFL; M_TPF; M_TPF } while (0);
  50
  51 #define BRANCH_NOPS \
  52     do { \
  53         if (CODEGENDATA_HAS_FLAG_LONGBRANCHES(cd)) { \
  54             M_NOP; \
  55             M_NOP; \
  56             M_NOP; \
  57         } else { \
  58             M_NOP; \
  59             M_NOP; \
  60         } \
  61     } while (0)
  62
  63
  64 /* coldfire instruction format:
  65  * -----------------------------
  66  * | Op Word                    |
  67  * |____________________________|
  68  * | extension word 1(optional) |
  69  * |____________________________|
  70  * | extension word 2(optional) |
  71  * |____________________________|
  72  *
  73  *
  74  * Opword:
  75  *
  76  *                     | effective addr
  77  *                     |  mode |  reg.
  78  * x x x x x x x x x x | M M M | R R R
  79  *
  80  * MMM = 000 ---> data register   direct: RRR = register
  81  * MMM = 001 ---> addr register   direct: RRR = register
  82  * MMM = 010 ---> addr register indirect: RRR = register
  83  * MMM = 011 ---> addr reg ind postincr : RRR = register
  84  * MMM = 100 ---> addr reg ind predecr  : RRR = register
  85  * MMM = 101 ---> addr reg ind + displac: RRR = register + ext.wrd.1
  86  * MMM = 110 ---> addr reg ind + scaled index and 8 bit displacement
  87  * MMM = 111, RRR = 010 ---> PC ind. with displacement + ext.wrd.1
  88  * MMM = 111, RRR = 011 ---> PC ind. with scaled inex + 8but displacement
  89  * MMM = 111, RRR = 000 + ext.wrd.1 ---> absolute short
  90  * MMM = 111, RRR = 001 + ext.wrd.1+2 -> absolute long
  91  * MMM = 111, RRR = 100 + ext.wrd1/2 --> immediate data
  92  */
  93
  94 /* one word opcodes */
  95 #define OPWORD(op, mode, reg) \
  96         do { \
  97                 *((u2*)cd->mcodeptr) = (u2) (((op) << 6) | ((mode)<<3) | (reg)); \
  98                 cd->mcodeptr += 2; \
  99         } while(0);
 100 /* opword + one extension word */
 101 /* usage of int16_t instead of s2 as is clashes with variable name */
 102 #define OPWORD_IMM16(op, mode, reg, imm) \
 103         do { \
 104                 *((u2*)cd->mcodeptr) = (u2) (((op) << 6) | ((mode)<<3) | (reg)); \
 105                 cd->mcodeptr += 2; \
 106                 *((int16_t*)(cd->mcodeptr)) = imm; \
 107                 cd->mcodeptr += 2; \
 108         } while(0);
 109
 110 /* opword + two extension words */
 111 /* usage of int32_t instead of s4 as is clashes with variable name */
 112 #define OPWORD_IMM32(op, mode, reg, imm) \
 113         do { \
 114                 *((u2*)cd->mcodeptr) = (u2) (((op) << 6) | ((mode)<<3) | (reg)); \
 115                 cd->mcodeptr += 2; \
 116                 *((int32_t*)(cd->mcodeptr)) = imm; \
 117                 cd->mcodeptr += 4; \
 118         } while(0);
 119
 120 /* create NOPS to align basicblock boundaries
 121  * using real nops here as they are not executed, so no performance penalty
 122  **/
 123 #define ALIGNCODENOP \
 124     do { \
 125         for (s1 = 0; s1 < (s4) (((ptrint) cd->mcodeptr) & 7); s1++) \
 126             M_NOP; \
 127     } while (0)
 128
 129
 130
 131 #define PATCHER_CALL_SIZE       6
 132
 133 #define M_NOP           OPWORD(0x139,6,1)                               /* 0x4371 do not use as it syncs pipeline */
 134 #define M_ILLEGAL       OPWORD(0x12b,7,4)                               /* 0x4afc */
 135 #define M_TPF           OPWORD(0x147,7,4)                               /* tfp with no  ext. word use instead of NOP*/
 136 #define M_TPFW          OPWORD(0x147,7,2)                               /* tfp with one ext. word */
 137 #define M_TPFL          OPWORD(0x147,7,3)                               /* tfp with two ext. word */
 138
 139 /*M_XMOVX....M_XMOVX(source, destination) */
 140 #define M_IMOV(a,b)     OPWORD( ( (2<<6) | ((b) << 3) | 0), 0, (a))     /* move.l */
 141 #define M_AMOV(a,b)     OPWORD( ( (2<<6) | ((b) << 3) | 1), 1, (a))     /* movea.l */
 142 #define M_IMOV_IMM(a,b) emit_mov_imm_reg(cd, (a), (b))
 143 #define M_AMOV_IMM(a,b) OPWORD_IMM32( ( (2<<6) | ((b) << 3) | 1), 7, 4, (a))
 144
 145 /* for sure generates a 32 bit immedeate form, needed when there are patchers involved */
 146 #define M_IMOV_IMM32(a,b)       OPWORD_IMM32(((2<<6) | ((b) << 3) | 0), 7, 4, (a))
 147
 148 #define M_ICLR(a)       OPWORD(0x10a, 0, (a))                           /* clr.l */
 149 #define M_ISET(a)       OPWORD( ( (0xa <<6) | (0 << 3) | 5), 0, (a))    /* mov3q #-1 */
 150
 151 #define M_JMP(a)        OPWORD(0x13b,2,(a))                             /* jmp %aX@ */
 152 #define M_JMP_IMM(a)    OPWORD_IMM32(0x13b,7,1,(a))                     /* jmp.l */
 153 #define M_JSR(a)        OPWORD(0x13a,2,(a))                             /* jsr %aX@ */
 154 #define M_JSR_IMM(a)    OPWORD_IMM32(0x13a,7,1,(a))                     /* jsr.l */
 155 #define M_BSR_IMM(a)    OPWORD_IMM32(0x187,7,7,(a))                     /* bsr.l */
 156 #define M_JSR_PCREL(a)  OPWORD_IMM16(0x13a,7,2,(a))                     /* jsr.l (d16,PC) */
 157
 158 #define M_RET           OPWORD(0x139,6,5)                               /* 0x4375 */
 159 #define M_LINK(a,b)     OPWORD_IMM16(0x139,2,(a), (b))                  /* link */
 160 #define M_UNLK(a)       OPWORD(0x139, 3, (a))                           /* unlk */
 161
 162 /* push and pop are implemented using move.l */
 163 /* we need 3 variants, data, address and float registers */
 164 /* also a POPALL and PUSHALL for verbose:call code, use them only there! */
 165 #define M_IPUSH(a)              OPWORD(0xbc,0,(a))
 166 #define M_APUSH(a)              OPWORD(0xbc,1,(a))
 167
 168 #define M_IPOP(a)               OPWORD( ( (2<<6) | ((a) << 3) | 0 ), 3, REG_SP)
 169 #define M_APOP(a)               OPWORD( ( (2<<6) | ((a) << 3) | 1 ), 3, REG_SP)         /* movea.l acutally */
 170
 171
 172 #define M_IPUSH_IMM(a)          OPWORD_IMM32(0x121,7,1, (a))                            /* pea.l */
 173
 174 #define M_PUSHALL               OPWORD_IMM16(0x123,2,REG_SP,0xFFFF)                     /* A0-A7, D0-D7 pushed onto stack */
 175 #define M_POPALL                OPWORD_IMM16(0x133,2,REG_SP,0xFFFF)                     /* A0-A7, D0-D7 poped off stack */
 176
 177 /* M_XLD(a,b,c)....M_XLD(destinationreg, addressbase, offset)   */
 178 #define M_ILD(a,b,c)            OPWORD_IMM16( ( (2<<6) | ((a) << 3) | 0), 5, (b), (c))
 179 #define M_ALD(a,b,c)            OPWORD_IMM16( ( (2<<6) | ((a) << 3) | 1), 5, (b), (c))
 180 #define M_LLD(a,b,c)            do {\
 181                                         M_ILD(GET_HIGH_REG(a), (b), (c));\
 182                                         M_ILD(GET_LOW_REG (a), (b), (c)+4);\
 183                                 } while(0);
 184
 185 #if !defined(ENABLE_SOFTFLOAT)
 186         #define M_FLD(a,b,c)            M_ILLEGAL
 187         #define M_DLD(a,b,c)            M_ILLEGAL
 188 #endif
 189
 190 /* M_XST(a,b,c)....M_XST(sourceregister, addressbase, offset)   */
 191 #define M_IST(a,b,c)            OPWORD_IMM16( ( (2<<6) | ((b) << 3) | 5), 0, (a), (c))
 192 #define M_AST(a,b,c)            OPWORD_IMM16( ( (2<<6) | ((b) << 3) | 5), 1, (a), (c))
 193 #define M_LST(a,b,c)            do      {\
 194                                         M_IST(GET_HIGH_REG(a), (b), (c));\
 195                                         M_IST(GET_LOW_REG (a), (b), (c)+4);\
 196                                 } while(0);
 197
 198 #if !defined(ENABLE_SOFTFLOAT)
 199         #define M_FST(a,b,c)            M_ILLEGAL
 200         #define M_DST(a,b,c)            M_ILLEGAL
 201 #endif
 202
 203 /*M_XADD_IMM(a,b)...M_XADD_IMM(offset, reg) */
 204 #define M_AADD_IMM(a,b)         OPWORD_IMM32( ( (0xd<<6) | ((b)<<3) | 7), 7, 4, (a))
 205 #define M_IADD_IMM(a,b)         OPWORD_IMM32( ( (0xd<<6) | ((b)<<3) | 2), 7, 4, (a))
 206 #define M_ISUB_IMM(a,b)         M_IADD_IMM(-(a), (b))
 207
 208 /* M_OP(source, dest) ...  dest (OP) source -> dest*/
 209 #define M_ISUB(a,b)             OPWORD ( ( (9<<6)   | ((b)<<3) | 2), 0, (a))                    /* sub.l */
 210 #define M_IADD(a,b)             OPWORD ( ( (0xd<<6) | ((b)<<3) | 2), 0, (a))                    /* add.l */
 211
 212 #define M_IMUL(a,b)             OPWORD_IMM16 ( 0x130, 0, (a), ( ((b) << 12) | (1 << 11)))       /* muls.l */
 213 #define M_IDIV(a,b)             OPWORD_IMM16 ( 0x131, 0, (a), ( ((b) << 12) | (1 << 11) | (b))) /* divs.l */
 214
 215 #define M_ISSL(a,b)             OPWORD ( ( (0xe<<6) | ((a) << 3) | 6), 4, (b))                  /* asl.l */
 216 #define M_ISSR(a,b)             OPWORD ( ( (0xe<<6) | ((a) << 3) | 2), 4, (b))                  /* asr.l */
 217 #define M_IUSR(a,b)             OPWORD ( ( (0xe<<6) | ((a) << 3) | 2), 5, (b))                  /* lsr.l */
 218
 219 #define M_IAND(a,b)             OPWORD ( ( (0xc<<6) | ((b) << 3) | 2), 0, (a))                  /* and.l */
 220
 221 #define M_IOR(a,b)              OPWORD ( ( (0x8<<6) | ((b) << 3) | 2), 0, (a))                  /* or.l */
 222
 223
 224 /* ultra sepcial 3 register form, b%a = c, (a!=c) */
 225 #define M_IREM(a,b,c)           OPWORD_IMM16 ( 0x131, 0, (a), ( ((b) << 12) | (1 << 11) | (c))) /* rems.l */
 226
 227 /* M_OP(dest) */
 228 #define M_INEG(a)               OPWORD(0x112, 0, (a))                                           /* neg.l */
 229
 230 /* only generate opcode when condition true */
 231 #define OPWORD_COND(c, u,v,w)   \
 232         do { \
 233                 if ( (c) ) { OPWORD( (u),(v),(w) ) }  \
 234         } while(0);
 235 /* assert on the opcode */
 236 #define OPWORD_ASSERT(a, u,v,w) \
 237         do { \
 238                 assert((a)); \
 239                 OPWORD( (u),(v),(w) )  \
 240         } while(0);
 241
 242 /* M_XMOVE....M_XMOVE(sourcereg, destreg) */
 243 #define M_INTMOVE(a,b)          OPWORD_COND(((a) != (b)), ( ( 2<<6) | ((b) << 3) | 0), 0, (a));
 244 #define M_ADRMOVE(a,b)          OPWORD_COND(((a) != (b)), ( ( 2<<6) | ((b) << 3) | 1), 1, (a));
 245 #define M_INT2ADRMOVE(a,b)      OPWORD( ( (2<<6) | ((b) << 3) | 1), 0, (a));
 246 #define M_ADR2INTMOVE(a,b)      OPWORD( ( (2<<6) | ((b) << 3) | 0), 1, (a));
 247 #define M_LNGMOVE(a,b)          do      {\
 248                                         M_INTMOVE(GET_LOW_REG (a), GET_LOW_REG (b));\
 249                                         M_INTMOVE(GET_HIGH_REG(a), GET_HIGH_REG(b));\
 250                                 } while(0);
 251
 252 #if !defined(ENABLE_SOFTLFOAT)
 253         #define M_FLTMOVE(a,b)          M_ILLEGAL
 254         #define M_DBLMOVE(a,b)          M_ILLEGAL
 255 #endif
 256 /* M_XTST....M_XTST(register) */
 257 #define M_ITST(a)               OPWORD(0x12a, 0, (a))                   /* tst.l */
 258 #define M_ATST(a)               OPWORD(0x12a, 1, (a))                   /* tst.l */
 259
 260 /* M_XCMPI....M_XMCPI(immideate, register) */
 261 #define M_ICMP_IMM(a,b)         OPWORD_IMM32( 0x32, 0, (b), (a))
 262 #if 0
 263 #define M_ACMPI(a,b)            OPWORD_IMM32( ( (0xb << 6) | ((b) << 3) | 7), 7, 4, (a))        /* cmpa.l # */
 264 #endif
 265 /* M_XCMP....M_XCMP(reg1, reg2) */
 266 #define M_ICMP(b,a)             OPWORD( ( (0xb << 6) | ((a) << 3) | 2), 0, (b))                 /* cmp.l */
 267 #define M_ACMP(b,a)             OPWORD( ( (0xb << 6) | ((a) << 3) | 7), 1, (b))                 /* cmpa.l */
 268
 269 /* M_AND_IMM(imm, register)     */
 270 #define M_IAND_IMM(a,b)         OPWORD_IMM32( 0xa, 0, (b), (a))                                 /* andi.l # */
 271
 272 /* All kind of branches one could ever possibly need, each with 16 and 32 bit displacement */
 273 /* BRANCH16 and BRANCH32 are helpers */
 274 #define BRANCH8(cond,imm) \
 275         do { \
 276                 *((u2*)cd->mcodeptr) = (u2) (((0x6) << 12) | ((cond)<<8) | (int8_t)imm); \
 277                 cd->mcodeptr += 2; \
 278         } while(0);
 279
 280 #define BRANCH16(cond,imm) \
 281         do { \
 282                 *((u2*)cd->mcodeptr) = (u2) (((0x6) << 12) | ((cond)<<8) | 0x00); \
 283                 cd->mcodeptr += 2; \
 284                 *((int16_t*)(cd->mcodeptr)) = imm; \
 285                 cd->mcodeptr += 2; \
 286         } while(0);
 287 #define BRANCH32(cond,imm) \
 288         do { \
 289                 *((u2*)cd->mcodeptr) = (u2) (((0x6) << 12) | ((cond)<<8) | 0xff); \
 290                 cd->mcodeptr += 2; \
 291                 *((int32_t*)(cd->mcodeptr)) = imm; \
 292                 cd->mcodeptr += 4; \
 293         } while(0);
 294
 295 #define M_BR_16(a)                      BRANCH16(0x0, (a))      /* branch always */
 296 #define M_BR_32(a)                      BRANCH32(0x0, (a))
 297
 298 #define M_BEQ(a)                        BRANCH8 (0x7, (a))
 299 #define M_BEQ_16(a)                     BRANCH16(0x7, (a))
 300 #define M_BEQ_32(a)                     BRANCH32(0x7, (a))
 301
 302 #define M_BNE(a)                        BRANCH8 (0x6, (a))
 303 #define M_BNE_16(a)                     BRANCH16(0x6, (a))
 304 #define M_BNE_32(a)                     BRANCH32(0x6, (a))
 305
 306 #define M_BLT(a)                        BRANCH8 (0xd, (a))
 307 #define M_BLT_16(a)                     BRANCH16(0xd, (a))
 308 #define M_BLT_32(a)                     BRANCH32(0xd, (a))
 309
 310 #define M_BGE(a)                        BRANCH8 (0xc, (a))
 311 #define M_BGE_16(a)                     BRANCH16(0xc, (a))
 312 #define M_BGE_32(a)                     BRANCH32(0xc, (a))
 313
 314 #define M_BGT(a)                        BRANCH8 (0xe, (a))
 315 #define M_BGT_16(a)                     BRANCH16(0xe, (a))
 316 #define M_BGT_32(a)                     BRANCH32(0xe, (a))
 317
 318 #define M_BLE(a)                        BRANCH8 (0xf, (a))
 319 #define M_BLE_16(a)                     BRANCH16(0xf, (a))
 320 #define M_BLE_32(a)                     BRANCH32(0xf, (a))
 321
 322 #define M_BHI(a)                        BRANCH8 (0x2, (a))
 323 #define M_BHI_16(a)                     BRANCH16(0x2, (a))
 324 #define M_BHI_32(a)                     BRANCH32(0x2, (a))
 325
 326 #define M_BMI(a)                        BRANCH8(0xb, (a))
 327 #define M_BPL(a)                        BRANCH8(0xa, (a))
 328
 329 #define M_BNAN_16(a)                    M_ILLEGAL               /* TODO */
 330 #define M_BNAN_32(a)                    M_ILLEGAL
 331
 332 /* array store/load stuff */
 333 /* M_LXXX(baseaddressregister, targetregister)  */
 334 /* M_SXXX(baseaddressregsiter, sourceregister)  */
 335 #define M_LBZX(a,c)                     OPWORD( ( (1<<6) | ((c) << 3) | 0), 2, (a))     /* move.l */
 336 #define M_LHZX(a,c)                     OPWORD( ( (3<<6) | ((c) << 3) | 0), 2, (a))
 337 #define M_LWZX(a,c)                     OPWORD( ( (2<<6) | ((c) << 3) | 0), 2, (a))
 338 #define M_LAX(a,c)                      OPWORD( ( (2<<6) | ((c) << 3) | 1), 2, (a))     /* movea.l */
 339
 340 #define M_STBX(a,c)                     OPWORD( ( (1<<6) | ((a) << 3) | 2), 0, (c))     /* move.l */
 341 #define M_STHX(a,c)                     OPWORD( ( (3<<6) | ((a) << 3) | 2), 0, (c))
 342 #define M_STWX(a,c)                     OPWORD( ( (2<<6) | ((a) << 3) | 2), 0, (c))
 343 #define M_STAX(a,c)                     OPWORD( ( (2<<6) | ((a) << 3) | 2), 1, (c))     /* movea.l */
 344
 345 #define M_BSEXT(a,b)                    OPWORD( ( (7<<6) | ((b) << 3) | 4), 0, (a))     /* mvs.b */
 346 #define M_CZEXT(a,b)                    OPWORD( ( (7<<6) | ((b) << 3) | 7), 0, (a))     /* mvz.w */
 347 #define M_SSEXT(a,b)                    OPWORD( ( (7<<6) | ((b) << 3) | 5), 0, (a))     /* mvs.w */
 348 #define M_HSEXT(a,b)                    M_ILLEGAL
 349
 350 /* adds content of integer reg a to address register b, result is b */
 351 #define M_AADDINT(a,b)                  OPWORD( ( (0xd<<6) | ((b) << 3) | 7), 0, (a))   /* adda.l */
 352 #define M_ASUBINT(a,b)                  OPWORD( ( (0x9<<6) | ((b) << 3) | 7), 0, (a))   /* suba.l */
 353
 354 /* immideate a shift left int register b, immideate has 3 bits */
 355 #define M_ISSL_IMM(a,b)                 OPWORD_ASSERT( ((a)<=7), ( (0xe<<6) | ((a) << 3) | 6), 1, (b))  /* lsl */
 356 #define M_ISSR_IMM(a,b)                 OPWORD_ASSERT( ((a)<=7), ( (0xe<<6) | ((a) << 3) | 2), 0, (b))  /* lsl */
 357 #define M_IUSR_IMM(a,b)                 OPWORD_ASSERT( ((a)<=7), ( (0xe<<6) | ((a) << 3) | 2), 1, (b))  /* lsl */
 358
 359
 360 /* constant handling */
 361 /* XCONST(constant value, register) */
 362 #define LCONST(a,b)                     do {\
 363                                                 M_IMOV_IMM(((uint32_t)(a)), GET_LOW_REG((b)));\
 364                                                 M_IMOV_IMM(((uint32_t)(a>>32)), GET_HIGH_REG((b)));\
 365                                         } while(0);
 366
 367 #if !defined(ENABLE_SOFTFLOAT)
 368         #define FCONST(a,b)             M_ILLEGAL
 369         #define DCONST(a,b)             M_ILLEGAL
 370 #endif
 371
 372 #define M_TRAP_SETREGISTER(a)           OPWORD( 0x128, 0, (a))          /* tst.b */
 373 #define M_TRAP(a) \
 374         do { \
 375                 *((u2*)cd->mcodeptr) = (u2) ( 0x4e40 | (a) ); \
 376                 cd->mcodeptr += 2; \
 377         } while(0);
 378
 379 #endif /* _CODEGEN_H */