c4c97162d92867511a31caea0737cbca62980585
[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         void*          entry;
169
170         switch (type) {
171         case TRAP_NullPointerException:
172                 p = exceptions_new_nullpointerexception();
173                 break;
174
175         case TRAP_ArithmeticException:
176                 p = exceptions_new_arithmeticexception();
177                 break;
178
179         case TRAP_ArrayIndexOutOfBoundsException:
180                 index = (int32_t) val;
181                 p = exceptions_new_arrayindexoutofboundsexception(index);
182                 break;
183
184         case TRAP_ArrayStoreException:
185                 p = exceptions_new_arraystoreexception();
186                 break;
187
188         case TRAP_ClassCastException:
189                 p = exceptions_new_classcastexception(o);
190                 break;
191
192         case TRAP_CHECK_EXCEPTION:
193                 p = exceptions_fillinstacktrace();
194                 break;
195
196         case TRAP_PATCHER:
197 #if defined(ENABLE_REPLACEMENT)
198                 if (replace_me_wrapper((uint8_t*) xpc, context)) {
199                         p = NULL;
200                         break;
201                 }
202 #endif
203                 p = patcher_handler((uint8_t*) xpc);
204                 break;
205
206         case TRAP_COMPILER:
207                 entry = jit_compile_handle(m, sfi.pv, ra, (void*) val);
208                 p = NULL;
209                 break;
210
211 #if defined(ENABLE_REPLACEMENT)
212         case TRAP_COUNTDOWN:
213 # if defined(__I386__)
214                 replace_me_wrapper((char*)xpc - 13, context);
215 # endif
216                 p = NULL;
217                 break;
218 #endif
219
220         default:
221                 /* Let's try to get a backtrace. */
222
223                 (void) methodtree_find(xpc);
224
225                 /* If that does not work, print more debug info. */
226
227                 log_println("signal_handle: unknown hardware exception type %d", type);
228
229 #if SIZEOF_VOID_P == 8
230                 log_println("PC=0x%016lx", xpc);
231 #else
232                 log_println("PC=0x%08x", xpc);
233 #endif
234
235 #if defined(ENABLE_DISASSEMBLER)
236                 log_println("machine instruction at PC:");
237                 disassinstr((uint8_t*) xpc);
238 #endif
239
240                 vm_abort("Exiting...");
241
242                 /* keep compiler happy */
243
244                 p = NULL;
245         }
246
247         /* Remove stackframeinfo. */
248
249         stacktrace_stackframeinfo_remove(&sfi);
250
251 #if defined(__ALPHA__) || defined(__ARM__) || defined(__I386__) || defined(__POWERPC__) || defined(__POWERPC64__) || defined(__X86_64__)
252         /* Update execution state and set registers. */
253         /* AFTER: removing stackframeinfo */
254
255         switch (type) {
256         case TRAP_COMPILER:
257                 // The normal case for a compiler trap is to jump directly to
258                 // the newly compiled method.
259
260                 if (entry != NULL) {
261                         es.pc = (uint8_t *) (uintptr_t) entry;
262                         es.pv = (uint8_t *) (uintptr_t) entry;
263                         break;
264                 }
265
266                 // In case of an exception during JIT compilation, we fetch
267                 // the exception here and proceed with exception handling.
268
269                 p = exceptions_get_and_clear_exception();
270                 assert(p != NULL);
271
272                 // Get and set the PV from the parent Java method.
273
274                 es.pv = (uint8_t *) md_codegen_get_pv_from_pc(ra);
275
276                 // Now fall-through to default exception handling.
277
278                 goto trap_handle_exception;
279
280         case TRAP_PATCHER:
281                 // The normal case for a patcher trap is to continue execution at
282                 // the trap instruction. On some archs the PC may point after the
283                 // trap instruction, so we reset it here.
284
285                 if (p == NULL) {
286                         es.pc = (uint8_t *) (uintptr_t) xpc;
287                         break;
288                 }
289
290                 // Fall-through to default exception handling.
291
292         trap_handle_exception:
293         default:
294                 if (p != NULL) {
295                         es.intregs[REG_ITMP1_XPTR] = (uintptr_t) LLNI_DIRECT(p);
296                         es.intregs[REG_ITMP2_XPC]  = (uintptr_t) xpc;
297                         es.pc                      = (uint8_t *) (uintptr_t) asm_handle_exception;
298                 }
299         }
300
301         /* Write back execution state to current context. */
302
303         md_executionstate_write(&es, context);
304 #endif
305
306         /* Unwrap and return the exception object. */
307         /* AFTER: removing stackframeinfo */
308
309         if (type == TRAP_COMPILER)
310                 return entry;
311         else
312                 return LLNI_UNWRAP(p);
313 }
314
315 #ifdef __cplusplus
316 }
317 #endif
318
319
320 /*
321  * These are local overrides for various environment variables in Emacs.
322  * Please do not remove this and leave it at the end of the file, where
323  * Emacs will automagically detect them.
324  * ---------------------------------------------------------------------
325  * Local variables:
326  * mode: c++
327  * indent-tabs-mode: t
328  * c-basic-offset: 4
329  * tab-width: 4
330  * End:
331  */