2 * This software is part of the SBCL system. See the README file for
5 * This software is derived from the CMU CL system, which was
6 * written at Carnegie Mellon University and released into the
7 * public domain. The software is in the public domain and is
8 * provided with absolutely no warranty. See the COPYING and CREDITS
9 * files for more information.
17 #ifndef LISP_FEATURE_WIN32
23 #include <sys/types.h>
24 #ifndef LISP_FEATURE_WIN32
28 #ifdef LISP_FEATURE_MACH_EXCEPTION_HANDLER
29 #include <mach/mach.h>
30 #include <mach/mach_error.h>
31 #include <mach/mach_types.h>
35 #include "validate.h" /* for BINDING_STACK_SIZE etc */
38 #include "target-arch-os.h"
42 #include "genesis/cons.h"
43 #include "genesis/fdefn.h"
44 #include "interr.h" /* for lose() */
46 #include "gc-internal.h"
48 #include "pseudo-atomic.h"
49 #include "interrupt.h"
52 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
53 # define IMMEDIATE_POST_MORTEM
56 #if defined(LISP_FEATURE_DARWIN) && defined(LISP_FEATURE_SB_THREAD)
57 #define DELAY_THREAD_POST_MORTEM 5
58 #define LOCK_CREATE_THREAD
61 #ifdef LISP_FEATURE_FREEBSD
62 #define CREATE_CLEANUP_THREAD
63 #define LOCK_CREATE_THREAD
66 #ifdef LISP_FEATURE_SB_THREAD
67 struct thread_post_mortem {
68 #ifdef DELAY_THREAD_POST_MORTEM
69 struct thread_post_mortem *next;
71 os_thread_t os_thread;
72 pthread_attr_t *os_attr;
73 os_vm_address_t os_address;
76 #ifdef DELAY_THREAD_POST_MORTEM
77 static int pending_thread_post_mortem_count = 0;
78 pthread_mutex_t thread_post_mortem_lock = PTHREAD_MUTEX_INITIALIZER;
80 static struct thread_post_mortem * volatile pending_thread_post_mortem = 0;
83 int dynamic_values_bytes=TLS_SIZE*sizeof(lispobj); /* same for all threads */
84 struct thread *all_threads;
85 extern struct interrupt_data * global_interrupt_data;
87 #ifdef LISP_FEATURE_SB_THREAD
88 pthread_mutex_t all_threads_lock = PTHREAD_MUTEX_INITIALIZER;
89 #ifdef LOCK_CREATE_THREAD
90 static pthread_mutex_t create_thread_lock = PTHREAD_MUTEX_INITIALIZER;
92 #ifdef LISP_FEATURE_GCC_TLS
93 __thread struct thread *current_thread;
95 pthread_key_t lisp_thread = 0;
98 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
99 extern lispobj call_into_lisp_first_time(lispobj fun, lispobj *args, int nargs)
100 # ifdef LISP_FEATURE_X86_64
101 __attribute__((sysv_abi))
107 link_thread(struct thread *th)
109 if (all_threads) all_threads->prev=th;
110 th->next=all_threads;
115 #ifdef LISP_FEATURE_SB_THREAD
117 unlink_thread(struct thread *th)
120 th->prev->next = th->next;
122 all_threads = th->next;
124 th->next->prev = th->prev;
127 #ifndef LISP_FEATURE_SB_SAFEPOINT
128 /* Only access thread state with blockables blocked. */
130 thread_state(struct thread *thread)
134 block_blockable_signals(NULL, &old);
135 os_sem_wait(thread->state_sem, "thread_state");
136 state = thread->state;
137 os_sem_post(thread->state_sem, "thread_state");
138 thread_sigmask(SIG_SETMASK, &old, NULL);
143 set_thread_state(struct thread *thread, lispobj state)
145 int i, waitcount = 0;
147 block_blockable_signals(NULL, &old);
148 os_sem_wait(thread->state_sem, "set_thread_state");
149 if (thread->state != state) {
150 if ((STATE_STOPPED==state) ||
151 (STATE_DEAD==state)) {
152 waitcount = thread->state_not_running_waitcount;
153 thread->state_not_running_waitcount = 0;
154 for (i=0; i<waitcount; i++)
155 os_sem_post(thread->state_not_running_sem, "set_thread_state (not running)");
157 if ((STATE_RUNNING==state) ||
158 (STATE_DEAD==state)) {
159 waitcount = thread->state_not_stopped_waitcount;
160 thread->state_not_stopped_waitcount = 0;
161 for (i=0; i<waitcount; i++)
162 os_sem_post(thread->state_not_stopped_sem, "set_thread_state (not stopped)");
164 thread->state = state;
166 os_sem_post(thread->state_sem, "set_thread_state");
167 thread_sigmask(SIG_SETMASK, &old, NULL);
171 wait_for_thread_state_change(struct thread *thread, lispobj state)
175 block_blockable_signals(NULL, &old);
177 os_sem_wait(thread->state_sem, "wait_for_thread_state_change");
178 if (thread->state == state) {
181 wait_sem = thread->state_not_running_sem;
182 thread->state_not_running_waitcount++;
185 wait_sem = thread->state_not_stopped_sem;
186 thread->state_not_stopped_waitcount++;
189 lose("Invalid state in wait_for_thread_state_change: "OBJ_FMTX"\n", state);
194 os_sem_post(thread->state_sem, "wait_for_thread_state_change");
196 os_sem_wait(wait_sem, "wait_for_thread_state_change");
199 thread_sigmask(SIG_SETMASK, &old, NULL);
201 #endif /* sb-safepoint */
202 #endif /* sb-thread */
205 initial_thread_trampoline(struct thread *th)
208 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
209 lispobj *args = NULL;
211 #ifdef LISP_FEATURE_SB_THREAD
212 pthread_setspecific(lisp_thread, (void *)1);
214 #if defined(THREADS_USING_GCSIGNAL) && defined(LISP_FEATURE_PPC)
215 /* SIG_STOP_FOR_GC defaults to blocked on PPC? */
216 unblock_gc_signals(0,0);
218 function = th->no_tls_value_marker;
219 th->no_tls_value_marker = NO_TLS_VALUE_MARKER_WIDETAG;
220 if(arch_os_thread_init(th)==0) return 1;
222 th->os_thread=thread_self();
223 #ifndef LISP_FEATURE_WIN32
224 protect_control_stack_hard_guard_page(1, NULL);
226 protect_binding_stack_hard_guard_page(1, NULL);
227 protect_alien_stack_hard_guard_page(1, NULL);
228 #ifndef LISP_FEATURE_WIN32
229 protect_control_stack_guard_page(1, NULL);
231 protect_binding_stack_guard_page(1, NULL);
232 protect_alien_stack_guard_page(1, NULL);
234 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
235 return call_into_lisp_first_time(function,args,0);
237 return funcall0(function);
241 #ifdef LISP_FEATURE_SB_THREAD
243 # if defined(IMMEDIATE_POST_MORTEM)
246 * If this feature is set, we are running on a stack managed by the OS,
247 * and no fancy delays are required for anything. Just do it.
250 schedule_thread_post_mortem(struct thread *corpse)
252 pthread_detach(pthread_self());
253 gc_assert(!pthread_attr_destroy(corpse->os_attr));
254 free(corpse->os_attr);
255 #if defined(LISP_FEATURE_WIN32)
256 os_invalidate_free(corpse->os_address, THREAD_STRUCT_SIZE);
258 os_invalidate(corpse->os_address, THREAD_STRUCT_SIZE);
264 /* THREAD POST MORTEM CLEANUP
266 * Memory allocated for the thread stacks cannot be reclaimed while
267 * the thread is still alive, so we need a mechanism for post mortem
268 * cleanups. FIXME: We actually have three, for historical reasons as
269 * the saying goes. Do we really need three? Nikodemus guesses that
270 * not anymore, now that we properly call pthread_attr_destroy before
271 * freeing the stack. */
273 static struct thread_post_mortem *
274 plan_thread_post_mortem(struct thread *corpse)
277 struct thread_post_mortem *post_mortem = malloc(sizeof(struct thread_post_mortem));
278 gc_assert(post_mortem);
279 post_mortem->os_thread = corpse->os_thread;
280 post_mortem->os_attr = corpse->os_attr;
281 post_mortem->os_address = corpse->os_address;
282 #ifdef DELAY_THREAD_POST_MORTEM
283 post_mortem->next = NULL;
287 /* FIXME: When does this happen? */
293 perform_thread_post_mortem(struct thread_post_mortem *post_mortem)
295 #ifdef CREATE_POST_MORTEM_THREAD
296 pthread_detach(pthread_self());
299 gc_assert(!pthread_join(post_mortem->os_thread, NULL));
300 gc_assert(!pthread_attr_destroy(post_mortem->os_attr));
301 free(post_mortem->os_attr);
302 os_invalidate(post_mortem->os_address, THREAD_STRUCT_SIZE);
308 schedule_thread_post_mortem(struct thread *corpse)
310 struct thread_post_mortem *post_mortem = NULL;
312 post_mortem = plan_thread_post_mortem(corpse);
314 #ifdef DELAY_THREAD_POST_MORTEM
315 pthread_mutex_lock(&thread_post_mortem_lock);
316 /* First stick the new post mortem to the end of the queue. */
317 if (pending_thread_post_mortem) {
318 struct thread_post_mortem *next = pending_thread_post_mortem;
322 next->next = post_mortem;
324 pending_thread_post_mortem = post_mortem;
326 /* Then, if there are enough things in the queue, clean up one
327 * from the head -- or increment the count, and null out the
328 * post_mortem we have. */
329 if (pending_thread_post_mortem_count > DELAY_THREAD_POST_MORTEM) {
330 post_mortem = pending_thread_post_mortem;
331 pending_thread_post_mortem = post_mortem->next;
333 pending_thread_post_mortem_count++;
336 pthread_mutex_unlock(&thread_post_mortem_lock);
337 /* Finally run, the cleanup, if any. */
338 perform_thread_post_mortem(post_mortem);
339 #elif defined(CREATE_POST_MORTEM_THREAD)
340 gc_assert(!pthread_create(&thread, NULL, perform_thread_post_mortem, post_mortem));
342 post_mortem = (struct thread_post_mortem *)
343 swap_lispobjs((lispobj *)(void *)&pending_thread_post_mortem,
344 (lispobj)post_mortem);
345 perform_thread_post_mortem(post_mortem);
350 # endif /* !IMMEDIATE_POST_MORTEM */
353 init_new_thread(struct thread *th, init_thread_data *scribble)
357 pthread_setspecific(lisp_thread, (void *)1);
358 if(arch_os_thread_init(th)==0) {
359 /* FIXME: handle error */
360 lose("arch_os_thread_init failed\n");
363 th->os_thread=thread_self();
364 protect_control_stack_guard_page(1, NULL);
365 protect_binding_stack_guard_page(1, NULL);
366 protect_alien_stack_guard_page(1, NULL);
367 /* Since GC can only know about this thread from the all_threads
368 * list and we're just adding this thread to it, there is no
369 * danger of deadlocking even with SIG_STOP_FOR_GC blocked (which
371 #ifdef LISP_FEATURE_SB_SAFEPOINT
372 *th->csp_around_foreign_call = (lispobj)&lock_ret;
374 lock_ret = pthread_mutex_lock(&all_threads_lock);
375 gc_assert(lock_ret == 0);
377 lock_ret = pthread_mutex_unlock(&all_threads_lock);
378 gc_assert(lock_ret == 0);
380 /* Kludge: Changed the order of some steps between the safepoint/
381 * non-safepoint versions of this code. Can we unify this more?
383 #ifdef LISP_FEATURE_SB_SAFEPOINT
385 gc_state_wait(GC_NONE);
387 push_gcing_safety(&scribble->safety);
392 undo_init_new_thread(struct thread *th, init_thread_data *scribble)
396 /* Kludge: Changed the order of some steps between the safepoint/
397 * non-safepoint versions of this code. Can we unify this more?
399 #ifdef LISP_FEATURE_SB_SAFEPOINT
400 block_blockable_signals(0, 0);
401 gc_alloc_update_page_tables(BOXED_PAGE_FLAG, &th->alloc_region);
402 pop_gcing_safety(&scribble->safety);
403 lock_ret = pthread_mutex_lock(&all_threads_lock);
404 gc_assert(lock_ret == 0);
406 lock_ret = pthread_mutex_unlock(&all_threads_lock);
407 gc_assert(lock_ret == 0);
410 block_blockable_signals(0, 0);
411 set_thread_state(th, STATE_DEAD);
413 /* SIG_STOP_FOR_GC is blocked and GC might be waiting for this
414 * thread, but since we are already dead it won't wait long. */
415 lock_ret = pthread_mutex_lock(&all_threads_lock);
416 gc_assert(lock_ret == 0);
418 gc_alloc_update_page_tables(BOXED_PAGE_FLAG, &th->alloc_region);
420 pthread_mutex_unlock(&all_threads_lock);
421 gc_assert(lock_ret == 0);
424 if(th->tls_cookie>=0) arch_os_thread_cleanup(th);
425 #ifndef LISP_FEATURE_SB_SAFEPOINT
426 os_sem_destroy(th->state_sem);
427 os_sem_destroy(th->state_not_running_sem);
428 os_sem_destroy(th->state_not_stopped_sem);
431 #if defined(LISP_FEATURE_WIN32)
432 free((os_vm_address_t)th->interrupt_data);
434 os_invalidate((os_vm_address_t)th->interrupt_data,
435 (sizeof (struct interrupt_data)));
438 #ifdef LISP_FEATURE_MACH_EXCEPTION_HANDLER
439 mach_lisp_thread_destroy(th);
442 #if defined(LISP_FEATURE_WIN32)
445 (int) (sizeof(th->private_events.events)/
446 sizeof(th->private_events.events[0])); ++i) {
447 CloseHandle(th->private_events.events[i]);
449 TlsSetValue(OUR_TLS_INDEX,NULL);
452 schedule_thread_post_mortem(th);
455 /* this is the first thing that runs in the child (which is why the
456 * silly calling convention). Basically it calls the user's requested
457 * lisp function after doing arch_os_thread_init and whatever other
458 * bookkeeping needs to be done
461 new_thread_trampoline(struct thread *th)
464 init_thread_data scribble;
466 FSHOW((stderr,"/creating thread %lu\n", thread_self()));
467 check_deferrables_blocked_or_lose(0);
468 #ifndef LISP_FEATURE_SB_SAFEPOINT
469 check_gc_signals_unblocked_or_lose(0);
472 lispobj function = th->no_tls_value_marker;
473 th->no_tls_value_marker = NO_TLS_VALUE_MARKER_WIDETAG;
474 init_new_thread(th, &scribble);
475 result = funcall0(function);
476 undo_init_new_thread(th, &scribble);
478 FSHOW((stderr,"/exiting thread %lu\n", thread_self()));
482 #endif /* LISP_FEATURE_SB_THREAD */
485 free_thread_struct(struct thread *th)
487 #if defined(LISP_FEATURE_WIN32)
488 if (th->interrupt_data) {
489 os_invalidate_free((os_vm_address_t) th->interrupt_data,
490 (sizeof (struct interrupt_data)));
492 os_invalidate_free((os_vm_address_t) th->os_address,
495 if (th->interrupt_data)
496 os_invalidate((os_vm_address_t) th->interrupt_data,
497 (sizeof (struct interrupt_data)));
498 os_invalidate((os_vm_address_t) th->os_address,
503 #ifdef LISP_FEATURE_SB_THREAD
504 /* FIXME: should be MAX_INTERRUPTS -1 ? */
505 const unsigned int tls_index_start =
506 MAX_INTERRUPTS + sizeof(struct thread)/sizeof(lispobj);
509 /* this is called from any other thread to create the new one, and
510 * initialize all parts of it that can be initialized from another
514 static struct thread *
515 create_thread_struct(lispobj initial_function) {
516 union per_thread_data *per_thread;
517 struct thread *th=0; /* subdue gcc */
519 void *aligned_spaces=0;
520 #if defined(LISP_FEATURE_SB_THREAD) || defined(LISP_FEATURE_WIN32)
524 /* May as well allocate all the spaces at once: it saves us from
525 * having to decide what to do if only some of the allocations
526 * succeed. SPACES must be appropriately aligned, since the GC
527 * expects the control stack to start at a page boundary -- and
528 * the OS may have even more rigorous requirements. We can't rely
529 * on the alignment passed from os_validate, since that might
530 * assume the current (e.g. 4k) pagesize, while we calculate with
531 * the biggest (e.g. 64k) pagesize allowed by the ABI. */
532 spaces=os_validate(0, THREAD_STRUCT_SIZE);
535 /* Aligning up is safe as THREAD_STRUCT_SIZE has
536 * THREAD_ALIGNMENT_BYTES padding. */
537 aligned_spaces = (void *)((((uword_t)(char *)spaces)
538 + THREAD_ALIGNMENT_BYTES-1)
539 &~(uword_t)(THREAD_ALIGNMENT_BYTES-1));
542 thread_control_stack_size+
545 per_thread=(union per_thread_data *)
546 (csp_page + THREAD_CSP_PAGE_SIZE);
547 struct nonpointer_thread_data *nonpointer_data
548 = (void *) &per_thread->dynamic_values[TLS_SIZE];
550 #ifdef LISP_FEATURE_SB_THREAD
551 for(i = 0; i < (dynamic_values_bytes / sizeof(lispobj)); i++)
552 per_thread->dynamic_values[i] = NO_TLS_VALUE_MARKER_WIDETAG;
553 if (all_threads == 0) {
554 if(SymbolValue(FREE_TLS_INDEX,0)==UNBOUND_MARKER_WIDETAG) {
555 SetSymbolValue(FREE_TLS_INDEX,tls_index_start << WORD_SHIFT,0);
556 SetSymbolValue(TLS_INDEX_LOCK,make_fixnum(0),0);
558 #define STATIC_TLS_INIT(sym,field) \
559 ((struct symbol *)(sym-OTHER_POINTER_LOWTAG))->tls_index= \
560 (THREAD_SLOT_OFFSET_WORDS(field) << WORD_SHIFT)
562 STATIC_TLS_INIT(BINDING_STACK_START,binding_stack_start);
563 #ifdef BINDING_STACK_POINTER
564 STATIC_TLS_INIT(BINDING_STACK_POINTER,binding_stack_pointer);
566 STATIC_TLS_INIT(CONTROL_STACK_START,control_stack_start);
567 STATIC_TLS_INIT(CONTROL_STACK_END,control_stack_end);
569 STATIC_TLS_INIT(ALIEN_STACK,alien_stack_pointer);
571 #if defined(LISP_FEATURE_X86) || defined (LISP_FEATURE_X86_64)
572 STATIC_TLS_INIT(PSEUDO_ATOMIC_BITS,pseudo_atomic_bits);
574 #undef STATIC_TLS_INIT
578 th=&per_thread->thread;
579 th->os_address = spaces;
580 th->control_stack_start = aligned_spaces;
581 th->binding_stack_start=
582 (lispobj*)((void*)th->control_stack_start+thread_control_stack_size);
583 th->control_stack_end = th->binding_stack_start;
584 th->control_stack_guard_page_protected = T;
585 th->alien_stack_start=
586 (lispobj*)((void*)th->binding_stack_start+BINDING_STACK_SIZE);
587 set_binding_stack_pointer(th,th->binding_stack_start);
591 #ifdef LISP_FEATURE_SB_SAFEPOINT
592 # ifdef LISP_FEATURE_WIN32
593 th->carried_base_pointer = 0;
595 # ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
596 th->pc_around_foreign_call = 0;
598 th->csp_around_foreign_call = csp_page;
601 #ifdef LISP_FEATURE_SB_THREAD
602 /* Contrary to the "allocate all the spaces at once" comment above,
603 * the os_attr is allocated separately. We cannot put it into the
604 * nonpointer data, because it's used for post_mortem and freed
606 th->os_attr=malloc(sizeof(pthread_attr_t));
607 th->nonpointer_data = nonpointer_data;
608 # ifndef LISP_FEATURE_SB_SAFEPOINT
609 th->state_sem=&nonpointer_data->state_sem;
610 th->state_not_running_sem=&nonpointer_data->state_not_running_sem;
611 th->state_not_stopped_sem=&nonpointer_data->state_not_stopped_sem;
612 os_sem_init(th->state_sem, 1);
613 os_sem_init(th->state_not_running_sem, 0);
614 os_sem_init(th->state_not_stopped_sem, 0);
616 th->state_not_running_waitcount = 0;
617 th->state_not_stopped_waitcount = 0;
619 th->state=STATE_RUNNING;
620 #ifdef LISP_FEATURE_STACK_GROWS_DOWNWARD_NOT_UPWARD
621 th->alien_stack_pointer=((void *)th->alien_stack_start
622 + ALIEN_STACK_SIZE-N_WORD_BYTES);
624 th->alien_stack_pointer=((void *)th->alien_stack_start);
626 #if defined(LISP_FEATURE_X86) || defined (LISP_FEATURE_X86_64) || defined(LISP_FEATURE_SB_THREAD)
627 th->pseudo_atomic_bits=0;
629 #ifdef LISP_FEATURE_GENCGC
630 gc_set_region_empty(&th->alloc_region);
632 #ifdef LISP_FEATURE_SB_THREAD
633 /* This parallels the same logic in globals.c for the
634 * single-threaded foreign_function_call_active, KLUDGE and
636 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
637 th->foreign_function_call_active = 0;
639 th->foreign_function_call_active = 1;
643 #ifndef LISP_FEATURE_SB_THREAD
644 /* the tls-points-into-struct-thread trick is only good for threaded
645 * sbcl, because unithread sbcl doesn't have tls. So, we copy the
646 * appropriate values from struct thread here, and make sure that
647 * we use the appropriate SymbolValue macros to access any of the
648 * variable quantities from the C runtime. It's not quite OAOOM,
649 * it just feels like it */
650 SetSymbolValue(BINDING_STACK_START,(lispobj)th->binding_stack_start,th);
651 SetSymbolValue(CONTROL_STACK_START,(lispobj)th->control_stack_start,th);
652 SetSymbolValue(CONTROL_STACK_END,(lispobj)th->control_stack_end,th);
653 #if defined(LISP_FEATURE_X86) || defined (LISP_FEATURE_X86_64)
654 SetSymbolValue(ALIEN_STACK,(lispobj)th->alien_stack_pointer,th);
655 SetSymbolValue(PSEUDO_ATOMIC_BITS,(lispobj)th->pseudo_atomic_bits,th);
658 bind_variable(CURRENT_CATCH_BLOCK,make_fixnum(0),th);
659 bind_variable(CURRENT_UNWIND_PROTECT_BLOCK,make_fixnum(0),th);
660 bind_variable(FREE_INTERRUPT_CONTEXT_INDEX,make_fixnum(0),th);
661 bind_variable(INTERRUPT_PENDING, NIL,th);
662 bind_variable(INTERRUPTS_ENABLED,T,th);
663 bind_variable(ALLOW_WITH_INTERRUPTS,T,th);
664 bind_variable(GC_PENDING,NIL,th);
665 bind_variable(ALLOC_SIGNAL,NIL,th);
666 #ifdef PINNED_OBJECTS
667 bind_variable(PINNED_OBJECTS,NIL,th);
669 #ifdef LISP_FEATURE_SB_THREAD
670 bind_variable(STOP_FOR_GC_PENDING,NIL,th);
672 #if defined(LISP_FEATURE_SB_SAFEPOINT)
673 bind_variable(GC_SAFE,NIL,th);
674 bind_variable(IN_SAFEPOINT,NIL,th);
676 #ifdef LISP_FEATURE_SB_THRUPTION
677 bind_variable(THRUPTION_PENDING,NIL,th);
678 bind_variable(RESTART_CLUSTERS,NIL,th);
680 #ifndef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
681 access_control_stack_pointer(th)=th->control_stack_start;
684 #if defined(LISP_FEATURE_WIN32)
685 th->interrupt_data = (struct interrupt_data *)
686 calloc((sizeof (struct interrupt_data)),1);
688 th->interrupt_data = (struct interrupt_data *)
689 os_validate(0,(sizeof (struct interrupt_data)));
691 if (!th->interrupt_data) {
692 free_thread_struct(th);
695 th->interrupt_data->pending_handler = 0;
696 th->interrupt_data->gc_blocked_deferrables = 0;
697 #ifdef GENCGC_IS_PRECISE
698 th->interrupt_data->allocation_trap_context = 0;
700 th->no_tls_value_marker=initial_function;
702 #if defined(LISP_FEATURE_WIN32)
703 for (i = 0; i<sizeof(th->private_events.events)/
704 sizeof(th->private_events.events[0]); ++i) {
705 th->private_events.events[i] = CreateEvent(NULL,FALSE,FALSE,NULL);
707 th->synchronous_io_handle_and_flag = 0;
713 void create_initial_thread(lispobj initial_function) {
714 struct thread *th=create_thread_struct(initial_function);
715 #ifdef LISP_FEATURE_SB_THREAD
716 pthread_key_create(&lisp_thread, 0);
719 initial_thread_trampoline(th); /* no return */
720 } else lose("can't create initial thread\n");
723 #ifdef LISP_FEATURE_SB_THREAD
725 #ifndef __USE_XOPEN2K
726 extern int pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,
730 boolean create_os_thread(struct thread *th,os_thread_t *kid_tid)
732 /* The new thread inherits the restrictive signal mask set here,
733 * and enables signals again when it is set up properly. */
736 int retcode = 0, initcode;
738 FSHOW_SIGNAL((stderr,"/create_os_thread: creating new thread\n"));
740 /* Blocking deferrable signals is enough, no need to block
741 * SIG_STOP_FOR_GC because the child process is not linked onto
742 * all_threads until it's ready. */
743 block_deferrable_signals(0, &oldset);
745 #ifdef LOCK_CREATE_THREAD
746 retcode = pthread_mutex_lock(&create_thread_lock);
747 gc_assert(retcode == 0);
748 FSHOW_SIGNAL((stderr,"/create_os_thread: got lock\n"));
751 if((initcode = pthread_attr_init(th->os_attr)) ||
752 /* call_into_lisp_first_time switches the stack for the initial
753 * thread. For the others, we use this. */
754 #if defined(LISP_FEATURE_WIN32)
755 (pthread_attr_setstacksize(th->os_attr, thread_control_stack_size)) ||
757 (pthread_attr_setstack(th->os_attr,th->control_stack_start,
758 thread_control_stack_size)) ||
760 (retcode = pthread_create
761 (kid_tid,th->os_attr,(void *(*)(void *))new_thread_trampoline,th))) {
762 FSHOW_SIGNAL((stderr, "init = %d\n", initcode));
763 FSHOW_SIGNAL((stderr, "pthread_create returned %d, errno %d\n",
766 perror("create_os_thread");
771 #ifdef LOCK_CREATE_THREAD
772 retcode = pthread_mutex_unlock(&create_thread_lock);
773 gc_assert(retcode == 0);
774 FSHOW_SIGNAL((stderr,"/create_os_thread: released lock\n"));
776 thread_sigmask(SIG_SETMASK,&oldset,0);
780 os_thread_t create_thread(lispobj initial_function) {
781 struct thread *th, *thread = arch_os_get_current_thread();
782 os_thread_t kid_tid = 0;
784 /* Must defend against async unwinds. */
785 if (SymbolValue(INTERRUPTS_ENABLED, thread) != NIL)
786 lose("create_thread is not safe when interrupts are enabled.\n");
788 /* Assuming that a fresh thread struct has no lisp objects in it,
789 * linking it to all_threads can be left to the thread itself
790 * without fear of gc lossage. initial_function violates this
791 * assumption and must stay pinned until the child starts up. */
792 th = create_thread_struct(initial_function);
793 if (th && !create_os_thread(th,&kid_tid)) {
794 free_thread_struct(th);
800 /* stopping the world is a two-stage process. From this thread we signal
801 * all the others with SIG_STOP_FOR_GC. The handler for this signal does
802 * the usual pseudo-atomic checks (we don't want to stop a thread while
803 * it's in the middle of allocation) then waits for another SIG_STOP_FOR_GC.
806 * (With SB-SAFEPOINT, see the definitions in safepoint.c instead.)
808 #ifndef LISP_FEATURE_SB_SAFEPOINT
810 /* To avoid deadlocks when gc stops the world all clients of each
811 * mutex must enable or disable SIG_STOP_FOR_GC for the duration of
812 * holding the lock, but they must agree on which. */
813 void gc_stop_the_world()
815 struct thread *p,*th=arch_os_get_current_thread();
816 int status, lock_ret;
817 #ifdef LOCK_CREATE_THREAD
818 /* KLUDGE: Stopping the thread during pthread_create() causes deadlock
820 FSHOW_SIGNAL((stderr,"/gc_stop_the_world:waiting on create_thread_lock\n"));
821 lock_ret = pthread_mutex_lock(&create_thread_lock);
822 gc_assert(lock_ret == 0);
823 FSHOW_SIGNAL((stderr,"/gc_stop_the_world:got create_thread_lock\n"));
825 FSHOW_SIGNAL((stderr,"/gc_stop_the_world:waiting on lock\n"));
826 /* keep threads from starting while the world is stopped. */
827 lock_ret = pthread_mutex_lock(&all_threads_lock); \
828 gc_assert(lock_ret == 0);
830 FSHOW_SIGNAL((stderr,"/gc_stop_the_world:got lock\n"));
831 /* stop all other threads by sending them SIG_STOP_FOR_GC */
832 for(p=all_threads; p; p=p->next) {
833 gc_assert(p->os_thread != 0);
834 FSHOW_SIGNAL((stderr,"/gc_stop_the_world: thread=%lu, state=%x\n",
835 p->os_thread, thread_state(p)));
836 if((p!=th) && ((thread_state(p)==STATE_RUNNING))) {
837 FSHOW_SIGNAL((stderr,"/gc_stop_the_world: suspending thread %lu\n",
839 /* We already hold all_thread_lock, P can become DEAD but
840 * cannot exit, ergo it's safe to use pthread_kill. */
841 status=pthread_kill(p->os_thread,SIG_STOP_FOR_GC);
843 /* This thread has exited. */
844 gc_assert(thread_state(p)==STATE_DEAD);
846 lose("cannot send suspend thread=%lu: %d, %s\n",
847 p->os_thread,status,strerror(status));
851 FSHOW_SIGNAL((stderr,"/gc_stop_the_world:signals sent\n"));
852 for(p=all_threads;p;p=p->next) {
856 "/gc_stop_the_world: waiting for thread=%lu: state=%x\n",
857 p->os_thread, thread_state(p)));
858 wait_for_thread_state_change(p, STATE_RUNNING);
859 if (p->state == STATE_RUNNING)
860 lose("/gc_stop_the_world: unexpected state");
863 FSHOW_SIGNAL((stderr,"/gc_stop_the_world:end\n"));
866 void gc_start_the_world()
868 struct thread *p,*th=arch_os_get_current_thread();
870 /* if a resumed thread creates a new thread before we're done with
871 * this loop, the new thread will get consed on the front of
872 * all_threads, but it won't have been stopped so won't need
874 FSHOW_SIGNAL((stderr,"/gc_start_the_world:begin\n"));
875 for(p=all_threads;p;p=p->next) {
876 gc_assert(p->os_thread!=0);
878 lispobj state = thread_state(p);
879 if (state != STATE_DEAD) {
880 if(state != STATE_STOPPED) {
881 lose("gc_start_the_world: wrong thread state is %d\n",
882 fixnum_value(state));
884 FSHOW_SIGNAL((stderr, "/gc_start_the_world: resuming %lu\n",
886 set_thread_state(p, STATE_RUNNING);
891 lock_ret = pthread_mutex_unlock(&all_threads_lock);
892 gc_assert(lock_ret == 0);
893 #ifdef LOCK_CREATE_THREAD
894 lock_ret = pthread_mutex_unlock(&create_thread_lock);
895 gc_assert(lock_ret == 0);
898 FSHOW_SIGNAL((stderr,"/gc_start_the_world:end\n"));
901 #endif /* !LISP_FEATURE_SB_SAFEPOINT */
902 #endif /* !LISP_FEATURE_SB_THREAD */
907 #ifdef LISP_FEATURE_SB_THREAD
908 return sched_yield();
915 wake_thread(os_thread_t os_thread)
917 #if defined(LISP_FEATURE_WIN32)
918 return kill_safely(os_thread, 1);
919 #elif !defined(LISP_FEATURE_SB_THRUPTION)
920 return kill_safely(os_thread, SIGPIPE);
922 return wake_thread_posix(os_thread);
926 /* If the thread id given does not belong to a running thread (it has
927 * exited or never even existed) pthread_kill _may_ fail with ESRCH,
928 * but it is also allowed to just segfault, see
929 * <http://udrepper.livejournal.com/16844.html>.
931 * Relying on thread ids can easily backfire since ids are recycled
932 * (NPTL recycles them extremely fast) so a signal can be sent to
933 * another process if the one it was sent to exited.
935 * For these reasons, we must make sure that the thread is still alive
936 * when the pthread_kill is called and return if the thread is
939 * Note (DFL, 2011-06-22): At the time of writing, this function is only
940 * used for INTERRUPT-THREAD, hence the wake_thread special-case for
943 kill_safely(os_thread_t os_thread, int signal)
945 FSHOW_SIGNAL((stderr,"/kill_safely: %lu, %d\n", os_thread, signal));
947 #ifdef LISP_FEATURE_SB_THREAD
949 struct thread *thread;
950 /* Frequent special case: resignalling to self. The idea is
951 * that leave_region safepoint will acknowledge the signal, so
952 * there is no need to take locks, roll thread to safepoint
954 /* Kludge (on safepoint builds): At the moment, this isn't just
955 * an optimization; rather it masks the fact that
956 * gc_stop_the_world() grabs the all_threads mutex without
957 * releasing it, and since we're not using recursive pthread
958 * mutexes, the pthread_mutex_lock() around the all_threads loop
959 * would go wrong. Why are we running interruptions while
960 * stopping the world though? Test case is (:ASYNC-UNWIND
961 * :SPECIALS), especially with s/10/100/ in both loops. */
962 if (os_thread == pthread_self()) {
963 pthread_kill(os_thread, signal);
964 #ifdef LISP_FEATURE_WIN32
965 check_pending_thruptions(NULL);
970 /* pthread_kill is not async signal safe and we don't want to be
971 * interrupted while holding the lock. */
972 block_deferrable_signals(0, &oldset);
973 pthread_mutex_lock(&all_threads_lock);
974 for (thread = all_threads; thread; thread = thread->next) {
975 if (thread->os_thread == os_thread) {
976 int status = pthread_kill(os_thread, signal);
978 lose("kill_safely: pthread_kill failed with %d\n", status);
979 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THRUPTION)
980 wake_thread_win32(thread);
985 pthread_mutex_unlock(&all_threads_lock);
986 thread_sigmask(SIG_SETMASK,&oldset,0);
991 #elif defined(LISP_FEATURE_WIN32)
996 lose("kill_safely: who do you want to kill? %d?\n", os_thread);
997 /* Dubious (as in don't know why it works) workaround for the
998 * signal sometimes not being generated on darwin. */
999 #ifdef LISP_FEATURE_DARWIN
1002 sigprocmask(SIG_BLOCK, &deferrable_sigset, &oldset);
1003 status = raise(signal);
1004 sigprocmask(SIG_SETMASK,&oldset,0);
1007 status = raise(signal);
1012 lose("cannot raise signal %d, %d %s\n",
1013 signal, status, strerror(errno));