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 } MonoThreadInfo;
 153
 154 typedef struct {
 155         void* (*thread_register)(THREAD_INFO_TYPE *info, void *baseaddr);
 156         /*
 157         This callback is called with @info still on the thread list.
 158         This call is made while holding the suspend lock, so don't do callbacks.
 159         SMR remains functional as its small_id has not been reclaimed.
 160         */
 161         void (*thread_unregister)(THREAD_INFO_TYPE *info);
 162         /*
 163         This callback is called right before thread_unregister. This is called
 164         without any locks held so it's the place for complicated cleanup.
 165
 166         The thread must remain operational between this call and thread_unregister.
 167         It must be possible to successfully suspend it after thread_unregister completes.
 168         */
 169         void (*thread_detach)(THREAD_INFO_TYPE *info);
 170         void (*thread_attach)(THREAD_INFO_TYPE *info);
 171         gboolean (*mono_method_is_critical) (void *method);
 172 #ifndef HOST_WIN32
 173         int (*mono_gc_pthread_create) (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg);
 174 #endif
 175 } MonoThreadInfoCallbacks;
 176
 177 typedef struct {
 178         void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
 179         gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
 180         gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoNativeThreadId thread_id, MonoNativeThreadHandle thread_handle);
 181 } MonoThreadInfoRuntimeCallbacks;
 182
 183 /*
 184 Requires the world to be stoped
 185 */
 186 #define FOREACH_THREAD(thread) MONO_LLS_FOREACH (mono_thread_info_list_head (), thread, THREAD_INFO_TYPE*)
 187 #define END_FOREACH_THREAD MONO_LLS_END_FOREACH
 188
 189 /*
 190 Snapshot iteration.
 191 */
 192 #define FOREACH_THREAD_SAFE(thread) MONO_LLS_FOREACH_SAFE (mono_thread_info_list_head (), thread, THREAD_INFO_TYPE*)
 193 #define END_FOREACH_THREAD_SAFE MONO_LLS_END_FOREACH_SAFE
 194
 195 #define mono_thread_info_get_tid(info) ((MonoNativeThreadId)((MonoThreadInfo*)info)->node.key)
 196 #define mono_thread_info_set_tid(info, val) do { ((MonoThreadInfo*)(info))->node.key = (uintptr_t)(val); } while (0)
 197
 198 /*
 199  * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
 200  * a single block with info from both camps.
 201  */
 202 void
 203 mono_threads_init (MonoThreadInfoCallbacks *callbacks, size_t thread_info_size) MONO_INTERNAL;
 204
 205 void
 206 mono_threads_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks) MONO_INTERNAL;
 207
 208 MonoThreadInfoCallbacks *
 209 mono_threads_get_callbacks (void) MONO_INTERNAL;
 210
 211 MonoThreadInfoRuntimeCallbacks *
 212 mono_threads_get_runtime_callbacks (void) MONO_INTERNAL;
 213
 214 int
 215 mono_thread_info_register_small_id (void) MONO_INTERNAL;
 216
 217 THREAD_INFO_TYPE *
 218 mono_thread_info_attach (void *baseptr) MONO_INTERNAL;
 219
 220 void
 221 mono_thread_info_dettach (void) MONO_INTERNAL;
 222
 223 THREAD_INFO_TYPE *
 224 mono_thread_info_current (void) MONO_INTERNAL;
 225
 226 int
 227 mono_thread_info_get_small_id (void) MONO_INTERNAL;
 228
 229 MonoLinkedListSet*
 230 mono_thread_info_list_head (void) MONO_INTERNAL;
 231
 232 THREAD_INFO_TYPE*
 233 mono_thread_info_lookup (MonoNativeThreadId id) MONO_INTERNAL;
 234
 235 THREAD_INFO_TYPE*
 236 mono_thread_info_safe_suspend_sync (MonoNativeThreadId tid, gboolean interrupt_kernel) MONO_INTERNAL;
 237
 238 gboolean
 239 mono_thread_info_resume (MonoNativeThreadId tid) MONO_INTERNAL;
 240
 241 void
 242 mono_thread_info_finish_suspend (void) MONO_INTERNAL;
 243
 244 void
 245 mono_thread_info_self_suspend (void) MONO_INTERNAL;
 246
 247 gboolean
 248 mono_thread_info_new_interrupt_enabled (void) MONO_INTERNAL;
 249
 250 void
 251 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data) MONO_INTERNAL;
 252
 253 void
 254 mono_thread_info_suspend_lock (void) MONO_INTERNAL;
 255
 256 void
 257 mono_thread_info_suspend_unlock (void) MONO_INTERNAL;
 258
 259 void
 260 mono_thread_info_disable_new_interrupt (gboolean disable) MONO_INTERNAL;
 261
 262 void
 263 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid) MONO_INTERNAL;
 264
 265 void
 266 mono_thread_info_set_is_async_context (gboolean async_context) MONO_INTERNAL;
 267
 268 gboolean
 269 mono_thread_info_is_async_context (void) MONO_INTERNAL;
 270
 271 void
 272 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
 273
 274 gboolean
 275 mono_thread_info_yield (void) MONO_INTERNAL;
 276
 277 gpointer
 278 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
 279
 280 void
 281 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
 282
 283 HANDLE
 284 mono_threads_create_thread (LPTHREAD_START_ROUTINE start, gpointer arg, guint32 stack_size, guint32 creation_flags, MonoNativeThreadId *out_tid);
 285
 286 #if !defined(HOST_WIN32)
 287
 288 #if !defined(__MACH__)
 289 /*Use this instead of pthread_kill */
 290 int
 291 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum) MONO_INTERNAL;
 292 #endif
 293
 294 #endif /* !defined(HOST_WIN32) */
 295
 296 /* Plartform specific functions DON'T use them */
 297 void mono_threads_init_platform (void) MONO_INTERNAL; //ok
 298 gboolean mono_threads_core_suspend (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 299 gboolean mono_threads_core_resume (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 300 void mono_threads_platform_register (THREAD_INFO_TYPE *info) MONO_INTERNAL; //ok
 301 void mono_threads_platform_free (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 302 void mono_threads_core_interrupt (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 303 void mono_threads_core_abort_syscall (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 304 gboolean mono_threads_core_needs_abort_syscall (void) MONO_INTERNAL;
 305 HANDLE mono_threads_core_create_thread (LPTHREAD_START_ROUTINE start, gpointer arg, guint32 stack_size, guint32 creation_flags, MonoNativeThreadId *out_tid) MONO_INTERNAL;
 306 void mono_threads_core_resume_created (THREAD_INFO_TYPE *info, MonoNativeThreadId tid) MONO_INTERNAL;
 307 void mono_threads_core_get_stack_bounds (guint8 **staddr, size_t *stsize) MONO_INTERNAL;
 308 gboolean mono_threads_core_yield (void) MONO_INTERNAL;
 309
 310 MonoNativeThreadId mono_native_thread_id_get (void) MONO_INTERNAL;
 311
 312 gboolean mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2) MONO_INTERNAL;
 313
 314 gboolean
 315 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg) MONO_INTERNAL;
 316
 317 #endif /* __MONO_THREADS_H__ */