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-semaphore.h>
  14 #include <mono/utils/mono-stack-unwinding.h>
  15 #include <mono/utils/mono-linked-list-set.h>
  16 #include <mono/utils/mono-mutex.h>
  17 #include <mono/utils/mono-tls.h>
  18
  19 #include <glib.h>
  20
  21 #ifdef HOST_WIN32
  22
  23 #include <windows.h>
  24
  25 typedef DWORD MonoNativeThreadId;
  26 typedef HANDLE MonoNativeThreadHandle; /* unused */
  27
  28 typedef DWORD mono_native_thread_return_t;
  29
  30 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (tid)
  31
  32 #else
  33
  34 #include <pthread.h>
  35
  36 #if defined(__MACH__)
  37 #include <mono/utils/mach-support.h>
  38
  39 typedef thread_port_t MonoNativeThreadHandle;
  40
  41 #else
  42
  43 #include <unistd.h>
  44
  45 typedef pid_t MonoNativeThreadHandle;
  46
  47 #endif /* defined(__MACH__) */
  48
  49 typedef pthread_t MonoNativeThreadId;
  50
  51 typedef void* mono_native_thread_return_t;
  52
  53 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (gsize)(tid)
  54
  55 #endif /* #ifdef HOST_WIN32 */
  56
  57 /*
  58 THREAD_INFO_TYPE is a way to make the mono-threads module parametric - or sort of.
  59 The GC using mono-threads might extend the MonoThreadInfo struct to add its own
  60 data, this avoid a pointer indirection on what is on a lot of hot paths.
  61
  62 But extending MonoThreadInfo has de disavantage that all functions here return type
  63 would require a cast, something like the following:
  64
  65 typedef struct {
  66         MonoThreadInfo info;
  67         int stuff;
  68 }  MyThreadInfo;
  69
  70 ...
  71 ((MyThreadInfo*)mono_thread_info_current ())->stuff = 1;
  72
  73 While porting sgen to use mono-threads, the number of casts required was too much and
  74 code ended up looking horrible. So we use this cute little hack. The idea is that
  75 whomever is including this header can set the expected type to be used by functions here
  76 and reduce the number of casts drastically.
  77
  78 */
  79 #ifndef THREAD_INFO_TYPE
  80 #define THREAD_INFO_TYPE MonoThreadInfo
  81 #endif
  82
  83 enum {
  84         STATE_STARTING                  = 0x00,
  85         STATE_RUNNING                   = 0x01,
  86         STATE_SHUTTING_DOWN             = 0x02,
  87         STATE_DEAD                              = 0x03,
  88         RUN_STATE_MASK                  = 0x0F,
  89
  90         STATE_SUSPENDED                 = 0x10,
  91         STATE_SELF_SUSPENDED    = 0x20,
  92         SUSPEND_STATE_MASK              = 0xF0,
  93 };
  94
  95 #define mono_thread_info_run_state(info) (((MonoThreadInfo*)info)->thread_state & RUN_STATE_MASK)
  96 #define mono_thread_info_suspend_state(info) (((MonoThreadInfo*)info)->thread_state & SUSPEND_STATE_MASK)
  97
  98 typedef struct {
  99         MonoLinkedListSetNode node;
 100         guint32 small_id; /*Used by hazard pointers */
 101         MonoNativeThreadHandle native_handle; /* Valid on mach and android */
 102         int thread_state;
 103
 104         /*Tells if this thread was created by the runtime or not.*/
 105         gboolean runtime_thread;
 106
 107         /* suspend machinery, fields protected by suspend_semaphore */
 108         MonoSemType suspend_semaphore;
 109         int suspend_count;
 110
 111         MonoSemType finish_resume_semaphore;
 112         MonoSemType resume_semaphore;
 113
 114         /* only needed by the posix backend */
 115 #if (defined(_POSIX_VERSION) || defined(__native_client__)) && !defined (__MACH__)
 116         MonoSemType begin_suspend_semaphore;
 117         gboolean syscall_break_signal;
 118         gboolean suspend_can_continue;
 119 #endif
 120
 121         /*In theory, only the posix backend needs this, but having it on mach/win32 simplifies things a lot.*/
 122         MonoThreadUnwindState suspend_state;
 123
 124         /*async call machinery, thread MUST be suspended before accessing those fields*/
 125         void (*async_target)(void*);
 126         void *user_data;
 127
 128         /*
 129         If true, this thread is running a critical region of code and cannot be suspended.
 130         A critical session is implicitly started when you call mono_thread_info_safe_suspend_sync
 131         and is ended when you call either mono_thread_info_resume or mono_thread_info_finish_suspend.
 132         */
 133         gboolean inside_critical_region;
 134
 135         /*
 136          * If TRUE, the thread is in async context. Code can use this information to avoid async-unsafe
 137          * operations like locking without having to pass an 'async' parameter around.
 138          */
 139         gboolean is_async_context;
 140
 141         gboolean create_suspended;
 142
 143         /* Semaphore used to implement CREATE_SUSPENDED */
 144         MonoSemType create_suspended_sem;
 145
 146         /*
 147          * Values of TLS variables for this thread.
 148          * This can be used to obtain the values of TLS variable for threads
 149          * other than the current one.
 150          */
 151         gpointer tls [TLS_KEY_NUM];
 152
 153         /* IO layer handle for this thread */
 154         /* Set when the thread is started, or in _wapi_thread_duplicate () */
 155         HANDLE handle;
 156 } MonoThreadInfo;
 157
 158 typedef struct {
 159         void* (*thread_register)(THREAD_INFO_TYPE *info, void *baseaddr);
 160         /*
 161         This callback is called with @info still on the thread list.
 162         This call is made while holding the suspend lock, so don't do callbacks.
 163         SMR remains functional as its small_id has not been reclaimed.
 164         */
 165         void (*thread_unregister)(THREAD_INFO_TYPE *info);
 166         /*
 167         This callback is called right before thread_unregister. This is called
 168         without any locks held so it's the place for complicated cleanup.
 169
 170         The thread must remain operational between this call and thread_unregister.
 171         It must be possible to successfully suspend it after thread_unregister completes.
 172         */
 173         void (*thread_detach)(THREAD_INFO_TYPE *info);
 174         void (*thread_attach)(THREAD_INFO_TYPE *info);
 175         gboolean (*mono_method_is_critical) (void *method);
 176         void (*thread_exit)(void *retval);
 177 #ifndef HOST_WIN32
 178         int (*mono_gc_pthread_create) (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg);
 179 #endif
 180 } MonoThreadInfoCallbacks;
 181
 182 typedef struct {
 183         void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
 184         gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
 185         gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoNativeThreadId thread_id, MonoNativeThreadHandle thread_handle);
 186 } MonoThreadInfoRuntimeCallbacks;
 187
 188 /*
 189 Requires the world to be stoped
 190 */
 191 #define FOREACH_THREAD(thread) MONO_LLS_FOREACH (mono_thread_info_list_head (), thread, THREAD_INFO_TYPE*)
 192 #define END_FOREACH_THREAD MONO_LLS_END_FOREACH
 193
 194 /*
 195 Snapshot iteration.
 196 */
 197 #define FOREACH_THREAD_SAFE(thread) MONO_LLS_FOREACH_SAFE (mono_thread_info_list_head (), thread, THREAD_INFO_TYPE*)
 198 #define END_FOREACH_THREAD_SAFE MONO_LLS_END_FOREACH_SAFE
 199
 200 #define mono_thread_info_get_tid(info) ((MonoNativeThreadId)((MonoThreadInfo*)info)->node.key)
 201 #define mono_thread_info_set_tid(info, val) do { ((MonoThreadInfo*)(info))->node.key = (uintptr_t)(val); } while (0)
 202
 203 /*
 204  * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
 205  * a single block with info from both camps.
 206  */
 207 void
 208 mono_threads_init (MonoThreadInfoCallbacks *callbacks, size_t thread_info_size) MONO_INTERNAL;
 209
 210 void
 211 mono_threads_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks) MONO_INTERNAL;
 212
 213 MonoThreadInfoCallbacks *
 214 mono_threads_get_callbacks (void) MONO_INTERNAL;
 215
 216 MonoThreadInfoRuntimeCallbacks *
 217 mono_threads_get_runtime_callbacks (void) MONO_INTERNAL;
 218
 219 int
 220 mono_thread_info_register_small_id (void) MONO_INTERNAL;
 221
 222 THREAD_INFO_TYPE *
 223 mono_thread_info_attach (void *baseptr) MONO_INTERNAL;
 224
 225 void
 226 mono_thread_info_detach (void) MONO_INTERNAL;
 227
 228 THREAD_INFO_TYPE *
 229 mono_thread_info_current (void) MONO_INTERNAL;
 230
 231 int
 232 mono_thread_info_get_small_id (void) MONO_INTERNAL;
 233
 234 MonoLinkedListSet*
 235 mono_thread_info_list_head (void) MONO_INTERNAL;
 236
 237 THREAD_INFO_TYPE*
 238 mono_thread_info_lookup (MonoNativeThreadId id) MONO_INTERNAL;
 239
 240 THREAD_INFO_TYPE*
 241 mono_thread_info_safe_suspend_sync (MonoNativeThreadId tid, gboolean interrupt_kernel) MONO_INTERNAL;
 242
 243 gboolean
 244 mono_thread_info_resume (MonoNativeThreadId tid) MONO_INTERNAL;
 245
 246 void
 247 mono_thread_info_finish_suspend (void) MONO_INTERNAL;
 248
 249 void
 250 mono_thread_info_self_suspend (void) MONO_INTERNAL;
 251
 252 gboolean
 253 mono_thread_info_new_interrupt_enabled (void) MONO_INTERNAL;
 254
 255 void
 256 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data) MONO_INTERNAL;
 257
 258 void
 259 mono_thread_info_suspend_lock (void) MONO_INTERNAL;
 260
 261 void
 262 mono_thread_info_suspend_unlock (void) MONO_INTERNAL;
 263
 264 void
 265 mono_thread_info_disable_new_interrupt (gboolean disable) MONO_INTERNAL;
 266
 267 void
 268 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid) MONO_INTERNAL;
 269
 270 void
 271 mono_thread_info_set_is_async_context (gboolean async_context) MONO_INTERNAL;
 272
 273 gboolean
 274 mono_thread_info_is_async_context (void) MONO_INTERNAL;
 275
 276 void
 277 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
 278
 279 gboolean
 280 mono_thread_info_yield (void) MONO_INTERNAL;
 281
 282 gpointer
 283 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
 284
 285 void
 286 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
 287
 288 void
 289 mono_thread_info_exit (void);
 290
 291 HANDLE
 292 mono_thread_info_open_handle (void);
 293
 294 HANDLE
 295 mono_threads_create_thread (LPTHREAD_START_ROUTINE start, gpointer arg, guint32 stack_size, guint32 creation_flags, MonoNativeThreadId *out_tid);
 296
 297 #if !defined(HOST_WIN32)
 298
 299 #if !defined(__MACH__)
 300 /*Use this instead of pthread_kill */
 301 int
 302 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum) MONO_INTERNAL;
 303 #endif
 304
 305 #endif /* !defined(HOST_WIN32) */
 306
 307 /* Plartform specific functions DON'T use them */
 308 void mono_threads_init_platform (void) MONO_INTERNAL; //ok
 309 gboolean mono_threads_core_suspend (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 310 gboolean mono_threads_core_resume (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 311 void mono_threads_platform_register (THREAD_INFO_TYPE *info) MONO_INTERNAL; //ok
 312 void mono_threads_platform_free (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 313 void mono_threads_core_interrupt (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 314 void mono_threads_core_abort_syscall (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 315 gboolean mono_threads_core_needs_abort_syscall (void) MONO_INTERNAL;
 316 HANDLE mono_threads_core_create_thread (LPTHREAD_START_ROUTINE start, gpointer arg, guint32 stack_size, guint32 creation_flags, MonoNativeThreadId *out_tid) MONO_INTERNAL;
 317 void mono_threads_core_resume_created (THREAD_INFO_TYPE *info, MonoNativeThreadId tid) MONO_INTERNAL;
 318 void mono_threads_core_get_stack_bounds (guint8 **staddr, size_t *stsize) MONO_INTERNAL;
 319 gboolean mono_threads_core_yield (void) MONO_INTERNAL;
 320 void mono_threads_core_exit (int exit_code) MONO_INTERNAL;
 321 void mono_threads_core_unregister (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 322 HANDLE mono_threads_core_open_handle (void) MONO_INTERNAL;
 323
 324 MonoNativeThreadId mono_native_thread_id_get (void) MONO_INTERNAL;
 325
 326 gboolean mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2) MONO_INTERNAL;
 327
 328 gboolean
 329 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg) MONO_INTERNAL;
 330
 331 #endif /* __MONO_THREADS_H__ */