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;
234 gint32 thread_pending_native_join;
236 #ifdef USE_WINDOWS_BACKEND
237 gint32 thread_wait_info;
243 void* (*thread_attach)(THREAD_INFO_TYPE *info);
245 This callback is called right before thread_detach_with_lock. This is called
246 without any locks held so it's the place for complicated cleanup.
248 The thread must remain operational between this call and thread_detach_with_lock.
249 It must be possible to successfully suspend it after thread_detach completes.
251 void (*thread_detach)(THREAD_INFO_TYPE *info);
253 This callback is called with @info still on the thread list.
254 This call is made while holding the suspend lock, so don't do callbacks.
255 SMR remains functional as its small_id has not been reclaimed.
257 void (*thread_detach_with_lock)(THREAD_INFO_TYPE *info);
258 gboolean (*ip_in_critical_region) (MonoDomain *domain, gpointer ip);
259 gboolean (*thread_in_critical_region) (THREAD_INFO_TYPE *info);
260 } MonoThreadInfoCallbacks;
263 void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
264 gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
265 gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoThreadInfo *info);
266 void (*thread_state_init) (MonoThreadUnwindState *tctx);
267 } MonoThreadInfoRuntimeCallbacks;
269 //Not using 0 and 1 to ensure callbacks are not returning bad data
271 MonoResumeThread = 0x1234,
272 KeepSuspended = 0x4321,
273 } SuspendThreadResult;
275 typedef SuspendThreadResult (*MonoSuspendThreadCallback) (THREAD_INFO_TYPE *info, gpointer user_data);
277 static inline gboolean
278 mono_threads_filter_tools_threads (THREAD_INFO_TYPE *info)
280 return !((MonoThreadInfo*)info)->tools_thread;
284 Requires the world to be stoped
286 #define FOREACH_THREAD(thread) \
287 MONO_LLS_FOREACH_FILTERED (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
289 #define FOREACH_THREAD_END \
295 #define FOREACH_THREAD_SAFE(thread) \
296 MONO_LLS_FOREACH_FILTERED_SAFE (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
298 #define FOREACH_THREAD_SAFE_END \
299 MONO_LLS_FOREACH_SAFE_END
301 static inline MonoNativeThreadId
302 mono_thread_info_get_tid (THREAD_INFO_TYPE *info)
304 return MONO_UINT_TO_NATIVE_THREAD_ID (((MonoThreadInfo*) info)->node.key);
308 mono_thread_info_set_tid (THREAD_INFO_TYPE *info, MonoNativeThreadId tid)
310 ((MonoThreadInfo*) info)->node.key = (uintptr_t) MONO_NATIVE_THREAD_ID_TO_UINT (tid);
314 * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
315 * a single block with info from both camps.
318 mono_thread_info_init (size_t thread_info_size);
321 mono_thread_info_callbacks_init (MonoThreadInfoCallbacks *callbacks);
324 mono_thread_info_signals_init (void);
327 mono_thread_info_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks);
329 MonoThreadInfoRuntimeCallbacks *
330 mono_threads_get_runtime_callbacks (void);
333 mono_thread_info_register_small_id (void);
336 mono_thread_info_attach (void);
339 mono_thread_info_detach (void);
342 mono_thread_info_try_get_internal_thread_gchandle (THREAD_INFO_TYPE *info, guint32 *gchandle);
345 mono_thread_info_set_internal_thread_gchandle (THREAD_INFO_TYPE *info, guint32 gchandle);
348 mono_thread_info_unset_internal_thread_gchandle (THREAD_INFO_TYPE *info);
351 mono_thread_info_is_exiting (void);
354 mono_thread_info_current (void);
357 mono_thread_info_current_unchecked (void);
360 mono_thread_info_get_small_id (void);
363 mono_thread_info_list_head (void);
366 mono_thread_info_lookup (MonoNativeThreadId id);
369 mono_thread_info_resume (MonoNativeThreadId tid);
372 mono_thread_info_safe_suspend_and_run (MonoNativeThreadId id, gboolean interrupt_kernel, MonoSuspendThreadCallback callback, gpointer user_data);
375 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data);
378 mono_thread_info_suspend_lock (void);
381 mono_thread_info_suspend_unlock (void);
384 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid);
387 mono_thread_info_set_is_async_context (gboolean async_context);
390 mono_thread_info_is_async_context (void);
393 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
396 mono_thread_info_yield (void);
399 mono_thread_info_sleep (guint32 ms, gboolean *alerted);
402 mono_thread_info_usleep (guint64 us);
405 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
408 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
411 mono_thread_info_exit (gsize exit_code);
414 mono_thread_info_install_interrupt (void (*callback) (gpointer data), gpointer data, gboolean *interrupted);
417 mono_thread_info_uninstall_interrupt (gboolean *interrupted);
419 MonoThreadInfoInterruptToken*
420 mono_thread_info_prepare_interrupt (THREAD_INFO_TYPE *info);
423 mono_thread_info_finish_interrupt (MonoThreadInfoInterruptToken *token);
426 mono_thread_info_self_interrupt (void);
429 mono_thread_info_clear_self_interrupt (void);
432 mono_thread_info_is_interrupt_state (THREAD_INFO_TYPE *info);
435 mono_thread_info_describe_interrupt_token (THREAD_INFO_TYPE *info, GString *text);
438 mono_thread_info_is_live (THREAD_INFO_TYPE *info);
441 mono_threads_get_max_stack_size (void);
444 mono_threads_open_thread_handle (MonoThreadHandle *handle);
447 mono_threads_close_thread_handle (MonoThreadHandle *handle);
450 mono_threads_attach_tools_thread (void);
453 #if !defined(HOST_WIN32)
455 /*Use this instead of pthread_kill */
457 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum);
459 #endif /* !defined(HOST_WIN32) */
461 /* Internal API between mono-threads and its backends. */
463 /* Backend functions - a backend must implement all of the following */
465 This is called very early in the runtime, it cannot access any runtime facilities.
468 void mono_threads_suspend_init (void); //ok
470 void mono_threads_suspend_init_signals (void);
472 void mono_threads_coop_init (void);
475 This begins async suspend. This function must do the following:
477 -Ensure the target will EINTR any syscalls if @interrupt_kernel is true
478 -Call mono_threads_transition_finish_async_suspend as part of its async suspend.
479 -Register the thread for pending suspend with mono_threads_add_to_pending_operation_set if needed.
481 If begin suspend fails the thread must be left uninterrupted and resumed.
483 gboolean mono_threads_suspend_begin_async_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel);
486 This verifies the outcome of an async suspend operation.
488 Some targets, such as posix, verify suspend results assynchronously. Suspend results must be
489 available (in a non blocking way) after mono_threads_wait_pending_operations completes.
491 gboolean mono_threads_suspend_check_suspend_result (THREAD_INFO_TYPE *info);
494 This begins async resume. This function must do the following:
496 - Install an async target if one was requested.
497 - Notify the target to resume.
498 - Register the thread for pending ack with mono_threads_add_to_pending_operation_set if needed.
500 gboolean mono_threads_suspend_begin_async_resume (THREAD_INFO_TYPE *info);
502 void mono_threads_suspend_register (THREAD_INFO_TYPE *info); //ok
503 void mono_threads_suspend_free (THREAD_INFO_TYPE *info);
504 void mono_threads_suspend_abort_syscall (THREAD_INFO_TYPE *info);
505 gint mono_threads_suspend_search_alternative_signal (void);
506 gint mono_threads_suspend_get_suspend_signal (void);
507 gint mono_threads_suspend_get_restart_signal (void);
508 gint mono_threads_suspend_get_abort_signal (void);
511 mono_thread_platform_create_thread (MonoThreadStart thread_fn, gpointer thread_data,
512 gsize* const stack_size, MonoNativeThreadId *tid);
514 void mono_threads_platform_get_stack_bounds (guint8 **staddr, size_t *stsize);
515 void mono_threads_platform_init (void);
516 gboolean mono_threads_platform_in_critical_region (MonoNativeThreadId tid);
517 gboolean mono_threads_platform_yield (void);
518 void mono_threads_platform_exit (gsize exit_code);
520 void mono_threads_coop_begin_global_suspend (void);
521 void mono_threads_coop_end_global_suspend (void);
523 MONO_API MonoNativeThreadId
524 mono_native_thread_id_get (void);
527 mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2);
530 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg);
533 mono_native_thread_set_name (MonoNativeThreadId tid, const char *name);
536 mono_native_thread_join (MonoNativeThreadId tid);
538 /*Mach specific internals */
539 void mono_threads_init_dead_letter (void);
540 void mono_threads_install_dead_letter (void);
542 /* mono-threads internal API used by the backends. */
544 This tells the suspend initiator that we completed suspend and will now be waiting for resume.
546 void mono_threads_notify_initiator_of_suspend (THREAD_INFO_TYPE* info);
548 This tells the resume initiator that we completed resume duties and will return to runnable state.
550 void mono_threads_notify_initiator_of_resume (THREAD_INFO_TYPE* info);
553 This tells the resume initiator that we completed abort duties and will return to previous state.
555 void mono_threads_notify_initiator_of_abort (THREAD_INFO_TYPE* info);
557 /* Thread state machine functions */
562 ResumeInitSelfResume,
563 ResumeInitAsyncResume,
564 ResumeInitBlockingResume,
570 SelfSuspendNotifyAndWait,
571 } MonoSelfSupendResult;
574 AsyncSuspendAlreadySuspended,
576 AsyncSuspendInitSuspend,
577 AsyncSuspendBlocking,
578 } MonoRequestAsyncSuspendResult;
581 DoBlockingContinue, //in blocking mode, continue
582 DoBlockingPollAndRetry, //async suspend raced blocking and won, pool and retry
583 } MonoDoBlockingResult;
586 DoneBlockingOk, //exited blocking fine
587 DoneBlockingWait, //thread should end suspended
588 } MonoDoneBlockingResult;
592 AbortBlockingIgnore, //Ignore
593 AbortBlockingIgnoreAndPoll, //Ignore and poll
594 AbortBlockingOk, //Abort worked
595 AbortBlockingWait, //Abort worked, but should wait for resume
596 } MonoAbortBlockingResult;
599 void mono_threads_transition_attach (THREAD_INFO_TYPE* info);
600 gboolean mono_threads_transition_detach (THREAD_INFO_TYPE *info);
601 MonoRequestAsyncSuspendResult mono_threads_transition_request_async_suspension (THREAD_INFO_TYPE *info);
602 MonoSelfSupendResult mono_threads_transition_state_poll (THREAD_INFO_TYPE *info);
603 MonoResumeResult mono_threads_transition_request_resume (THREAD_INFO_TYPE* info);
604 gboolean mono_threads_transition_finish_async_suspend (THREAD_INFO_TYPE* info);
605 MonoDoBlockingResult mono_threads_transition_do_blocking (THREAD_INFO_TYPE* info);
606 MonoDoneBlockingResult mono_threads_transition_done_blocking (THREAD_INFO_TYPE* info);
607 MonoAbortBlockingResult mono_threads_transition_abort_blocking (THREAD_INFO_TYPE* info);
609 MonoThreadUnwindState* mono_thread_info_get_suspend_state (THREAD_INFO_TYPE *info);
612 mono_threads_enter_gc_unsafe_region_cookie (void);
615 void mono_thread_info_wait_for_resume (THREAD_INFO_TYPE *info);
616 /* Advanced suspend API, used for suspending multiple threads as once. */
617 gboolean mono_thread_info_is_running (THREAD_INFO_TYPE *info);
618 gboolean mono_thread_info_is_live (THREAD_INFO_TYPE *info);
619 int mono_thread_info_suspend_count (THREAD_INFO_TYPE *info);
620 int mono_thread_info_current_state (THREAD_INFO_TYPE *info);
621 const char* mono_thread_state_name (int state);
622 gboolean mono_thread_is_gc_unsafe_mode (void);
624 gboolean mono_thread_info_in_critical_location (THREAD_INFO_TYPE *info);
625 gboolean mono_thread_info_begin_suspend (THREAD_INFO_TYPE *info);
626 gboolean mono_thread_info_begin_resume (THREAD_INFO_TYPE *info);
628 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
629 gboolean mono_threads_wait_pending_operations (void);
630 void mono_threads_begin_global_suspend (void);
631 void mono_threads_end_global_suspend (void);
634 mono_thread_info_is_current (THREAD_INFO_TYPE *info);
637 MONO_THREAD_INFO_WAIT_RET_SUCCESS_0 = 0,
638 MONO_THREAD_INFO_WAIT_RET_ALERTED = -1,
639 MONO_THREAD_INFO_WAIT_RET_TIMEOUT = -2,
640 MONO_THREAD_INFO_WAIT_RET_FAILED = -3,
641 } MonoThreadInfoWaitRet;
643 MonoThreadInfoWaitRet
644 mono_thread_info_wait_one_handle (MonoThreadHandle *handle, guint32 timeout, gboolean alertable);
646 MonoThreadInfoWaitRet
647 mono_thread_info_wait_multiple_handle (MonoThreadHandle **thread_handles, gsize nhandles, MonoOSEvent *background_change_event, gboolean waitall, guint32 timeout, gboolean alertable);
649 void mono_threads_join_lock (void);
650 void mono_threads_join_unlock (void);
652 #endif /* __MONO_THREADS_H__ */