* removed deprecated BlockPtrOfPC macro
[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 R. Grafl, A. Krall, C. Kruegel, C. Oates,
5    R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
6    C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
7    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., 59 Temple Place - Suite 330, Boston, MA
24    02111-1307, USA.
25
26    Contact: cacao@complang.tuwien.ac.at
27
28    Authors: Andreas Krall
29             Stefan Ring
30
31    Changes: Christian Thalinger
32
33    $Id: codegen.h 2693 2005-06-14 18:34:47Z twisti $
34
35 */
36
37
38 #ifndef _CODEGEN_H
39 #define _CODEGEN_H
40
41 #include "md-abi.h"
42
43 #include "vm/global.h"
44 #include "vm/jit/reg.h"
45
46
47 /* additional functions and macros to generate code ***************************/
48
49 #if defined(STATISTICS)
50 #define COUNT_SPILLS count_spills++
51 #else
52 #define COUNT_SPILLS
53 #endif
54
55
56 /* gen_nullptr_check(objreg) */
57
58 #define gen_nullptr_check(objreg) \
59     if (checknull) { \
60         M_TST((objreg)); \
61         M_BEQ(0); \
62         codegen_addxnullrefs(cd, mcodeptr); \
63     }
64
65 #define gen_bound_check \
66     if (checkbounds) { \
67         M_ILD(REG_ITMP3, s1, OFFSET(java_arrayheader, size));\
68         M_CMPU(s2, REG_ITMP3);\
69         M_BGE(0);\
70         codegen_addxboundrefs(cd, mcodeptr, s2); \
71     }
72
73
74 /* MCODECHECK(icnt) */
75
76 #define MCODECHECK(icnt) \
77         if ((mcodeptr + (icnt)) > cd->mcodeend) \
78         mcodeptr = codegen_increase(cd, (u1 *) mcodeptr)
79
80
81 /* M_INTMOVE:
82      generates an integer-move from register a to b.
83      if a and b are the same int-register, no code will be generated.
84 */ 
85
86 #define M_INTMOVE(a,b) if ((a) != (b)) { M_MOV(a, b); }
87
88 #define M_TINTMOVE(t,a,b) \
89         if ((t) == TYPE_LNG) { \
90                 if ((a) <= (b)) \
91             M_INTMOVE(rd->secondregs[(a)], rd->secondregs[(b)]); \
92                 M_INTMOVE((a), (b)); \
93         if ((a) > (b)) \
94             M_INTMOVE(rd->secondregs[(a)], rd->secondregs[(b)]); \
95         } else { \
96                 M_INTMOVE((a), (b)); \
97     }
98
99
100 /* M_FLTMOVE:
101     generates a floating-point-move from register a to b.
102     if a and b are the same float-register, no code will be generated
103 */ 
104
105 #define M_FLTMOVE(a,b) if ((a) != (b)) { M_FMOV(a, b); }
106
107
108 /* var_to_reg_xxx:
109     this function generates code to fetch data from a pseudo-register
110     into a real register. 
111     If the pseudo-register has actually been assigned to a real 
112     register, no code will be emitted, since following operations
113     can use this register directly.
114     
115     v: pseudoregister to be fetched from
116     tempregnum: temporary register to be used if v is actually spilled to ram
117
118     return: the register number, where the operand can be found after 
119             fetching (this wil be either tempregnum or the register
120             number allready given to v)
121 */
122
123 #define var_to_reg_int0(regnr,v,tempnr,a,b) { \
124         if ((v)->flags & INMEMORY) { \
125                 COUNT_SPILLS; \
126         if ((a)) M_ILD((tempnr), REG_SP, 4 * (v)->regoff); \
127                 regnr = tempnr; \
128                 if ((b) && IS_2_WORD_TYPE((v)->type)) \
129                         M_ILD((a) ? rd->secondregs[(tempnr)] : (tempnr), REG_SP, 4 * (v)->regoff + 4); \
130     } else \
131         regnr = (!(a) && (b)) ? rd->secondregs[(v)->regoff] : (v)->regoff; \
132 }
133 #define var_to_reg_int(regnr,v,tempnr) var_to_reg_int0(regnr,v,tempnr,1,1)
134
135
136 #define var_to_reg_flt(regnr,v,tempnr) { \
137         if ((v)->flags & INMEMORY) { \
138                 COUNT_SPILLS; \
139                 if ((v)->type==TYPE_DBL) \
140                         M_DLD(tempnr,REG_SP,4*(v)->regoff); \
141                 else \
142                         M_FLD(tempnr,REG_SP,4*(v)->regoff); \
143                 regnr=tempnr; \
144         } else regnr=(v)->regoff; \
145 }
146
147
148 /* store_reg_to_var_xxx:
149     This function generates the code to store the result of an operation
150     back into a spilled pseudo-variable.
151     If the pseudo-variable has not been spilled in the first place, this 
152     function will generate nothing.
153     
154     v ............ Pseudovariable
155     tempregnum ... Number of the temporary registers as returned by
156                    reg_of_var.
157 */      
158
159 #define store_reg_to_var_int0(sptr, tempregnum, a, b) {       \
160         if ((sptr)->flags & INMEMORY) {                    \
161                 COUNT_SPILLS;                                  \
162                 if (a) M_IST(tempregnum, REG_SP, 4 * (sptr)->regoff); \
163                 if ((b) && IS_2_WORD_TYPE((sptr)->type)) \
164                         M_IST(rd->secondregs[tempregnum], REG_SP, 4 * (sptr)->regoff + 4); \
165                 }                                              \
166         }
167
168 #define store_reg_to_var_int(sptr, tempregnum) \
169         store_reg_to_var_int0(sptr, tempregnum, 1, 1)
170
171 #define store_reg_to_var_flt(sptr, tempregnum) {       \
172         if ((sptr)->flags & INMEMORY) {                    \
173                 COUNT_SPILLS;                                  \
174                 if ((sptr)->type==TYPE_DBL) \
175                         M_DST(tempregnum, REG_SP, 4 * (sptr)->regoff); \
176                 else \
177                         M_FST(tempregnum, REG_SP, 4 * (sptr)->regoff); \
178                 }                                              \
179         }
180
181
182 #define ICONST(reg,c) \
183     if (((c) >= 0 && (c) <= 32767) || ((c) >= -32768 && (c) < 0)) {\
184         M_LDA((reg), REG_ZERO, (c)); \
185     } else { \
186         a = dseg_adds4(cd, c); \
187         M_ILD((reg), REG_PV, a); \
188     }
189
190 #define LCONST(reg,c) \
191     ICONST((reg), (s4) ((s8) (c) >> 32)); \
192     ICONST(rd->secondregs[(reg)], (s4) ((s8) (c)));
193
194
195 #define M_COPY(from,to) \
196                         d = reg_of_var(rd, to, REG_IFTMP); \
197                         if ((from->regoff != to->regoff) || \
198                             ((from->flags ^ to->flags) & INMEMORY)) { \
199                                 if (IS_FLT_DBL_TYPE(from->type)) { \
200                                         var_to_reg_flt(s1, from, d); \
201                                         M_FLTMOVE(s1,d); \
202                                         store_reg_to_var_flt(to, d); \
203                                         }\
204                                 else { \
205                                         var_to_reg_int(s1, from, d); \
206                                         M_TINTMOVE(from->type,s1,d); \
207                                         store_reg_to_var_int(to, d); \
208                                         }\
209                                 }
210
211
212 #define ALIGNCODENOP \
213     if ((s4) ((ptrint) mcodeptr & 7)) { \
214         M_NOP; \
215     }
216
217
218 /* macros to create code ******************************************************/
219
220 #define M_OP3(x,y,oe,rc,d,a,b) \
221         *(mcodeptr++) = (((x) << 26) | ((d) << 21) | ((a) << 16) | ((b) << 11) | ((oe) << 10) | ((y) << 1) | (rc))
222
223 #define M_OP4(x,y,rc,d,a,b,c) \
224         *(mcodeptr++) = (((x) << 26) | ((d) << 21) | ((a) << 16) | ((b) << 11) | ((c) << 6) | ((y) << 1) | (rc))
225
226 #define M_OP2_IMM(x,d,a,i) \
227         *(mcodeptr++) = (((x) << 26) | ((d) << 21) | ((a) << 16) | ((i) & 0xffff))
228
229 #define M_BRMASK     0x0000fffc                     /* (((1 << 16) - 1) & ~3) */
230 #define M_BRAMASK    0x03fffffc                     /* (((1 << 26) - 1) & ~3) */
231
232 #define M_BRA(x,i,a,l) \
233         *(mcodeptr++) = (((x) << 26) | ((((i) * 4) + 4) & M_BRAMASK) | ((a) << 1) | (l))
234
235 #define M_BRAC(x,bo,bi,i,a,l) \
236         *(mcodeptr++) = (((x) << 26) | ((bo) << 21) | ((bi) << 16) | (((i) * 4 + 4) & M_BRMASK) | ((a) << 1) | (l))
237
238
239 /* instruction macros *********************************************************/
240
241 #define M_IADD(a,b,c)                   M_OP3(31, 266, 0, 0, c, a, b)
242 #define M_IADD_IMM(a,b,c)               M_OP2_IMM(14, c, a, b)
243 #define M_ADDC(a,b,c)                   M_OP3(31, 10, 0, 0, c, a, b)
244 #define M_ADDIC(a,b,c)                  M_OP2_IMM(12, c, a, b)
245 #define M_ADDICTST(a,b,c)               M_OP2_IMM(13, c, a, b)
246 #define M_ADDE(a,b,c)                   M_OP3(31, 138, 0, 0, c, a, b)
247 #define M_ADDZE(a,b)                    M_OP3(31, 202, 0, 0, b, a, 0)
248 #define M_ADDME(a,b)                    M_OP3(31, 234, 0, 0, b, a, 0)
249 #define M_ISUB(a,b,c)                   M_OP3(31, 40, 0, 0, c, b, a)
250 #define M_ISUBTST(a,b,c)                M_OP3(31, 40, 0, 1, c, b, a)
251 #define M_SUBC(a,b,c)                   M_OP3(31, 8, 0, 0, c, b, a)
252 #define M_SUBIC(a,b,c)                  M_OP2_IMM(8, c, b, a)
253 #define M_SUBE(a,b,c)                   M_OP3(31, 136, 0, 0, c, b, a)
254 #define M_SUBZE(a,b)                    M_OP3(31, 200, 0, 0, b, a, 0)
255 #define M_SUBME(a,b)                    M_OP3(31, 232, 0, 0, b, a, 0)
256
257 #define M_AND(a,b,c)                    M_OP3(31, 28, 0, 0, a, c, b)
258 #define M_AND_IMM(a,b,c)                M_OP2_IMM(28, a, c, b)
259 #define M_ANDIS(a,b,c)                  M_OP2_IMM(29, a, c, b)
260 #define M_OR(a,b,c)                     M_OP3(31, 444, 0, 0, a, c, b)
261 #define M_OR_IMM(a,b,c)                 M_OP2_IMM(24, a, c, b)
262 #define M_ORIS(a,b,c)                   M_OP2_IMM(25, a, c, b)
263 #define M_XOR(a,b,c)                    M_OP3(31, 316, 0, 0, a, c, b)
264 #define M_XOR_IMM(a,b,c)                M_OP2_IMM(26, a, c, b)
265 #define M_XORIS(a,b,c)                  M_OP2_IMM(27, a, c, b)
266
267 #define M_SLL(a,b,c)                    M_OP3(31, 24, 0, 0, a, c, b)
268 #define M_SRL(a,b,c)                    M_OP3(31, 536, 0, 0, a, c, b)
269 #define M_SRA(a,b,c)                    M_OP3(31, 792, 0, 0, a, c, b)
270 #define M_SRA_IMM(a,b,c)                M_OP3(31, 824, 0, 0, a, c, b)
271
272 #define M_IMUL(a,b,c)                   M_OP3(31, 235, 0, 0, c, a, b)
273 #define M_IMUL_IMM(a,b,c)               M_OP2_IMM(7, c, a, b)
274 #define M_IDIV(a,b,c)                   M_OP3(31, 491, 0, 0, c, a, b)
275
276 #define M_NEG(a,b)                      M_OP3(31, 104, 0, 0, b, a, 0)
277 #define M_NOT(a,b)                      M_OP3(31, 124, 0, 0, a, b, a)
278
279 #define M_SUBFIC(a,b,c)                 M_OP2_IMM(8, c, a, b)
280 #define M_SUBFZE(a,b)                   M_OP3(31, 200, 0, 0, b, a, 0)
281 #define M_RLWINM(a,b,c,d,e)             M_OP4(21, d, 0, a, e, b, c)
282 #define M_ADDZE(a,b)                    M_OP3(31, 202, 0, 0, b, a, 0)
283 #define M_SLL_IMM(a,b,c)                M_RLWINM(a,b,0,31-(b),c)
284 #define M_SRL_IMM(a,b,c)                M_RLWINM(a,32-(b),b,31,c)
285 #define M_ADDIS(a,b,c)                  M_OP2_IMM(15, c, a, b)
286 #define M_STFIWX(a,b,c)                 M_OP3(31, 983, 0, 0, a, b, c)
287 #define M_LWZX(a,b,c)                   M_OP3(31, 23, 0, 0, a, b, c)
288 #define M_LHZX(a,b,c)                   M_OP3(31, 279, 0, 0, a, b, c)
289 #define M_LHAX(a,b,c)                   M_OP3(31, 343, 0, 0, a, b, c)
290 #define M_LBZX(a,b,c)                   M_OP3(31, 87, 0, 0, a, b, c)
291 #define M_LFSX(a,b,c)                   M_OP3(31, 535, 0, 0, a, b, c)
292 #define M_LFDX(a,b,c)                   M_OP3(31, 599, 0, 0, a, b, c)
293 #define M_STWX(a,b,c)                   M_OP3(31, 151, 0, 0, a, b, c)
294 #define M_STHX(a,b,c)                   M_OP3(31, 407, 0, 0, a, b, c)
295 #define M_STBX(a,b,c)                   M_OP3(31, 215, 0, 0, a, b, c)
296 #define M_STFSX(a,b,c)                  M_OP3(31, 663, 0, 0, a, b, c)
297 #define M_STFDX(a,b,c)                  M_OP3(31, 727, 0, 0, a, b, c)
298 #define M_STWU(a,b,c)                   M_OP2_IMM(37, a, b, c)
299 #define M_LDAH(a,b,c)                   M_ADDIS(b, c, a)
300 #define M_TRAP                          M_OP3(31, 4, 0, 0, 31, 0, 0)
301
302 #define M_NOP                           M_OR_IMM(0, 0, 0)
303 #define M_MOV(a,b)                      M_OR(a, a, b)
304 #define M_TST(a)                        M_OP3(31, 444, 0, 1, a, a, a)
305
306 #define M_DADD(a,b,c)                   M_OP3(63, 21, 0, 0, c, a, b)
307 #define M_FADD(a,b,c)                   M_OP3(59, 21, 0, 0, c, a, b)
308 #define M_DSUB(a,b,c)                   M_OP3(63, 20, 0, 0, c, a, b)
309 #define M_FSUB(a,b,c)                   M_OP3(59, 20, 0, 0, c, a, b)
310 #define M_DMUL(a,b,c)                   M_OP4(63, 25, 0, c, a, 0, b)
311 #define M_FMUL(a,b,c)                   M_OP4(59, 25, 0, c, a, 0, b)
312 #define M_DDIV(a,b,c)                   M_OP3(63, 18, 0, 0, c, a, b)
313 #define M_FDIV(a,b,c)                   M_OP3(59, 18, 0, 0, c, a, b)
314
315 #define M_FABS(a,b)                     M_OP3(63, 264, 0, 0, b, 0, a)
316 #define M_CVTDL(a,b)                    M_OP3(63, 14, 0, 0, b, 0, a)
317 #define M_CVTDL_C(a,b)                  M_OP3(63, 15, 0, 0, b, 0, a)
318 #define M_CVTDF(a,b)                    M_OP3(63, 12, 0, 0, b, 0, a)
319 #define M_FMOV(a,b)                     M_OP3(63, 72, 0, 0, b, 0, a)
320 #define M_FMOVN(a,b)                    M_OP3(63, 40, 0, 0, b, 0, a)
321 #define M_DSQRT(a,b)                    M_OP3(63, 22, 0, 0, b, 0, a)
322 #define M_FSQRT(a,b)                    M_OP3(59, 22, 0, 0, b, 0, a)
323
324 #define M_FCMPU(a,b)                    M_OP3(63, 0, 0, 0, 0, a, b)
325 #define M_FCMPO(a,b)                    M_OP3(63, 32, 0, 0, 0, a, b)
326
327 #define M_BST(a,b,c)                    M_OP2_IMM(38, a, b, c)
328 #define M_SST(a,b,c)                    M_OP2_IMM(44, a, b, c)
329 #define M_IST(a,b,c)                    M_OP2_IMM(36, a, b, c)
330 #define M_AST(a,b,c)                    M_OP2_IMM(36, a, b, c)
331 #define M_BLDU(a,b,c)                   M_OP2_IMM(34, a, b, c)
332 #define M_SLDU(a,b,c)                   M_OP2_IMM(40, a, b, c)
333 #define M_ILD(a,b,c)                    M_OP2_IMM(32, a, b, c)
334 #define M_ALD(a,b,c)                    M_OP2_IMM(32, a, b, c)
335
336 #define M_BSEXT(a,b)                    M_OP3(31, 954, 0, 0, a, b, 0)
337 #define M_SSEXT(a,b)                    M_OP3(31, 922, 0, 0, a, b, 0)
338 #define M_CZEXT(a,b)                    M_RLWINM(a,0,16,31,b)
339
340 #define M_BR(a)                         M_BRA(18, a, 0, 0);
341 #define M_BL(a)                         M_BRA(18, a, 0, 1);
342 #define M_RET                           M_OP3(19, 16, 0, 0, 20, 0, 0);
343 #define M_JSR                           M_OP3(19, 528, 0, 1, 20, 0, 0);
344 #define M_RTS                           M_OP3(19, 528, 0, 0, 20, 0, 0);
345
346 #define M_CMP(a,b)                      M_OP3(31, 0, 0, 0, 0, a, b);
347 #define M_CMPU(a,b)                     M_OP3(31, 32, 0, 0, 0, a, b);
348 #define M_CMPI(a,b)                     M_OP2_IMM(11, 0, a, b);
349 #define M_CMPUI(a,b)                    M_OP2_IMM(10, 0, a, b);
350
351 #define M_BLT(a)                        M_BRAC(16, 12, 0, a, 0, 0);
352 #define M_BLE(a)                        M_BRAC(16, 4, 1, a, 0, 0);
353 #define M_BGT(a)                        M_BRAC(16, 12, 1, a, 0, 0);
354 #define M_BGE(a)                        M_BRAC(16, 4, 0, a, 0, 0);
355 #define M_BEQ(a)                        M_BRAC(16, 12, 2, a, 0, 0);
356 #define M_BNE(a)                        M_BRAC(16, 4, 2, a, 0, 0);
357 #define M_BNAN(a)                       M_BRAC(16, 12, 3, a, 0, 0);
358
359 #define M_DLD(a,b,c)                    M_OP2_IMM(50, a, b, c)
360 #define M_DST(a,b,c)                    M_OP2_IMM(54, a, b, c)
361 #define M_FLD(a,b,c)                    M_OP2_IMM(48, a, b, c)
362 #define M_FST(a,b,c)                    M_OP2_IMM(52, a, b, c)
363
364 #define M_MFLR(a)                       M_OP3(31, 339, 0, 0, a, 8, 0)
365 #define M_MFXER(a)                      M_OP3(31, 339, 0, 0, a, 1, 0)
366 #define M_MFCTR(a)                      M_OP3(31, 339, 0, 0, a, 9, 0)
367 #define M_MTLR(a)                       M_OP3(31, 467, 0, 0, a, 8, 0)
368 #define M_MTXER(a)                      M_OP3(31, 467, 0, 0, a, 1, 0)
369 #define M_MTCTR(a)                      M_OP3(31, 467, 0, 0, a, 9, 0)
370
371 #define M_LDA(a,b,c)                    M_IADD_IMM(b, c, a)
372 #define M_LDATST(a,b,c)                 M_ADDICTST(b, c, a)
373 #define M_CLR(a)                        M_IADD_IMM(0, 0, a)
374 #define M_AADD_IMM(a,b,c)               M_IADD_IMM(a, b, c)
375
376
377 /* function gen_resolvebranch **************************************************
378
379         parameters: ip ... pointer to instruction after branch (void*)
380                     so ... offset of instruction after branch  (s4)
381                     to ... offset of branch target             (s4)
382
383 *******************************************************************************/
384
385 #define gen_resolvebranch(ip,so,to) \
386         *((s4*)(ip)-1)=(*((s4*)(ip)-1) & ~M_BRMASK) | (((s4)((to)-(so))+4)&((((*((s4*)(ip)-1)>>26)&63)==18)?M_BRAMASK:M_BRMASK))
387
388
389 /* function prototypes */
390
391 void preregpass(methodinfo *m, registerdata *rd);
392 void docacheflush(u1 *p, long bytelen);
393
394 #endif /* _CODEGEN_H */
395
396
397 /*
398  * These are local overrides for various environment variables in Emacs.
399  * Please do not remove this and leave it at the end of the file, where
400  * Emacs will automagically detect them.
401  * ---------------------------------------------------------------------
402  * Local variables:
403  * mode: c
404  * indent-tabs-mode: t
405  * c-basic-offset: 4
406  * tab-width: 4
407  * End:
408  */