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