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