[threads] Always use the `suspended` MonoOSEvent for self-suspend (#3915)
[mono.git] / mono / utils / mono-threads.h
1 /*
2  * mono-threads.h: Low-level threading
3  *
4  * Author:
5  *      Rodrigo Kumpera (kumpera@gmail.com)
6  *
7  * (C) 2011 Novell, Inc
8  */
9
10 #ifndef __MONO_THREADS_H__
11 #define __MONO_THREADS_H__
12
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>
18 #include <mono/utils/os-event.h>
19
20 #include <mono/io-layer/io-layer.h>
21
22 #include <glib.h>
23 #include <config.h>
24 #ifdef HOST_WIN32
25
26 #include <windows.h>
27
28 typedef DWORD MonoNativeThreadId;
29 typedef HANDLE MonoNativeThreadHandle; /* unused */
30
31 typedef DWORD mono_native_thread_return_t;
32
33 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (tid)
34 #define MONO_UINT_TO_NATIVE_THREAD_ID(tid) ((MonoNativeThreadId)(tid))
35
36 typedef LPTHREAD_START_ROUTINE MonoThreadStart;
37
38 #else
39
40 #include <pthread.h>
41
42 #if defined(__MACH__)
43 #include <mono/utils/mach-support.h>
44
45 typedef thread_port_t MonoNativeThreadHandle;
46
47 #else
48
49 #include <unistd.h>
50
51 typedef pid_t MonoNativeThreadHandle;
52
53 #endif /* defined(__MACH__) */
54
55 typedef pthread_t MonoNativeThreadId;
56
57 typedef void* mono_native_thread_return_t;
58
59 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (gsize)(tid)
60 #define MONO_UINT_TO_NATIVE_THREAD_ID(tid) (MonoNativeThreadId)(gsize)(tid)
61
62 typedef gsize (*MonoThreadStart)(gpointer);
63
64 #endif /* #ifdef HOST_WIN32 */
65
66 typedef struct {
67         guint32 ref;
68         MonoOSEvent event;
69 } MonoThreadHandle;
70
71 /*
72 THREAD_INFO_TYPE is a way to make the mono-threads module parametric - or sort of.
73 The GC using mono-threads might extend the MonoThreadInfo struct to add its own
74 data, this avoid a pointer indirection on what is on a lot of hot paths.
75
76 But extending MonoThreadInfo has de disavantage that all functions here return type
77 would require a cast, something like the following:
78
79 typedef struct {
80         MonoThreadInfo info;
81         int stuff;
82 }  MyThreadInfo;
83
84 ...
85 ((MyThreadInfo*)mono_thread_info_current ())->stuff = 1;
86
87 While porting sgen to use mono-threads, the number of casts required was too much and
88 code ended up looking horrible. So we use this cute little hack. The idea is that
89 whomever is including this header can set the expected type to be used by functions here
90 and reduce the number of casts drastically.
91
92 */
93 #ifndef THREAD_INFO_TYPE
94 #define THREAD_INFO_TYPE MonoThreadInfo
95 #endif
96
97 /* Mono Threads internal configuration knows*/
98
99 /* If this is defined, use the signals backed on Mach. Debug only as signals can't be made usable on OSX. */
100 // #define USE_SIGNALS_ON_MACH
101
102 #if defined (_POSIX_VERSION) || defined (__native_client__)
103 #if defined (__MACH__) && !defined (USE_SIGNALS_ON_MACH)
104 #define USE_MACH_BACKEND
105 #else
106 #define USE_POSIX_BACKEND
107 #endif
108 #elif HOST_WIN32
109 #define USE_WINDOWS_BACKEND
110 #else
111 #error "no backend support for current platform"
112 #endif /* defined (_POSIX_VERSION) || defined (__native_client__) */
113
114 enum {
115         STATE_STARTING                          = 0x00,
116         STATE_RUNNING                           = 0x01,
117         STATE_DETACHED                          = 0x02,
118
119         STATE_ASYNC_SUSPENDED                   = 0x03,
120         STATE_SELF_SUSPENDED                    = 0x04,
121         STATE_ASYNC_SUSPEND_REQUESTED   = 0x05,
122         STATE_SELF_SUSPEND_REQUESTED    = 0x06,
123         STATE_BLOCKING                                  = 0x07,
124         STATE_BLOCKING_AND_SUSPENDED    = 0x8,
125
126         STATE_MAX                                               = 0x08,
127
128         THREAD_STATE_MASK                       = 0x00FF,
129         THREAD_SUSPEND_COUNT_MASK       = 0xFF00,
130         THREAD_SUSPEND_COUNT_SHIFT      = 8,
131         THREAD_SUSPEND_COUNT_MAX        = 0xFF,
132
133         SELF_SUSPEND_STATE_INDEX = 0,
134         ASYNC_SUSPEND_STATE_INDEX = 1,
135 };
136
137 typedef struct _MonoThreadInfoInterruptToken MonoThreadInfoInterruptToken;
138
139 typedef struct {
140         MonoLinkedListSetNode node;
141         guint32 small_id; /*Used by hazard pointers */
142         MonoNativeThreadHandle native_handle; /* Valid on mach and android */
143         int thread_state;
144
145         /*Tells if this thread was created by the runtime or not.*/
146         gboolean runtime_thread;
147
148         /* Tells if this thread should be ignored or not by runtime services such as GC and profiling */
149         gboolean tools_thread;
150
151         /* Max stack bounds, all valid addresses must be between [stack_start_limit, stack_end[ */
152         void *stack_start_limit, *stack_end;
153
154         /* suspend machinery, fields protected by suspend_semaphore */
155         MonoSemType suspend_semaphore;
156         int suspend_count;
157
158         MonoSemType resume_semaphore;
159
160         /* only needed by the posix backend */
161 #if defined(USE_POSIX_BACKEND)
162         MonoSemType finish_resume_semaphore;
163         gboolean syscall_break_signal;
164         int signal;
165 #endif
166
167         gboolean suspend_can_continue;
168
169         /* This memory pool is used by coop GC to save stack data roots between GC unsafe regions */
170         GByteArray *stackdata;
171
172         /*In theory, only the posix backend needs this, but having it on mach/win32 simplifies things a lot.*/
173         MonoThreadUnwindState thread_saved_state [2]; //0 is self suspend, 1 is async suspend.
174
175         /*async call machinery, thread MUST be suspended before accessing those fields*/
176         void (*async_target)(void*);
177         void *user_data;
178
179         /*
180         If true, this thread is running a critical region of code and cannot be suspended.
181         A critical session is implicitly started when you call mono_thread_info_safe_suspend_sync
182         and is ended when you call either mono_thread_info_resume or mono_thread_info_finish_suspend.
183         */
184         gboolean inside_critical_region;
185
186         /*
187          * If TRUE, the thread is in async context. Code can use this information to avoid async-unsafe
188          * operations like locking without having to pass an 'async' parameter around.
189          */
190         gboolean is_async_context;
191
192         /*
193          * Values of TLS variables for this thread.
194          * This can be used to obtain the values of TLS variable for threads
195          * other than the current one.
196          */
197         gpointer tls [TLS_KEY_NUM];
198
199         /* IO layer handle for this thread */
200         /* Set when the thread is started, or in _wapi_thread_duplicate () */
201         MonoThreadHandle *handle;
202
203         void *jit_data;
204
205         MonoThreadInfoInterruptToken *interrupt_token;
206
207         /* HandleStack for coop handles */
208         gpointer handle_stack;
209
210         /* Stack mark for targets that explicitly require one */
211         gpointer stack_mark;
212 } MonoThreadInfo;
213
214 typedef struct {
215         void* (*thread_register)(THREAD_INFO_TYPE *info, void *baseaddr);
216         /*
217         This callback is called with @info still on the thread list.
218         This call is made while holding the suspend lock, so don't do callbacks.
219         SMR remains functional as its small_id has not been reclaimed.
220         */
221         void (*thread_unregister)(THREAD_INFO_TYPE *info);
222         /*
223         This callback is called right before thread_unregister. This is called
224         without any locks held so it's the place for complicated cleanup.
225
226         The thread must remain operational between this call and thread_unregister.
227         It must be possible to successfully suspend it after thread_unregister completes.
228         */
229         void (*thread_detach)(THREAD_INFO_TYPE *info);
230         void (*thread_attach)(THREAD_INFO_TYPE *info);
231         gboolean (*mono_method_is_critical) (void *method);
232         gboolean (*ip_in_critical_region) (MonoDomain *domain, gpointer ip);
233         gboolean (*mono_thread_in_critical_region) (THREAD_INFO_TYPE *info);
234 } MonoThreadInfoCallbacks;
235
236 typedef struct {
237         void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
238         gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
239         gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoThreadInfo *info);
240         void (*thread_state_init) (MonoThreadUnwindState *tctx);
241 } MonoThreadInfoRuntimeCallbacks;
242
243 //Not using 0 and 1 to ensure callbacks are not returning bad data
244 typedef enum {
245         MonoResumeThread = 0x1234,
246         KeepSuspended = 0x4321,
247 } SuspendThreadResult;
248
249 typedef SuspendThreadResult (*MonoSuspendThreadCallback) (THREAD_INFO_TYPE *info, gpointer user_data);
250
251 static inline gboolean
252 mono_threads_filter_tools_threads (THREAD_INFO_TYPE *info)
253 {
254         return !((MonoThreadInfo*)info)->tools_thread;
255 }
256
257 /*
258 Requires the world to be stoped
259 */
260 #define FOREACH_THREAD(thread) \
261         MONO_LLS_FOREACH_FILTERED (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
262
263 #define FOREACH_THREAD_END \
264         MONO_LLS_FOREACH_END
265
266 /*
267 Snapshot iteration.
268 */
269 #define FOREACH_THREAD_SAFE(thread) \
270         MONO_LLS_FOREACH_FILTERED_SAFE (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
271
272 #define FOREACH_THREAD_SAFE_END \
273         MONO_LLS_FOREACH_SAFE_END
274
275 static inline MonoNativeThreadId
276 mono_thread_info_get_tid (THREAD_INFO_TYPE *info)
277 {
278         return MONO_UINT_TO_NATIVE_THREAD_ID (((MonoThreadInfo*) info)->node.key);
279 }
280
281 static inline void
282 mono_thread_info_set_tid (THREAD_INFO_TYPE *info, MonoNativeThreadId tid)
283 {
284         ((MonoThreadInfo*) info)->node.key = (uintptr_t) MONO_NATIVE_THREAD_ID_TO_UINT (tid);
285 }
286
287 /*
288  * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
289  * a single block with info from both camps. 
290  */
291 void
292 mono_threads_init (MonoThreadInfoCallbacks *callbacks, size_t thread_info_size);
293
294 void
295 mono_threads_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks);
296
297 MonoThreadInfoRuntimeCallbacks *
298 mono_threads_get_runtime_callbacks (void);
299
300 int
301 mono_thread_info_register_small_id (void);
302
303 THREAD_INFO_TYPE *
304 mono_thread_info_attach (void *baseptr);
305
306 MONO_API void
307 mono_thread_info_detach (void);
308
309 gboolean
310 mono_thread_info_is_exiting (void);
311
312 THREAD_INFO_TYPE *
313 mono_thread_info_current (void);
314
315 THREAD_INFO_TYPE*
316 mono_thread_info_current_unchecked (void);
317
318 int
319 mono_thread_info_get_small_id (void);
320
321 MonoLinkedListSet*
322 mono_thread_info_list_head (void);
323
324 THREAD_INFO_TYPE*
325 mono_thread_info_lookup (MonoNativeThreadId id);
326
327 gboolean
328 mono_thread_info_resume (MonoNativeThreadId tid);
329
330 void
331 mono_thread_info_safe_suspend_and_run (MonoNativeThreadId id, gboolean interrupt_kernel, MonoSuspendThreadCallback callback, gpointer user_data);
332
333 void
334 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data);
335
336 void
337 mono_thread_info_suspend_lock (void);
338
339 void
340 mono_thread_info_suspend_unlock (void);
341
342 void
343 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid);
344
345 void
346 mono_thread_info_set_is_async_context (gboolean async_context);
347
348 gboolean
349 mono_thread_info_is_async_context (void);
350
351 void
352 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
353
354 MONO_API gboolean
355 mono_thread_info_yield (void);
356
357 gint
358 mono_thread_info_sleep (guint32 ms, gboolean *alerted);
359
360 gint
361 mono_thread_info_usleep (guint64 us);
362
363 gpointer
364 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
365
366 void
367 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
368
369 void
370 mono_thread_info_exit (gsize exit_code);
371
372 void
373 mono_thread_info_install_interrupt (void (*callback) (gpointer data), gpointer data, gboolean *interrupted);
374
375 void
376 mono_thread_info_uninstall_interrupt (gboolean *interrupted);
377
378 MonoThreadInfoInterruptToken*
379 mono_thread_info_prepare_interrupt (THREAD_INFO_TYPE *info);
380
381 void
382 mono_thread_info_finish_interrupt (MonoThreadInfoInterruptToken *token);
383
384 void
385 mono_thread_info_self_interrupt (void);
386
387 void
388 mono_thread_info_clear_self_interrupt (void);
389
390 gboolean
391 mono_thread_info_is_interrupt_state (THREAD_INFO_TYPE *info);
392
393 void
394 mono_thread_info_describe_interrupt_token (THREAD_INFO_TYPE *info, GString *text);
395
396 gboolean
397 mono_thread_info_is_live (THREAD_INFO_TYPE *info);
398
399 MonoThreadHandle*
400 mono_threads_create_thread (MonoThreadStart start, gpointer arg, gsize * const stack_size, MonoNativeThreadId *out_tid);
401
402 int
403 mono_threads_get_max_stack_size (void);
404
405 MonoThreadHandle*
406 mono_threads_open_thread_handle (MonoThreadHandle *handle);
407
408 void
409 mono_threads_close_thread_handle (MonoThreadHandle *handle);
410
411 MONO_API void
412 mono_threads_attach_tools_thread (void);
413
414
415 #if !defined(HOST_WIN32)
416
417 /*Use this instead of pthread_kill */
418 int
419 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum);
420
421 #endif /* !defined(HOST_WIN32) */
422
423 /* Internal API between mono-threads and its backends. */
424
425 /* Backend functions - a backend must implement all of the following */
426 /*
427 This is called very early in the runtime, it cannot access any runtime facilities.
428
429 */
430 void mono_threads_suspend_init (void); //ok
431
432 void mono_threads_suspend_init_signals (void);
433
434 void mono_threads_coop_init (void);
435
436 /*
437 This begins async suspend. This function must do the following:
438
439 -Ensure the target will EINTR any syscalls if @interrupt_kernel is true
440 -Call mono_threads_transition_finish_async_suspend as part of its async suspend.
441 -Register the thread for pending suspend with mono_threads_add_to_pending_operation_set if needed.
442
443 If begin suspend fails the thread must be left uninterrupted and resumed.
444 */
445 gboolean mono_threads_suspend_begin_async_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel);
446
447 /*
448 This verifies the outcome of an async suspend operation.
449
450 Some targets, such as posix, verify suspend results assynchronously. Suspend results must be
451 available (in a non blocking way) after mono_threads_wait_pending_operations completes.
452 */
453 gboolean mono_threads_suspend_check_suspend_result (THREAD_INFO_TYPE *info);
454
455 /*
456 This begins async resume. This function must do the following:
457
458 - Install an async target if one was requested.
459 - Notify the target to resume.
460 - Register the thread for pending ack with mono_threads_add_to_pending_operation_set if needed.
461 */
462 gboolean mono_threads_suspend_begin_async_resume (THREAD_INFO_TYPE *info);
463
464 void mono_threads_suspend_register (THREAD_INFO_TYPE *info); //ok
465 void mono_threads_suspend_free (THREAD_INFO_TYPE *info);
466 void mono_threads_suspend_abort_syscall (THREAD_INFO_TYPE *info);
467 gboolean mono_threads_suspend_needs_abort_syscall (void);
468 gint mono_threads_suspend_search_alternative_signal (void);
469 gint mono_threads_suspend_get_suspend_signal (void);
470 gint mono_threads_suspend_get_restart_signal (void);
471 gint mono_threads_suspend_get_abort_signal (void);
472
473 int mono_threads_platform_create_thread (MonoThreadStart thread_fn, gpointer thread_data, gsize* const stack_size, MonoNativeThreadId *out_tid);
474 void mono_threads_platform_get_stack_bounds (guint8 **staddr, size_t *stsize);
475 gboolean mono_threads_platform_yield (void);
476 void mono_threads_platform_exit (gsize exit_code);
477
478 void mono_threads_coop_begin_global_suspend (void);
479 void mono_threads_coop_end_global_suspend (void);
480
481 MONO_API MonoNativeThreadId
482 mono_native_thread_id_get (void);
483
484 MONO_API gboolean
485 mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2);
486
487 MONO_API gboolean
488 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg);
489
490 MONO_API void
491 mono_native_thread_set_name (MonoNativeThreadId tid, const char *name);
492
493 MONO_API gboolean
494 mono_native_thread_join (MonoNativeThreadId tid);
495
496 /*Mach specific internals */
497 void mono_threads_init_dead_letter (void);
498 void mono_threads_install_dead_letter (void);
499
500 /* mono-threads internal API used by the backends. */
501 /*
502 This tells the suspend initiator that we completed suspend and will now be waiting for resume.
503 */
504 void mono_threads_notify_initiator_of_suspend (THREAD_INFO_TYPE* info);
505 /*
506 This tells the resume initiator that we completed resume duties and will return to runnable state.
507 */
508 void mono_threads_notify_initiator_of_resume (THREAD_INFO_TYPE* info);
509
510 /*
511 This tells the resume initiator that we completed abort duties and will return to previous state.
512 */
513 void mono_threads_notify_initiator_of_abort (THREAD_INFO_TYPE* info);
514
515 /* Thread state machine functions */
516
517 typedef enum {
518         ResumeError,
519         ResumeOk,
520         ResumeInitSelfResume,
521         ResumeInitAsyncResume,
522         ResumeInitBlockingResume,
523 } MonoResumeResult;
524
525 typedef enum {
526         SelfSuspendResumed,
527         SelfSuspendWait,
528         SelfSuspendNotifyAndWait,
529 } MonoSelfSupendResult;
530
531 typedef enum {
532         AsyncSuspendAlreadySuspended,
533         AsyncSuspendWait,
534         AsyncSuspendInitSuspend,
535         AsyncSuspendBlocking,
536 } MonoRequestAsyncSuspendResult;
537
538 typedef enum {
539         DoBlockingContinue, //in blocking mode, continue
540         DoBlockingPollAndRetry, //async suspend raced blocking and won, pool and retry
541 } MonoDoBlockingResult;
542
543 typedef enum {
544         DoneBlockingOk, //exited blocking fine
545         DoneBlockingWait, //thread should end suspended
546 } MonoDoneBlockingResult;
547
548
549 typedef enum {
550         AbortBlockingIgnore, //Ignore
551         AbortBlockingIgnoreAndPoll, //Ignore and poll
552         AbortBlockingOk, //Abort worked
553         AbortBlockingWait, //Abort worked, but should wait for resume
554 } MonoAbortBlockingResult;
555
556
557 void mono_threads_transition_attach (THREAD_INFO_TYPE* info);
558 gboolean mono_threads_transition_detach (THREAD_INFO_TYPE *info);
559 MonoRequestAsyncSuspendResult mono_threads_transition_request_async_suspension (THREAD_INFO_TYPE *info);
560 MonoSelfSupendResult mono_threads_transition_state_poll (THREAD_INFO_TYPE *info);
561 MonoResumeResult mono_threads_transition_request_resume (THREAD_INFO_TYPE* info);
562 gboolean mono_threads_transition_finish_async_suspend (THREAD_INFO_TYPE* info);
563 MonoDoBlockingResult mono_threads_transition_do_blocking (THREAD_INFO_TYPE* info);
564 MonoDoneBlockingResult mono_threads_transition_done_blocking (THREAD_INFO_TYPE* info);
565 MonoAbortBlockingResult mono_threads_transition_abort_blocking (THREAD_INFO_TYPE* info);
566
567 MonoThreadUnwindState* mono_thread_info_get_suspend_state (THREAD_INFO_TYPE *info);
568
569 gpointer
570 mono_threads_enter_gc_unsafe_region_cookie (void);
571
572
573 void mono_thread_info_wait_for_resume (THREAD_INFO_TYPE *info);
574 /* Advanced suspend API, used for suspending multiple threads as once. */
575 gboolean mono_thread_info_is_running (THREAD_INFO_TYPE *info);
576 gboolean mono_thread_info_is_live (THREAD_INFO_TYPE *info);
577 int mono_thread_info_suspend_count (THREAD_INFO_TYPE *info);
578 int mono_thread_info_current_state (THREAD_INFO_TYPE *info);
579 const char* mono_thread_state_name (int state);
580
581 gboolean mono_thread_info_in_critical_location (THREAD_INFO_TYPE *info);
582 gboolean mono_thread_info_begin_suspend (THREAD_INFO_TYPE *info);
583 gboolean mono_thread_info_begin_resume (THREAD_INFO_TYPE *info);
584
585 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
586 gboolean mono_threads_wait_pending_operations (void);
587 void mono_threads_begin_global_suspend (void);
588 void mono_threads_end_global_suspend (void);
589
590 gboolean
591 mono_thread_info_is_current (THREAD_INFO_TYPE *info);
592
593 typedef enum {
594         MONO_THREAD_INFO_WAIT_RET_SUCCESS_0   =  0,
595         MONO_THREAD_INFO_WAIT_RET_ALERTED     = -1,
596         MONO_THREAD_INFO_WAIT_RET_TIMEOUT     = -2,
597         MONO_THREAD_INFO_WAIT_RET_FAILED      = -3,
598 } MonoThreadInfoWaitRet;
599
600 MonoThreadInfoWaitRet
601 mono_thread_info_wait_one_handle (MonoThreadHandle *handle, guint32 timeout, gboolean alertable);
602
603 MonoThreadInfoWaitRet
604 mono_thread_info_wait_multiple_handle (MonoThreadHandle **thread_handles, gsize nhandles, MonoOSEvent *background_change_event, gboolean waitall, guint32 timeout, gboolean alertable);
605
606 #endif /* __MONO_THREADS_H__ */