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