* Removed all Id tags.
[cacao.git] / src / vm / jit / powerpc / codegen.h
1 /* src/vm/jit/powerpc/codegen.h - code generation macros and definitions for
2                                   32-bit PowerPC
3
4    Copyright (C) 1996-2005, 2006, 2007 R. Grafl, A. Krall, C. Kruegel,
5    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
6    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
7    J. Wenninger, Institut f. Computersprachen - TU Wien
8
9    This file is part of CACAO.
10
11    This program is free software; you can redistribute it and/or
12    modify it under the terms of the GNU General Public License as
13    published by the Free Software Foundation; either version 2, or (at
14    your option) any later version.
15
16    This program is distributed in the hope that it will be useful, but
17    WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19    General Public License for more details.
20
21    You should have received a copy of the GNU General Public License
22    along with this program; if not, write to the Free Software
23    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24    02110-1301, USA.
25
26 */
27
28
29 #ifndef _CODEGEN_H
30 #define _CODEGEN_H
31
32 #include "config.h"
33
34 #include "md-abi.h"
35
36 #include "vm/global.h"
37 #include "vm/jit/jit.h"
38 #include "vm/jit/reg.h"
39
40
41 /* additional functions and macros to generate code ***************************/
42
43 /* MCODECHECK(icnt) */
44
45 #define MCODECHECK(icnt) \
46     do { \
47         if ((cd->mcodeptr + (icnt) * 4) > cd->mcodeend) \
48             codegen_increase(cd); \
49     } while (0)
50
51
52 /* M_INTMOVE:
53      generates an integer-move from register a to b.
54      if a and b are the same int-register, no code will be generated.
55 */ 
56
57 #define M_INTMOVE(a,b) \
58     do { \
59         if ((a) != (b)) { \
60             M_MOV(a, b); \
61         } \
62     } while (0)
63
64 #define M_LNGMOVE(a,b) \
65     do { \
66         if (GET_HIGH_REG(a) == GET_LOW_REG(b)) { \
67             assert((GET_LOW_REG(a) != GET_HIGH_REG(b))); \
68             M_INTMOVE(GET_HIGH_REG(a), GET_HIGH_REG(b)); \
69             M_INTMOVE(GET_LOW_REG(a), GET_LOW_REG(b)); \
70         } else { \
71             M_INTMOVE(GET_LOW_REG(a), GET_LOW_REG(b)); \
72             M_INTMOVE(GET_HIGH_REG(a), GET_HIGH_REG(b)); \
73         } \
74     } while (0)
75
76
77 /* M_FLTMOVE:
78     generates a floating-point-move from register a to b.
79     if a and b are the same float-register, no code will be generated
80 */ 
81
82 #define M_FLTMOVE(a,b) \
83     do { \
84         if ((a) != (b)) { \
85             M_FMOV(a, b); \
86         } \
87     } while (0)
88
89
90 #define ICONST(d,c)                     emit_iconst(cd, (d), (c))
91
92 #define LCONST(reg,c) \
93     ICONST(GET_HIGH_REG((reg)), (s4) ((s8) (c) >> 32)); \
94     ICONST(GET_LOW_REG((reg)), (s4) ((s8) (c)));
95
96
97 #define ALIGNCODENOP \
98     if ((s4) ((ptrint) cd->mcodeptr & 7)) { \
99         M_NOP; \
100     }
101
102
103 /* branch defines *************************************************************/
104
105 #define BRANCH_NOPS \
106     do { \
107         if (CODEGENDATA_HAS_FLAG_LONGBRANCHES(cd)) { \
108             M_NOP; \
109             M_NOP; \
110         } \
111         else { \
112             M_NOP; \
113         } \
114     } while (0)
115
116
117 /* patcher defines ************************************************************/
118
119 #define PATCHER_CALL_SIZE    1 * 4      /* an instruction is 4-bytes long     */
120
121 #define PATCHER_NOPS \
122     do { \
123         M_NOP; \
124     } while (0)
125
126
127 /* stub defines ***************************************************************/
128
129 #define COMPILERSTUB_CODESIZE    4 * 4
130
131
132 /* macros to create code ******************************************************/
133
134 #define M_OP3(opcode,y,oe,rc,d,a,b) \
135     do { \
136         *((u4 *) cd->mcodeptr) = (((opcode) << 26) | ((d) << 21) | ((a) << 16) | ((b) << 11) | ((oe) << 10) | ((y) << 1) | (rc)); \
137         cd->mcodeptr += 4; \
138     } while (0)
139
140 #define M_OP3_GET_A(x)                (((x) >> 16) & 0x1f  )
141 #define M_OP3_GET_B(x)                (((x) >> 11) & 0x1f  )
142
143
144 #define M_OP4(x,y,rc,d,a,b,c) \
145     do { \
146         *((u4 *) cd->mcodeptr) = (((x) << 26) | ((d) << 21) | ((a) << 16) | ((b) << 11) | ((c) << 6) | ((y) << 1) | (rc)); \
147         cd->mcodeptr += 4; \
148     } while (0)
149
150
151 #define M_OP2_IMM(x,d,a,i) \
152     do { \
153         *((u4 *) cd->mcodeptr) = (((x) << 26) | ((d) << 21) | ((a) << 16) | ((i) & 0xffff)); \
154         cd->mcodeptr += 4; \
155     } while (0)
156
157 #define M_INSTR_OP2_IMM_D(x)            (((x) >> 21) & 0x1f  )
158 #define M_INSTR_OP2_IMM_A(x)            (((x) >> 16) & 0x1f  )
159 #define M_INSTR_OP2_IMM_I(x)            ( (x)        & 0xffff)
160
161
162 #define M_BMASK     0x03fffffc                      /* (((1 << 26) - 1) & ~3) */
163 #define M_BCMASK    0x0000fffc                      /* (((1 << 16) - 1) & ~3) */
164
165 #define M_B(LI,AA,LK) \
166     do { \
167         *((u4 *) cd->mcodeptr) = ((18 << 26) | ((((LI) * 4) + 4) & M_BMASK) | ((AA) << 1) | (LK)); \
168         cd->mcodeptr += 4; \
169     } while (0)
170
171 #define M_BC(BO,BI,BD,AA,LK) \
172     do { \
173         *((u4 *) cd->mcodeptr) = ((16 << 26) | ((BO) << 21) | ((BI) << 16) | ((((BD) * 4) + 4) & M_BCMASK) | ((AA) << 1) | (LK)); \
174         cd->mcodeptr += 4; \
175     } while (0)
176
177
178 /* instruction macros *********************************************************/
179
180 #define M_IADD(a,b,c)                   M_OP3(31, 266, 0, 0, c, a, b)
181 #define M_IADD_IMM(a,b,c)               M_OP2_IMM(14, c, a, b)
182 #define M_ADDC(a,b,c)                   M_OP3(31, 10, 0, 0, c, a, b)
183 #define M_ADDIC(a,b,c)                  M_OP2_IMM(12, c, a, b)
184 #define M_ADDICTST(a,b,c)               M_OP2_IMM(13, c, a, b)
185 #define M_ADDE(a,b,c)                   M_OP3(31, 138, 0, 0, c, a, b)
186 #define M_ADDZE(a,b)                    M_OP3(31, 202, 0, 0, b, a, 0)
187 #define M_ADDME(a,b)                    M_OP3(31, 234, 0, 0, b, a, 0)
188 #define M_ISUB(a,b,c)                   M_OP3(31, 40, 0, 0, c, b, a)
189 #define M_ISUBTST(a,b,c)                M_OP3(31, 40, 0, 1, c, b, a)
190 #define M_SUBC(a,b,c)                   M_OP3(31, 8, 0, 0, c, b, a)
191 #define M_SUBIC(a,b,c)                  M_OP2_IMM(8, c, b, a)
192 #define M_SUBE(a,b,c)                   M_OP3(31, 136, 0, 0, c, b, a)
193 #define M_SUBZE(a,b)                    M_OP3(31, 200, 0, 0, b, a, 0)
194 #define M_SUBME(a,b)                    M_OP3(31, 232, 0, 0, b, a, 0)
195
196 #define M_AND(a,b,c)                    M_OP3(31, 28, 0, 0, a, c, b)
197 #define M_AND_IMM(a,b,c)                M_OP2_IMM(28, a, c, b)
198 #define M_ANDIS(a,b,c)                  M_OP2_IMM(29, a, c, b)
199 #define M_OR(a,b,c)                     M_OP3(31, 444, 0, 0, a, c, b)
200 #define M_OR_TST(a,b,c)                 M_OP3(31, 444, 0, 1, a, c, b)
201 #define M_OR_IMM(a,b,c)                 M_OP2_IMM(24, a, c, b)
202 #define M_ORIS(a,b,c)                   M_OP2_IMM(25, a, c, b)
203 #define M_XOR(a,b,c)                    M_OP3(31, 316, 0, 0, a, c, b)
204 #define M_XOR_IMM(a,b,c)                M_OP2_IMM(26, a, c, b)
205 #define M_XORIS(a,b,c)                  M_OP2_IMM(27, a, c, b)
206
207 #define M_SLL(a,b,c)                    M_OP3(31, 24, 0, 0, a, c, b)
208 #define M_SRL(a,b,c)                    M_OP3(31, 536, 0, 0, a, c, b)
209 #define M_SRA(a,b,c)                    M_OP3(31, 792, 0, 0, a, c, b)
210 #define M_SRA_IMM(a,b,c)                M_OP3(31, 824, 0, 0, a, c, b)
211
212 #define M_IMUL(a,b,c)                   M_OP3(31, 235, 0, 0, c, a, b)
213 #define M_IMUL_IMM(a,b,c)               M_OP2_IMM(7, c, a, b)
214 #define M_IDIV(a,b,c)                   M_OP3(31, 491, 0, 0, c, a, b)
215
216 #define M_NEG(a,b)                      M_OP3(31, 104, 0, 0, b, a, 0)
217 #define M_NOT(a,b)                      M_OP3(31, 124, 0, 0, a, b, a)
218
219 #define M_SUBFIC(a,b,c)                 M_OP2_IMM(8, c, a, b)
220 #define M_SUBFZE(a,b)                   M_OP3(31, 200, 0, 0, b, a, 0)
221 #define M_RLWINM(a,b,c,d,e)             M_OP4(21, d, 0, a, e, b, c)
222 #define M_ADDZE(a,b)                    M_OP3(31, 202, 0, 0, b, a, 0)
223 #define M_SLL_IMM(a,b,c)                M_RLWINM(a,b,0,31-(b),c)
224 #define M_SRL_IMM(a,b,c)                M_RLWINM(a,32-(b),b,31,c)
225 #define M_ADDIS(a,b,c)                  M_OP2_IMM(15, c, a, b)
226 #define M_STFIWX(a,b,c)                 M_OP3(31, 983, 0, 0, a, b, c)
227 #define M_LWZX(a,b,c)                   M_OP3(31, 23, 0, 0, a, b, c)
228 #define M_LHZX(a,b,c)                   M_OP3(31, 279, 0, 0, a, b, c)
229 #define M_LHAX(a,b,c)                   M_OP3(31, 343, 0, 0, a, b, c)
230 #define M_LBZX(a,b,c)                   M_OP3(31, 87, 0, 0, a, b, c)
231 #define M_LFSX(a,b,c)                   M_OP3(31, 535, 0, 0, a, b, c)
232 #define M_LFDX(a,b,c)                   M_OP3(31, 599, 0, 0, a, b, c)
233 #define M_STWX(a,b,c)                   M_OP3(31, 151, 0, 0, a, b, c)
234 #define M_STHX(a,b,c)                   M_OP3(31, 407, 0, 0, a, b, c)
235 #define M_STBX(a,b,c)                   M_OP3(31, 215, 0, 0, a, b, c)
236 #define M_STFSX(a,b,c)                  M_OP3(31, 663, 0, 0, a, b, c)
237 #define M_STFDX(a,b,c)                  M_OP3(31, 727, 0, 0, a, b, c)
238
239 #define M_STWU_INTERN(a,b,disp)         M_OP2_IMM(37,a,b,disp)
240
241 #define M_STWU(a,b,disp) \
242     do { \
243         s4 lo = (disp) & 0x0000ffff; \
244         s4 hi = ((disp) >> 16); \
245         if (((disp) >= -32678) && ((disp) <= 32767)) { \
246             M_STWU_INTERN(a,b,lo); \
247         } else { \
248             M_ADDIS(REG_ZERO,hi,REG_ITMP3); \
249             M_OR_IMM(REG_ITMP3,lo,REG_ITMP3); \
250             M_STWUX(REG_SP,REG_SP,REG_ITMP3); \
251         } \
252     } while (0)
253
254 #define M_STWUX(a,b,c)                  M_OP3(31,183,0,0,a,b,c)
255
256 #define M_LDAH(a,b,c)                   M_ADDIS(b, c, a)
257
258 #define M_TRAP                          M_OP3(31, 4, 0, 0, 31, 0, 0)
259 #define M_TRAPGEU(a,b)                  M_OP3(31, 4, 0, 0, 5, a, b)
260
261 #define M_NOP                           M_OR_IMM(0, 0, 0)
262 #define M_MOV(a,b)                      M_OR(a, a, b)
263 #define M_TST(a)                        M_OP3(31, 444, 0, 1, a, a, a)
264
265 #define M_DADD(a,b,c)                   M_OP3(63, 21, 0, 0, c, a, b)
266 #define M_FADD(a,b,c)                   M_OP3(59, 21, 0, 0, c, a, b)
267 #define M_DSUB(a,b,c)                   M_OP3(63, 20, 0, 0, c, a, b)
268 #define M_FSUB(a,b,c)                   M_OP3(59, 20, 0, 0, c, a, b)
269 #define M_DMUL(a,b,c)                   M_OP4(63, 25, 0, c, a, 0, b)
270 #define M_FMUL(a,b,c)                   M_OP4(59, 25, 0, c, a, 0, b)
271 #define M_DDIV(a,b,c)                   M_OP3(63, 18, 0, 0, c, a, b)
272 #define M_FDIV(a,b,c)                   M_OP3(59, 18, 0, 0, c, a, b)
273
274 #define M_FABS(a,b)                     M_OP3(63, 264, 0, 0, b, 0, a)
275 #define M_CVTDL(a,b)                    M_OP3(63, 14, 0, 0, b, 0, a)
276 #define M_CVTDL_C(a,b)                  M_OP3(63, 15, 0, 0, b, 0, a)
277 #define M_CVTDF(a,b)                    M_OP3(63, 12, 0, 0, b, 0, a)
278 #define M_FMOV(a,b)                     M_OP3(63, 72, 0, 0, b, 0, a)
279 #define M_FMOVN(a,b)                    M_OP3(63, 40, 0, 0, b, 0, a)
280 #define M_DSQRT(a,b)                    M_OP3(63, 22, 0, 0, b, 0, a)
281 #define M_FSQRT(a,b)                    M_OP3(59, 22, 0, 0, b, 0, a)
282
283 #define M_FCMPU(a,b)                    M_OP3(63, 0, 0, 0, 0, a, b)
284 #define M_FCMPO(a,b)                    M_OP3(63, 32, 0, 0, 0, a, b)
285
286 #define M_BLDU(a,b,c)                   M_OP2_IMM(34, a, b, c)
287 #define M_SLDU(a,b,c)                   M_OP2_IMM(40, a, b, c)
288
289 #define M_ILD_INTERN(a,b,disp)          M_OP2_IMM(32,a,b,disp)
290
291 #define M_ILD(a,b,disp) \
292     do { \
293         s4 lo = (short) (disp); \
294         s4 hi = (short) (((disp) - lo) >> 16); \
295         if (hi == 0) { \
296             M_ILD_INTERN(a,b,lo); \
297         } else { \
298             M_ADDIS(b,hi,a); \
299             M_ILD_INTERN(a,a,lo); \
300         } \
301     } while (0)
302
303 #define M_LLD_INTERN(a,b,disp) \
304     do { \
305         M_ILD_INTERN(GET_HIGH_REG(a), b, disp); \
306         M_ILD_INTERN(GET_LOW_REG(a), b, disp + 4); \
307     } while (0)
308
309 #define M_LLD(a,b,disp) \
310     do { \
311         s4 lo = (short) (disp); \
312         s4 hi = (short) (((disp) - lo) >> 16); \
313         if (hi == 0) { \
314             M_LLD_INTERN(a,b,lo); \
315         } else { \
316             M_ADDIS(b,hi,a); \
317             M_LLD_INTERN(a,GET_LOW_REG(a),lo); \
318         } \
319     } while (0)
320
321 #define M_ALD_INTERN(a,b,disp)          M_ILD_INTERN(a,b,disp)
322 #define M_ALD(a,b,disp)                 M_ILD(a,b,disp)
323
324 #define M_BST(a,b,c)                    M_OP2_IMM(38, a, b, c)
325 #define M_SST(a,b,c)                    M_OP2_IMM(44, a, b, c)
326
327 #define M_IST_INTERN(a,b,disp)          M_OP2_IMM(36,a,b,disp)
328
329 /* Stores with displacement overflow should only happen with PUTFIELD
330    or on the stack. The PUTFIELD instruction does not use REG_ITMP3
331    and a reg_of_var call should not use REG_ITMP3!!! */
332
333 #define M_IST(a,b,disp) \
334     do { \
335         s4 lo = (short) (disp); \
336         s4 hi = (short) (((disp) - lo) >> 16); \
337         if (hi == 0) { \
338             M_IST_INTERN(a,b,lo); \
339         } else { \
340             M_ADDIS(b,hi,REG_ITMP3); \
341             M_IST_INTERN(a,REG_ITMP3,lo); \
342         } \
343     } while (0)
344
345 #define M_LST_INTERN(a,b,disp) \
346     do { \
347         M_IST_INTERN(GET_HIGH_REG(a), b, disp); \
348         M_IST_INTERN(GET_LOW_REG(a), b, disp + 4); \
349     } while (0)
350
351 #define M_LST(a,b,disp) \
352     do { \
353         s4 lo = (short) (disp); \
354         s4 hi = (short) (((disp) - lo) >> 16); \
355         if (hi == 0) { \
356             M_LST_INTERN(a,b,lo); \
357         } else { \
358             M_ADDIS(b,hi,REG_ITMP3); \
359             M_LST_INTERN(a,REG_ITMP3, lo); \
360         } \
361     } while (0)
362
363 #define M_AST_INTERN(a,b,disp)          M_IST_INTERN(a,b,disp)
364 #define M_AST(a,b,disp)                 M_IST(a,b,disp)
365
366 #define M_BSEXT(a,b)                    M_OP3(31, 954, 0, 0, a, b, 0)
367 #define M_SSEXT(a,b)                    M_OP3(31, 922, 0, 0, a, b, 0)
368 #define M_CZEXT(a,b)                    M_RLWINM(a,0,16,31,b)
369
370 #define M_BR(a)                         M_B(a, 0, 0)
371 #define M_BL(a)                         M_B(a, 0, 1)
372 #define M_RET                           M_OP3(19, 16, 0, 0, 20, 0, 0)
373 #define M_JSR                           M_OP3(19, 528, 0, 1, 20, 0, 0)
374 #define M_RTS                           M_OP3(19, 528, 0, 0, 20, 0, 0)
375
376 #define M_CMP(a,b)                      M_OP3(31, 0, 0, 0, 0, a, b)
377 #define M_CMPU(a,b)                     M_OP3(31, 32, 0, 0, 0, a, b)
378 #define M_CMPI(a,b)                     M_OP2_IMM(11, 0, a, b)
379 #define M_CMPUI(a,b)                    M_OP2_IMM(10, 0, a, b)
380
381 #define M_BLT(a)                        M_BC(12, 0, a, 0, 0)
382 #define M_BLE(a)                        M_BC(4,  1, a, 0, 0)
383 #define M_BGT(a)                        M_BC(12, 1, a, 0, 0)
384 #define M_BGE(a)                        M_BC(4,  0, a, 0, 0)
385 #define M_BEQ(a)                        M_BC(12, 2, a, 0, 0)
386 #define M_BNE(a)                        M_BC(4,  2, a, 0, 0)
387 #define M_BNAN(a)                       M_BC(12, 3, a, 0, 0)
388
389 #define M_FLD_INTERN(a,b,disp)          M_OP2_IMM(48,a,b,disp)
390 #define M_DLD_INTERN(a,b,disp)          M_OP2_IMM(50,a,b,disp)
391
392 #define M_FLD(a,b,disp) \
393     do { \
394         s4 lo = (short) (disp); \
395         s4 hi = (short) (((disp) - lo) >> 16); \
396         if (hi == 0) { \
397             M_FLD_INTERN(a,b,lo); \
398         } else { \
399             M_ADDIS(b,hi,REG_ITMP3); \
400             M_FLD_INTERN(a,REG_ITMP3,lo); \
401         } \
402     } while (0)
403
404 #define M_DLD(a,b,disp) \
405     do { \
406         s4 lo = (short) (disp); \
407         s4 hi = (short) (((disp) - lo) >> 16); \
408         if (hi == 0) { \
409             M_DLD_INTERN(a,b,lo); \
410         } else { \
411             M_ADDIS(b,hi,REG_ITMP3); \
412             M_DLD_INTERN(a,REG_ITMP3,lo); \
413         } \
414     } while (0)
415
416 #define M_FST_INTERN(a,b,disp)          M_OP2_IMM(52,a,b,disp)
417 #define M_DST_INTERN(a,b,disp)          M_OP2_IMM(54,a,b,disp)
418
419 #define M_FST(a,b,disp) \
420     do { \
421         s4 lo = (short) (disp); \
422         s4 hi = (short) (((disp) - lo) >> 16); \
423         if (hi == 0) { \
424             M_FST_INTERN(a,b,lo); \
425         } else { \
426             M_ADDIS(b,hi,REG_ITMP3); \
427             M_FST_INTERN(a,REG_ITMP3,lo); \
428         } \
429     } while (0)
430
431 #define M_DST(a,b,disp) \
432     do { \
433         s4 lo = (short) (disp); \
434         s4 hi = (short) (((disp) - lo) >> 16); \
435         if (hi == 0) { \
436             M_DST_INTERN(a,b,lo); \
437         } else { \
438             M_ADDIS(b,hi,REG_ITMP3); \
439             M_DST_INTERN(a,REG_ITMP3,lo); \
440         } \
441     } while (0)
442
443 #define M_MFLR(a)                       M_OP3(31, 339, 0, 0, a, 8, 0)
444 #define M_MFXER(a)                      M_OP3(31, 339, 0, 0, a, 1, 0)
445 #define M_MFCTR(a)                      M_OP3(31, 339, 0, 0, a, 9, 0)
446 #define M_MTLR(a)                       M_OP3(31, 467, 0, 0, a, 8, 0)
447 #define M_MTXER(a)                      M_OP3(31, 467, 0, 0, a, 1, 0)
448 #define M_MTCTR(a)                      M_OP3(31, 467, 0, 0, a, 9, 0)
449
450 #define M_LDA_INTERN(a,b,c)             M_IADD_IMM(b, c, a)
451
452 #define M_LDA(a,b,disp) \
453     do { \
454         s4 lo = (short) (disp); \
455         s4 hi = (short) (((disp) - lo) >> 16); \
456         if (hi == 0) { \
457             M_LDA_INTERN(a,b,lo); \
458         } else { \
459             M_ADDIS(b,hi,a); \
460             M_LDA_INTERN(a,a,lo); \
461         } \
462     } while (0)
463
464
465 #define M_LDATST(a,b,c)                 M_ADDICTST(b, c, a)
466 #define M_CLR(a)                        M_IADD_IMM(0, 0, a)
467 #define M_AADD_IMM(a,b,c)               M_IADD_IMM(a, b, c)
468
469 #endif /* _CODEGEN_H */
470
471
472 /*
473  * These are local overrides for various environment variables in Emacs.
474  * Please do not remove this and leave it at the end of the file, where
475  * Emacs will automagically detect them.
476  * ---------------------------------------------------------------------
477  * Local variables:
478  * mode: c
479  * indent-tabs-mode: t
480  * c-basic-offset: 4
481  * tab-width: 4
482  * End:
483  */