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
112 #if defined (_POSIX_VERSION)
113 #if defined (__MACH__) && !defined (USE_SIGNALS_ON_MACH)
114 #define USE_MACH_BACKEND
116 #define USE_POSIX_BACKEND
119 #define USE_WINDOWS_BACKEND
121 #error "no backend support for current platform"
122 #endif /* defined (_POSIX_VERSION) */
125 STATE_STARTING = 0x00,
126 STATE_RUNNING = 0x01,
127 STATE_DETACHED = 0x02,
129 STATE_ASYNC_SUSPENDED = 0x03,
130 STATE_SELF_SUSPENDED = 0x04,
131 STATE_ASYNC_SUSPEND_REQUESTED = 0x05,
132 STATE_SELF_SUSPEND_REQUESTED = 0x06,
133 STATE_BLOCKING = 0x07,
134 STATE_BLOCKING_AND_SUSPENDED = 0x8,
138 THREAD_STATE_MASK = 0x00FF,
139 THREAD_SUSPEND_COUNT_MASK = 0xFF00,
140 THREAD_SUSPEND_COUNT_SHIFT = 8,
141 THREAD_SUSPEND_COUNT_MAX = 0xFF,
143 SELF_SUSPEND_STATE_INDEX = 0,
144 ASYNC_SUSPEND_STATE_INDEX = 1,
147 typedef struct _MonoThreadInfoInterruptToken MonoThreadInfoInterruptToken;
150 MonoLinkedListSetNode node;
151 guint32 small_id; /*Used by hazard pointers */
152 MonoNativeThreadHandle native_handle; /* Valid on mach and android */
155 /*Tells if this thread was created by the runtime or not.*/
156 gboolean runtime_thread;
158 /* Tells if this thread should be ignored or not by runtime services such as GC and profiling */
159 gboolean tools_thread;
161 /* Max stack bounds, all valid addresses must be between [stack_start_limit, stack_end[ */
162 void *stack_start_limit, *stack_end;
164 /* suspend machinery, fields protected by suspend_semaphore */
165 MonoSemType suspend_semaphore;
168 MonoSemType resume_semaphore;
170 /* only needed by the posix backend */
171 #if defined(USE_POSIX_BACKEND)
172 MonoSemType finish_resume_semaphore;
173 gboolean syscall_break_signal;
177 gboolean suspend_can_continue;
179 /* This memory pool is used by coop GC to save stack data roots between GC unsafe regions */
180 GByteArray *stackdata;
182 /*In theory, only the posix backend needs this, but having it on mach/win32 simplifies things a lot.*/
183 MonoThreadUnwindState thread_saved_state [2]; //0 is self suspend, 1 is async suspend.
185 /*async call machinery, thread MUST be suspended before accessing those fields*/
186 void (*async_target)(void*);
190 If true, this thread is running a critical region of code and cannot be suspended.
191 A critical session is implicitly started when you call mono_thread_info_safe_suspend_sync
192 and is ended when you call either mono_thread_info_resume or mono_thread_info_finish_suspend.
194 gboolean inside_critical_region;
197 * If TRUE, the thread is in async context. Code can use this information to avoid async-unsafe
198 * operations like locking without having to pass an 'async' parameter around.
200 gboolean is_async_context;
203 * Values of TLS variables for this thread.
204 * This can be used to obtain the values of TLS variable for threads
205 * other than the current one.
207 gpointer tls [TLS_KEY_NUM];
209 /* IO layer handle for this thread */
210 /* Set when the thread is started, or in _wapi_thread_duplicate () */
211 MonoThreadHandle *handle;
215 MonoThreadInfoInterruptToken *interrupt_token;
217 /* HandleStack for coop handles */
218 gpointer handle_stack;
220 /* Stack mark for targets that explicitly require one */
223 /* GCHandle to MonoInternalThread */
224 guint32 internal_thread_gchandle;
227 * Used by the sampling code in mini-posix.c to ensure that a thread has
228 * handled a sampling signal before sending another one.
230 gint32 profiler_signal_ack;
234 void* (*thread_attach)(THREAD_INFO_TYPE *info);
236 This callback is called right before thread_detach_with_lock. This is called
237 without any locks held so it's the place for complicated cleanup.
239 The thread must remain operational between this call and thread_detach_with_lock.
240 It must be possible to successfully suspend it after thread_detach completes.
242 void (*thread_detach)(THREAD_INFO_TYPE *info);
244 This callback is called with @info still on the thread list.
245 This call is made while holding the suspend lock, so don't do callbacks.
246 SMR remains functional as its small_id has not been reclaimed.
248 void (*thread_detach_with_lock)(THREAD_INFO_TYPE *info);
249 gboolean (*ip_in_critical_region) (MonoDomain *domain, gpointer ip);
250 gboolean (*thread_in_critical_region) (THREAD_INFO_TYPE *info);
251 } MonoThreadInfoCallbacks;
254 void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
255 gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
256 gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoThreadInfo *info);
257 void (*thread_state_init) (MonoThreadUnwindState *tctx);
258 } MonoThreadInfoRuntimeCallbacks;
260 //Not using 0 and 1 to ensure callbacks are not returning bad data
262 MonoResumeThread = 0x1234,
263 KeepSuspended = 0x4321,
264 } SuspendThreadResult;
266 typedef SuspendThreadResult (*MonoSuspendThreadCallback) (THREAD_INFO_TYPE *info, gpointer user_data);
268 static inline gboolean
269 mono_threads_filter_tools_threads (THREAD_INFO_TYPE *info)
271 return !((MonoThreadInfo*)info)->tools_thread;
275 Requires the world to be stoped
277 #define FOREACH_THREAD(thread) \
278 MONO_LLS_FOREACH_FILTERED (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
280 #define FOREACH_THREAD_END \
286 #define FOREACH_THREAD_SAFE(thread) \
287 MONO_LLS_FOREACH_FILTERED_SAFE (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
289 #define FOREACH_THREAD_SAFE_END \
290 MONO_LLS_FOREACH_SAFE_END
292 static inline MonoNativeThreadId
293 mono_thread_info_get_tid (THREAD_INFO_TYPE *info)
295 return MONO_UINT_TO_NATIVE_THREAD_ID (((MonoThreadInfo*) info)->node.key);
299 mono_thread_info_set_tid (THREAD_INFO_TYPE *info, MonoNativeThreadId tid)
301 ((MonoThreadInfo*) info)->node.key = (uintptr_t) MONO_NATIVE_THREAD_ID_TO_UINT (tid);
305 * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
306 * a single block with info from both camps.
309 mono_thread_info_init (size_t thread_info_size);
312 mono_thread_info_callbacks_init (MonoThreadInfoCallbacks *callbacks);
315 mono_thread_info_signals_init (void);
318 mono_thread_info_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks);
320 MonoThreadInfoRuntimeCallbacks *
321 mono_threads_get_runtime_callbacks (void);
324 mono_thread_info_register_small_id (void);
327 mono_thread_info_attach (void);
330 mono_thread_info_detach (void);
333 mono_thread_info_try_get_internal_thread_gchandle (THREAD_INFO_TYPE *info, guint32 *gchandle);
336 mono_thread_info_set_internal_thread_gchandle (THREAD_INFO_TYPE *info, guint32 gchandle);
339 mono_thread_info_unset_internal_thread_gchandle (THREAD_INFO_TYPE *info);
342 mono_thread_info_is_exiting (void);
345 mono_thread_info_current (void);
348 mono_thread_info_current_unchecked (void);
351 mono_thread_info_get_small_id (void);
354 mono_thread_info_list_head (void);
357 mono_thread_info_lookup (MonoNativeThreadId id);
360 mono_thread_info_resume (MonoNativeThreadId tid);
363 mono_thread_info_safe_suspend_and_run (MonoNativeThreadId id, gboolean interrupt_kernel, MonoSuspendThreadCallback callback, gpointer user_data);
366 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data);
369 mono_thread_info_suspend_lock (void);
372 mono_thread_info_suspend_unlock (void);
375 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid);
378 mono_thread_info_set_is_async_context (gboolean async_context);
381 mono_thread_info_is_async_context (void);
384 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
387 mono_thread_info_yield (void);
390 mono_thread_info_sleep (guint32 ms, gboolean *alerted);
393 mono_thread_info_usleep (guint64 us);
396 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
399 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
402 mono_thread_info_exit (gsize exit_code);
405 mono_thread_info_install_interrupt (void (*callback) (gpointer data), gpointer data, gboolean *interrupted);
408 mono_thread_info_uninstall_interrupt (gboolean *interrupted);
410 MonoThreadInfoInterruptToken*
411 mono_thread_info_prepare_interrupt (THREAD_INFO_TYPE *info);
414 mono_thread_info_finish_interrupt (MonoThreadInfoInterruptToken *token);
417 mono_thread_info_self_interrupt (void);
420 mono_thread_info_clear_self_interrupt (void);
423 mono_thread_info_is_interrupt_state (THREAD_INFO_TYPE *info);
426 mono_thread_info_describe_interrupt_token (THREAD_INFO_TYPE *info, GString *text);
429 mono_thread_info_is_live (THREAD_INFO_TYPE *info);
432 mono_threads_get_max_stack_size (void);
435 mono_threads_open_thread_handle (MonoThreadHandle *handle);
438 mono_threads_close_thread_handle (MonoThreadHandle *handle);
441 mono_threads_attach_tools_thread (void);
444 #if !defined(HOST_WIN32)
446 /*Use this instead of pthread_kill */
448 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum);
450 #endif /* !defined(HOST_WIN32) */
452 /* Internal API between mono-threads and its backends. */
454 /* Backend functions - a backend must implement all of the following */
456 This is called very early in the runtime, it cannot access any runtime facilities.
459 void mono_threads_suspend_init (void); //ok
461 void mono_threads_suspend_init_signals (void);
463 void mono_threads_coop_init (void);
466 This begins async suspend. This function must do the following:
468 -Ensure the target will EINTR any syscalls if @interrupt_kernel is true
469 -Call mono_threads_transition_finish_async_suspend as part of its async suspend.
470 -Register the thread for pending suspend with mono_threads_add_to_pending_operation_set if needed.
472 If begin suspend fails the thread must be left uninterrupted and resumed.
474 gboolean mono_threads_suspend_begin_async_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel);
477 This verifies the outcome of an async suspend operation.
479 Some targets, such as posix, verify suspend results assynchronously. Suspend results must be
480 available (in a non blocking way) after mono_threads_wait_pending_operations completes.
482 gboolean mono_threads_suspend_check_suspend_result (THREAD_INFO_TYPE *info);
485 This begins async resume. This function must do the following:
487 - Install an async target if one was requested.
488 - Notify the target to resume.
489 - Register the thread for pending ack with mono_threads_add_to_pending_operation_set if needed.
491 gboolean mono_threads_suspend_begin_async_resume (THREAD_INFO_TYPE *info);
493 void mono_threads_suspend_register (THREAD_INFO_TYPE *info); //ok
494 void mono_threads_suspend_free (THREAD_INFO_TYPE *info);
495 void mono_threads_suspend_abort_syscall (THREAD_INFO_TYPE *info);
496 gint mono_threads_suspend_search_alternative_signal (void);
497 gint mono_threads_suspend_get_suspend_signal (void);
498 gint mono_threads_suspend_get_restart_signal (void);
499 gint mono_threads_suspend_get_abort_signal (void);
502 mono_thread_platform_create_thread (MonoThreadStart thread_fn, gpointer thread_data,
503 gsize* const stack_size, MonoNativeThreadId *tid);
505 void mono_threads_platform_get_stack_bounds (guint8 **staddr, size_t *stsize);
506 void mono_threads_platform_init (void);
507 gboolean mono_threads_platform_in_critical_region (MonoNativeThreadId tid);
508 gboolean mono_threads_platform_yield (void);
509 void mono_threads_platform_exit (gsize exit_code);
511 void mono_threads_coop_begin_global_suspend (void);
512 void mono_threads_coop_end_global_suspend (void);
514 MONO_API MonoNativeThreadId
515 mono_native_thread_id_get (void);
518 mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2);
521 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg);
524 mono_native_thread_set_name (MonoNativeThreadId tid, const char *name);
527 mono_native_thread_join (MonoNativeThreadId tid);
529 /*Mach specific internals */
530 void mono_threads_init_dead_letter (void);
531 void mono_threads_install_dead_letter (void);
533 /* mono-threads internal API used by the backends. */
535 This tells the suspend initiator that we completed suspend and will now be waiting for resume.
537 void mono_threads_notify_initiator_of_suspend (THREAD_INFO_TYPE* info);
539 This tells the resume initiator that we completed resume duties and will return to runnable state.
541 void mono_threads_notify_initiator_of_resume (THREAD_INFO_TYPE* info);
544 This tells the resume initiator that we completed abort duties and will return to previous state.
546 void mono_threads_notify_initiator_of_abort (THREAD_INFO_TYPE* info);
548 /* Thread state machine functions */
553 ResumeInitSelfResume,
554 ResumeInitAsyncResume,
555 ResumeInitBlockingResume,
561 SelfSuspendNotifyAndWait,
562 } MonoSelfSupendResult;
565 AsyncSuspendAlreadySuspended,
567 AsyncSuspendInitSuspend,
568 AsyncSuspendBlocking,
569 } MonoRequestAsyncSuspendResult;
572 DoBlockingContinue, //in blocking mode, continue
573 DoBlockingPollAndRetry, //async suspend raced blocking and won, pool and retry
574 } MonoDoBlockingResult;
577 DoneBlockingOk, //exited blocking fine
578 DoneBlockingWait, //thread should end suspended
579 } MonoDoneBlockingResult;
583 AbortBlockingIgnore, //Ignore
584 AbortBlockingIgnoreAndPoll, //Ignore and poll
585 AbortBlockingOk, //Abort worked
586 AbortBlockingWait, //Abort worked, but should wait for resume
587 } MonoAbortBlockingResult;
590 void mono_threads_transition_attach (THREAD_INFO_TYPE* info);
591 gboolean mono_threads_transition_detach (THREAD_INFO_TYPE *info);
592 MonoRequestAsyncSuspendResult mono_threads_transition_request_async_suspension (THREAD_INFO_TYPE *info);
593 MonoSelfSupendResult mono_threads_transition_state_poll (THREAD_INFO_TYPE *info);
594 MonoResumeResult mono_threads_transition_request_resume (THREAD_INFO_TYPE* info);
595 gboolean mono_threads_transition_finish_async_suspend (THREAD_INFO_TYPE* info);
596 MonoDoBlockingResult mono_threads_transition_do_blocking (THREAD_INFO_TYPE* info);
597 MonoDoneBlockingResult mono_threads_transition_done_blocking (THREAD_INFO_TYPE* info);
598 MonoAbortBlockingResult mono_threads_transition_abort_blocking (THREAD_INFO_TYPE* info);
600 MonoThreadUnwindState* mono_thread_info_get_suspend_state (THREAD_INFO_TYPE *info);
603 mono_threads_enter_gc_unsafe_region_cookie (void);
606 void mono_thread_info_wait_for_resume (THREAD_INFO_TYPE *info);
607 /* Advanced suspend API, used for suspending multiple threads as once. */
608 gboolean mono_thread_info_is_running (THREAD_INFO_TYPE *info);
609 gboolean mono_thread_info_is_live (THREAD_INFO_TYPE *info);
610 int mono_thread_info_suspend_count (THREAD_INFO_TYPE *info);
611 int mono_thread_info_current_state (THREAD_INFO_TYPE *info);
612 const char* mono_thread_state_name (int state);
614 gboolean mono_thread_info_in_critical_location (THREAD_INFO_TYPE *info);
615 gboolean mono_thread_info_begin_suspend (THREAD_INFO_TYPE *info);
616 gboolean mono_thread_info_begin_resume (THREAD_INFO_TYPE *info);
618 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
619 gboolean mono_threads_wait_pending_operations (void);
620 void mono_threads_begin_global_suspend (void);
621 void mono_threads_end_global_suspend (void);
624 mono_thread_info_is_current (THREAD_INFO_TYPE *info);
627 MONO_THREAD_INFO_WAIT_RET_SUCCESS_0 = 0,
628 MONO_THREAD_INFO_WAIT_RET_ALERTED = -1,
629 MONO_THREAD_INFO_WAIT_RET_TIMEOUT = -2,
630 MONO_THREAD_INFO_WAIT_RET_FAILED = -3,
631 } MonoThreadInfoWaitRet;
633 MonoThreadInfoWaitRet
634 mono_thread_info_wait_one_handle (MonoThreadHandle *handle, guint32 timeout, gboolean alertable);
636 MonoThreadInfoWaitRet
637 mono_thread_info_wait_multiple_handle (MonoThreadHandle **thread_handles, gsize nhandles, MonoOSEvent *background_change_event, gboolean waitall, guint32 timeout, gboolean alertable);
639 void mono_threads_join_lock (void);
640 void mono_threads_join_unlock (void);
642 #endif /* __MONO_THREADS_H__ */