2 #ifdef LISP_FEATURE_SB_THREAD
3 #include <architecture/i386/table.h>
4 #include <i386/user_ldt.h>
5 #include <mach/mach_init.h>
11 #include "interrupt.h"
12 #include "x86-64-darwin-os.h"
13 #include "genesis/fdefn.h"
15 #include <mach/mach.h>
16 #include <mach/mach_error.h>
17 #include <mach/mach_types.h>
18 #include <mach/sync_policy.h>
19 #include <mach/machine/thread_state.h>
20 #include <mach/machine/thread_status.h>
21 #include <sys/_types.h>
22 #include <sys/ucontext.h>
28 #ifdef LISP_FEATURE_SB_THREAD
29 pthread_mutex_t mach_exception_lock
= PTHREAD_MUTEX_INITIALIZER
;
32 #ifdef LISP_FEATURE_MACH_EXCEPTION_HANDLER
34 kern_return_t
mach_thread_init(mach_port_t thread_exception_port
);
36 void sigill_handler(int signal
, siginfo_t
*siginfo
, void *void_context
);
37 void sigtrap_handler(int signal
, siginfo_t
*siginfo
, void *void_context
);
38 void memory_fault_handler(int signal
, siginfo_t
*siginfo
, void *void_context
);
40 /* exc_server handles mach exception messages from the kernel and
41 * calls catch exception raise. We use the system-provided
42 * mach_msg_server, which, I assume, calls exc_server in a loop.
45 extern boolean_t
exc_server();
47 /* This executes in the faulting thread as part of the signal
48 * emulation. It is passed a context with the uc_mcontext field
49 * pointing to a valid block of memory. */
50 void build_fake_signal_context(struct ucontext
*context
,
51 x86_thread_state64_t
*thread_state
,
52 x86_float_state64_t
*float_state
) {
53 pthread_sigmask(0, NULL
, &context
->uc_sigmask
);
54 context
->uc_mcontext
->ss
= *thread_state
;
55 context
->uc_mcontext
->fs
= *float_state
;
58 /* This executes in the faulting thread as part of the signal
59 * emulation. It is effectively the inverse operation from above. */
60 void update_thread_state_from_context(x86_thread_state64_t
*thread_state
,
61 x86_float_state64_t
*float_state
,
62 struct ucontext
*context
) {
63 *thread_state
= context
->uc_mcontext
->ss
;
64 *float_state
= context
->uc_mcontext
->fs
;
65 pthread_sigmask(SIG_SETMASK
, &context
->uc_sigmask
, NULL
);
68 /* Modify a context to push new data on its stack. */
69 void push_context(u64 data
, x86_thread_state64_t
*context
)
73 stack_pointer
= (u64
*) context
->rsp
;
74 *(--stack_pointer
) = data
;
75 context
->rsp
= (u64
) stack_pointer
;
78 void align_context_stack(x86_thread_state64_t
*context
)
80 /* 16byte align the stack (provided that the stack is, as it
81 * should be, 8byte aligned. */
82 while (context
->rsp
& 15) push_context(0, context
);
85 /* Stack allocation starts with a context that has a mod-4 ESP value
86 * and needs to leave a context with a mod-16 ESP that will restore
87 * the old ESP value and other register state when activated. The
88 * first part of this is the recovery trampoline, which loads ESP from
89 * EBP, pops EBP, and returns. */
90 asm(".globl _stack_allocation_recover; .align 4; _stack_allocation_recover: mov %rbp, %rsp; pop %rsi; pop %rdi; pop \
91 %rdx; pop %rcx; pop %r8; pop %r9; pop %rbp; ret;");
93 void open_stack_allocation(x86_thread_state64_t
*context
)
95 void stack_allocation_recover(void);
97 push_context(context
->rip
, context
);
98 push_context(context
->rbp
, context
);
100 push_context(context
->r9
, context
);
101 push_context(context
->r8
, context
);
102 push_context(context
->rcx
, context
);
103 push_context(context
->rdx
, context
);
104 push_context(context
->rsi
, context
);
105 push_context(context
->rdi
, context
);
107 context
->rbp
= context
->rsp
;
108 context
->rip
= (u64
) stack_allocation_recover
;
110 align_context_stack(context
);
113 /* Stack allocation of data starts with a context with a mod-16 ESP
114 * value and reserves some space on it by manipulating the ESP
116 void *stack_allocate(x86_thread_state64_t
*context
, size_t size
)
118 /* round up size to 16byte multiple */
119 size
= (size
+ 15) & -16;
121 context
->rsp
= ((u64
)context
->rsp
) - size
;
123 return (void *)context
->rsp
;
126 /* Arranging to invoke a C function is tricky, as we have to assume
127 * cdecl calling conventions (caller removes args) and x86/darwin
128 * alignment requirements. The simplest way to arrange this,
129 * actually, is to open a new stack allocation.
130 * WARNING!!! THIS DOES NOT PRESERVE REGISTERS! */
131 void call_c_function_in_context(x86_thread_state64_t
*context
,
140 /* Set up to restore stack on exit. */
141 open_stack_allocation(context
);
143 /* Have to keep stack 16byte aligned on x86/darwin. */
144 for (i
= (1 & -nargs
); i
; i
--) {
145 push_context(0, context
);
148 context
->rsp
= ((u64
)context
->rsp
) - nargs
* 8;
149 stack_pointer
= (u64
*)context
->rsp
;
152 if (nargs
> 0) context
->rdi
= va_arg(ap
, u64
);
153 if (nargs
> 1) context
->rsi
= va_arg(ap
, u64
);
154 if (nargs
> 2) context
->rdx
= va_arg(ap
, u64
);
155 if (nargs
> 3) context
->rcx
= va_arg(ap
, u64
);
156 if (nargs
> 4) context
->r8
= va_arg(ap
, u64
);
157 if (nargs
> 5) context
->r9
= va_arg(ap
, u64
);
158 for (i
= 6; i
< nargs
; i
++) {
159 stack_pointer
[i
] = va_arg(ap
, u64
);
163 push_context(context
->rip
, context
);
164 context
->rip
= (u64
) function
;
167 void signal_emulation_wrapper(x86_thread_state64_t
*thread_state
,
168 x86_float_state64_t
*float_state
,
171 void (*handler
)(int, siginfo_t
*, void *))
174 /* CLH: FIXME **NOTE: HACK ALERT!** Ideally, we would allocate
175 * context and regs on the stack as local variables, but this
176 * causes problems for the lisp debugger. When it walks the stack
177 * for a back trace, it sees the 1) address of the local variable
178 * on the stack and thinks that is a frame pointer to a lisp
179 * frame, and, 2) the address of the sap that we alloc'ed in
180 * dynamic space and thinks that is a return address, so it,
181 * heuristicly (and wrongly), chooses that this should be
182 * interpreted as a lisp frame instead of as a C frame.
183 * We can work around this in this case by os_validating the
184 * context (and regs just for symmetry).
187 struct ucontext
*context
;
188 struct mcontext
*regs
;
190 context
= (struct ucontext
*) os_validate(0, sizeof(struct ucontext
));
191 regs
= (struct mcontext
*) os_validate(0, sizeof(struct mcontext
));
192 context
->uc_mcontext
= regs
;
194 /* when BSD signals are fired, they mask they signals in sa_mask
195 which always seem to be the blockable_sigset, for us, so we
197 1) save the current sigmask
198 2) block blockable signals
199 3) call the signal handler
200 4) restore the sigmask */
202 build_fake_signal_context(context
, thread_state
, float_state
);
204 block_blockable_signals();
206 handler(signal
, siginfo
, context
);
208 update_thread_state_from_context(thread_state
, float_state
, context
);
210 os_invalidate((os_vm_address_t
)context
, sizeof(struct ucontext
));
211 os_invalidate((os_vm_address_t
)regs
, sizeof(struct mcontext
));
213 /* Trap to restore the signal context. */
214 asm volatile ("mov %0, %%rax; mov %1, %%rbx; .quad 0xffffffffffff0b0f"
215 : : "r" (thread_state
), "r" (float_state
));
218 #if defined DUMP_CONTEXT
219 void dump_context(x86_thread_state64_t
*context
)
224 printf("rax: %08lx rcx: %08lx rdx: %08lx rbx: %08lx\n",
225 context
->rax
, context
->rcx
, context
->rdx
, context
->rbx
);
226 printf("rsp: %08lx rbp: %08lx rsi: %08lx rdi: %08lx\n",
227 context
->rsp
, context
->rbp
, context
->rsi
, context
->rdi
);
228 printf("rip: %08lx eflags: %08lx\n",
229 context
->rip
, context
->rflags
);
230 printf("cs: %04hx ds: %04hx es: %04hx "
231 "ss: %04hx fs: %04hx gs: %04hx\n",
232 context
->cs
, context
->ds
, context
->rs
,
233 context
->ss
, context
->fs
, context
->gs
);
235 stack_pointer
= (u64
*)context
->rsp
;
236 for (i
= 0; i
< 48; i
+=4) {
237 printf("%08x: %08x %08x %08x %08x\n",
238 context
->rsp
+ (i
* 4),
248 control_stack_exhausted_handler(int signal
, siginfo_t
*siginfo
, void *void_context
) {
249 os_context_t
*context
= arch_os_get_context(&void_context
);
251 arrange_return_to_lisp_function
252 (context
, SymbolFunction(CONTROL_STACK_EXHAUSTED_ERROR
));
256 undefined_alien_handler(int signal
, siginfo_t
*siginfo
, void *void_context
) {
257 os_context_t
*context
= arch_os_get_context(&void_context
);
259 arrange_return_to_lisp_function
260 (context
, SymbolFunction(UNDEFINED_ALIEN_VARIABLE_ERROR
));
264 catch_exception_raise(mach_port_t exception_port
,
267 exception_type_t exception
,
268 exception_data_t code_vector
,
269 mach_msg_type_number_t code_count
)
275 #ifdef LISP_FEATURE_SB_THREAD
276 thread_mutex_lock(&mach_exception_lock
);
279 x86_thread_state64_t thread_state
;
280 mach_msg_type_number_t thread_state_count
= x86_THREAD_STATE64_COUNT
;
282 x86_float_state64_t float_state
;
283 mach_msg_type_number_t float_state_count
= x86_FLOAT_STATE64_COUNT
;
285 x86_exception_state64_t exception_state
;
286 mach_msg_type_number_t exception_state_count
= x86_EXCEPTION_STATE64_COUNT
;
288 x86_thread_state64_t backup_thread_state
;
289 x86_thread_state64_t
*target_thread_state
;
290 x86_float_state64_t
*target_float_state
;
292 os_vm_address_t addr
;
294 struct thread
*th
= (struct thread
*) exception_port
;
296 FSHOW((stderr
,"/entering catch_exception_raise with exception: %d\n", exception
));
302 ret
= thread_get_state(thread
,
304 (thread_state_t
)&thread_state
,
305 &thread_state_count
);
306 ret
= thread_get_state(thread
,
308 (thread_state_t
)&float_state
,
310 ret
= thread_get_state(thread
,
311 x86_EXCEPTION_STATE64
,
312 (thread_state_t
)&exception_state
,
313 &exception_state_count
);
314 addr
= (void*)exception_state
.faultvaddr
;
317 /* note the os_context hackery here. When the signal handler returns,
318 * it won't go back to what it was doing ... */
319 if(addr
>= CONTROL_STACK_GUARD_PAGE(th
) &&
320 addr
< CONTROL_STACK_GUARD_PAGE(th
) + os_vm_page_size
) {
321 /* We hit the end of the control stack: disable guard page
322 * protection so the error handler has some headroom, protect the
323 * previous page so that we can catch returns from the guard page
325 protect_control_stack_guard_page_thread(0, th
);
326 protect_control_stack_return_guard_page_thread(1, th
);
328 backup_thread_state
= thread_state
;
329 open_stack_allocation(&thread_state
);
331 /* Save thread state */
332 target_thread_state
=
333 stack_allocate(&thread_state
, sizeof(*target_thread_state
));
334 (*target_thread_state
) = backup_thread_state
;
336 /* Save float state */
338 stack_allocate(&thread_state
, sizeof(*target_float_state
));
339 (*target_float_state
) = float_state
;
342 siginfo
= stack_allocate(&thread_state
, sizeof(*siginfo
));
343 /* what do we need to put in our fake siginfo? It looks like
344 * the x86 code only uses si_signo and si_adrr. */
345 siginfo
->si_signo
= signal
;
346 siginfo
->si_addr
= (void*)exception_state
.faultvaddr
;
348 call_c_function_in_context(&thread_state
,
349 signal_emulation_wrapper
,
355 control_stack_exhausted_handler
);
357 else if(addr
>= CONTROL_STACK_RETURN_GUARD_PAGE(th
) &&
358 addr
< CONTROL_STACK_RETURN_GUARD_PAGE(th
) + os_vm_page_size
) {
359 /* We're returning from the guard page: reprotect it, and
360 * unprotect this one. This works even if we somehow missed
361 * the return-guard-page, and hit it on our way to new
362 * exhaustion instead. */
363 protect_control_stack_guard_page_thread(1, th
);
364 protect_control_stack_return_guard_page_thread(0, th
);
366 else if (addr
>= undefined_alien_address
&&
367 addr
< undefined_alien_address
+ os_vm_page_size
) {
368 backup_thread_state
= thread_state
;
369 open_stack_allocation(&thread_state
);
371 /* Save thread state */
372 target_thread_state
=
373 stack_allocate(&thread_state
, sizeof(*target_thread_state
));
374 (*target_thread_state
) = backup_thread_state
;
377 stack_allocate(&thread_state
, sizeof(*target_float_state
));
378 (*target_float_state
) = float_state
;
381 siginfo
= stack_allocate(&thread_state
, sizeof(*siginfo
));
382 /* what do we need to put in our fake siginfo? It looks like
383 * the x86 code only uses si_signo and si_adrr. */
384 siginfo
->si_signo
= signal
;
385 siginfo
->si_addr
= (void*)exception_state
.faultvaddr
;
387 call_c_function_in_context(&thread_state
,
388 signal_emulation_wrapper
,
394 undefined_alien_handler
);
397 backup_thread_state
= thread_state
;
398 open_stack_allocation(&thread_state
);
400 /* Save thread state */
401 target_thread_state
=
402 stack_allocate(&thread_state
, sizeof(*target_thread_state
));
403 (*target_thread_state
) = backup_thread_state
;
406 stack_allocate(&thread_state
, sizeof(*target_float_state
));
407 (*target_float_state
) = float_state
;
410 siginfo
= stack_allocate(&thread_state
, sizeof(*siginfo
));
411 /* what do we need to put in our fake siginfo? It looks like
412 * the x86 code only uses si_signo and si_adrr. */
413 siginfo
->si_signo
= signal
;
414 siginfo
->si_addr
= (void*)exception_state
.faultvaddr
;
416 call_c_function_in_context(&thread_state
,
417 signal_emulation_wrapper
,
423 memory_fault_handler
);
425 ret
= thread_set_state(thread
,
427 (thread_state_t
)&thread_state
,
430 ret
= thread_set_state(thread
,
432 (thread_state_t
)&float_state
,
434 #ifdef LISP_FEATURE_SB_THREAD
435 thread_mutex_unlock(&mach_exception_lock
);
439 case EXC_BAD_INSTRUCTION
:
441 ret
= thread_get_state(thread
,
443 (thread_state_t
)&thread_state
,
444 &thread_state_count
);
445 ret
= thread_get_state(thread
,
447 (thread_state_t
)&float_state
,
449 ret
= thread_get_state(thread
,
450 x86_EXCEPTION_STATE64
,
451 (thread_state_t
)&exception_state
,
452 &exception_state_count
);
453 if (0xffffffffffff0b0f == *((u64
*)thread_state
.rip
)) {
454 /* fake sigreturn. */
456 /* When we get here, thread_state.rax is a pointer to a
457 * thread_state to restore. */
458 /* thread_state = *((thread_state_t *)thread_state.rax); */
460 ret
= thread_set_state(thread
,
462 (thread_state_t
) thread_state
.rax
,
466 ret
= thread_set_state(thread
,
468 (thread_state_t
) thread_state
.rbx
,
473 backup_thread_state
= thread_state
;
474 open_stack_allocation(&thread_state
);
476 /* Save thread state */
477 target_thread_state
=
478 stack_allocate(&thread_state
, sizeof(*target_thread_state
));
479 (*target_thread_state
) = backup_thread_state
;
482 stack_allocate(&thread_state
, sizeof(*target_float_state
));
483 (*target_float_state
) = float_state
;
486 siginfo
= stack_allocate(&thread_state
, sizeof(*siginfo
));
487 /* what do we need to put in our fake siginfo? It looks like
488 * the x86 code only uses si_signo and si_adrr. */
489 if (*((unsigned short *)target_thread_state
->rip
) == 0x0b0f) {
491 siginfo
->si_signo
= signal
;
492 siginfo
->si_addr
= (void*)exception_state
.faultvaddr
;
493 target_thread_state
->rip
+= 2;
494 call_c_function_in_context(&thread_state
,
495 signal_emulation_wrapper
,
504 siginfo
->si_signo
= signal
;
505 siginfo
->si_addr
= (void*)exception_state
.faultvaddr
;
507 call_c_function_in_context(&thread_state
,
508 signal_emulation_wrapper
,
516 ret
= thread_set_state(thread
,
518 (thread_state_t
)&thread_state
,
520 ret
= thread_set_state(thread
,
522 (thread_state_t
)&float_state
,
525 #ifdef LISP_FEATURE_SB_THREAD
526 thread_mutex_unlock(&mach_exception_lock
);
531 #ifdef LISP_FEATURE_SB_THREAD
532 thread_mutex_unlock(&mach_exception_lock
);
534 return KERN_INVALID_RIGHT
;
539 mach_exception_handler(void *port
)
541 mach_msg_server(exc_server
, 2048, (mach_port_t
) port
, 0);
542 /* mach_msg_server should never return, but it should dispatch mach
543 * exceptions to our catch_exception_raise function
548 /* Sets up the thread that will listen for mach exceptions. note that
549 the exception handlers will be run on this thread. This is
550 different from the BSD-style signal handling situation in which the
551 signal handlers run in the relevant thread directly. */
553 mach_port_t mach_exception_handler_port_set
= MACH_PORT_NULL
;
556 setup_mach_exception_handling_thread()
559 pthread_t mach_exception_handling_thread
= NULL
;
562 /* allocate a mach_port for this process */
563 ret
= mach_port_allocate(mach_task_self(),
564 MACH_PORT_RIGHT_PORT_SET
,
565 &mach_exception_handler_port_set
);
567 /* create the thread that will receive the mach exceptions */
569 FSHOW((stderr
, "Creating mach_exception_handler thread!\n"));
571 pthread_attr_init(&attr
);
572 pthread_create(&mach_exception_handling_thread
,
574 mach_exception_handler
,
575 (void*) mach_exception_handler_port_set
);
576 pthread_attr_destroy(&attr
);
578 return mach_exception_handling_thread
;
581 /* tell the kernel that we want EXC_BAD_ACCESS exceptions sent to the
582 exception port (which is being listened to do by the mach
583 exception handling thread). */
585 mach_thread_init(mach_port_t thread_exception_port
)
588 /* allocate a named port for the thread */
590 FSHOW((stderr
, "Allocating mach port %x\n", thread_exception_port
));
592 ret
= mach_port_allocate_name(mach_task_self(),
593 MACH_PORT_RIGHT_RECEIVE
,
594 thread_exception_port
);
596 lose("mach_port_allocate_name failed with return_code %d\n", ret
);
599 /* establish the right for the thread_exception_port to send messages */
600 ret
= mach_port_insert_right(mach_task_self(),
601 thread_exception_port
,
602 thread_exception_port
,
603 MACH_MSG_TYPE_MAKE_SEND
);
605 lose("mach_port_insert_right failed with return_code %d\n", ret
);
608 ret
= thread_set_exception_ports(mach_thread_self(),
609 EXC_MASK_BAD_ACCESS
| EXC_MASK_BAD_INSTRUCTION
,
610 thread_exception_port
,
614 lose("thread_set_exception_port failed with return_code %d\n", ret
);
617 ret
= mach_port_move_member(mach_task_self(),
618 thread_exception_port
,
619 mach_exception_handler_port_set
);
621 lose("mach_port_ failed with return_code %d\n", ret
);
628 setup_mach_exceptions() {
629 setup_mach_exception_handling_thread();
630 mach_thread_init(THREAD_STRUCT_TO_EXCEPTION_PORT(all_threads
));
637 setup_mach_exceptions();