* Removed all Id tags.
[cacao.git] / src / vm / jit / arm / emit.c
1 /* src/vm/jit/arm/emit.c - Arm code emitter functions
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 */
26
27
28 #include "config.h"
29
30 #include <assert.h>
31 #include <stdint.h>
32
33 #include "vm/types.h"
34
35 #include "md-abi.h"
36
37 #include "vm/jit/arm/codegen.h"
38
39 #include "mm/memory.h"
40
41 #include "threads/lock-common.h"
42
43 #include "vm/builtin.h"
44 #include "vm/exceptions.h"
45 #include "vm/global.h"
46
47 #include "vm/jit/abi.h"
48 #include "vm/jit/asmpart.h"
49 #include "vm/jit/emit-common.h"
50 #include "vm/jit/jit.h"
51 #include "vm/jit/patcher-common.h"
52 #include "vm/jit/replace.h"
53
54 #include "toolbox/logging.h" /* XXX for debugging only */
55
56
57 /* emit_load *******************************************************************
58
59    Emits a possible load of an operand.
60
61 *******************************************************************************/
62
63 s4 emit_load(jitdata *jd, instruction *iptr, varinfo *src, s4 tempreg)
64 {
65         codegendata  *cd;
66         s4            disp;
67         s4            reg;
68
69         /* get required compiler data */
70
71         cd = jd->cd;
72
73         if (src->flags & INMEMORY) {
74                 COUNT_SPILLS;
75
76                 disp = src->vv.regoff;
77
78 #if defined(ENABLE_SOFTFLOAT)
79                 switch (src->type) {
80                 case TYPE_INT:
81                 case TYPE_FLT:
82                 case TYPE_ADR:
83                         M_ILD(tempreg, REG_SP, disp);
84                         break;
85                 case TYPE_LNG:
86                 case TYPE_DBL:
87                         M_LLD(tempreg, REG_SP, disp);
88                         break;
89                 default:
90                         vm_abort("emit_load: unknown type %d", src->type);
91                 }
92 #else
93                 switch (src->type) {
94                 case TYPE_INT:
95                 case TYPE_ADR:
96                         M_ILD(tempreg, REG_SP, disp);
97                         break;
98                 case TYPE_LNG:
99                         M_LLD(tempreg, REG_SP, disp);
100                         break;
101                 case TYPE_FLT:
102                         M_FLD(tempreg, REG_SP, disp);
103                         break;
104                 case TYPE_DBL:
105                         M_DLD(tempreg, REG_SP, disp);
106                         break;
107                 default:
108                         vm_abort("emit_load: unknown type %d", src->type);
109                 }
110 #endif
111
112                 reg = tempreg;
113         }
114         else
115                 reg = src->vv.regoff;
116
117         return reg;
118 }
119
120
121 /* emit_load_low ***************************************************************
122
123    Emits a possible load of the low 32-bits of a long source operand.
124
125 *******************************************************************************/
126
127 s4 emit_load_low(jitdata *jd, instruction *iptr, varinfo *src, s4 tempreg)
128 {
129         codegendata  *cd;
130         s4            disp;
131         s4            reg;
132
133         assert(src->type == TYPE_LNG);
134
135         /* get required compiler data */
136
137         cd = jd->cd;
138
139         if (src->flags & INMEMORY) {
140                 COUNT_SPILLS;
141
142                 disp = src->vv.regoff;
143
144 #if defined(__ARMEL__)
145                 M_ILD(tempreg, REG_SP, disp);
146 #else
147                 M_ILD(tempreg, REG_SP, disp + 4);
148 #endif
149
150                 reg = tempreg;
151         }
152         else
153                 reg = GET_LOW_REG(src->vv.regoff);
154
155         return reg;
156 }
157
158
159 /* emit_load_high **************************************************************
160
161    Emits a possible load of the high 32-bits of a long source operand.
162
163 *******************************************************************************/
164
165 s4 emit_load_high(jitdata *jd, instruction *iptr, varinfo *src, s4 tempreg)
166 {
167         codegendata  *cd;
168         s4            disp;
169         s4            reg;
170
171         assert(src->type == TYPE_LNG);
172
173         /* get required compiler data */
174
175         cd = jd->cd;
176
177         if (src->flags & INMEMORY) {
178                 COUNT_SPILLS;
179
180                 disp = src->vv.regoff;
181
182 #if defined(__ARMEL__)
183                 M_ILD(tempreg, REG_SP, disp + 4);
184 #else
185                 M_ILD(tempreg, REG_SP, disp);
186 #endif
187
188                 reg = tempreg;
189         }
190         else
191                 reg = GET_HIGH_REG(src->vv.regoff);
192
193         return reg;
194 }
195
196
197 /* emit_store ******************************************************************
198
199    Emits a possible store to a variable.
200
201 *******************************************************************************/
202
203 void emit_store(jitdata *jd, instruction *iptr, varinfo *dst, s4 d)
204 {
205         codegendata  *cd;
206         s4            disp;
207
208         /* get required compiler data */
209
210         cd = jd->cd;
211
212         if (dst->flags & INMEMORY) {
213                 COUNT_SPILLS;
214
215                 disp = dst->vv.regoff;
216
217 #if defined(ENABLE_SOFTFLOAT)
218                 switch (dst->type) {
219                 case TYPE_INT:
220                 case TYPE_FLT:
221                 case TYPE_ADR:
222                         M_IST(d, REG_SP, disp);
223                         break;
224                 case TYPE_LNG:
225                 case TYPE_DBL:
226                         M_LST(d, REG_SP, disp);
227                         break;
228                 default:
229                         vm_abort("emit_store: unknown type %d", dst->type);
230                 }
231 #else
232                 switch (dst->type) {
233                 case TYPE_INT:
234                 case TYPE_ADR:
235                         M_IST(d, REG_SP, disp);
236                         break;
237                 case TYPE_LNG:
238                         M_LST(d, REG_SP, disp);
239                         break;
240                 case TYPE_FLT:
241                         M_FST(d, REG_SP, disp);
242                         break;
243                 case TYPE_DBL:
244                         M_DST(d, REG_SP, disp);
245                         break;
246                 default:
247                         vm_abort("emit_store: unknown type %d", dst->type);
248                 }
249 #endif
250         }
251 }
252
253
254 /* emit_copy *******************************************************************
255
256    Generates a register/memory to register/memory copy.
257
258 *******************************************************************************/
259
260 void emit_copy(jitdata *jd, instruction *iptr)
261 {
262         codegendata *cd;
263         varinfo     *src;
264         varinfo     *dst;
265         s4           s1, d;
266
267         /* get required compiler data */
268
269         cd = jd->cd;
270
271         /* get source and destination variables */
272
273         src = VAROP(iptr->s1);
274         dst = VAROP(iptr->dst);
275
276         /* XXX dummy call, removed me!!! */
277         d = codegen_reg_of_var(iptr->opc, dst, REG_ITMP1);
278
279         if ((src->vv.regoff != dst->vv.regoff) ||
280                 ((src->flags ^ dst->flags) & INMEMORY)) {
281
282                 if ((src->type == TYPE_RET) || (dst->type == TYPE_RET)) {
283                         /* emit nothing, as the value won't be used anyway */
284                         return;
285                 }
286
287                 /* If one of the variables resides in memory, we can eliminate
288                    the register move from/to the temporary register with the
289                    order of getting the destination register and the load. */
290
291                 if (IS_INMEMORY(src->flags)) {
292 #if !defined(ENABLE_SOFTFLOAT)
293                         if (IS_FLT_DBL_TYPE(src->type))
294                                 d = codegen_reg_of_var(iptr->opc, dst, REG_FTMP1);
295                         else
296 #endif
297                         {
298                                 if (IS_2_WORD_TYPE(src->type))
299                                         d = codegen_reg_of_var(iptr->opc, dst, REG_ITMP12_PACKED);
300                                 else
301                                         d = codegen_reg_of_var(iptr->opc, dst, REG_ITMP1);
302                         }
303
304                         s1 = emit_load(jd, iptr, src, d);
305                 }
306                 else {
307 #if !defined(ENABLE_SOFTFLOAT)
308                         if (IS_FLT_DBL_TYPE(src->type))
309                                 s1 = emit_load(jd, iptr, src, REG_FTMP1);
310                         else
311 #endif
312                         {
313                                 if (IS_2_WORD_TYPE(src->type))
314                                         s1 = emit_load(jd, iptr, src, REG_ITMP12_PACKED);
315                                 else
316                                         s1 = emit_load(jd, iptr, src, REG_ITMP1);
317                         }
318
319                         d = codegen_reg_of_var(iptr->opc, dst, s1);
320                 }
321
322                 if (s1 != d) {
323 #if defined(ENABLE_SOFTFLOAT)
324                         switch (src->type) {
325                         case TYPE_INT:
326                         case TYPE_FLT:
327                         case TYPE_ADR:
328                                 /* XXX grrrr, wrong direction! */
329                                 M_MOV(d, s1);
330                                 break;
331                         case TYPE_LNG:
332                         case TYPE_DBL:
333                                 /* XXX grrrr, wrong direction! */
334                                 M_MOV(GET_LOW_REG(d), GET_LOW_REG(s1));
335                                 M_MOV(GET_HIGH_REG(d), GET_HIGH_REG(s1));
336                                 break;
337                         default:
338                                 vm_abort("emit_copy: unknown type %d", src->type);
339                         }
340 #else
341                         switch (src->type) {
342                         case TYPE_INT:
343                         case TYPE_ADR:
344                                 /* XXX grrrr, wrong direction! */
345                                 M_MOV(d, s1);
346                                 break;
347                         case TYPE_LNG:
348                                 /* XXX grrrr, wrong direction! */
349                                 M_MOV(GET_LOW_REG(d), GET_LOW_REG(s1));
350                                 M_MOV(GET_HIGH_REG(d), GET_HIGH_REG(s1));
351                                 break;
352                         case TYPE_FLT:
353                                 M_FMOV(s1, d);
354                                 break;
355                         case TYPE_DBL:
356                                 M_DMOV(s1, d);
357                                 break;
358                         default:
359                                 vm_abort("emit_copy: unknown type %d", src->type);
360                         }
361 #endif
362                 }
363
364                 emit_store(jd, iptr, dst, d);
365         }
366 }
367
368
369 /* emit_iconst *****************************************************************
370
371    XXX
372
373 *******************************************************************************/
374
375 void emit_iconst(codegendata *cd, s4 d, s4 value)
376 {
377         s4 disp;
378
379         if (IS_IMM(value))
380                 M_MOV_IMM(d, value);
381         else {
382                 disp = dseg_add_s4(cd, value);
383                 M_DSEG_LOAD(d, disp);
384         }
385 }
386
387
388 /* emit_branch *****************************************************************
389
390    Emits the code for conditional and unconditional branchs.
391
392 *******************************************************************************/
393
394 void emit_branch(codegendata *cd, s4 disp, s4 condition, s4 reg, u4 opt)
395 {
396         s4 checkdisp;
397         s4 branchdisp;
398
399         /* calculate the different displacements */
400
401         checkdisp  = (disp - 8);
402         branchdisp = (disp - 8) >> 2;
403
404         /* check which branch to generate */
405
406         if (condition == BRANCH_UNCONDITIONAL) {
407                 /* check displacement for overflow */
408
409                 if ((checkdisp < (s4) 0xff000000) || (checkdisp > (s4) 0x00ffffff)) {
410                         /* if the long-branches flag isn't set yet, do it */
411
412                         if (!CODEGENDATA_HAS_FLAG_LONGBRANCHES(cd)) {
413                                 cd->flags |= (CODEGENDATA_FLAG_ERROR |
414                                                           CODEGENDATA_FLAG_LONGBRANCHES);
415                         }
416
417                         vm_abort("emit_branch: emit unconditional long-branch code");
418                 }
419                 else {
420                         M_B(branchdisp);
421                 }
422         }
423         else {
424                 /* and displacement for overflow */
425
426                 if ((checkdisp < (s4) 0xff000000) || (checkdisp > (s4) 0x00ffffff)) {
427                         /* if the long-branches flag isn't set yet, do it */
428
429                         if (!CODEGENDATA_HAS_FLAG_LONGBRANCHES(cd)) {
430                                 cd->flags |= (CODEGENDATA_FLAG_ERROR |
431                                                           CODEGENDATA_FLAG_LONGBRANCHES);
432                         }
433
434                         vm_abort("emit_branch: emit conditional long-branch code");
435                 }
436                 else {
437                         switch (condition) {
438                         case BRANCH_EQ:
439                                 M_BEQ(branchdisp);
440                                 break;
441                         case BRANCH_NE:
442                                 M_BNE(branchdisp);
443                                 break;
444                         case BRANCH_LT:
445                                 M_BLT(branchdisp);
446                                 break;
447                         case BRANCH_GE:
448                                 M_BGE(branchdisp);
449                                 break;
450                         case BRANCH_GT:
451                                 M_BGT(branchdisp);
452                                 break;
453                         case BRANCH_LE:
454                                 M_BLE(branchdisp);
455                                 break;
456                         case BRANCH_UGT:
457                                 M_BHI(branchdisp);
458                                 break;
459                         default:
460                                 vm_abort("emit_branch: unknown condition %d", condition);
461                         }
462                 }
463         }
464 }
465
466
467 /* emit_arithmetic_check *******************************************************
468
469    Emit an ArithmeticException check.
470
471 *******************************************************************************/
472
473 void emit_arithmetic_check(codegendata *cd, instruction *iptr, s4 reg)
474 {
475         if (INSTRUCTION_MUST_CHECK(iptr)) {
476                 CHECK_INT_REG(reg);
477                 M_TEQ_IMM(reg, 0);
478                 M_TRAPEQ(0, EXCEPTION_HARDWARE_ARITHMETIC);
479         }
480 }
481
482
483 /* emit_nullpointer_check ******************************************************
484
485    Emit a NullPointerException check.
486
487 *******************************************************************************/
488
489 void emit_nullpointer_check(codegendata *cd, instruction *iptr, s4 reg)
490 {
491         if (INSTRUCTION_MUST_CHECK(iptr)) {
492                 M_TST(reg, reg);
493                 M_TRAPEQ(0, EXCEPTION_HARDWARE_NULLPOINTER);
494         }
495 }
496
497 void emit_nullpointer_check_force(codegendata *cd, instruction *iptr, s4 reg)
498 {
499         M_TST(reg, reg);
500         M_TRAPEQ(0, EXCEPTION_HARDWARE_NULLPOINTER);
501 }
502
503
504 /* emit_arrayindexoutofbounds_check ********************************************
505
506    Emit a ArrayIndexOutOfBoundsException check.
507
508 *******************************************************************************/
509
510 void emit_arrayindexoutofbounds_check(codegendata *cd, instruction *iptr, s4 s1, s4 s2)
511 {
512         if (INSTRUCTION_MUST_CHECK(iptr)) {
513                 M_ILD_INTERN(REG_ITMP3, s1, OFFSET(java_array_t, size));
514                 M_CMP(s2, REG_ITMP3);
515                 M_TRAPHS(s2, EXCEPTION_HARDWARE_ARRAYINDEXOUTOFBOUNDS);
516         }
517 }
518
519
520 /* emit_classcast_check ********************************************************
521
522    Emit a ClassCastException check.
523
524 *******************************************************************************/
525
526 void emit_classcast_check(codegendata *cd, instruction *iptr, s4 condition, s4 reg, s4 s1)
527 {
528         if (INSTRUCTION_MUST_CHECK(iptr)) {
529                 switch (condition) {
530                 case BRANCH_EQ:
531                         M_TRAPEQ(s1, EXCEPTION_HARDWARE_CLASSCAST);
532                         break;
533
534                 case BRANCH_LE:
535                         M_TRAPLE(s1, EXCEPTION_HARDWARE_CLASSCAST);
536                         break;
537
538                 case BRANCH_UGT:
539                         M_TRAPHI(s1, EXCEPTION_HARDWARE_CLASSCAST);
540                         break;
541
542                 default:
543                         vm_abort("emit_classcast_check: unknown condition %d", condition);
544                 }
545         }
546 }
547
548 /* emit_exception_check ********************************************************
549
550    Emit an Exception check.
551
552 *******************************************************************************/
553
554 void emit_exception_check(codegendata *cd, instruction *iptr)
555 {
556         if (INSTRUCTION_MUST_CHECK(iptr)) {
557                 M_TST(REG_RESULT, REG_RESULT);
558                 M_TRAPEQ(0, EXCEPTION_HARDWARE_EXCEPTION);
559         }
560 }
561
562
563 /* emit_trap *******************************************************************
564
565    Emit a trap instruction and return the original machine code.
566
567 *******************************************************************************/
568
569 uint32_t emit_trap(codegendata *cd)
570 {
571         uint32_t mcode;
572
573         /* Get machine code which is patched back in later. The
574            trap is 1 instruction word long. */
575
576         mcode = *((u4 *) cd->mcodeptr);
577
578         M_TRAP(0, EXCEPTION_HARDWARE_PATCHER);
579
580         return mcode;
581 }
582
583
584 /* emit_verbosecall_enter ******************************************************
585
586    Generates the code for the call trace.
587
588 *******************************************************************************/
589
590 #if !defined(NDEBUG)
591 void emit_verbosecall_enter(jitdata *jd)
592 {
593         methodinfo   *m;
594         codegendata  *cd;
595         registerdata *rd;
596         methoddesc   *md;
597         s4            stackframesize;
598         s4            disp;
599         s4            i, t, s1, s2;
600
601         /* get required compiler data */
602
603         m  = jd->m;
604         cd = jd->cd;
605         rd = jd->rd;
606
607         md = m->parseddesc;
608
609         /* stackframesize is changed below */
610
611         stackframesize = cd->stackframesize;
612
613         /* mark trace code */
614
615         M_NOP;
616
617         /* Save argument registers to stack (including LR and PV).  Keep
618            stack 8-byte aligned. */
619
620         M_STMFD(BITMASK_ARGS | (1<<REG_LR) | (1<<REG_PV), REG_SP);
621         M_SUB_IMM(REG_SP, REG_SP, (2 + 2 + 1 + 1) * 4); /* space for a3, a4 and m */
622
623         stackframesize += (6 + 2 + 2 + 1 + 1) * 4;
624
625         /* prepare args for tracer */
626
627         i = md->paramcount - 1;
628
629         if (i > 3)
630                 i = 3;
631
632         for (; i >= 0; i--) {
633                 t = md->paramtypes[i].type;
634
635                 /* load argument into register (s1) and make it of TYPE_LNG */
636
637                 if (!md->params[i].inmemory) {
638                         s1 = md->params[i].regoff;
639
640                         if (!IS_2_WORD_TYPE(t)) {
641                                 M_MOV_IMM(REG_ITMP1, 0);
642                                 s1 = PACK_REGS(s1, REG_ITMP1);
643                         }
644                 }
645                 else {
646                         s1 = REG_ITMP12_PACKED;
647                         s2 = md->params[i].regoff + stackframesize;
648
649                         if (IS_2_WORD_TYPE(t))
650                                 M_LLD(s1, REG_SP, s2);
651                         else {
652                                 M_ILD(GET_LOW_REG(s1), REG_SP, s2);
653                                 M_MOV_IMM(GET_HIGH_REG(s1), 0);
654                         }
655                 }
656
657                 /* place argument for tracer */
658
659                 if (i < 2) {
660 #if defined(__ARMEL__)
661                         s2 = PACK_REGS(abi_registers_integer_argument[i * 2],
662                                                    abi_registers_integer_argument[i * 2 + 1]);
663 #else /* defined(__ARMEB__) */
664                         s2 = PACK_REGS(abi_registers_integer_argument[i * 2 + 1],
665                                                    abi_registers_integer_argument[i * 2]);
666 #endif          
667                         M_LNGMOVE(s1, s2);
668                 }
669                 else {
670                         s2 = (i - 2) * 2;
671                         M_LST(s1, REG_SP, s2 * 4);
672                 }
673         }
674
675         /* prepare methodinfo pointer for tracer */
676
677         disp = dseg_add_address(cd, m);
678         M_DSEG_LOAD(REG_ITMP1, disp);
679         M_STR_INTERN(REG_ITMP1, REG_SP, 16);
680
681         /* call tracer here (we use a long branch) */
682
683         M_LONGBRANCH(builtin_verbosecall_enter);
684
685         /* Restore argument registers from stack.  Keep stack 8-byte
686            aligned. */
687
688         M_ADD_IMM(REG_SP, REG_SP, (2 + 2 + 1 + 1) * 4);    /* free argument stack */
689         M_LDMFD(BITMASK_ARGS | (1<<REG_LR) | (1<<REG_PV), REG_SP);
690
691         /* mark trace code */
692
693         M_NOP;
694 }
695 #endif /* !defined(NDEBUG) */
696
697
698 /* emit_verbosecall_exit *******************************************************
699
700    Generates the code for the call trace.
701
702    void builtin_verbosecall_exit(s8 l, double d, float f, methodinfo *m);
703
704 *******************************************************************************/
705
706 #if !defined(NDEBUG)
707 void emit_verbosecall_exit(jitdata *jd)
708 {
709         methodinfo   *m;
710         codegendata  *cd;
711         registerdata *rd;
712         methoddesc   *md;
713         s4            disp;
714
715         /* get required compiler data */
716
717         m  = jd->m;
718         cd = jd->cd;
719         rd = jd->rd;
720
721         md = m->parseddesc;
722
723         /* mark trace code */
724
725         M_NOP;
726
727         /* Keep stack 8-byte aligned. */
728
729         M_STMFD(BITMASK_RESULT | (1<<REG_LR) | (1<<REG_PV), REG_SP);
730         M_SUB_IMM(REG_SP, REG_SP, (1 + 1) * 4);              /* space for f and m */
731
732         switch (md->returntype.type) {
733         case TYPE_ADR:
734         case TYPE_INT:
735                 M_INTMOVE(REG_RESULT, GET_LOW_REG(REG_A0_A1_PACKED));
736                 M_MOV_IMM(GET_HIGH_REG(REG_A0_A1_PACKED), 0);
737                 break;
738
739         case TYPE_LNG:
740                 M_LNGMOVE(REG_RESULT_PACKED, REG_A0_A1_PACKED);
741                 break;
742
743         case TYPE_FLT:
744                 M_IST(REG_RESULT, REG_SP, 0 * 4);
745                 break;
746
747         case TYPE_DBL:
748                 M_LNGMOVE(REG_RESULT_PACKED, REG_A2_A3_PACKED);
749                 break;
750         }
751
752         disp = dseg_add_address(cd, m);
753         M_DSEG_LOAD(REG_ITMP1, disp);
754         M_AST(REG_ITMP1, REG_SP, 1 * 4);
755         M_LONGBRANCH(builtin_verbosecall_exit);
756
757         /* Keep stack 8-byte aligned. */
758
759         M_ADD_IMM(REG_SP, REG_SP, (1 + 1) * 4);            /* free argument stack */
760         M_LDMFD(BITMASK_RESULT | (1<<REG_LR) | (1<<REG_PV), REG_SP);
761
762         /* mark trace code */
763
764         M_NOP;
765 }
766 #endif /* !defined(NDEBUG) */
767
768
769 /*
770  * These are local overrides for various environment variables in Emacs.
771  * Please do not remove this and leave it at the end of the file, where
772  * Emacs will automagically detect them.
773  * ---------------------------------------------------------------------
774  * Local variables:
775  * mode: c
776  * indent-tabs-mode: t
777  * c-basic-offset: 4
778  * tab-width: 4
779  * End:
780  * vim:noexpandtab:sw=4:ts=4:
781  */