* src/vm/jit/trap.c: Moved to C++
[cacao.git] / src / vm / jit / trap.cpp
1 /* src/vm/jit/trap.cpp - hardware traps
2
3    Copyright (C) 2008
4    CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
5
6    This file is part of CACAO.
7
8    This program is free software; you can redistribute it and/or
9    modify it under the terms of the GNU General Public License as
10    published by the Free Software Foundation; either version 2, or (at
11    your option) any later version.
12
13    This program is distributed in the hope that it will be useful, but
14    WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16    General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21    02110-1301, USA.
22
23 */
24
25
26 #include "config.h"
27
28 #include <stdint.h>
29
30 /* Include machine dependent trap stuff. */
31
32 #include "md.h"
33 #include "md-trap.h"
34
35 #include "mm/memory.hpp"
36
37 #include "native/llni.h"
38
39 #include "toolbox/logging.hpp"
40
41 #include "vm/exceptions.hpp"
42 #include "vm/options.h"
43 #include "vm/os.hpp"
44 #include "vm/vm.hpp"
45
46 #include "vm/jit/asmpart.h"
47 #include "vm/jit/code.hpp"
48 #include "vm/jit/disass.h"
49 #include "vm/jit/executionstate.h"
50 #include "vm/jit/jit.hpp"
51 #include "vm/jit/methodtree.h"
52 #include "vm/jit/patcher-common.hpp"
53 #include "vm/jit/replace.hpp"
54 #include "vm/jit/stacktrace.hpp"
55
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59
60 /**
61  * Mmap the first memory page to support hardware exceptions and check
62  * the maximum hardware trap displacement on the architectures where
63  * it is required (TRAP_INSTRUCTION_IS_LOAD defined to 1).
64  */
65 void trap_init(void)
66 {
67 #if !(defined(__ARM__) && defined(__LINUX__))
68         /* On arm-linux the first memory page can't be mmap'ed, as it
69            contains the exception vectors. */
70
71         int pagesize;
72
73         /* mmap a memory page at address 0x0, so our hardware-exceptions
74            work. */
75
76         pagesize = os::getpagesize();
77
78         (void) os::mmap_anonymous(NULL, pagesize, PROT_NONE, MAP_PRIVATE | MAP_FIXED);
79 #endif
80
81         TRACESUBSYSTEMINITIALIZATION("trap_init");
82
83 #if !defined(TRAP_INSTRUCTION_IS_LOAD)
84 # error TRAP_INSTRUCTION_IS_LOAD is not defined in your md-trap.h
85 #endif
86
87 #if TRAP_INSTRUCTION_IS_LOAD == 1
88         /* Check if we get into trouble with our hardware-exceptions. */
89
90         if (TRAP_END > OFFSET(java_bytearray_t, data))
91                 vm_abort("trap_init: maximum hardware trap displacement is greater than the array-data offset: %d > %d", TRAP_END, OFFSET(java_bytearray_t, data));
92 #endif
93 }
94
95
96 /**
97  * Handles the signal which is generated by trap instructions, caught
98  * by a signal handler and calls the correct function.
99  *
100  * @param type trap number
101  * @param 
102  */
103 void* trap_handle(int type, intptr_t val, void *pv, void *sp, void *ra, void *xpc, void *context)
104 {
105         executionstate_t es;
106         stackframeinfo_t sfi;
107
108 #if !defined(NDEBUG)
109         if (opt_TraceTraps)
110                 log_println("[signal_handle: trap %d]", type);
111 #endif
112         
113 #if defined(ENABLE_VMLOG)
114         vmlog_cacao_signl_type(type);
115 #endif
116
117         /* Prevent compiler warnings. */
118
119         java_handle_t* o = NULL;
120         methodinfo*    m = NULL;
121
122 #if defined(__ALPHA__) || defined(__ARM__) || defined(__I386__) || defined(__POWERPC__) || defined(__POWERPC64__) || defined(__X86_64__)
123 # if !defined(NDEBUG)
124         /* Perform a sanity check on our execution state functions. */
125
126         executionstate_sanity_check(context);
127 # endif
128
129         /* Read execution state from current context. */
130
131         es.code = NULL;
132         md_executionstate_read(&es, context);
133 #endif
134
135         /* Do some preparations before we enter the nativeworld. */
136         /* BEFORE: creating stackframeinfo */
137
138         switch (type) {
139         case TRAP_ClassCastException:
140                 /* Wrap the value into a handle, as it is a reference. */
141
142                 o = LLNI_WRAP((java_object_t *) val);
143                 break;
144
145         case TRAP_COMPILER:
146                 /* In this case the passed PV points to the compiler stub.  We
147                    get the methodinfo pointer here and set PV to NULL so
148                    stacktrace_stackframeinfo_add determines the PV for the
149                    parent Java method. */
150
151                 m  = code_get_methodinfo_for_pv(pv);
152                 pv = NULL;
153                 break;
154
155         default:
156                 /* do nothing */
157                 break;
158         }
159
160         /* Fill and add a stackframeinfo. */
161
162         stacktrace_stackframeinfo_add(&sfi, pv, sp, ra, xpc);
163
164         /* Get resulting exception (or pointer to compiled method). */
165
166         int32_t        index;
167         java_handle_t* p;
168
169         switch (type) {
170         case TRAP_NullPointerException:
171                 p = exceptions_new_nullpointerexception();
172                 break;
173
174         case TRAP_ArithmeticException:
175                 p = exceptions_new_arithmeticexception();
176                 break;
177
178         case TRAP_ArrayIndexOutOfBoundsException:
179                 index = (int32_t) val;
180                 p = exceptions_new_arrayindexoutofboundsexception(index);
181                 break;
182
183         case TRAP_ArrayStoreException:
184                 p = exceptions_new_arraystoreexception();
185                 break;
186
187         case TRAP_ClassCastException:
188                 p = exceptions_new_classcastexception(o);
189                 break;
190
191         case TRAP_CHECK_EXCEPTION:
192                 p = exceptions_fillinstacktrace();
193                 break;
194
195         case TRAP_PATCHER:
196 #if defined(ENABLE_REPLACEMENT)
197                 if (replace_me_wrapper((uint8_t*) xpc, context)) {
198                         p = NULL;
199                         break;
200                 }
201 #endif
202                 p = patcher_handler((uint8_t*) xpc);
203                 break;
204
205         case TRAP_COMPILER:
206                 p = (java_handle_t*) jit_compile_handle(m, sfi.pv, ra, (void*) val);
207                 break;
208
209 #if defined(ENABLE_REPLACEMENT)
210         case TRAP_COUNTDOWN:
211 # if defined(__I386__)
212                 replace_me_wrapper((char*)xpc - 13, context);
213 # endif
214                 p = NULL;
215                 break;
216 #endif
217
218         default:
219                 /* Let's try to get a backtrace. */
220
221                 (void) methodtree_find(xpc);
222
223                 /* If that does not work, print more debug info. */
224
225                 log_println("signal_handle: unknown hardware exception type %d", type);
226
227 #if SIZEOF_VOID_P == 8
228                 log_println("PC=0x%016lx", xpc);
229 #else
230                 log_println("PC=0x%08x", xpc);
231 #endif
232
233 #if defined(ENABLE_DISASSEMBLER)
234                 log_println("machine instruction at PC:");
235                 disassinstr((uint8_t*) xpc);
236 #endif
237
238                 vm_abort("Exiting...");
239
240                 /* keep compiler happy */
241
242                 p = NULL;
243         }
244
245         /* Remove stackframeinfo. */
246
247         stacktrace_stackframeinfo_remove(&sfi);
248
249 #if defined(__ALPHA__) || defined(__ARM__) || defined(__I386__) || defined(__POWERPC__) || defined(__POWERPC64__) || defined(__X86_64__)
250         /* Update execution state and set registers. */
251         /* AFTER: removing stackframeinfo */
252
253         switch (type) {
254         case TRAP_COMPILER:
255                 // The normal case for a compiler trap is to jump directly to
256                 // the newly compiled method.
257
258                 if (p != NULL) {
259                         es.pc = (uint8_t *) (uintptr_t) p;
260                         es.pv = (uint8_t *) (uintptr_t) p;
261                         break;
262                 }
263
264                 // In case of an exception during JIT compilation, we fetch
265                 // the exception here and proceed with exception handling.
266
267                 p = exceptions_get_and_clear_exception();
268                 assert(p != NULL);
269
270                 // Get and set the PV from the parent Java method.
271
272                 es.pv = (uint8_t *) md_codegen_get_pv_from_pc(ra);
273
274                 // Now fall-through to default exception handling.
275
276                 goto trap_handle_exception;
277
278         case TRAP_PATCHER:
279                 // The normal case for a patcher trap is to continue execution at
280                 // the trap instruction. On some archs the PC may point after the
281                 // trap instruction, so we reset it here.
282
283                 if (p == NULL) {
284                         es.pc = (uint8_t *) (uintptr_t) xpc;
285                         break;
286                 }
287
288                 // Fall-through to default exception handling.
289
290         trap_handle_exception:
291         default:
292                 if (p != NULL) {
293                         es.intregs[REG_ITMP1_XPTR] = (uintptr_t) LLNI_DIRECT(p);
294                         es.intregs[REG_ITMP2_XPC]  = (uintptr_t) xpc;
295                         es.pc                      = (uint8_t *) (uintptr_t) asm_handle_exception;
296                 }
297         }
298
299         /* Write back execution state to current context. */
300
301         md_executionstate_write(&es, context);
302 #endif
303
304         /* Unwrap and return the exception object. */
305         /* AFTER: removing stackframeinfo */
306
307         if (type == TRAP_COMPILER)
308                 return p;
309         else
310                 return LLNI_UNWRAP(p);
311 }
312
313 #ifdef __cplusplus
314 }
315 #endif
316
317
318 /*
319  * These are local overrides for various environment variables in Emacs.
320  * Please do not remove this and leave it at the end of the file, where
321  * Emacs will automagically detect them.
322  * ---------------------------------------------------------------------
323  * Local variables:
324  * mode: c++
325  * indent-tabs-mode: t
326  * c-basic-offset: 4
327  * tab-width: 4
328  * End:
329  */