2 * mono-threads.h: Low-level threading
5 * Rodrigo Kumpera (kumpera@gmail.com)
10 #ifndef __MONO_THREADS_H__
11 #define __MONO_THREADS_H__
13 #include <mono/utils/mono-os-semaphore.h>
14 #include <mono/utils/mono-stack-unwinding.h>
15 #include <mono/utils/mono-linked-list-set.h>
16 #include <mono/utils/mono-tls.h>
17 #include <mono/utils/mono-coop-semaphore.h>
19 #include <mono/io-layer/io-layer.h>
27 typedef DWORD MonoNativeThreadId;
28 typedef HANDLE MonoNativeThreadHandle; /* unused */
30 typedef DWORD mono_native_thread_return_t;
32 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (tid)
33 #define MONO_UINT_TO_NATIVE_THREAD_ID(tid) ((MonoNativeThreadId)(tid))
35 typedef LPTHREAD_START_ROUTINE MonoThreadStart;
42 #include <mono/utils/mach-support.h>
44 typedef thread_port_t MonoNativeThreadHandle;
50 typedef pid_t MonoNativeThreadHandle;
52 #endif /* defined(__MACH__) */
54 typedef pthread_t MonoNativeThreadId;
56 typedef void* mono_native_thread_return_t;
58 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (gsize)(tid)
59 #define MONO_UINT_TO_NATIVE_THREAD_ID(tid) (MonoNativeThreadId)(gsize)(tid)
61 typedef gsize (*MonoThreadStart)(gpointer);
63 #endif /* #ifdef HOST_WIN32 */
66 THREAD_INFO_TYPE is a way to make the mono-threads module parametric - or sort of.
67 The GC using mono-threads might extend the MonoThreadInfo struct to add its own
68 data, this avoid a pointer indirection on what is on a lot of hot paths.
70 But extending MonoThreadInfo has de disavantage that all functions here return type
71 would require a cast, something like the following:
79 ((MyThreadInfo*)mono_thread_info_current ())->stuff = 1;
81 While porting sgen to use mono-threads, the number of casts required was too much and
82 code ended up looking horrible. So we use this cute little hack. The idea is that
83 whomever is including this header can set the expected type to be used by functions here
84 and reduce the number of casts drastically.
87 #ifndef THREAD_INFO_TYPE
88 #define THREAD_INFO_TYPE MonoThreadInfo
91 /* Mono Threads internal configuration knows*/
93 /* Logging - enable them below if you need specific logging for the category you need */
94 #define MOSTLY_ASYNC_SAFE_PRINTF(...) do { \
95 char __buff[1024]; __buff [0] = '\0'; \
96 g_snprintf (__buff, sizeof (__buff), __VA_ARGS__); \
97 write (1, __buff, strlen (__buff)); \
102 #define THREADS_DEBUG(...)
104 #define THREADS_DEBUG MOSTLY_ASYNC_SAFE_PRINTF
108 #define THREADS_STW_DEBUG(...)
110 #define THREADS_STW_DEBUG MOSTLY_ASYNC_SAFE_PRINTF
114 #define THREADS_SUSPEND_DEBUG(...)
116 #define THREADS_SUSPEND_DEBUG MOSTLY_ASYNC_SAFE_PRINTF
120 #define THREADS_STATE_MACHINE_DEBUG(...)
122 #define THREADS_STATE_MACHINE_DEBUG MOSTLY_ASYNC_SAFE_PRINTF
126 #define THREADS_INTERRUPT_DEBUG(...)
128 #define THREADS_INTERRUPT_DEBUG MOSTLY_ASYNC_SAFE_PRINTF
131 /* If this is defined, use the signals backed on Mach. Debug only as signals can't be made usable on OSX. */
132 // #define USE_SIGNALS_ON_MACH
134 #if defined (_POSIX_VERSION) || defined (__native_client__)
135 #if defined (__MACH__) && !defined (USE_SIGNALS_ON_MACH)
136 #define USE_MACH_BACKEND
138 #define USE_POSIX_BACKEND
141 #define USE_WINDOWS_BACKEND
143 #error "no backend support for current platform"
144 #endif /* defined (_POSIX_VERSION) || defined (__native_client__) */
147 STATE_STARTING = 0x00,
148 STATE_RUNNING = 0x01,
149 STATE_DETACHED = 0x02,
151 STATE_ASYNC_SUSPENDED = 0x03,
152 STATE_SELF_SUSPENDED = 0x04,
153 STATE_ASYNC_SUSPEND_REQUESTED = 0x05,
154 STATE_SELF_SUSPEND_REQUESTED = 0x06,
155 STATE_BLOCKING = 0x07,
156 STATE_BLOCKING_AND_SUSPENDED = 0x8,
160 THREAD_STATE_MASK = 0x00FF,
161 THREAD_SUSPEND_COUNT_MASK = 0xFF00,
162 THREAD_SUSPEND_COUNT_SHIFT = 8,
163 THREAD_SUSPEND_COUNT_MAX = 0xFF,
165 SELF_SUSPEND_STATE_INDEX = 0,
166 ASYNC_SUSPEND_STATE_INDEX = 1,
169 typedef struct _MonoThreadInfoInterruptToken MonoThreadInfoInterruptToken;
172 MonoLinkedListSetNode node;
173 guint32 small_id; /*Used by hazard pointers */
174 MonoNativeThreadHandle native_handle; /* Valid on mach and android */
177 /*Tells if this thread was created by the runtime or not.*/
178 gboolean runtime_thread;
180 /* Tells if this thread should be ignored or not by runtime services such as GC and profiling */
181 gboolean tools_thread;
183 /* Max stack bounds, all valid addresses must be between [stack_start_limit, stack_end[ */
184 void *stack_start_limit, *stack_end;
186 /* suspend machinery, fields protected by suspend_semaphore */
187 MonoSemType suspend_semaphore;
190 MonoSemType resume_semaphore;
192 /* only needed by the posix backend */
193 #if defined(USE_POSIX_BACKEND)
194 MonoSemType finish_resume_semaphore;
195 gboolean syscall_break_signal;
199 gboolean suspend_can_continue;
201 /* This memory pool is used by coop GC to save stack data roots between GC unsafe regions */
202 GByteArray *stackdata;
204 /*In theory, only the posix backend needs this, but having it on mach/win32 simplifies things a lot.*/
205 MonoThreadUnwindState thread_saved_state [2]; //0 is self suspend, 1 is async suspend.
207 /*async call machinery, thread MUST be suspended before accessing those fields*/
208 void (*async_target)(void*);
212 If true, this thread is running a critical region of code and cannot be suspended.
213 A critical session is implicitly started when you call mono_thread_info_safe_suspend_sync
214 and is ended when you call either mono_thread_info_resume or mono_thread_info_finish_suspend.
216 gboolean inside_critical_region;
219 * If TRUE, the thread is in async context. Code can use this information to avoid async-unsafe
220 * operations like locking without having to pass an 'async' parameter around.
222 gboolean is_async_context;
224 gboolean create_suspended;
226 /* Semaphore used to implement CREATE_SUSPENDED */
227 MonoCoopSem create_suspended_sem;
230 * Values of TLS variables for this thread.
231 * This can be used to obtain the values of TLS variable for threads
232 * other than the current one.
234 gpointer tls [TLS_KEY_NUM];
236 /* IO layer handle for this thread */
237 /* Set when the thread is started, or in _wapi_thread_duplicate () */
242 MonoThreadInfoInterruptToken *interrupt_token;
244 /* HandleStack for coop handles */
245 gpointer handle_stack;
247 /* Stack mark for targets that explicitly require one */
250 #if defined(_POSIX_VERSION) || defined(__native_client__)
251 /* This is the data that was stored in the w32 handle */
252 GPtrArray *owned_mutexes;
258 void* (*thread_register)(THREAD_INFO_TYPE *info, void *baseaddr);
260 This callback is called with @info still on the thread list.
261 This call is made while holding the suspend lock, so don't do callbacks.
262 SMR remains functional as its small_id has not been reclaimed.
264 void (*thread_unregister)(THREAD_INFO_TYPE *info);
266 This callback is called right before thread_unregister. This is called
267 without any locks held so it's the place for complicated cleanup.
269 The thread must remain operational between this call and thread_unregister.
270 It must be possible to successfully suspend it after thread_unregister completes.
272 void (*thread_detach)(THREAD_INFO_TYPE *info);
273 void (*thread_attach)(THREAD_INFO_TYPE *info);
274 gboolean (*mono_method_is_critical) (void *method);
275 gboolean (*mono_thread_in_critical_region) (THREAD_INFO_TYPE *info);
276 } MonoThreadInfoCallbacks;
279 void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
280 gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
281 gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoThreadInfo *info);
282 void (*thread_state_init) (MonoThreadUnwindState *tctx);
283 } MonoThreadInfoRuntimeCallbacks;
285 //Not using 0 and 1 to ensure callbacks are not returning bad data
287 MonoResumeThread = 0x1234,
288 KeepSuspended = 0x4321,
289 } SuspendThreadResult;
291 typedef SuspendThreadResult (*MonoSuspendThreadCallback) (THREAD_INFO_TYPE *info, gpointer user_data);
294 * Parameters to pass for thread creation
298 guint32 creation_flags;
303 MONO_THREAD_PRIORITY_LOWEST = 0,
304 MONO_THREAD_PRIORITY_BELOW_NORMAL = 1,
305 MONO_THREAD_PRIORITY_NORMAL = 2,
306 MONO_THREAD_PRIORITY_ABOVE_NORMAL = 3,
307 MONO_THREAD_PRIORITY_HIGHEST = 4,
308 } MonoThreadPriority;
310 static inline gboolean
311 mono_threads_filter_tools_threads (THREAD_INFO_TYPE *info)
313 return !((MonoThreadInfo*)info)->tools_thread;
317 Requires the world to be stoped
319 #define FOREACH_THREAD(thread) \
320 MONO_LLS_FOREACH_FILTERED (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
322 #define FOREACH_THREAD_END \
328 #define FOREACH_THREAD_SAFE(thread) \
329 MONO_LLS_FOREACH_FILTERED_SAFE (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
331 #define FOREACH_THREAD_SAFE_END \
332 MONO_LLS_FOREACH_SAFE_END
334 static inline MonoNativeThreadId
335 mono_thread_info_get_tid (THREAD_INFO_TYPE *info)
337 return MONO_UINT_TO_NATIVE_THREAD_ID (((MonoThreadInfo*) info)->node.key);
341 mono_thread_info_set_tid (THREAD_INFO_TYPE *info, MonoNativeThreadId tid)
343 ((MonoThreadInfo*) info)->node.key = (uintptr_t) MONO_NATIVE_THREAD_ID_TO_UINT (tid);
347 * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
348 * a single block with info from both camps.
351 mono_threads_init (MonoThreadInfoCallbacks *callbacks, size_t thread_info_size);
354 mono_threads_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks);
356 MonoThreadInfoRuntimeCallbacks *
357 mono_threads_get_runtime_callbacks (void);
360 mono_thread_info_register_small_id (void);
363 mono_thread_info_attach (void *baseptr);
366 mono_thread_info_detach (void);
369 mono_thread_info_is_exiting (void);
372 mono_thread_info_current (void);
375 mono_thread_info_current_unchecked (void);
378 mono_thread_info_get_small_id (void);
381 mono_thread_info_list_head (void);
384 mono_thread_info_lookup (MonoNativeThreadId id);
387 mono_thread_info_resume (MonoNativeThreadId tid);
390 mono_thread_info_safe_suspend_and_run (MonoNativeThreadId id, gboolean interrupt_kernel, MonoSuspendThreadCallback callback, gpointer user_data);
392 //XXX new API, fix the world
394 mono_thread_info_begin_self_suspend (void);
397 mono_thread_info_end_self_suspend (void);
402 mono_thread_info_unified_management_enabled (void);
405 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data);
408 mono_thread_info_suspend_lock (void);
411 mono_thread_info_suspend_unlock (void);
414 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid);
417 mono_thread_info_set_is_async_context (gboolean async_context);
420 mono_thread_info_is_async_context (void);
423 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
426 mono_thread_info_yield (void);
429 mono_thread_info_sleep (guint32 ms, gboolean *alerted);
432 mono_thread_info_usleep (guint64 us);
435 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
438 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
441 mono_thread_info_exit (void);
444 mono_thread_info_set_exited (THREAD_INFO_TYPE *info);
447 mono_thread_info_install_interrupt (void (*callback) (gpointer data), gpointer data, gboolean *interrupted);
450 mono_thread_info_uninstall_interrupt (gboolean *interrupted);
452 MonoThreadInfoInterruptToken*
453 mono_thread_info_prepare_interrupt (THREAD_INFO_TYPE *info);
456 mono_thread_info_finish_interrupt (MonoThreadInfoInterruptToken *token);
459 mono_thread_info_self_interrupt (void);
462 mono_thread_info_clear_self_interrupt (void);
465 mono_thread_info_is_interrupt_state (THREAD_INFO_TYPE *info);
468 mono_thread_info_describe_interrupt_token (THREAD_INFO_TYPE *info, GString *text);
471 mono_thread_info_is_live (THREAD_INFO_TYPE *info);
474 mono_threads_create_thread (MonoThreadStart start, gpointer arg, MonoThreadParm *tp, MonoNativeThreadId *out_tid);
477 mono_threads_get_max_stack_size (void);
480 mono_threads_open_thread_handle (HANDLE handle, MonoNativeThreadId tid);
483 mono_threads_close_thread_handle (HANDLE handle);
486 mono_threads_attach_tools_thread (void);
489 #if !defined(HOST_WIN32)
491 /*Use this instead of pthread_kill */
493 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum);
495 #endif /* !defined(HOST_WIN32) */
497 /* Internal API between mono-threads and its backends. */
499 /* Backend functions - a backend must implement all of the following */
501 This is called very early in the runtime, it cannot access any runtime facilities.
504 void mono_threads_suspend_init (void); //ok
506 void mono_threads_platform_init (void);
508 void mono_threads_coop_init (void);
510 void mono_threads_abort_syscall_init (void);
513 This begins async suspend. This function must do the following:
515 -Ensure the target will EINTR any syscalls if @interrupt_kernel is true
516 -Call mono_threads_transition_finish_async_suspend as part of its async suspend.
517 -Register the thread for pending suspend with mono_threads_add_to_pending_operation_set if needed.
519 If begin suspend fails the thread must be left uninterrupted and resumed.
521 gboolean mono_threads_suspend_begin_async_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel);
524 This verifies the outcome of an async suspend operation.
526 Some targets, such as posix, verify suspend results assynchronously. Suspend results must be
527 available (in a non blocking way) after mono_threads_wait_pending_operations completes.
529 gboolean mono_threads_suspend_check_suspend_result (THREAD_INFO_TYPE *info);
532 This begins async resume. This function must do the following:
534 - Install an async target if one was requested.
535 - Notify the target to resume.
536 - Register the thread for pending ack with mono_threads_add_to_pending_operation_set if needed.
538 gboolean mono_threads_suspend_begin_async_resume (THREAD_INFO_TYPE *info);
540 void mono_threads_suspend_register (THREAD_INFO_TYPE *info); //ok
541 void mono_threads_suspend_free (THREAD_INFO_TYPE *info);
542 void mono_threads_suspend_abort_syscall (THREAD_INFO_TYPE *info);
543 gboolean mono_threads_suspend_needs_abort_syscall (void);
545 void mono_threads_platform_register (THREAD_INFO_TYPE *info);
546 void mono_threads_platform_unregister (THREAD_INFO_TYPE *info);
547 int mono_threads_platform_create_thread (MonoThreadStart thread_fn, gpointer thread_data, gsize stack_size, MonoNativeThreadId *out_tid);
548 void mono_threads_platform_get_stack_bounds (guint8 **staddr, size_t *stsize);
549 gboolean mono_threads_platform_yield (void);
550 void mono_threads_platform_exit (int exit_code);
551 HANDLE mono_threads_platform_open_thread_handle (HANDLE handle, MonoNativeThreadId tid);
552 void mono_threads_platform_close_thread_handle (HANDLE handle);
553 void mono_threads_platform_set_exited (THREAD_INFO_TYPE *info);
554 void mono_threads_platform_describe (THREAD_INFO_TYPE *info, GString *text);
555 void mono_threads_platform_own_mutex (THREAD_INFO_TYPE *info, gpointer mutex_handle);
556 void mono_threads_platform_disown_mutex (THREAD_INFO_TYPE *info, gpointer mutex_handle);
557 MonoThreadPriority mono_threads_platform_get_priority (THREAD_INFO_TYPE *info);
558 gboolean mono_threads_platform_set_priority (THREAD_INFO_TYPE *info, MonoThreadPriority priority);
560 void mono_threads_coop_begin_global_suspend (void);
561 void mono_threads_coop_end_global_suspend (void);
563 MONO_API MonoNativeThreadId
564 mono_native_thread_id_get (void);
567 mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2);
570 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg);
573 mono_native_thread_set_name (MonoNativeThreadId tid, const char *name);
575 /*Mach specific internals */
576 void mono_threads_init_dead_letter (void);
577 void mono_threads_install_dead_letter (void);
579 /* mono-threads internal API used by the backends. */
581 This tells the suspend initiator that we completed suspend and will now be waiting for resume.
583 void mono_threads_notify_initiator_of_suspend (THREAD_INFO_TYPE* info);
585 This tells the resume initiator that we completed resume duties and will return to runnable state.
587 void mono_threads_notify_initiator_of_resume (THREAD_INFO_TYPE* info);
590 This tells the resume initiator that we completed abort duties and will return to previous state.
592 void mono_threads_notify_initiator_of_abort (THREAD_INFO_TYPE* info);
594 /* Thread state machine functions */
599 ResumeInitSelfResume,
600 ResumeInitAsyncResume,
601 ResumeInitBlockingResume,
607 SelfSuspendNotifyAndWait,
608 } MonoSelfSupendResult;
611 AsyncSuspendAlreadySuspended,
613 AsyncSuspendInitSuspend,
614 AsyncSuspendBlocking,
615 } MonoRequestAsyncSuspendResult;
618 DoBlockingContinue, //in blocking mode, continue
619 DoBlockingPollAndRetry, //async suspend raced blocking and won, pool and retry
620 } MonoDoBlockingResult;
623 DoneBlockingOk, //exited blocking fine
624 DoneBlockingWait, //thread should end suspended
625 } MonoDoneBlockingResult;
629 AbortBlockingIgnore, //Ignore
630 AbortBlockingIgnoreAndPoll, //Ignore and poll
631 AbortBlockingOk, //Abort worked
632 AbortBlockingWait, //Abort worked, but should wait for resume
633 } MonoAbortBlockingResult;
636 void mono_threads_transition_attach (THREAD_INFO_TYPE* info);
637 gboolean mono_threads_transition_detach (THREAD_INFO_TYPE *info);
638 void mono_threads_transition_request_self_suspension (THREAD_INFO_TYPE *info);
639 MonoRequestAsyncSuspendResult mono_threads_transition_request_async_suspension (THREAD_INFO_TYPE *info);
640 MonoSelfSupendResult mono_threads_transition_state_poll (THREAD_INFO_TYPE *info);
641 MonoResumeResult mono_threads_transition_request_resume (THREAD_INFO_TYPE* info);
642 gboolean mono_threads_transition_finish_async_suspend (THREAD_INFO_TYPE* info);
643 MonoDoBlockingResult mono_threads_transition_do_blocking (THREAD_INFO_TYPE* info);
644 MonoDoneBlockingResult mono_threads_transition_done_blocking (THREAD_INFO_TYPE* info);
645 MonoAbortBlockingResult mono_threads_transition_abort_blocking (THREAD_INFO_TYPE* info);
647 MonoThreadUnwindState* mono_thread_info_get_suspend_state (THREAD_INFO_TYPE *info);
650 mono_threads_enter_gc_unsafe_region_cookie (void);
653 void mono_thread_info_wait_for_resume (THREAD_INFO_TYPE *info);
654 /* Advanced suspend API, used for suspending multiple threads as once. */
655 gboolean mono_thread_info_is_running (THREAD_INFO_TYPE *info);
656 gboolean mono_thread_info_is_live (THREAD_INFO_TYPE *info);
657 int mono_thread_info_suspend_count (THREAD_INFO_TYPE *info);
658 int mono_thread_info_current_state (THREAD_INFO_TYPE *info);
659 const char* mono_thread_state_name (int state);
661 gboolean mono_thread_info_in_critical_location (THREAD_INFO_TYPE *info);
662 gboolean mono_thread_info_begin_suspend (THREAD_INFO_TYPE *info);
663 gboolean mono_thread_info_begin_resume (THREAD_INFO_TYPE *info);
665 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
666 gboolean mono_threads_wait_pending_operations (void);
667 void mono_threads_begin_global_suspend (void);
668 void mono_threads_end_global_suspend (void);
671 mono_thread_info_is_current (THREAD_INFO_TYPE *info);
674 mono_thread_info_get_handle (THREAD_INFO_TYPE *info);
677 mono_thread_info_describe (THREAD_INFO_TYPE *info, GString *text);
680 mono_thread_info_own_mutex (THREAD_INFO_TYPE *info, gpointer mutex_handle);
683 mono_thread_info_disown_mutex (THREAD_INFO_TYPE *info, gpointer mutex_handle);
686 mono_thread_info_get_priority (THREAD_INFO_TYPE *info);
689 mono_thread_info_set_priority (THREAD_INFO_TYPE *info, MonoThreadPriority priority);
691 #endif /* __MONO_THREADS_H__ */