[runtime] Remove all NACL support. It was unmaintained for a long time. (#4955)
[mono.git] / mono / utils / mono-threads.h
1 /**
2  * \file
3  * Low-level threading
4  *
5  * Author:
6  *      Rodrigo Kumpera (kumpera@gmail.com)
7  *
8  * (C) 2011 Novell, Inc
9  */
10
11 #ifndef __MONO_THREADS_H__
12 #define __MONO_THREADS_H__
13
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>
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 typedef DWORD mono_thread_start_return_t;
33
34 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (tid)
35 #define MONO_UINT_TO_NATIVE_THREAD_ID(tid) ((MonoNativeThreadId)(tid))
36
37 typedef LPTHREAD_START_ROUTINE MonoThreadStart;
38
39 #else
40
41 #include <pthread.h>
42
43 #if defined(__MACH__)
44 #include <mono/utils/mach-support.h>
45
46 typedef thread_port_t MonoNativeThreadHandle;
47
48 #else
49
50 #include <unistd.h>
51
52 typedef pid_t MonoNativeThreadHandle;
53
54 #endif /* defined(__MACH__) */
55
56 typedef pthread_t MonoNativeThreadId;
57
58 typedef void* mono_native_thread_return_t;
59 typedef gsize mono_thread_start_return_t;
60
61 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (gsize)(tid)
62 #define MONO_UINT_TO_NATIVE_THREAD_ID(tid) (MonoNativeThreadId)(gsize)(tid)
63
64 typedef gsize (*MonoThreadStart)(gpointer);
65
66 #if !defined(__HAIKU__)
67 #define MONO_THREADS_PLATFORM_HAS_ATTR_SETSCHED
68 #endif /* !defined(__HAIKU__) */
69
70 #endif /* #ifdef HOST_WIN32 */
71
72 #ifndef MONO_INFINITE_WAIT
73 #define MONO_INFINITE_WAIT ((guint32) 0xFFFFFFFF)
74 #endif
75
76 typedef struct {
77         MonoRefCount ref;
78         MonoOSEvent event;
79 } MonoThreadHandle;
80
81 /*
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.
85
86 But extending MonoThreadInfo has de disavantage that all functions here return type
87 would require a cast, something like the following:
88
89 typedef struct {
90         MonoThreadInfo info;
91         int stuff;
92 }  MyThreadInfo;
93
94 ...
95 ((MyThreadInfo*)mono_thread_info_current ())->stuff = 1;
96
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.
101
102 */
103 #ifndef THREAD_INFO_TYPE
104 #define THREAD_INFO_TYPE MonoThreadInfo
105 #endif
106
107 /* Mono Threads internal configuration knows*/
108
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
111
112 #if defined (_POSIX_VERSION)
113 #if defined (__MACH__) && !defined (USE_SIGNALS_ON_MACH)
114 #define USE_MACH_BACKEND
115 #else
116 #define USE_POSIX_BACKEND
117 #endif
118 #elif HOST_WIN32
119 #define USE_WINDOWS_BACKEND
120 #else
121 #error "no backend support for current platform"
122 #endif /* defined (_POSIX_VERSION) */
123
124 enum {
125         STATE_STARTING                          = 0x00,
126         STATE_RUNNING                           = 0x01,
127         STATE_DETACHED                          = 0x02,
128
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,
135
136         STATE_MAX                                               = 0x08,
137
138         THREAD_STATE_MASK                       = 0x00FF,
139         THREAD_SUSPEND_COUNT_MASK       = 0xFF00,
140         THREAD_SUSPEND_COUNT_SHIFT      = 8,
141         THREAD_SUSPEND_COUNT_MAX        = 0xFF,
142
143         SELF_SUSPEND_STATE_INDEX = 0,
144         ASYNC_SUSPEND_STATE_INDEX = 1,
145 };
146
147 typedef struct _MonoThreadInfoInterruptToken MonoThreadInfoInterruptToken;
148
149 typedef struct {
150         MonoLinkedListSetNode node;
151         guint32 small_id; /*Used by hazard pointers */
152         MonoNativeThreadHandle native_handle; /* Valid on mach and android */
153         int thread_state;
154
155         /*Tells if this thread was created by the runtime or not.*/
156         gboolean runtime_thread;
157
158         /* Tells if this thread should be ignored or not by runtime services such as GC and profiling */
159         gboolean tools_thread;
160
161         /* Max stack bounds, all valid addresses must be between [stack_start_limit, stack_end[ */
162         void *stack_start_limit, *stack_end;
163
164         /* suspend machinery, fields protected by suspend_semaphore */
165         MonoSemType suspend_semaphore;
166         int suspend_count;
167
168         MonoSemType resume_semaphore;
169
170         /* only needed by the posix backend */
171 #if defined(USE_POSIX_BACKEND)
172         MonoSemType finish_resume_semaphore;
173         gboolean syscall_break_signal;
174         int signal;
175 #endif
176
177         gboolean suspend_can_continue;
178
179         /* This memory pool is used by coop GC to save stack data roots between GC unsafe regions */
180         GByteArray *stackdata;
181
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.
184
185         /*async call machinery, thread MUST be suspended before accessing those fields*/
186         void (*async_target)(void*);
187         void *user_data;
188
189         /*
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.
193         */
194         gboolean inside_critical_region;
195
196         /*
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.
199          */
200         gboolean is_async_context;
201
202         /*
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.
206          */
207         gpointer tls [TLS_KEY_NUM];
208
209         /* IO layer handle for this thread */
210         /* Set when the thread is started, or in _wapi_thread_duplicate () */
211         MonoThreadHandle *handle;
212
213         void *jit_data;
214
215         MonoThreadInfoInterruptToken *interrupt_token;
216
217         /* HandleStack for coop handles */
218         gpointer handle_stack;
219
220         /* Stack mark for targets that explicitly require one */
221         gpointer stack_mark;
222 } MonoThreadInfo;
223
224 typedef struct {
225         void* (*thread_register)(THREAD_INFO_TYPE *info, void *baseaddr);
226         /*
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.
230         */
231         void (*thread_unregister)(THREAD_INFO_TYPE *info);
232         /*
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.
235
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.
238         */
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;
245
246 typedef struct {
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;
252
253 //Not using 0 and 1 to ensure callbacks are not returning bad data
254 typedef enum {
255         MonoResumeThread = 0x1234,
256         KeepSuspended = 0x4321,
257 } SuspendThreadResult;
258
259 typedef SuspendThreadResult (*MonoSuspendThreadCallback) (THREAD_INFO_TYPE *info, gpointer user_data);
260
261 static inline gboolean
262 mono_threads_filter_tools_threads (THREAD_INFO_TYPE *info)
263 {
264         return !((MonoThreadInfo*)info)->tools_thread;
265 }
266
267 /*
268 Requires the world to be stoped
269 */
270 #define FOREACH_THREAD(thread) \
271         MONO_LLS_FOREACH_FILTERED (mono_thread_info_list_head (), THREAD_INFO_TYPE, thread, mono_threads_filter_tools_threads)
272
273 #define FOREACH_THREAD_END \
274         MONO_LLS_FOREACH_END
275
276 /*
277 Snapshot iteration.
278 */
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)
281
282 #define FOREACH_THREAD_SAFE_END \
283         MONO_LLS_FOREACH_SAFE_END
284
285 static inline MonoNativeThreadId
286 mono_thread_info_get_tid (THREAD_INFO_TYPE *info)
287 {
288         return MONO_UINT_TO_NATIVE_THREAD_ID (((MonoThreadInfo*) info)->node.key);
289 }
290
291 static inline void
292 mono_thread_info_set_tid (THREAD_INFO_TYPE *info, MonoNativeThreadId tid)
293 {
294         ((MonoThreadInfo*) info)->node.key = (uintptr_t) MONO_NATIVE_THREAD_ID_TO_UINT (tid);
295 }
296
297 /*
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. 
300  */
301 void
302 mono_threads_init (MonoThreadInfoCallbacks *callbacks, size_t thread_info_size);
303
304 void
305 mono_threads_signals_init (void);
306
307 void
308 mono_threads_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks);
309
310 MonoThreadInfoRuntimeCallbacks *
311 mono_threads_get_runtime_callbacks (void);
312
313 int
314 mono_thread_info_register_small_id (void);
315
316 THREAD_INFO_TYPE *
317 mono_thread_info_attach (void *baseptr);
318
319 MONO_API void
320 mono_thread_info_detach (void);
321
322 gboolean
323 mono_thread_info_is_exiting (void);
324
325 THREAD_INFO_TYPE *
326 mono_thread_info_current (void);
327
328 THREAD_INFO_TYPE*
329 mono_thread_info_current_unchecked (void);
330
331 int
332 mono_thread_info_get_small_id (void);
333
334 MonoLinkedListSet*
335 mono_thread_info_list_head (void);
336
337 THREAD_INFO_TYPE*
338 mono_thread_info_lookup (MonoNativeThreadId id);
339
340 gboolean
341 mono_thread_info_resume (MonoNativeThreadId tid);
342
343 void
344 mono_thread_info_safe_suspend_and_run (MonoNativeThreadId id, gboolean interrupt_kernel, MonoSuspendThreadCallback callback, gpointer user_data);
345
346 void
347 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data);
348
349 void
350 mono_thread_info_suspend_lock (void);
351
352 void
353 mono_thread_info_suspend_unlock (void);
354
355 void
356 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid);
357
358 void
359 mono_thread_info_set_is_async_context (gboolean async_context);
360
361 gboolean
362 mono_thread_info_is_async_context (void);
363
364 void
365 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
366
367 MONO_API gboolean
368 mono_thread_info_yield (void);
369
370 gint
371 mono_thread_info_sleep (guint32 ms, gboolean *alerted);
372
373 gint
374 mono_thread_info_usleep (guint64 us);
375
376 gpointer
377 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
378
379 void
380 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
381
382 void
383 mono_thread_info_exit (gsize exit_code);
384
385 void
386 mono_thread_info_install_interrupt (void (*callback) (gpointer data), gpointer data, gboolean *interrupted);
387
388 void
389 mono_thread_info_uninstall_interrupt (gboolean *interrupted);
390
391 MonoThreadInfoInterruptToken*
392 mono_thread_info_prepare_interrupt (THREAD_INFO_TYPE *info);
393
394 void
395 mono_thread_info_finish_interrupt (MonoThreadInfoInterruptToken *token);
396
397 void
398 mono_thread_info_self_interrupt (void);
399
400 void
401 mono_thread_info_clear_self_interrupt (void);
402
403 gboolean
404 mono_thread_info_is_interrupt_state (THREAD_INFO_TYPE *info);
405
406 void
407 mono_thread_info_describe_interrupt_token (THREAD_INFO_TYPE *info, GString *text);
408
409 gboolean
410 mono_thread_info_is_live (THREAD_INFO_TYPE *info);
411
412 int
413 mono_threads_get_max_stack_size (void);
414
415 MonoThreadHandle*
416 mono_threads_open_thread_handle (MonoThreadHandle *handle);
417
418 void
419 mono_threads_close_thread_handle (MonoThreadHandle *handle);
420
421 MONO_API void
422 mono_threads_attach_tools_thread (void);
423
424
425 #if !defined(HOST_WIN32)
426
427 /*Use this instead of pthread_kill */
428 int
429 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum);
430
431 #endif /* !defined(HOST_WIN32) */
432
433 /* Internal API between mono-threads and its backends. */
434
435 /* Backend functions - a backend must implement all of the following */
436 /*
437 This is called very early in the runtime, it cannot access any runtime facilities.
438
439 */
440 void mono_threads_suspend_init (void); //ok
441
442 void mono_threads_suspend_init_signals (void);
443
444 void mono_threads_coop_init (void);
445
446 /*
447 This begins async suspend. This function must do the following:
448
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.
452
453 If begin suspend fails the thread must be left uninterrupted and resumed.
454 */
455 gboolean mono_threads_suspend_begin_async_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel);
456
457 /*
458 This verifies the outcome of an async suspend operation.
459
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.
462 */
463 gboolean mono_threads_suspend_check_suspend_result (THREAD_INFO_TYPE *info);
464
465 /*
466 This begins async resume. This function must do the following:
467
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.
471 */
472 gboolean mono_threads_suspend_begin_async_resume (THREAD_INFO_TYPE *info);
473
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);
481
482 gboolean
483 mono_thread_platform_create_thread (MonoThreadStart thread_fn, gpointer thread_data,
484         gsize* const stack_size, MonoNativeThreadId *tid);
485
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);
491
492 void mono_threads_coop_begin_global_suspend (void);
493 void mono_threads_coop_end_global_suspend (void);
494
495 MONO_API MonoNativeThreadId
496 mono_native_thread_id_get (void);
497
498 MONO_API gboolean
499 mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2);
500
501 MONO_API gboolean
502 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg);
503
504 MONO_API void
505 mono_native_thread_set_name (MonoNativeThreadId tid, const char *name);
506
507 MONO_API gboolean
508 mono_native_thread_join (MonoNativeThreadId tid);
509
510 /*Mach specific internals */
511 void mono_threads_init_dead_letter (void);
512 void mono_threads_install_dead_letter (void);
513
514 /* mono-threads internal API used by the backends. */
515 /*
516 This tells the suspend initiator that we completed suspend and will now be waiting for resume.
517 */
518 void mono_threads_notify_initiator_of_suspend (THREAD_INFO_TYPE* info);
519 /*
520 This tells the resume initiator that we completed resume duties and will return to runnable state.
521 */
522 void mono_threads_notify_initiator_of_resume (THREAD_INFO_TYPE* info);
523
524 /*
525 This tells the resume initiator that we completed abort duties and will return to previous state.
526 */
527 void mono_threads_notify_initiator_of_abort (THREAD_INFO_TYPE* info);
528
529 /* Thread state machine functions */
530
531 typedef enum {
532         ResumeError,
533         ResumeOk,
534         ResumeInitSelfResume,
535         ResumeInitAsyncResume,
536         ResumeInitBlockingResume,
537 } MonoResumeResult;
538
539 typedef enum {
540         SelfSuspendResumed,
541         SelfSuspendWait,
542         SelfSuspendNotifyAndWait,
543 } MonoSelfSupendResult;
544
545 typedef enum {
546         AsyncSuspendAlreadySuspended,
547         AsyncSuspendWait,
548         AsyncSuspendInitSuspend,
549         AsyncSuspendBlocking,
550 } MonoRequestAsyncSuspendResult;
551
552 typedef enum {
553         DoBlockingContinue, //in blocking mode, continue
554         DoBlockingPollAndRetry, //async suspend raced blocking and won, pool and retry
555 } MonoDoBlockingResult;
556
557 typedef enum {
558         DoneBlockingOk, //exited blocking fine
559         DoneBlockingWait, //thread should end suspended
560 } MonoDoneBlockingResult;
561
562
563 typedef enum {
564         AbortBlockingIgnore, //Ignore
565         AbortBlockingIgnoreAndPoll, //Ignore and poll
566         AbortBlockingOk, //Abort worked
567         AbortBlockingWait, //Abort worked, but should wait for resume
568 } MonoAbortBlockingResult;
569
570
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);
580
581 MonoThreadUnwindState* mono_thread_info_get_suspend_state (THREAD_INFO_TYPE *info);
582
583 gpointer
584 mono_threads_enter_gc_unsafe_region_cookie (void);
585
586
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);
594
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);
598
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);
603
604 gboolean
605 mono_thread_info_is_current (THREAD_INFO_TYPE *info);
606
607 typedef enum {
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;
613
614 MonoThreadInfoWaitRet
615 mono_thread_info_wait_one_handle (MonoThreadHandle *handle, guint32 timeout, gboolean alertable);
616
617 MonoThreadInfoWaitRet
618 mono_thread_info_wait_multiple_handle (MonoThreadHandle **thread_handles, gsize nhandles, MonoOSEvent *background_change_event, gboolean waitall, guint32 timeout, gboolean alertable);
619
620 void mono_threads_join_lock (void);
621 void mono_threads_join_unlock (void);
622
623 #endif /* __MONO_THREADS_H__ */