6 * Rodrigo Kumpera (kumpera@gmail.com)
11 #ifndef __MONO_THREADS_H__
12 #define __MONO_THREADS_H__
14 #include <mono/utils/mono-os-semaphore.h>
15 #include <mono/utils/mono-stack-unwinding.h>
16 #include <mono/utils/mono-linked-list-set.h>
17 #include <mono/utils/mono-tls.h>
18 #include <mono/utils/mono-coop-semaphore.h>
19 #include <mono/utils/os-event.h>
20 #include <mono/utils/refcount.h>
28 typedef DWORD MonoNativeThreadId;
29 typedef HANDLE MonoNativeThreadHandle; /* unused */
31 typedef DWORD mono_native_thread_return_t;
32 typedef DWORD mono_thread_start_return_t;
34 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (tid)
35 #define MONO_UINT_TO_NATIVE_THREAD_ID(tid) ((MonoNativeThreadId)(tid))
37 typedef LPTHREAD_START_ROUTINE MonoThreadStart;
44 #include <mono/utils/mach-support.h>
46 typedef thread_port_t MonoNativeThreadHandle;
52 typedef pid_t MonoNativeThreadHandle;
54 #endif /* defined(__MACH__) */
56 typedef pthread_t MonoNativeThreadId;
58 typedef void* mono_native_thread_return_t;
59 typedef gsize mono_thread_start_return_t;
61 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (gsize)(tid)
62 #define MONO_UINT_TO_NATIVE_THREAD_ID(tid) (MonoNativeThreadId)(gsize)(tid)
64 typedef gsize (*MonoThreadStart)(gpointer);
66 #if !defined(__HAIKU__)
67 #define MONO_THREADS_PLATFORM_HAS_ATTR_SETSCHED
68 #endif /* !defined(__HAIKU__) */
70 #endif /* #ifdef HOST_WIN32 */
72 #ifndef MONO_INFINITE_WAIT
73 #define MONO_INFINITE_WAIT ((guint32) 0xFFFFFFFF)
82 THREAD_INFO_TYPE is a way to make the mono-threads module parametric - or sort of.
83 The GC using mono-threads might extend the MonoThreadInfo struct to add its own
84 data, this avoid a pointer indirection on what is on a lot of hot paths.
86 But extending MonoThreadInfo has de disavantage that all functions here return type
87 would require a cast, something like the following:
95 ((MyThreadInfo*)mono_thread_info_current ())->stuff = 1;
97 While porting sgen to use mono-threads, the number of casts required was too much and
98 code ended up looking horrible. So we use this cute little hack. The idea is that
99 whomever is including this header can set the expected type to be used by functions here
100 and reduce the number of casts drastically.
103 #ifndef THREAD_INFO_TYPE
104 #define THREAD_INFO_TYPE MonoThreadInfo
107 /* Mono Threads internal configuration knows*/
109 /* If this is defined, use the signals backed on Mach. Debug only as signals can't be made usable on OSX. */
110 // #define USE_SIGNALS_ON_MACH
113 #define USE_WASM_BACKEND
114 #elif defined (_POSIX_VERSION)
115 #if defined (__MACH__) && !defined (USE_SIGNALS_ON_MACH)
116 #define USE_MACH_BACKEND
118 #define USE_POSIX_BACKEND
121 #define USE_WINDOWS_BACKEND
123 #error "no backend support for current platform"
124 #endif /* defined (_POSIX_VERSION) */
127 STATE_STARTING = 0x00,
128 STATE_RUNNING = 0x01,
129 STATE_DETACHED = 0x02,
131 STATE_ASYNC_SUSPENDED = 0x03,
132 STATE_SELF_SUSPENDED = 0x04,
133 STATE_ASYNC_SUSPEND_REQUESTED = 0x05,
134 STATE_SELF_SUSPEND_REQUESTED = 0x06,
135 STATE_BLOCKING = 0x07,
136 STATE_BLOCKING_AND_SUSPENDED = 0x8,
140 THREAD_STATE_MASK = 0x00FF,
141 THREAD_SUSPEND_COUNT_MASK = 0xFF00,
142 THREAD_SUSPEND_COUNT_SHIFT = 8,
143 THREAD_SUSPEND_COUNT_MAX = 0xFF,
145 SELF_SUSPEND_STATE_INDEX = 0,
146 ASYNC_SUSPEND_STATE_INDEX = 1,
149 typedef struct _MonoThreadInfoInterruptToken MonoThreadInfoInterruptToken;
152 MonoLinkedListSetNode node;
153 guint32 small_id; /*Used by hazard pointers */
154 MonoNativeThreadHandle native_handle; /* Valid on mach and android */
157 /*Tells if this thread was created by the runtime or not.*/
158 gboolean runtime_thread;
160 /* Tells if this thread should be ignored or not by runtime services such as GC and profiling */
161 gboolean tools_thread;
163 /* Max stack bounds, all valid addresses must be between [stack_start_limit, stack_end[ */
164 void *stack_start_limit, *stack_end;
166 /* suspend machinery, fields protected by suspend_semaphore */
167 MonoSemType suspend_semaphore;
170 MonoSemType resume_semaphore;
172 /* only needed by the posix backend */
173 #if defined(USE_POSIX_BACKEND)
174 MonoSemType finish_resume_semaphore;
175 gboolean syscall_break_signal;
179 gboolean suspend_can_continue;
181 /* This memory pool is used by coop GC to save stack data roots between GC unsafe regions */
182 GByteArray *stackdata;
184 /*In theory, only the posix backend needs this, but having it on mach/win32 simplifies things a lot.*/
185 MonoThreadUnwindState thread_saved_state [2]; //0 is self suspend, 1 is async suspend.
187 /*async call machinery, thread MUST be suspended before accessing those fields*/
188 void (*async_target)(void*);
192 If true, this thread is running a critical region of code and cannot be suspended.
193 A critical session is implicitly started when you call mono_thread_info_safe_suspend_sync
194 and is ended when you call either mono_thread_info_resume or mono_thread_info_finish_suspend.
196 gboolean inside_critical_region;
199 * If TRUE, the thread is in async context. Code can use this information to avoid async-unsafe
200 * operations like locking without having to pass an 'async' parameter around.
202 gboolean is_async_context;
205 * Values of TLS variables for this thread.
206 * This can be used to obtain the values of TLS variable for threads
207 * other than the current one.
209 gpointer tls [TLS_KEY_NUM];
211 /* IO layer handle for this thread */
212 /* Set when the thread is started, or in _wapi_thread_duplicate () */
213 MonoThreadHandle *handle;
217 MonoThreadInfoInterruptToken *interrupt_token;
219 /* HandleStack for coop handles */
220 gpointer handle_stack;
222 /* Stack mark for targets that explicitly require one */
225 /* GCHandle to MonoInternalThread */
226 guint32 internal_thread_gchandle;
229 * Used by the sampling code in mini-posix.c to ensure that a thread has
230 * handled a sampling signal before sending another one.
232 gint32 profiler_signal_ack;
236 void* (*thread_attach)(THREAD_INFO_TYPE *info);
238 This callback is called right before thread_detach_with_lock. This is called
239 without any locks held so it's the place for complicated cleanup.
241 The thread must remain operational between this call and thread_detach_with_lock.
242 It must be possible to successfully suspend it after thread_detach completes.
244 void (*thread_detach)(THREAD_INFO_TYPE *info);
246 This callback is called with @info still on the thread list.
247 This call is made while holding the suspend lock, so don't do callbacks.
248 SMR remains functional as its small_id has not been reclaimed.
250 void (*thread_detach_with_lock)(THREAD_INFO_TYPE *info);
251 gboolean (*ip_in_critical_region) (MonoDomain *domain, gpointer ip);
252 gboolean (*thread_in_critical_region) (THREAD_INFO_TYPE *info);
253 } MonoThreadInfoCallbacks;
256 void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
257 gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
258 gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoThreadInfo *info);
259 void (*thread_state_init) (MonoThreadUnwindState *tctx);
260 } MonoThreadInfoRuntimeCallbacks;
262 //Not using 0 and 1 to ensure callbacks are not returning bad data
264 MonoResumeThread = 0x1234,
265 KeepSuspended = 0x4321,
266 } SuspendThreadResult;
268 typedef SuspendThreadResult (*MonoSuspendThreadCallback) (THREAD_INFO_TYPE *info, gpointer user_data);
270 static inline gboolean
271 mono_threads_filter_tools_threads (THREAD_INFO_TYPE *info)
273 return !((MonoThreadInfo*)info)->tools_thread;
277 Requires the world to be stoped
279 #define FOREACH_THREAD(thread) \
280 MONO_LLS_FOREACH_FILTERED (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
282 #define FOREACH_THREAD_END \
288 #define FOREACH_THREAD_SAFE(thread) \
289 MONO_LLS_FOREACH_FILTERED_SAFE (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
291 #define FOREACH_THREAD_SAFE_END \
292 MONO_LLS_FOREACH_SAFE_END
294 static inline MonoNativeThreadId
295 mono_thread_info_get_tid (THREAD_INFO_TYPE *info)
297 return MONO_UINT_TO_NATIVE_THREAD_ID (((MonoThreadInfo*) info)->node.key);
301 mono_thread_info_set_tid (THREAD_INFO_TYPE *info, MonoNativeThreadId tid)
303 ((MonoThreadInfo*) info)->node.key = (uintptr_t) MONO_NATIVE_THREAD_ID_TO_UINT (tid);
307 * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
308 * a single block with info from both camps.
311 mono_thread_info_init (size_t thread_info_size);
314 mono_thread_info_callbacks_init (MonoThreadInfoCallbacks *callbacks);
317 mono_thread_info_signals_init (void);
320 mono_thread_info_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks);
322 MonoThreadInfoRuntimeCallbacks *
323 mono_threads_get_runtime_callbacks (void);
326 mono_thread_info_register_small_id (void);
329 mono_thread_info_attach (void);
332 mono_thread_info_detach (void);
335 mono_thread_info_try_get_internal_thread_gchandle (THREAD_INFO_TYPE *info, guint32 *gchandle);
338 mono_thread_info_set_internal_thread_gchandle (THREAD_INFO_TYPE *info, guint32 gchandle);
341 mono_thread_info_unset_internal_thread_gchandle (THREAD_INFO_TYPE *info);
344 mono_thread_info_is_exiting (void);
347 mono_thread_info_current (void);
350 mono_thread_info_current_unchecked (void);
353 mono_thread_info_get_small_id (void);
356 mono_thread_info_list_head (void);
359 mono_thread_info_lookup (MonoNativeThreadId id);
362 mono_thread_info_resume (MonoNativeThreadId tid);
365 mono_thread_info_safe_suspend_and_run (MonoNativeThreadId id, gboolean interrupt_kernel, MonoSuspendThreadCallback callback, gpointer user_data);
368 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data);
371 mono_thread_info_suspend_lock (void);
374 mono_thread_info_suspend_unlock (void);
377 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid);
380 mono_thread_info_set_is_async_context (gboolean async_context);
383 mono_thread_info_is_async_context (void);
386 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
389 mono_thread_info_yield (void);
392 mono_thread_info_sleep (guint32 ms, gboolean *alerted);
395 mono_thread_info_usleep (guint64 us);
398 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
401 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
404 mono_thread_info_exit (gsize exit_code);
407 mono_thread_info_install_interrupt (void (*callback) (gpointer data), gpointer data, gboolean *interrupted);
410 mono_thread_info_uninstall_interrupt (gboolean *interrupted);
412 MonoThreadInfoInterruptToken*
413 mono_thread_info_prepare_interrupt (THREAD_INFO_TYPE *info);
416 mono_thread_info_finish_interrupt (MonoThreadInfoInterruptToken *token);
419 mono_thread_info_self_interrupt (void);
422 mono_thread_info_clear_self_interrupt (void);
425 mono_thread_info_is_interrupt_state (THREAD_INFO_TYPE *info);
428 mono_thread_info_describe_interrupt_token (THREAD_INFO_TYPE *info, GString *text);
431 mono_thread_info_is_live (THREAD_INFO_TYPE *info);
434 mono_threads_get_max_stack_size (void);
437 mono_threads_open_thread_handle (MonoThreadHandle *handle);
440 mono_threads_close_thread_handle (MonoThreadHandle *handle);
443 mono_threads_attach_tools_thread (void);
446 #if !defined(HOST_WIN32)
448 /*Use this instead of pthread_kill */
450 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum);
452 #endif /* !defined(HOST_WIN32) */
454 /* Internal API between mono-threads and its backends. */
456 /* Backend functions - a backend must implement all of the following */
458 This is called very early in the runtime, it cannot access any runtime facilities.
461 void mono_threads_suspend_init (void); //ok
463 void mono_threads_suspend_init_signals (void);
465 void mono_threads_coop_init (void);
468 This begins async suspend. This function must do the following:
470 -Ensure the target will EINTR any syscalls if @interrupt_kernel is true
471 -Call mono_threads_transition_finish_async_suspend as part of its async suspend.
472 -Register the thread for pending suspend with mono_threads_add_to_pending_operation_set if needed.
474 If begin suspend fails the thread must be left uninterrupted and resumed.
476 gboolean mono_threads_suspend_begin_async_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel);
479 This verifies the outcome of an async suspend operation.
481 Some targets, such as posix, verify suspend results assynchronously. Suspend results must be
482 available (in a non blocking way) after mono_threads_wait_pending_operations completes.
484 gboolean mono_threads_suspend_check_suspend_result (THREAD_INFO_TYPE *info);
487 This begins async resume. This function must do the following:
489 - Install an async target if one was requested.
490 - Notify the target to resume.
491 - Register the thread for pending ack with mono_threads_add_to_pending_operation_set if needed.
493 gboolean mono_threads_suspend_begin_async_resume (THREAD_INFO_TYPE *info);
495 void mono_threads_suspend_register (THREAD_INFO_TYPE *info); //ok
496 void mono_threads_suspend_free (THREAD_INFO_TYPE *info);
497 void mono_threads_suspend_abort_syscall (THREAD_INFO_TYPE *info);
498 gint mono_threads_suspend_search_alternative_signal (void);
499 gint mono_threads_suspend_get_suspend_signal (void);
500 gint mono_threads_suspend_get_restart_signal (void);
501 gint mono_threads_suspend_get_abort_signal (void);
504 mono_thread_platform_create_thread (MonoThreadStart thread_fn, gpointer thread_data,
505 gsize* const stack_size, MonoNativeThreadId *tid);
507 void mono_threads_platform_get_stack_bounds (guint8 **staddr, size_t *stsize);
508 void mono_threads_platform_init (void);
509 gboolean mono_threads_platform_in_critical_region (MonoNativeThreadId tid);
510 gboolean mono_threads_platform_yield (void);
511 void mono_threads_platform_exit (gsize exit_code);
513 void mono_threads_coop_begin_global_suspend (void);
514 void mono_threads_coop_end_global_suspend (void);
516 MONO_API MonoNativeThreadId
517 mono_native_thread_id_get (void);
520 mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2);
523 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg);
526 mono_native_thread_set_name (MonoNativeThreadId tid, const char *name);
529 mono_native_thread_join (MonoNativeThreadId tid);
531 /*Mach specific internals */
532 void mono_threads_init_dead_letter (void);
533 void mono_threads_install_dead_letter (void);
535 /* mono-threads internal API used by the backends. */
537 This tells the suspend initiator that we completed suspend and will now be waiting for resume.
539 void mono_threads_notify_initiator_of_suspend (THREAD_INFO_TYPE* info);
541 This tells the resume initiator that we completed resume duties and will return to runnable state.
543 void mono_threads_notify_initiator_of_resume (THREAD_INFO_TYPE* info);
546 This tells the resume initiator that we completed abort duties and will return to previous state.
548 void mono_threads_notify_initiator_of_abort (THREAD_INFO_TYPE* info);
550 /* Thread state machine functions */
555 ResumeInitSelfResume,
556 ResumeInitAsyncResume,
557 ResumeInitBlockingResume,
563 SelfSuspendNotifyAndWait,
564 } MonoSelfSupendResult;
567 AsyncSuspendAlreadySuspended,
569 AsyncSuspendInitSuspend,
570 AsyncSuspendBlocking,
571 } MonoRequestAsyncSuspendResult;
574 DoBlockingContinue, //in blocking mode, continue
575 DoBlockingPollAndRetry, //async suspend raced blocking and won, pool and retry
576 } MonoDoBlockingResult;
579 DoneBlockingOk, //exited blocking fine
580 DoneBlockingWait, //thread should end suspended
581 } MonoDoneBlockingResult;
585 AbortBlockingIgnore, //Ignore
586 AbortBlockingIgnoreAndPoll, //Ignore and poll
587 AbortBlockingOk, //Abort worked
588 AbortBlockingWait, //Abort worked, but should wait for resume
589 } MonoAbortBlockingResult;
592 void mono_threads_transition_attach (THREAD_INFO_TYPE* info);
593 gboolean mono_threads_transition_detach (THREAD_INFO_TYPE *info);
594 MonoRequestAsyncSuspendResult mono_threads_transition_request_async_suspension (THREAD_INFO_TYPE *info);
595 MonoSelfSupendResult mono_threads_transition_state_poll (THREAD_INFO_TYPE *info);
596 MonoResumeResult mono_threads_transition_request_resume (THREAD_INFO_TYPE* info);
597 gboolean mono_threads_transition_finish_async_suspend (THREAD_INFO_TYPE* info);
598 MonoDoBlockingResult mono_threads_transition_do_blocking (THREAD_INFO_TYPE* info);
599 MonoDoneBlockingResult mono_threads_transition_done_blocking (THREAD_INFO_TYPE* info);
600 MonoAbortBlockingResult mono_threads_transition_abort_blocking (THREAD_INFO_TYPE* info);
602 MonoThreadUnwindState* mono_thread_info_get_suspend_state (THREAD_INFO_TYPE *info);
605 mono_threads_enter_gc_unsafe_region_cookie (void);
608 void mono_thread_info_wait_for_resume (THREAD_INFO_TYPE *info);
609 /* Advanced suspend API, used for suspending multiple threads as once. */
610 gboolean mono_thread_info_is_running (THREAD_INFO_TYPE *info);
611 gboolean mono_thread_info_is_live (THREAD_INFO_TYPE *info);
612 int mono_thread_info_suspend_count (THREAD_INFO_TYPE *info);
613 int mono_thread_info_current_state (THREAD_INFO_TYPE *info);
614 const char* mono_thread_state_name (int state);
616 gboolean mono_thread_info_in_critical_location (THREAD_INFO_TYPE *info);
617 gboolean mono_thread_info_begin_suspend (THREAD_INFO_TYPE *info);
618 gboolean mono_thread_info_begin_resume (THREAD_INFO_TYPE *info);
620 void mono_threads_add_to_pending_operation_set (THREAD_INFO_TYPE* info); //XXX rename to something to reflect the fact that this is used for both suspend and resume
621 gboolean mono_threads_wait_pending_operations (void);
622 void mono_threads_begin_global_suspend (void);
623 void mono_threads_end_global_suspend (void);
626 mono_thread_info_is_current (THREAD_INFO_TYPE *info);
629 MONO_THREAD_INFO_WAIT_RET_SUCCESS_0 = 0,
630 MONO_THREAD_INFO_WAIT_RET_ALERTED = -1,
631 MONO_THREAD_INFO_WAIT_RET_TIMEOUT = -2,
632 MONO_THREAD_INFO_WAIT_RET_FAILED = -3,
633 } MonoThreadInfoWaitRet;
635 MonoThreadInfoWaitRet
636 mono_thread_info_wait_one_handle (MonoThreadHandle *handle, guint32 timeout, gboolean alertable);
638 MonoThreadInfoWaitRet
639 mono_thread_info_wait_multiple_handle (MonoThreadHandle **thread_handles, gsize nhandles, MonoOSEvent *background_change_event, gboolean waitall, guint32 timeout, gboolean alertable);
641 void mono_threads_join_lock (void);
642 void mono_threads_join_unlock (void);
644 #endif /* __MONO_THREADS_H__ */