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