src/runtime/thread.c

   1 /*
   2  * This software is part of the SBCL system. See the README file for
   3  * more information.
   4  *
   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.
  10  */
  11
  12 #include "sbcl.h"
  13
  14 #include <stdlib.h>
  15 #include <stdio.h>
  16 #include <string.h>
  17 #ifndef LISP_FEATURE_WIN32
  18 #include <sched.h>
  19 #endif
  20 #include "runtime.h"
  21 #include <stddef.h>
  22 #include <errno.h>
  23 #include <sys/types.h>
  24 #ifndef LISP_FEATURE_WIN32
  25 #include <sys/wait.h>
  26 #endif
  27
  28 #ifdef LISP_FEATURE_MACH_EXCEPTION_HANDLER
  29 #include <mach/mach.h>
  30 #include <mach/mach_error.h>
  31 #include <mach/mach_types.h>
  32 #endif
  33
  34 #include "runtime.h"
  35 #include "validate.h"           /* for BINDING_STACK_SIZE etc */
  36 #include "thread.h"
  37 #include "arch.h"
  38 #include "target-arch-os.h"
  39 #include "os.h"
  40 #include "globals.h"
  41 #include "dynbind.h"
  42 #include "genesis/cons.h"
  43 #include "genesis/fdefn.h"
  44 #include "interr.h"             /* for lose() */
  45 #include "alloc.h"
  46 #include "gc-internal.h"
  47 #include "cpputil.h"
  48 #include "pseudo-atomic.h"
  49 #include "interrupt.h"
  50 #include "lispregs.h"
  51
  52 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
  53 # define IMMEDIATE_POST_MORTEM
  54 #endif
  55
  56 #if defined(LISP_FEATURE_DARWIN) && defined(LISP_FEATURE_SB_THREAD)
  57 #define DELAY_THREAD_POST_MORTEM 5
  58 #define LOCK_CREATE_THREAD
  59 #endif
  60
  61 #ifdef LISP_FEATURE_FREEBSD
  62 #define CREATE_CLEANUP_THREAD
  63 #define LOCK_CREATE_THREAD
  64 #endif
  65
  66 #ifdef LISP_FEATURE_SB_THREAD
  67 struct thread_post_mortem {
  68 #ifdef DELAY_THREAD_POST_MORTEM
  69     struct thread_post_mortem *next;
  70 #endif
  71     os_thread_t os_thread;
  72     pthread_attr_t *os_attr;
  73     os_vm_address_t os_address;
  74 };
  75
  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;
  79 #endif
  80 static struct thread_post_mortem * volatile pending_thread_post_mortem = 0;
  81 #endif
  82
  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;
  86
  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;
  91 #endif
  92 #ifdef LISP_FEATURE_GCC_TLS
  93 __thread struct thread *current_thread;
  94 #endif
  95 pthread_key_t lisp_thread = 0;
  96 #endif
  97
  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))
 102 # endif
 103     ;
 104 #endif
 105
 106 static void
 107 link_thread(struct thread *th)
 108 {
 109     if (all_threads) all_threads->prev=th;
 110     th->next=all_threads;
 111     th->prev=0;
 112     all_threads=th;
 113 }
 114
 115 #ifdef LISP_FEATURE_SB_THREAD
 116 static void
 117 unlink_thread(struct thread *th)
 118 {
 119     if (th->prev)
 120         th->prev->next = th->next;
 121     else
 122         all_threads = th->next;
 123     if (th->next)
 124         th->next->prev = th->prev;
 125 }
 126
 127 #ifndef LISP_FEATURE_SB_SAFEPOINT
 128 /* Only access thread state with blockables blocked. */
 129 lispobj
 130 thread_state(struct thread *thread)
 131 {
 132     lispobj state;
 133     sigset_t old;
 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);
 139     return state;
 140 }
 141
 142 void
 143 set_thread_state(struct thread *thread, lispobj state)
 144 {
 145     int i, waitcount = 0;
 146     sigset_t old;
 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)");
 156         }
 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)");
 163         }
 164         thread->state = state;
 165     }
 166     os_sem_post(thread->state_sem, "set_thread_state");
 167     thread_sigmask(SIG_SETMASK, &old, NULL);
 168 }
 169
 170 void
 171 wait_for_thread_state_change(struct thread *thread, lispobj state)
 172 {
 173     sigset_t old;
 174     os_sem_t *wait_sem;
 175     block_blockable_signals(NULL, &old);
 176   start:
 177     os_sem_wait(thread->state_sem, "wait_for_thread_state_change");
 178     if (thread->state == state) {
 179         switch (state) {
 180         case STATE_RUNNING:
 181             wait_sem = thread->state_not_running_sem;
 182             thread->state_not_running_waitcount++;
 183             break;
 184         case STATE_STOPPED:
 185             wait_sem = thread->state_not_stopped_sem;
 186             thread->state_not_stopped_waitcount++;
 187             break;
 188         default:
 189             lose("Invalid state in wait_for_thread_state_change: "OBJ_FMTX"\n", state);
 190         }
 191     } else {
 192         wait_sem = NULL;
 193     }
 194     os_sem_post(thread->state_sem, "wait_for_thread_state_change");
 195     if (wait_sem) {
 196         os_sem_wait(wait_sem, "wait_for_thread_state_change");
 197         goto start;
 198     }
 199     thread_sigmask(SIG_SETMASK, &old, NULL);
 200 }
 201 #endif /* sb-safepoint */
 202 #endif /* sb-thread */
 203
 204 static int
 205 initial_thread_trampoline(struct thread *th)
 206 {
 207     lispobj function;
 208 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
 209     lispobj *args = NULL;
 210 #endif
 211 #ifdef LISP_FEATURE_SB_THREAD
 212     pthread_setspecific(lisp_thread, (void *)1);
 213 #endif
 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);
 217 #endif
 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;
 221     link_thread(th);
 222     th->os_thread=thread_self();
 223 #ifndef LISP_FEATURE_WIN32
 224     protect_control_stack_hard_guard_page(1, NULL);
 225 #endif
 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);
 230 #endif
 231     protect_binding_stack_guard_page(1, NULL);
 232     protect_alien_stack_guard_page(1, NULL);
 233
 234 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
 235     return call_into_lisp_first_time(function,args,0);
 236 #else
 237     return funcall0(function);
 238 #endif
 239 }
 240
 241 #ifdef LISP_FEATURE_SB_THREAD
 242
 243 # if defined(IMMEDIATE_POST_MORTEM)
 244
 245 /*
 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.
 248  */
 249 static void
 250 schedule_thread_post_mortem(struct thread *corpse)
 251 {
 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);
 257 #else
 258     os_invalidate(corpse->os_address, THREAD_STRUCT_SIZE);
 259 #endif
 260 }
 261
 262 # else
 263
 264 /* THREAD POST MORTEM CLEANUP
 265  *
 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. */
 272
 273 static struct thread_post_mortem *
 274 plan_thread_post_mortem(struct thread *corpse)
 275 {
 276     if (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;
 284 #endif
 285         return post_mortem;
 286     } else {
 287         /* FIXME: When does this happen? */
 288         return NULL;
 289     }
 290 }
 291
 292 static void
 293 perform_thread_post_mortem(struct thread_post_mortem *post_mortem)
 294 {
 295 #ifdef CREATE_POST_MORTEM_THREAD
 296     pthread_detach(pthread_self());
 297 #endif
 298     if (post_mortem) {
 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);
 303         free(post_mortem);
 304     }
 305 }
 306
 307 static void
 308 schedule_thread_post_mortem(struct thread *corpse)
 309 {
 310     struct thread_post_mortem *post_mortem = NULL;
 311     if (corpse) {
 312         post_mortem = plan_thread_post_mortem(corpse);
 313
 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;
 319             while (next->next) {
 320                 next = next->next;
 321             }
 322             next->next = post_mortem;
 323         } else {
 324             pending_thread_post_mortem = post_mortem;
 325         }
 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;
 332         } else {
 333             pending_thread_post_mortem_count++;
 334             post_mortem = NULL;
 335         }
 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));
 341 #else
 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);
 346 #endif
 347     }
 348 }
 349
 350 # endif /* !IMMEDIATE_POST_MORTEM */
 351
 352 /* this is the first thing that runs in the child (which is why the
 353  * silly calling convention).  Basically it calls the user's requested
 354  * lisp function after doing arch_os_thread_init and whatever other
 355  * bookkeeping needs to be done
 356  */
 357 int
 358 new_thread_trampoline(struct thread *th)
 359 {
 360     lispobj function;
 361     int result, lock_ret;
 362
 363     FSHOW((stderr,"/creating thread %lu\n", thread_self()));
 364     check_deferrables_blocked_or_lose(0);
 365 #ifndef LISP_FEATURE_SB_SAFEPOINT
 366     check_gc_signals_unblocked_or_lose(0);
 367 #endif
 368     pthread_setspecific(lisp_thread, (void *)1);
 369     function = th->no_tls_value_marker;
 370     th->no_tls_value_marker = NO_TLS_VALUE_MARKER_WIDETAG;
 371     if(arch_os_thread_init(th)==0) {
 372         /* FIXME: handle error */
 373         lose("arch_os_thread_init failed\n");
 374     }
 375
 376     th->os_thread=thread_self();
 377     protect_control_stack_guard_page(1, NULL);
 378     protect_binding_stack_guard_page(1, NULL);
 379     protect_alien_stack_guard_page(1, NULL);
 380     /* Since GC can only know about this thread from the all_threads
 381      * list and we're just adding this thread to it, there is no
 382      * danger of deadlocking even with SIG_STOP_FOR_GC blocked (which
 383      * it is not). */
 384 #ifdef LISP_FEATURE_SB_SAFEPOINT
 385     *th->csp_around_foreign_call = (lispobj)&function;
 386 #endif
 387     lock_ret = pthread_mutex_lock(&all_threads_lock);
 388     gc_assert(lock_ret == 0);
 389     link_thread(th);
 390     lock_ret = pthread_mutex_unlock(&all_threads_lock);
 391     gc_assert(lock_ret == 0);
 392
 393     /* Kludge: Changed the order of some steps between the safepoint/
 394      * non-safepoint versions of this code.  Can we unify this more?
 395      */
 396 #ifdef LISP_FEATURE_SB_SAFEPOINT
 397     gc_state_lock();
 398     gc_state_wait(GC_NONE);
 399     gc_state_unlock();
 400     WITH_GC_AT_SAFEPOINTS_ONLY() {
 401         result = funcall0(function);
 402         block_blockable_signals(0, 0);
 403         gc_alloc_update_page_tables(BOXED_PAGE_FLAG, &th->alloc_region);
 404     }
 405     lock_ret = pthread_mutex_lock(&all_threads_lock);
 406     gc_assert(lock_ret == 0);
 407     unlink_thread(th);
 408     lock_ret = pthread_mutex_unlock(&all_threads_lock);
 409     gc_assert(lock_ret == 0);
 410 #else
 411     result = funcall0(function);
 412
 413     /* Block GC */
 414     block_blockable_signals(0, 0);
 415     set_thread_state(th, STATE_DEAD);
 416
 417     /* SIG_STOP_FOR_GC is blocked and GC might be waiting for this
 418      * thread, but since we are already dead it won't wait long. */
 419     lock_ret = pthread_mutex_lock(&all_threads_lock);
 420     gc_assert(lock_ret == 0);
 421
 422     gc_alloc_update_page_tables(BOXED_PAGE_FLAG, &th->alloc_region);
 423     unlink_thread(th);
 424     pthread_mutex_unlock(&all_threads_lock);
 425     gc_assert(lock_ret == 0);
 426 #endif
 427
 428     if(th->tls_cookie>=0) arch_os_thread_cleanup(th);
 429 #ifndef LISP_FEATURE_SB_SAFEPOINT
 430     os_sem_destroy(th->state_sem);
 431     os_sem_destroy(th->state_not_running_sem);
 432     os_sem_destroy(th->state_not_stopped_sem);
 433 #endif
 434
 435 #if defined(LISP_FEATURE_WIN32)
 436     free((os_vm_address_t)th->interrupt_data);
 437 #else
 438     os_invalidate((os_vm_address_t)th->interrupt_data,
 439                   (sizeof (struct interrupt_data)));
 440 #endif
 441
 442 #ifdef LISP_FEATURE_MACH_EXCEPTION_HANDLER
 443     mach_lisp_thread_destroy(th);
 444 #endif
 445
 446 #if defined(LISP_FEATURE_WIN32)
 447     int i;
 448     for (i = 0; i<
 449              (int) (sizeof(th->private_events.events)/
 450                     sizeof(th->private_events.events[0])); ++i) {
 451       CloseHandle(th->private_events.events[i]);
 452     }
 453     TlsSetValue(OUR_TLS_INDEX,NULL);
 454 #endif
 455
 456     schedule_thread_post_mortem(th);
 457     FSHOW((stderr,"/exiting thread %lu\n", thread_self()));
 458     return result;
 459 }
 460
 461 #endif /* LISP_FEATURE_SB_THREAD */
 462
 463 static void
 464 free_thread_struct(struct thread *th)
 465 {
 466 #if defined(LISP_FEATURE_WIN32)
 467     if (th->interrupt_data) {
 468         os_invalidate_free((os_vm_address_t) th->interrupt_data,
 469                       (sizeof (struct interrupt_data)));
 470     }
 471     os_invalidate_free((os_vm_address_t) th->os_address,
 472                   THREAD_STRUCT_SIZE);
 473 #else
 474     if (th->interrupt_data)
 475         os_invalidate((os_vm_address_t) th->interrupt_data,
 476                       (sizeof (struct interrupt_data)));
 477     os_invalidate((os_vm_address_t) th->os_address,
 478                   THREAD_STRUCT_SIZE);
 479 #endif
 480 }
 481
 482 #ifdef LISP_FEATURE_SB_THREAD
 483 /* FIXME: should be MAX_INTERRUPTS -1 ? */
 484 const unsigned int tls_index_start =
 485   MAX_INTERRUPTS + sizeof(struct thread)/sizeof(lispobj);
 486 #endif
 487
 488 /* this is called from any other thread to create the new one, and
 489  * initialize all parts of it that can be initialized from another
 490  * thread
 491  */
 492
 493 static struct thread *
 494 create_thread_struct(lispobj initial_function) {
 495     union per_thread_data *per_thread;
 496     struct thread *th=0;        /*  subdue gcc */
 497     void *spaces=0;
 498     void *aligned_spaces=0;
 499 #if defined(LISP_FEATURE_SB_THREAD) || defined(LISP_FEATURE_WIN32)
 500     unsigned int i;
 501 #endif
 502
 503     /* May as well allocate all the spaces at once: it saves us from
 504      * having to decide what to do if only some of the allocations
 505      * succeed. SPACES must be appropriately aligned, since the GC
 506      * expects the control stack to start at a page boundary -- and
 507      * the OS may have even more rigorous requirements. We can't rely
 508      * on the alignment passed from os_validate, since that might
 509      * assume the current (e.g. 4k) pagesize, while we calculate with
 510      * the biggest (e.g. 64k) pagesize allowed by the ABI. */
 511     spaces=os_validate(0, THREAD_STRUCT_SIZE);
 512     if(!spaces)
 513         return NULL;
 514     /* Aligning up is safe as THREAD_STRUCT_SIZE has
 515      * THREAD_ALIGNMENT_BYTES padding. */
 516     aligned_spaces = (void *)((((uword_t)(char *)spaces)
 517                                + THREAD_ALIGNMENT_BYTES-1)
 518                               &~(uword_t)(THREAD_ALIGNMENT_BYTES-1));
 519     void* csp_page=
 520         (aligned_spaces+
 521          thread_control_stack_size+
 522          BINDING_STACK_SIZE+
 523          ALIEN_STACK_SIZE);
 524     per_thread=(union per_thread_data *)
 525         (csp_page + THREAD_CSP_PAGE_SIZE);
 526     struct nonpointer_thread_data *nonpointer_data
 527         = (void *) &per_thread->dynamic_values[TLS_SIZE];
 528
 529 #ifdef LISP_FEATURE_SB_THREAD
 530     for(i = 0; i < (dynamic_values_bytes / sizeof(lispobj)); i++)
 531         per_thread->dynamic_values[i] = NO_TLS_VALUE_MARKER_WIDETAG;
 532     if (all_threads == 0) {
 533         if(SymbolValue(FREE_TLS_INDEX,0)==UNBOUND_MARKER_WIDETAG) {
 534             SetSymbolValue(FREE_TLS_INDEX,tls_index_start << WORD_SHIFT,0);
 535             SetSymbolValue(TLS_INDEX_LOCK,make_fixnum(0),0);
 536         }
 537 #define STATIC_TLS_INIT(sym,field) \
 538   ((struct symbol *)(sym-OTHER_POINTER_LOWTAG))->tls_index= \
 539   (THREAD_SLOT_OFFSET_WORDS(field) << WORD_SHIFT)
 540
 541         STATIC_TLS_INIT(BINDING_STACK_START,binding_stack_start);
 542 #ifdef BINDING_STACK_POINTER
 543         STATIC_TLS_INIT(BINDING_STACK_POINTER,binding_stack_pointer);
 544 #endif
 545         STATIC_TLS_INIT(CONTROL_STACK_START,control_stack_start);
 546         STATIC_TLS_INIT(CONTROL_STACK_END,control_stack_end);
 547 #ifdef ALIEN_STACK
 548         STATIC_TLS_INIT(ALIEN_STACK,alien_stack_pointer);
 549 #endif
 550 #if defined(LISP_FEATURE_X86) || defined (LISP_FEATURE_X86_64)
 551         STATIC_TLS_INIT(PSEUDO_ATOMIC_BITS,pseudo_atomic_bits);
 552 #endif
 553 #undef STATIC_TLS_INIT
 554     }
 555 #endif
 556
 557     th=&per_thread->thread;
 558     th->os_address = spaces;
 559     th->control_stack_start = aligned_spaces;
 560     th->binding_stack_start=
 561         (lispobj*)((void*)th->control_stack_start+thread_control_stack_size);
 562     th->control_stack_end = th->binding_stack_start;
 563     th->control_stack_guard_page_protected = T;
 564     th->alien_stack_start=
 565         (lispobj*)((void*)th->binding_stack_start+BINDING_STACK_SIZE);
 566     set_binding_stack_pointer(th,th->binding_stack_start);
 567     th->this=th;
 568     th->os_thread=0;
 569
 570 #ifdef LISP_FEATURE_SB_SAFEPOINT
 571 # ifdef LISP_FEATURE_WIN32
 572     th->carried_base_pointer = 0;
 573 # endif
 574 # ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
 575     th->pc_around_foreign_call = 0;
 576 # endif
 577     th->csp_around_foreign_call = csp_page;
 578 #endif
 579
 580 #ifdef LISP_FEATURE_SB_THREAD
 581     /* Contrary to the "allocate all the spaces at once" comment above,
 582      * the os_attr is allocated separately.  We cannot put it into the
 583      * nonpointer data, because it's used for post_mortem and freed
 584      * separately */
 585     th->os_attr=malloc(sizeof(pthread_attr_t));
 586     th->nonpointer_data = nonpointer_data;
 587 # ifndef LISP_FEATURE_SB_SAFEPOINT
 588     th->state_sem=&nonpointer_data->state_sem;
 589     th->state_not_running_sem=&nonpointer_data->state_not_running_sem;
 590     th->state_not_stopped_sem=&nonpointer_data->state_not_stopped_sem;
 591     os_sem_init(th->state_sem, 1);
 592     os_sem_init(th->state_not_running_sem, 0);
 593     os_sem_init(th->state_not_stopped_sem, 0);
 594 # endif
 595     th->state_not_running_waitcount = 0;
 596     th->state_not_stopped_waitcount = 0;
 597 #endif
 598     th->state=STATE_RUNNING;
 599 #ifdef LISP_FEATURE_STACK_GROWS_DOWNWARD_NOT_UPWARD
 600     th->alien_stack_pointer=((void *)th->alien_stack_start
 601                              + ALIEN_STACK_SIZE-N_WORD_BYTES);
 602 #else
 603     th->alien_stack_pointer=((void *)th->alien_stack_start);
 604 #endif
 605 #if defined(LISP_FEATURE_X86) || defined (LISP_FEATURE_X86_64) || defined(LISP_FEATURE_SB_THREAD)
 606     th->pseudo_atomic_bits=0;
 607 #endif
 608 #ifdef LISP_FEATURE_GENCGC
 609     gc_set_region_empty(&th->alloc_region);
 610 #endif
 611 #ifdef LISP_FEATURE_SB_THREAD
 612     /* This parallels the same logic in globals.c for the
 613      * single-threaded foreign_function_call_active, KLUDGE and
 614      * all. */
 615 #if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
 616     th->foreign_function_call_active = 0;
 617 #else
 618     th->foreign_function_call_active = 1;
 619 #endif
 620 #endif
 621
 622 #ifndef LISP_FEATURE_SB_THREAD
 623     /* the tls-points-into-struct-thread trick is only good for threaded
 624      * sbcl, because unithread sbcl doesn't have tls.  So, we copy the
 625      * appropriate values from struct thread here, and make sure that
 626      * we use the appropriate SymbolValue macros to access any of the
 627      * variable quantities from the C runtime.  It's not quite OAOOM,
 628      * it just feels like it */
 629     SetSymbolValue(BINDING_STACK_START,(lispobj)th->binding_stack_start,th);
 630     SetSymbolValue(CONTROL_STACK_START,(lispobj)th->control_stack_start,th);
 631     SetSymbolValue(CONTROL_STACK_END,(lispobj)th->control_stack_end,th);
 632 #if defined(LISP_FEATURE_X86) || defined (LISP_FEATURE_X86_64)
 633     SetSymbolValue(ALIEN_STACK,(lispobj)th->alien_stack_pointer,th);
 634     SetSymbolValue(PSEUDO_ATOMIC_BITS,(lispobj)th->pseudo_atomic_bits,th);
 635 #endif
 636 #endif
 637     bind_variable(CURRENT_CATCH_BLOCK,make_fixnum(0),th);
 638     bind_variable(CURRENT_UNWIND_PROTECT_BLOCK,make_fixnum(0),th);
 639     bind_variable(FREE_INTERRUPT_CONTEXT_INDEX,make_fixnum(0),th);
 640     bind_variable(INTERRUPT_PENDING, NIL,th);
 641     bind_variable(INTERRUPTS_ENABLED,T,th);
 642     bind_variable(ALLOW_WITH_INTERRUPTS,T,th);
 643     bind_variable(GC_PENDING,NIL,th);
 644     bind_variable(ALLOC_SIGNAL,NIL,th);
 645 #ifdef PINNED_OBJECTS
 646     bind_variable(PINNED_OBJECTS,NIL,th);
 647 #endif
 648 #ifdef LISP_FEATURE_SB_THREAD
 649     bind_variable(STOP_FOR_GC_PENDING,NIL,th);
 650 #endif
 651 #if defined(LISP_FEATURE_SB_SAFEPOINT)
 652     bind_variable(GC_SAFE,NIL,th);
 653     bind_variable(IN_SAFEPOINT,NIL,th);
 654 #endif
 655 #ifdef LISP_FEATURE_SB_THRUPTION
 656     bind_variable(THRUPTION_PENDING,NIL,th);
 657     bind_variable(RESTART_CLUSTERS,NIL,th);
 658 #endif
 659 #ifndef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
 660     access_control_stack_pointer(th)=th->control_stack_start;
 661 #endif
 662
 663 #if defined(LISP_FEATURE_WIN32)
 664     th->interrupt_data = (struct interrupt_data *)
 665         calloc((sizeof (struct interrupt_data)),1);
 666 #else
 667     th->interrupt_data = (struct interrupt_data *)
 668         os_validate(0,(sizeof (struct interrupt_data)));
 669 #endif
 670     if (!th->interrupt_data) {
 671         free_thread_struct(th);
 672         return 0;
 673     }
 674     th->interrupt_data->pending_handler = 0;
 675     th->interrupt_data->gc_blocked_deferrables = 0;
 676 #ifdef GENCGC_IS_PRECISE
 677     th->interrupt_data->allocation_trap_context = 0;
 678 #endif
 679     th->no_tls_value_marker=initial_function;
 680
 681 #if defined(LISP_FEATURE_WIN32)
 682     for (i = 0; i<sizeof(th->private_events.events)/
 683            sizeof(th->private_events.events[0]); ++i) {
 684       th->private_events.events[i] = CreateEvent(NULL,FALSE,FALSE,NULL);
 685     }
 686     th->synchronous_io_handle_and_flag = 0;
 687 #endif
 688     th->stepping = NIL;
 689     return th;
 690 }
 691
 692 void create_initial_thread(lispobj initial_function) {
 693     struct thread *th=create_thread_struct(initial_function);
 694 #ifdef LISP_FEATURE_SB_THREAD
 695     pthread_key_create(&lisp_thread, 0);
 696 #endif
 697     if(th) {
 698         initial_thread_trampoline(th); /* no return */
 699     } else lose("can't create initial thread\n");
 700 }
 701
 702 #ifdef LISP_FEATURE_SB_THREAD
 703
 704 #ifndef __USE_XOPEN2K
 705 extern int pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,
 706                                   size_t __stacksize);
 707 #endif
 708
 709 boolean create_os_thread(struct thread *th,os_thread_t *kid_tid)
 710 {
 711     /* The new thread inherits the restrictive signal mask set here,
 712      * and enables signals again when it is set up properly. */
 713     sigset_t oldset;
 714     boolean r=1;
 715     int retcode = 0, initcode;
 716
 717     FSHOW_SIGNAL((stderr,"/create_os_thread: creating new thread\n"));
 718
 719     /* Blocking deferrable signals is enough, no need to block
 720      * SIG_STOP_FOR_GC because the child process is not linked onto
 721      * all_threads until it's ready. */
 722     block_deferrable_signals(0, &oldset);
 723
 724 #ifdef LOCK_CREATE_THREAD
 725     retcode = pthread_mutex_lock(&create_thread_lock);
 726     gc_assert(retcode == 0);
 727     FSHOW_SIGNAL((stderr,"/create_os_thread: got lock\n"));
 728 #endif
 729
 730     if((initcode = pthread_attr_init(th->os_attr)) ||
 731        /* call_into_lisp_first_time switches the stack for the initial
 732         * thread. For the others, we use this. */
 733 #if defined(LISP_FEATURE_WIN32)
 734        (pthread_attr_setstacksize(th->os_attr, thread_control_stack_size)) ||
 735 #else
 736        (pthread_attr_setstack(th->os_attr,th->control_stack_start,
 737                               thread_control_stack_size)) ||
 738 #endif
 739        (retcode = pthread_create
 740         (kid_tid,th->os_attr,(void *(*)(void *))new_thread_trampoline,th))) {
 741         FSHOW_SIGNAL((stderr, "init = %d\n", initcode));
 742         FSHOW_SIGNAL((stderr, "pthread_create returned %d, errno %d\n",
 743                       retcode, errno));
 744         if(retcode < 0) {
 745             perror("create_os_thread");
 746         }
 747         r=0;
 748     }
 749
 750 #ifdef LOCK_CREATE_THREAD
 751     retcode = pthread_mutex_unlock(&create_thread_lock);
 752     gc_assert(retcode == 0);
 753     FSHOW_SIGNAL((stderr,"/create_os_thread: released lock\n"));
 754 #endif
 755     thread_sigmask(SIG_SETMASK,&oldset,0);
 756     return r;
 757 }
 758
 759 os_thread_t create_thread(lispobj initial_function) {
 760     struct thread *th, *thread = arch_os_get_current_thread();
 761     os_thread_t kid_tid = 0;
 762
 763     /* Must defend against async unwinds. */
 764     if (SymbolValue(INTERRUPTS_ENABLED, thread) != NIL)
 765         lose("create_thread is not safe when interrupts are enabled.\n");
 766
 767     /* Assuming that a fresh thread struct has no lisp objects in it,
 768      * linking it to all_threads can be left to the thread itself
 769      * without fear of gc lossage. initial_function violates this
 770      * assumption and must stay pinned until the child starts up. */
 771     th = create_thread_struct(initial_function);
 772     if (th && !create_os_thread(th,&kid_tid)) {
 773         free_thread_struct(th);
 774         kid_tid = 0;
 775     }
 776     return kid_tid;
 777 }
 778
 779 /* stopping the world is a two-stage process.  From this thread we signal
 780  * all the others with SIG_STOP_FOR_GC.  The handler for this signal does
 781  * the usual pseudo-atomic checks (we don't want to stop a thread while
 782  * it's in the middle of allocation) then waits for another SIG_STOP_FOR_GC.
 783  */
 784 /*
 785  * (With SB-SAFEPOINT, see the definitions in safepoint.c instead.)
 786  */
 787 #ifndef LISP_FEATURE_SB_SAFEPOINT
 788
 789 /* To avoid deadlocks when gc stops the world all clients of each
 790  * mutex must enable or disable SIG_STOP_FOR_GC for the duration of
 791  * holding the lock, but they must agree on which. */
 792 void gc_stop_the_world()
 793 {
 794     struct thread *p,*th=arch_os_get_current_thread();
 795     int status, lock_ret;
 796 #ifdef LOCK_CREATE_THREAD
 797     /* KLUDGE: Stopping the thread during pthread_create() causes deadlock
 798      * on FreeBSD. */
 799     FSHOW_SIGNAL((stderr,"/gc_stop_the_world:waiting on create_thread_lock\n"));
 800     lock_ret = pthread_mutex_lock(&create_thread_lock);
 801     gc_assert(lock_ret == 0);
 802     FSHOW_SIGNAL((stderr,"/gc_stop_the_world:got create_thread_lock\n"));
 803 #endif
 804     FSHOW_SIGNAL((stderr,"/gc_stop_the_world:waiting on lock\n"));
 805     /* keep threads from starting while the world is stopped. */
 806     lock_ret = pthread_mutex_lock(&all_threads_lock);      \
 807     gc_assert(lock_ret == 0);
 808
 809     FSHOW_SIGNAL((stderr,"/gc_stop_the_world:got lock\n"));
 810     /* stop all other threads by sending them SIG_STOP_FOR_GC */
 811     for(p=all_threads; p; p=p->next) {
 812         gc_assert(p->os_thread != 0);
 813         FSHOW_SIGNAL((stderr,"/gc_stop_the_world: thread=%lu, state=%x\n",
 814                       p->os_thread, thread_state(p)));
 815         if((p!=th) && ((thread_state(p)==STATE_RUNNING))) {
 816             FSHOW_SIGNAL((stderr,"/gc_stop_the_world: suspending thread %lu\n",
 817                           p->os_thread));
 818             /* We already hold all_thread_lock, P can become DEAD but
 819              * cannot exit, ergo it's safe to use pthread_kill. */
 820             status=pthread_kill(p->os_thread,SIG_STOP_FOR_GC);
 821             if (status==ESRCH) {
 822                 /* This thread has exited. */
 823                 gc_assert(thread_state(p)==STATE_DEAD);
 824             } else if (status) {
 825                 lose("cannot send suspend thread=%lu: %d, %s\n",
 826                      p->os_thread,status,strerror(status));
 827             }
 828         }
 829     }
 830     FSHOW_SIGNAL((stderr,"/gc_stop_the_world:signals sent\n"));
 831     for(p=all_threads;p;p=p->next) {
 832         if (p!=th) {
 833             FSHOW_SIGNAL
 834                 ((stderr,
 835                   "/gc_stop_the_world: waiting for thread=%lu: state=%x\n",
 836                   p->os_thread, thread_state(p)));
 837             wait_for_thread_state_change(p, STATE_RUNNING);
 838             if (p->state == STATE_RUNNING)
 839                 lose("/gc_stop_the_world: unexpected state");
 840         }
 841     }
 842     FSHOW_SIGNAL((stderr,"/gc_stop_the_world:end\n"));
 843 }
 844
 845 void gc_start_the_world()
 846 {
 847     struct thread *p,*th=arch_os_get_current_thread();
 848     int lock_ret;
 849     /* if a resumed thread creates a new thread before we're done with
 850      * this loop, the new thread will get consed on the front of
 851      * all_threads, but it won't have been stopped so won't need
 852      * restarting */
 853     FSHOW_SIGNAL((stderr,"/gc_start_the_world:begin\n"));
 854     for(p=all_threads;p;p=p->next) {
 855         gc_assert(p->os_thread!=0);
 856         if (p!=th) {
 857             lispobj state = thread_state(p);
 858             if (state != STATE_DEAD) {
 859                 if(state != STATE_STOPPED) {
 860                     lose("gc_start_the_world: wrong thread state is %d\n",
 861                          fixnum_value(state));
 862                 }
 863                 FSHOW_SIGNAL((stderr, "/gc_start_the_world: resuming %lu\n",
 864                               p->os_thread));
 865                 set_thread_state(p, STATE_RUNNING);
 866             }
 867         }
 868     }
 869
 870     lock_ret = pthread_mutex_unlock(&all_threads_lock);
 871     gc_assert(lock_ret == 0);
 872 #ifdef LOCK_CREATE_THREAD
 873     lock_ret = pthread_mutex_unlock(&create_thread_lock);
 874     gc_assert(lock_ret == 0);
 875 #endif
 876
 877     FSHOW_SIGNAL((stderr,"/gc_start_the_world:end\n"));
 878 }
 879
 880 #endif /* !LISP_FEATURE_SB_SAFEPOINT */
 881 #endif /* !LISP_FEATURE_SB_THREAD */
 882
 883 int
 884 thread_yield()
 885 {
 886 #ifdef LISP_FEATURE_SB_THREAD
 887     return sched_yield();
 888 #else
 889     return 0;
 890 #endif
 891 }
 892
 893 int
 894 wake_thread(os_thread_t os_thread)
 895 {
 896 #if defined(LISP_FEATURE_WIN32)
 897     return kill_safely(os_thread, 1);
 898 #elif !defined(LISP_FEATURE_SB_THRUPTION)
 899     return kill_safely(os_thread, SIGPIPE);
 900 #else
 901     return wake_thread_posix(os_thread);
 902 #endif
 903 }
 904
 905 /* If the thread id given does not belong to a running thread (it has
 906  * exited or never even existed) pthread_kill _may_ fail with ESRCH,
 907  * but it is also allowed to just segfault, see
 908  * <http://udrepper.livejournal.com/16844.html>.
 909  *
 910  * Relying on thread ids can easily backfire since ids are recycled
 911  * (NPTL recycles them extremely fast) so a signal can be sent to
 912  * another process if the one it was sent to exited.
 913  *
 914  * For these reasons, we must make sure that the thread is still alive
 915  * when the pthread_kill is called and return if the thread is
 916  * exiting.
 917  *
 918  * Note (DFL, 2011-06-22): At the time of writing, this function is only
 919  * used for INTERRUPT-THREAD, hence the wake_thread special-case for
 920  * Windows is OK. */
 921 int
 922 kill_safely(os_thread_t os_thread, int signal)
 923 {
 924     FSHOW_SIGNAL((stderr,"/kill_safely: %lu, %d\n", os_thread, signal));
 925     {
 926 #ifdef LISP_FEATURE_SB_THREAD
 927         sigset_t oldset;
 928         struct thread *thread;
 929         /* Frequent special case: resignalling to self.  The idea is
 930          * that leave_region safepoint will acknowledge the signal, so
 931          * there is no need to take locks, roll thread to safepoint
 932          * etc. */
 933         /* Kludge (on safepoint builds): At the moment, this isn't just
 934          * an optimization; rather it masks the fact that
 935          * gc_stop_the_world() grabs the all_threads mutex without
 936          * releasing it, and since we're not using recursive pthread
 937          * mutexes, the pthread_mutex_lock() around the all_threads loop
 938          * would go wrong.  Why are we running interruptions while
 939          * stopping the world though?  Test case is (:ASYNC-UNWIND
 940          * :SPECIALS), especially with s/10/100/ in both loops. */
 941         if (os_thread == pthread_self()) {
 942             pthread_kill(os_thread, signal);
 943 #ifdef LISP_FEATURE_WIN32
 944             check_pending_thruptions(NULL);
 945 #endif
 946             return 0;
 947         }
 948
 949         /* pthread_kill is not async signal safe and we don't want to be
 950          * interrupted while holding the lock. */
 951         block_deferrable_signals(0, &oldset);
 952         pthread_mutex_lock(&all_threads_lock);
 953         for (thread = all_threads; thread; thread = thread->next) {
 954             if (thread->os_thread == os_thread) {
 955                 int status = pthread_kill(os_thread, signal);
 956                 if (status)
 957                     lose("kill_safely: pthread_kill failed with %d\n", status);
 958 #if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THRUPTION)
 959                 wake_thread_win32(thread);
 960 #endif
 961                 break;
 962             }
 963         }
 964         pthread_mutex_unlock(&all_threads_lock);
 965         thread_sigmask(SIG_SETMASK,&oldset,0);
 966         if (thread)
 967             return 0;
 968         else
 969             return -1;
 970 #elif defined(LISP_FEATURE_WIN32)
 971         return 0;
 972 #else
 973         int status;
 974         if (os_thread != 0)
 975             lose("kill_safely: who do you want to kill? %d?\n", os_thread);
 976         /* Dubious (as in don't know why it works) workaround for the
 977          * signal sometimes not being generated on darwin. */
 978 #ifdef LISP_FEATURE_DARWIN
 979         {
 980             sigset_t oldset;
 981             sigprocmask(SIG_BLOCK, &deferrable_sigset, &oldset);
 982             status = raise(signal);
 983             sigprocmask(SIG_SETMASK,&oldset,0);
 984         }
 985 #else
 986         status = raise(signal);
 987 #endif
 988         if (status == 0) {
 989             return 0;
 990         } else {
 991             lose("cannot raise signal %d, %d %s\n",
 992                  signal, status, strerror(errno));
 993         }
 994 #endif
 995     }
 996 }