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 */
225 void* (*thread_register)(THREAD_INFO_TYPE *info, void *baseaddr);
227 This callback is called with @info still on the thread list.
228 This call is made while holding the suspend lock, so don't do callbacks.
229 SMR remains functional as its small_id has not been reclaimed.
231 void (*thread_unregister)(THREAD_INFO_TYPE *info);
233 This callback is called right before thread_unregister. This is called
234 without any locks held so it's the place for complicated cleanup.
236 The thread must remain operational between this call and thread_unregister.
237 It must be possible to successfully suspend it after thread_unregister completes.
239 void (*thread_detach)(THREAD_INFO_TYPE *info);
240 void (*thread_attach)(THREAD_INFO_TYPE *info);
241 gboolean (*mono_method_is_critical) (void *method);
242 gboolean (*ip_in_critical_region) (MonoDomain *domain, gpointer ip);
243 gboolean (*mono_thread_in_critical_region) (THREAD_INFO_TYPE *info);
244 } MonoThreadInfoCallbacks;
247 void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
248 gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
249 gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoThreadInfo *info);
250 void (*thread_state_init) (MonoThreadUnwindState *tctx);
251 } MonoThreadInfoRuntimeCallbacks;
253 //Not using 0 and 1 to ensure callbacks are not returning bad data
255 MonoResumeThread = 0x1234,
256 KeepSuspended = 0x4321,
257 } SuspendThreadResult;
259 typedef SuspendThreadResult (*MonoSuspendThreadCallback) (THREAD_INFO_TYPE *info, gpointer user_data);
261 static inline gboolean
262 mono_threads_filter_tools_threads (THREAD_INFO_TYPE *info)
264 return !((MonoThreadInfo*)info)->tools_thread;
268 Requires the world to be stoped
270 #define FOREACH_THREAD(thread) \
271 MONO_LLS_FOREACH_FILTERED (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
273 #define FOREACH_THREAD_END \
279 #define FOREACH_THREAD_SAFE(thread) \
280 MONO_LLS_FOREACH_FILTERED_SAFE (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
282 #define FOREACH_THREAD_SAFE_END \
283 MONO_LLS_FOREACH_SAFE_END
285 static inline MonoNativeThreadId
286 mono_thread_info_get_tid (THREAD_INFO_TYPE *info)
288 return MONO_UINT_TO_NATIVE_THREAD_ID (((MonoThreadInfo*) info)->node.key);
292 mono_thread_info_set_tid (THREAD_INFO_TYPE *info, MonoNativeThreadId tid)
294 ((MonoThreadInfo*) info)->node.key = (uintptr_t) MONO_NATIVE_THREAD_ID_TO_UINT (tid);
298 * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
299 * a single block with info from both camps.
302 mono_threads_init (MonoThreadInfoCallbacks *callbacks, size_t thread_info_size);
305 mono_threads_signals_init (void);
308 mono_threads_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks);
310 MonoThreadInfoRuntimeCallbacks *
311 mono_threads_get_runtime_callbacks (void);
314 mono_thread_info_register_small_id (void);
317 mono_thread_info_attach (void *baseptr);
320 mono_thread_info_detach (void);
323 mono_thread_info_is_exiting (void);
326 mono_thread_info_current (void);
329 mono_thread_info_current_unchecked (void);
332 mono_thread_info_get_small_id (void);
335 mono_thread_info_list_head (void);
338 mono_thread_info_lookup (MonoNativeThreadId id);
341 mono_thread_info_resume (MonoNativeThreadId tid);
344 mono_thread_info_safe_suspend_and_run (MonoNativeThreadId id, gboolean interrupt_kernel, MonoSuspendThreadCallback callback, gpointer user_data);
347 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data);
350 mono_thread_info_suspend_lock (void);
353 mono_thread_info_suspend_unlock (void);
356 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid);
359 mono_thread_info_set_is_async_context (gboolean async_context);
362 mono_thread_info_is_async_context (void);
365 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
368 mono_thread_info_yield (void);
371 mono_thread_info_sleep (guint32 ms, gboolean *alerted);
374 mono_thread_info_usleep (guint64 us);
377 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
380 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
383 mono_thread_info_exit (gsize exit_code);
386 mono_thread_info_install_interrupt (void (*callback) (gpointer data), gpointer data, gboolean *interrupted);
389 mono_thread_info_uninstall_interrupt (gboolean *interrupted);
391 MonoThreadInfoInterruptToken*
392 mono_thread_info_prepare_interrupt (THREAD_INFO_TYPE *info);
395 mono_thread_info_finish_interrupt (MonoThreadInfoInterruptToken *token);
398 mono_thread_info_self_interrupt (void);
401 mono_thread_info_clear_self_interrupt (void);
404 mono_thread_info_is_interrupt_state (THREAD_INFO_TYPE *info);
407 mono_thread_info_describe_interrupt_token (THREAD_INFO_TYPE *info, GString *text);
410 mono_thread_info_is_live (THREAD_INFO_TYPE *info);
413 mono_threads_get_max_stack_size (void);
416 mono_threads_open_thread_handle (MonoThreadHandle *handle);
419 mono_threads_close_thread_handle (MonoThreadHandle *handle);
422 mono_threads_attach_tools_thread (void);
425 #if !defined(HOST_WIN32)
427 /*Use this instead of pthread_kill */
429 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum);
431 #endif /* !defined(HOST_WIN32) */
433 /* Internal API between mono-threads and its backends. */
435 /* Backend functions - a backend must implement all of the following */
437 This is called very early in the runtime, it cannot access any runtime facilities.
440 void mono_threads_suspend_init (void); //ok
442 void mono_threads_suspend_init_signals (void);
444 void mono_threads_coop_init (void);
447 This begins async suspend. This function must do the following:
449 -Ensure the target will EINTR any syscalls if @interrupt_kernel is true
450 -Call mono_threads_transition_finish_async_suspend as part of its async suspend.
451 -Register the thread for pending suspend with mono_threads_add_to_pending_operation_set if needed.
453 If begin suspend fails the thread must be left uninterrupted and resumed.
455 gboolean mono_threads_suspend_begin_async_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel);
458 This verifies the outcome of an async suspend operation.
460 Some targets, such as posix, verify suspend results assynchronously. Suspend results must be
461 available (in a non blocking way) after mono_threads_wait_pending_operations completes.
463 gboolean mono_threads_suspend_check_suspend_result (THREAD_INFO_TYPE *info);
466 This begins async resume. This function must do the following:
468 - Install an async target if one was requested.
469 - Notify the target to resume.
470 - Register the thread for pending ack with mono_threads_add_to_pending_operation_set if needed.
472 gboolean mono_threads_suspend_begin_async_resume (THREAD_INFO_TYPE *info);
474 void mono_threads_suspend_register (THREAD_INFO_TYPE *info); //ok
475 void mono_threads_suspend_free (THREAD_INFO_TYPE *info);
476 void mono_threads_suspend_abort_syscall (THREAD_INFO_TYPE *info);
477 gint mono_threads_suspend_search_alternative_signal (void);
478 gint mono_threads_suspend_get_suspend_signal (void);
479 gint mono_threads_suspend_get_restart_signal (void);
480 gint mono_threads_suspend_get_abort_signal (void);
483 mono_thread_platform_create_thread (MonoThreadStart thread_fn, gpointer thread_data,
484 gsize* const stack_size, MonoNativeThreadId *tid);
486 void mono_threads_platform_get_stack_bounds (guint8 **staddr, size_t *stsize);
487 void mono_threads_platform_init (void);
488 gboolean mono_threads_platform_in_critical_region (MonoNativeThreadId tid);
489 gboolean mono_threads_platform_yield (void);
490 void mono_threads_platform_exit (gsize exit_code);
492 void mono_threads_coop_begin_global_suspend (void);
493 void mono_threads_coop_end_global_suspend (void);
495 MONO_API MonoNativeThreadId
496 mono_native_thread_id_get (void);
499 mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2);
502 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg);
505 mono_native_thread_set_name (MonoNativeThreadId tid, const char *name);
508 mono_native_thread_join (MonoNativeThreadId tid);
510 /*Mach specific internals */
511 void mono_threads_init_dead_letter (void);
512 void mono_threads_install_dead_letter (void);
514 /* mono-threads internal API used by the backends. */
516 This tells the suspend initiator that we completed suspend and will now be waiting for resume.
518 void mono_threads_notify_initiator_of_suspend (THREAD_INFO_TYPE* info);
520 This tells the resume initiator that we completed resume duties and will return to runnable state.
522 void mono_threads_notify_initiator_of_resume (THREAD_INFO_TYPE* info);
525 This tells the resume initiator that we completed abort duties and will return to previous state.
527 void mono_threads_notify_initiator_of_abort (THREAD_INFO_TYPE* info);
529 /* Thread state machine functions */
534 ResumeInitSelfResume,
535 ResumeInitAsyncResume,
536 ResumeInitBlockingResume,
542 SelfSuspendNotifyAndWait,
543 } MonoSelfSupendResult;
546 AsyncSuspendAlreadySuspended,
548 AsyncSuspendInitSuspend,
549 AsyncSuspendBlocking,
550 } MonoRequestAsyncSuspendResult;
553 DoBlockingContinue, //in blocking mode, continue
554 DoBlockingPollAndRetry, //async suspend raced blocking and won, pool and retry
555 } MonoDoBlockingResult;
558 DoneBlockingOk, //exited blocking fine
559 DoneBlockingWait, //thread should end suspended
560 } MonoDoneBlockingResult;
564 AbortBlockingIgnore, //Ignore
565 AbortBlockingIgnoreAndPoll, //Ignore and poll
566 AbortBlockingOk, //Abort worked
567 AbortBlockingWait, //Abort worked, but should wait for resume
568 } MonoAbortBlockingResult;
571 void mono_threads_transition_attach (THREAD_INFO_TYPE* info);
572 gboolean mono_threads_transition_detach (THREAD_INFO_TYPE *info);
573 MonoRequestAsyncSuspendResult mono_threads_transition_request_async_suspension (THREAD_INFO_TYPE *info);
574 MonoSelfSupendResult mono_threads_transition_state_poll (THREAD_INFO_TYPE *info);
575 MonoResumeResult mono_threads_transition_request_resume (THREAD_INFO_TYPE* info);
576 gboolean mono_threads_transition_finish_async_suspend (THREAD_INFO_TYPE* info);
577 MonoDoBlockingResult mono_threads_transition_do_blocking (THREAD_INFO_TYPE* info);
578 MonoDoneBlockingResult mono_threads_transition_done_blocking (THREAD_INFO_TYPE* info);
579 MonoAbortBlockingResult mono_threads_transition_abort_blocking (THREAD_INFO_TYPE* info);
581 MonoThreadUnwindState* mono_thread_info_get_suspend_state (THREAD_INFO_TYPE *info);
584 mono_threads_enter_gc_unsafe_region_cookie (void);
587 void mono_thread_info_wait_for_resume (THREAD_INFO_TYPE *info);
588 /* Advanced suspend API, used for suspending multiple threads as once. */
589 gboolean mono_thread_info_is_running (THREAD_INFO_TYPE *info);
590 gboolean mono_thread_info_is_live (THREAD_INFO_TYPE *info);
591 int mono_thread_info_suspend_count (THREAD_INFO_TYPE *info);
592 int mono_thread_info_current_state (THREAD_INFO_TYPE *info);
593 const char* mono_thread_state_name (int state);
595 gboolean mono_thread_info_in_critical_location (THREAD_INFO_TYPE *info);
596 gboolean mono_thread_info_begin_suspend (THREAD_INFO_TYPE *info);
597 gboolean mono_thread_info_begin_resume (THREAD_INFO_TYPE *info);
599 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
600 gboolean mono_threads_wait_pending_operations (void);
601 void mono_threads_begin_global_suspend (void);
602 void mono_threads_end_global_suspend (void);
605 mono_thread_info_is_current (THREAD_INFO_TYPE *info);
608 MONO_THREAD_INFO_WAIT_RET_SUCCESS_0 = 0,
609 MONO_THREAD_INFO_WAIT_RET_ALERTED = -1,
610 MONO_THREAD_INFO_WAIT_RET_TIMEOUT = -2,
611 MONO_THREAD_INFO_WAIT_RET_FAILED = -3,
612 } MonoThreadInfoWaitRet;
614 MonoThreadInfoWaitRet
615 mono_thread_info_wait_one_handle (MonoThreadHandle *handle, guint32 timeout, gboolean alertable);
617 MonoThreadInfoWaitRet
618 mono_thread_info_wait_multiple_handle (MonoThreadHandle **thread_handles, gsize nhandles, MonoOSEvent *background_change_event, gboolean waitall, guint32 timeout, gboolean alertable);
620 void mono_threads_join_lock (void);
621 void mono_threads_join_unlock (void);
623 #endif /* __MONO_THREADS_H__ */