src/runtime/thread.h

   1 #if !defined(_INCLUDE_THREAD_H_)
   2 #define _INCLUDE_THREAD_H_
   3
   4 #include <sys/types.h>
   5 #include <unistd.h>
   6 #include <stddef.h>
   7 #include "sbcl.h"
   8 #include "globals.h"
   9 #include "runtime.h"
  10 #include "os.h"
  11 #ifdef LISP_FEATURE_GENCGC
  12 #include "gencgc-alloc-region.h"
  13 #endif
  14 #ifdef LISP_FEATURE_WIN32
  15 #include "win32-thread-private-events.h"
  16 #endif
  17 #include "genesis/symbol.h"
  18 #include "genesis/static-symbols.h"
  19
  20 #include "genesis/thread.h"
  21 #include "genesis/fdefn.h"
  22 #include "interrupt.h"
  23 #include "validate.h"           /* for BINDING_STACK_SIZE etc */
  24
  25 #define STATE_RUNNING MAKE_FIXNUM(1)
  26 #define STATE_STOPPED MAKE_FIXNUM(2)
  27 #define STATE_DEAD MAKE_FIXNUM(3)
  28 #if defined(LISP_FEATURE_SB_SAFEPOINT)
  29 # define STATE_SUSPENDED_BRIEFLY MAKE_FIXNUM(4)
  30 # define STATE_GC_BLOCKER MAKE_FIXNUM(5)
  31 # define STATE_PHASE1_BLOCKER MAKE_FIXNUM(5)
  32 # define STATE_PHASE2_BLOCKER MAKE_FIXNUM(6)
  33 # define STATE_INTERRUPT_BLOCKER MAKE_FIXNUM(7)
  34 #endif
  35
  36 #ifdef LISP_FEATURE_SB_THREAD
  37 lispobj thread_state(struct thread *thread);
  38 void set_thread_state(struct thread *thread, lispobj state);
  39 void wait_for_thread_state_change(struct thread *thread, lispobj state);
  40
  41 #if defined(LISP_FEATURE_SB_SAFEPOINT)
  42 enum threads_suspend_reason {
  43     SUSPEND_REASON_NONE,
  44     SUSPEND_REASON_GC,
  45     SUSPEND_REASON_INTERRUPT,
  46     SUSPEND_REASON_GCING
  47 };
  48
  49 struct threads_suspend_info {
  50     int suspend;
  51     pthread_mutex_t world_lock;
  52     pthread_mutex_t lock;
  53     enum threads_suspend_reason reason;
  54     int phase;
  55     struct thread * gc_thread;
  56     struct thread * interrupted_thread;
  57     int blockers;
  58     int used_gc_page;
  59 };
  60
  61 struct suspend_phase {
  62     int suspend;
  63     enum threads_suspend_reason reason;
  64     int phase;
  65     struct suspend_phase *next;
  66 };
  67
  68 extern struct threads_suspend_info suspend_info;
  69
  70 struct gcing_safety {
  71     lispobj csp_around_foreign_call;
  72 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
  73     lispobj* pc_around_foreign_call;
  74 #endif
  75 };
  76
  77 int handle_safepoint_violation(os_context_t *context, os_vm_address_t addr);
  78 void** os_get_csp(struct thread* th);
  79 void alloc_gc_page();
  80 void assert_on_stack(struct thread *th, void *esp);
  81 #endif /* defined(LISP_FEATURE_SB_SAFEPOINT) */
  82
  83 extern pthread_key_t lisp_thread;
  84 #endif
  85
  86 extern int kill_safely(os_thread_t os_thread, int signal);
  87
  88 #define THREAD_SLOT_OFFSET_WORDS(c) \
  89  (offsetof(struct thread,c)/(sizeof (struct thread *)))
  90
  91 union per_thread_data {
  92     struct thread thread;
  93     lispobj dynamic_values[1];  /* actually more like 4000 or so */
  94 };
  95
  96 /* The thread struct is generated from lisp during genesis and it
  97  * needs to know the sizes of all its members, but some types may have
  98  * arbitrary lengths, thus the pointers are stored instead. This
  99  * structure is used to help allocation of those types, so that the
 100  * pointers can be later shoved into the thread struct. */
 101 struct nonpointer_thread_data
 102 {
 103 #if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_SB_SAFEPOINT)
 104     os_sem_t state_sem;
 105     os_sem_t state_not_running_sem;
 106     os_sem_t state_not_stopped_sem;
 107 #endif
 108 };
 109
 110 extern struct thread *all_threads;
 111 extern int dynamic_values_bytes;
 112
 113 #if defined(LISP_FEATURE_DARWIN)
 114 #define CONTROL_STACK_ALIGNMENT_BYTES 8192 /* darwin wants page-aligned stacks */
 115 #define THREAD_ALIGNMENT_BYTES CONTROL_STACK_ALIGNMENT_BYTES
 116 #else
 117 #define THREAD_ALIGNMENT_BYTES BACKEND_PAGE_BYTES
 118 #define CONTROL_STACK_ALIGNMENT_BYTES 16
 119 #endif
 120
 121
 122 #ifdef LISP_FEATURE_SB_THREAD
 123 #define for_each_thread(th) for(th=all_threads;th;th=th->next)
 124 #else
 125 /* there's some possibility a SSC could notice this never actually
 126  * loops  */
 127 #define for_each_thread(th) for(th=all_threads;th;th=0)
 128 #endif
 129
 130 #ifndef LISP_FEATURE_SB_THREAD
 131 /* no threads: every symbol's tls_index is statically zero */
 132 #  define tls_index_of(x) 0
 133 #  define per_thread_value(sym, thread) sym->value
 134 #else
 135 #ifdef LISP_FEATURE_64_BIT
 136 static inline int
 137 tls_index_of(struct symbol *symbol) // untagged pointer
 138 {
 139   return symbol->header >> 32;
 140 }
 141 #else
 142 #  define tls_index_of(x) (x->tls_index)
 143 #endif
 144 #define per_thread_value(sym,th) \
 145   ((union per_thread_data *)th)->dynamic_values[tls_index_of(sym)>>WORD_SHIFT]
 146 #endif
 147
 148 static inline lispobj *
 149 SymbolValueAddress(u64 tagged_symbol_pointer, void *thread)
 150 {
 151     struct symbol *sym= SYMBOL(tagged_symbol_pointer);
 152     if(thread && tls_index_of(sym)) {
 153         lispobj *r = &per_thread_value(sym, thread);
 154         if((*r)!=NO_TLS_VALUE_MARKER_WIDETAG) return r;
 155     }
 156     return &sym->value;
 157 }
 158
 159 static inline lispobj
 160 SymbolValue(u64 tagged_symbol_pointer, void *thread)
 161 {
 162     struct symbol *sym= SYMBOL(tagged_symbol_pointer);
 163     if(thread && tls_index_of(sym)) {
 164         lispobj r = per_thread_value(sym, thread);
 165         if(r!=NO_TLS_VALUE_MARKER_WIDETAG) return r;
 166     }
 167     return sym->value;
 168 }
 169
 170 static inline void
 171 SetSymbolValue(u64 tagged_symbol_pointer,lispobj val, void *thread)
 172 {
 173     struct symbol *sym= SYMBOL(tagged_symbol_pointer);
 174     if(thread && tls_index_of(sym)) {
 175         if (per_thread_value(sym, thread) != NO_TLS_VALUE_MARKER_WIDETAG) {
 176             per_thread_value(sym, thread) = val;
 177             return;
 178         }
 179     }
 180     sym->value = val;
 181 }
 182
 183 static inline lispobj
 184 SymbolTlValue(u64 tagged_symbol_pointer, void *thread)
 185 {
 186     struct symbol *sym= SYMBOL(tagged_symbol_pointer);
 187     return per_thread_value(sym, thread);
 188 }
 189
 190 static inline void
 191 SetTlSymbolValue(u64 tagged_symbol_pointer,lispobj val, void *thread)
 192 {
 193     struct symbol *sym= SYMBOL(tagged_symbol_pointer);
 194     // dynbind asserts that there is a tls_index in multithread runtime
 195     per_thread_value(sym, thread) = val;
 196 }
 197
 198 /* This only works for static symbols. */
 199 static inline lispobj
 200 StaticSymbolFunction(lispobj sym)
 201 {
 202     return ((struct fdefn *)native_pointer(SymbolValue(sym, 0)))->fun;
 203 }
 204
 205 /* These are for use during GC, on the current thread, or on prenatal
 206  * threads only. */
 207 #if defined(LISP_FEATURE_SB_THREAD)
 208 #define get_binding_stack_pointer(thread)       \
 209     ((thread)->binding_stack_pointer)
 210 #define set_binding_stack_pointer(thread,value) \
 211     ((thread)->binding_stack_pointer = (lispobj *)(value))
 212 #define access_control_stack_pointer(thread) \
 213     ((thread)->control_stack_pointer)
 214 #  if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
 215 #define access_control_frame_pointer(thread) \
 216     ((thread)->control_frame_pointer)
 217 #  endif
 218 #else
 219 #  if defined(BINDING_STACK_POINTER)
 220 #define get_binding_stack_pointer(thread)       \
 221     SymbolValue(BINDING_STACK_POINTER, thread)
 222 #define set_binding_stack_pointer(thread,value) \
 223     SetSymbolValue(BINDING_STACK_POINTER, (lispobj)(value), thread)
 224 #  else
 225 #define get_binding_stack_pointer(thread)       \
 226     (current_binding_stack_pointer)
 227 #define set_binding_stack_pointer(thread,value) \
 228     (current_binding_stack_pointer = (lispobj *)(value))
 229 #  endif
 230 #define access_control_stack_pointer(thread)    \
 231     (current_control_stack_pointer)
 232 #  if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
 233 #define access_control_frame_pointer(thread) \
 234     (current_control_frame_pointer)
 235 #  endif
 236 #endif
 237
 238 #if defined(LISP_FEATURE_SB_THREAD) && defined(LISP_FEATURE_GCC_TLS)
 239 extern __thread struct thread *current_thread;
 240 #endif
 241
 242 #ifndef LISP_FEATURE_SB_SAFEPOINT
 243 # define THREAD_CSP_PAGE_SIZE 0
 244 #elif defined(LISP_FEATURE_PPC)
 245   /* BACKEND_PAGE_BYTES is nice and large on this platform, but therefore
 246    * does not fit into an immediate, making it awkward to access the page
 247    * relative to the thread-tn... */
 248 # define THREAD_CSP_PAGE_SIZE 4096
 249 #else
 250 # define THREAD_CSP_PAGE_SIZE BACKEND_PAGE_BYTES
 251 #endif
 252
 253 #ifdef LISP_FEATURE_WIN32
 254 /*
 255  * Win32 doesn't have SIGSTKSZ, and we're not switching stacks anyway,
 256  * so define it arbitrarily
 257  */
 258 #define SIGSTKSZ 1024
 259 #endif
 260
 261 #define THREAD_STRUCT_SIZE (thread_control_stack_size + BINDING_STACK_SIZE + \
 262                             ALIEN_STACK_SIZE +                          \
 263                             sizeof(struct nonpointer_thread_data) +     \
 264                             dynamic_values_bytes +                      \
 265                             32 * SIGSTKSZ +                             \
 266                             THREAD_ALIGNMENT_BYTES +                    \
 267                             THREAD_CSP_PAGE_SIZE)
 268
 269 #if defined(LISP_FEATURE_WIN32)
 270 static inline struct thread* arch_os_get_current_thread()
 271     __attribute__((__const__));
 272 #endif
 273
 274 /* This is clearly per-arch and possibly even per-OS code, but we can't
 275  * put it somewhere sensible like x86-linux-os.c because it needs too
 276  * much stuff like struct thread and all_threads to be defined, which
 277  * usually aren't by that time.  So, it's here instead.  Sorry */
 278
 279 static inline struct thread *arch_os_get_current_thread(void)
 280 {
 281 #if !defined(LISP_FEATURE_SB_THREAD)
 282      return all_threads;
 283
 284 #elif defined(LISP_FEATURE_X86) && defined(LISP_FEATURE_WIN32)
 285     register struct thread *me=0;
 286     __asm__ volatile ("movl %%fs:0xE10+(4*63), %0" : "=r"(me) :);
 287     return me;
 288
 289 #else
 290
 291 # if defined(LISP_FEATURE_X86)
 292     if (!all_threads) return 0;
 293 #endif
 294
 295     /* Otherwise, use pthreads to find the right value.  We do not load
 296      * directly from %fs:this even on x86 platforms (like Linux and
 297      * Solaris) with dependable %fs, because we want to return NULL if
 298      * called by a non-Lisp thread, and %fs would not be initialized
 299      * suitably in that case. */
 300     struct thread *th;
 301 # ifdef LISP_FEATURE_GCC_TLS
 302     th = current_thread;
 303 # else
 304     th = pthread_getspecific(specials);
 305 # endif
 306
 307 # if defined(LISP_FEATURE_RESTORE_FS_SEGMENT_REGISTER_FROM_TLS)
 308     /* If enabled by make-config (currently Darwin and FreeBSD only),
 309      * re-setup %fs.  This is an out-of-line call, and potentially
 310      * expensive.*/
 311     if (th) {
 312         void arch_os_load_ldt(struct thread*);
 313         arch_os_load_ldt(th);
 314     }
 315 # endif
 316
 317     return th;
 318 #endif
 319 }
 320
 321 #if defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
 322 extern kern_return_t mach_lisp_thread_init(struct thread *thread);
 323 extern kern_return_t mach_lisp_thread_destroy(struct thread *thread);
 324 #endif
 325
 326 typedef struct init_thread_data {
 327     sigset_t oldset;
 328 #ifdef LISP_FEATURE_SB_SAFEPOINT
 329     struct gcing_safety safety;
 330 #endif
 331 } init_thread_data;
 332
 333 #ifdef LISP_FEATURE_SB_SAFEPOINT
 334 void thread_in_safety_transition(os_context_t *ctx);
 335 void thread_in_lisp_raised(os_context_t *ctx);
 336 void thread_interrupted(os_context_t *ctx);
 337 void thread_pitstop(os_context_t *ctxptr);
 338 extern void thread_register_gc_trigger();
 339
 340 # ifdef LISP_FEATURE_SB_THRUPTION
 341 int wake_thread(os_thread_t os_thread);
 342 #  ifdef LISP_FEATURE_WIN32
 343 void wake_thread_win32(struct thread *thread);
 344 #  else
 345 int wake_thread_posix(os_thread_t os_thread);
 346 #  endif
 347 # endif
 348
 349 static inline
 350 void push_gcing_safety(struct gcing_safety *into)
 351 {
 352     struct thread* th = arch_os_get_current_thread();
 353     asm volatile ("");
 354     if ((into->csp_around_foreign_call =
 355          *th->csp_around_foreign_call)) {
 356         *th->csp_around_foreign_call = 0;
 357         asm volatile ("");
 358 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
 359         into->pc_around_foreign_call = th->pc_around_foreign_call;
 360         th->pc_around_foreign_call = 0;
 361         asm volatile ("");
 362 #endif
 363     } else {
 364 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
 365         into->pc_around_foreign_call = 0;
 366 #endif
 367     }
 368 }
 369
 370 static inline
 371 void pop_gcing_safety(struct gcing_safety *from)
 372 {
 373     struct thread* th = arch_os_get_current_thread();
 374     if (from->csp_around_foreign_call) {
 375         asm volatile ("");
 376         *th->csp_around_foreign_call = from->csp_around_foreign_call;
 377         asm volatile ("");
 378 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
 379         th->pc_around_foreign_call = from->pc_around_foreign_call;
 380         asm volatile ("");
 381 #endif
 382     }
 383 }
 384
 385 /* Even with just -O1, gcc optimizes the jumps in this "loop" away
 386  * entirely, giving the ability to define WITH-FOO-style macros. */
 387 #define RUN_BODY_ONCE(prefix, finally_do)               \
 388     int prefix##done = 0;                               \
 389     for (; !prefix##done; finally_do, prefix##done = 1)
 390
 391 #define WITH_GC_AT_SAFEPOINTS_ONLY_hygenic(var)        \
 392     struct gcing_safety var;                    \
 393     push_gcing_safety(&var);                    \
 394     RUN_BODY_ONCE(var, pop_gcing_safety(&var))
 395
 396 #define WITH_GC_AT_SAFEPOINTS_ONLY()                           \
 397     WITH_GC_AT_SAFEPOINTS_ONLY_hygenic(sbcl__gc_safety)
 398
 399 #define WITH_STATE_SEM_hygenic(var, thread)                             \
 400     os_sem_wait((thread)->state_sem, "thread_state");                   \
 401     RUN_BODY_ONCE(var, os_sem_post((thread)->state_sem, "thread_state"))
 402
 403 #define WITH_STATE_SEM(thread)                                     \
 404     WITH_STATE_SEM_hygenic(sbcl__state_sem, thread)
 405
 406 int check_pending_thruptions(os_context_t *ctx);
 407
 408 void attach_os_thread(init_thread_data *);
 409 void detach_os_thread(init_thread_data *);
 410
 411 # if defined(LISP_FEATURE_SB_SAFEPOINT_STRICTLY) && !defined(LISP_FEATURE_WIN32)
 412
 413 void signal_handler_callback(lispobj, int, void *, void *);
 414 # endif
 415
 416 #endif
 417
 418 extern void create_initial_thread(lispobj);
 419
 420 #ifdef LISP_FEATURE_SB_THREAD
 421 extern pthread_mutex_t all_threads_lock;
 422 #endif
 423
 424 #endif /* _INCLUDE_THREAD_H_ */