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                  = 0x01,
  80         STATE_RUNNING                   = 0x02,
  81         STATE_SHUTTING_DOWN             = 0x03,
  82         STATE_DEAD                              = 0x04,
  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) ((info)->thread_state & RUN_STATE_MASK)
  91 #define mono_thread_info_suspend_state(info) ((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 the suspend_lock */
 103         mono_mutex_t suspend_lock;
 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 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 } MonoThreadInfo;
 123
 124 typedef struct {
 125         void* (*thread_register)(THREAD_INFO_TYPE *info, void *baseaddr);
 126         /*
 127         This callback is called after @info is removed from the thread list.
 128         SMR remains functional as its small_id has not been reclaimed.
 129         */
 130         void (*thread_unregister)(THREAD_INFO_TYPE *info);
 131         void (*thread_attach)(THREAD_INFO_TYPE *info);
 132         gboolean (*mono_method_is_critical) (void *method);
 133 #ifndef HOST_WIN32
 134         int (*mono_gc_pthread_create) (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg);
 135 #endif
 136 } MonoThreadInfoCallbacks;
 137
 138 typedef struct {
 139         void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
 140         gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
 141         gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoNativeThreadId thread_id, MonoNativeThreadHandle thread_handle);
 142 } MonoThreadInfoRuntimeCallbacks;
 143
 144 /*
 145 Requires the world to be stoped
 146 */
 147 #define FOREACH_THREAD(thread) MONO_LLS_FOREACH (mono_thread_info_list_head (), thread, SgenThreadInfo*)
 148 #define END_FOREACH_THREAD MONO_LLS_END_FOREACH
 149
 150 /*
 151 Snapshot iteration.
 152 */
 153 #define FOREACH_THREAD_SAFE(thread) MONO_LLS_FOREACH_SAFE (mono_thread_info_list_head (), thread, SgenThreadInfo*)
 154 #define END_FOREACH_THREAD_SAFE MONO_LLS_END_FOREACH_SAFE
 155
 156 #define mono_thread_info_get_tid(info) ((MonoNativeThreadId)((MonoThreadInfo*)info)->node.key)
 157 #define mono_thread_info_set_tid(info, val) do { ((MonoThreadInfo*)(info))->node.key = (uintptr_t)(val); } while (0)
 158
 159 /*
 160  * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
 161  * a single block with info from both camps.
 162  */
 163 void
 164 mono_threads_init (MonoThreadInfoCallbacks *callbacks, size_t thread_info_size) MONO_INTERNAL;
 165
 166 void
 167 mono_threads_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks) MONO_INTERNAL;
 168
 169 MonoThreadInfoCallbacks *
 170 mono_threads_get_callbacks (void) MONO_INTERNAL;
 171
 172 MonoThreadInfoRuntimeCallbacks *
 173 mono_threads_get_runtime_callbacks (void) MONO_INTERNAL;
 174
 175 int
 176 mono_thread_info_register_small_id (void) MONO_INTERNAL;
 177
 178 THREAD_INFO_TYPE *
 179 mono_thread_info_attach (void *baseptr) MONO_INTERNAL;
 180
 181 void
 182 mono_thread_info_dettach (void) MONO_INTERNAL;
 183
 184 THREAD_INFO_TYPE *
 185 mono_thread_info_current (void) MONO_INTERNAL;
 186
 187 int
 188 mono_thread_info_get_small_id (void) MONO_INTERNAL;
 189
 190 MonoLinkedListSet*
 191 mono_thread_info_list_head (void) MONO_INTERNAL;
 192
 193 MonoThreadInfo*
 194 mono_thread_info_lookup (MonoNativeThreadId id) MONO_INTERNAL;
 195
 196 MonoThreadInfo*
 197 mono_thread_info_safe_suspend_sync (MonoNativeThreadId tid, gboolean interrupt_kernel) MONO_INTERNAL;
 198
 199 gboolean
 200 mono_thread_info_resume (MonoNativeThreadId tid) MONO_INTERNAL;
 201
 202 void
 203 mono_thread_info_self_suspend (void) MONO_INTERNAL;
 204
 205 gboolean
 206 mono_thread_info_new_interrupt_enabled (void) MONO_INTERNAL;
 207
 208 void
 209 mono_thread_info_setup_async_call (MonoThreadInfo *info, void (*target_func)(void*), void *user_data) MONO_INTERNAL;
 210
 211 void
 212 mono_thread_info_suspend_lock (void) MONO_INTERNAL;
 213
 214 void
 215 mono_thread_info_suspend_unlock (void) MONO_INTERNAL;
 216
 217 void
 218 mono_threads_unregister_current_thread (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 219
 220 void
 221 mono_thread_info_disable_new_interrupt (gboolean disable) MONO_INTERNAL;
 222
 223 void
 224 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid) MONO_INTERNAL;
 225
 226 #if !defined(HOST_WIN32)
 227
 228 int
 229 mono_threads_pthread_create (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg) MONO_INTERNAL;
 230
 231 #if !defined(__MACH__)
 232 /*Use this instead of pthread_kill */
 233 int
 234 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum) MONO_INTERNAL;
 235 #endif
 236
 237 #else  /* !defined(HOST_WIN32) */
 238
 239 HANDLE
 240         mono_threads_CreateThread (LPSECURITY_ATTRIBUTES attributes, SIZE_T stack_size, LPTHREAD_START_ROUTINE start_routine, LPVOID arg, DWORD creation_flags, LPDWORD thread_id);
 241
 242
 243 #endif /* !defined(HOST_WIN32) */
 244
 245 /* Plartform specific functions DON'T use them */
 246 void mono_threads_init_platform (void) MONO_INTERNAL; //ok
 247 gboolean mono_threads_core_suspend (MonoThreadInfo *info) MONO_INTERNAL;
 248 gboolean mono_threads_core_resume (MonoThreadInfo *info) MONO_INTERNAL;
 249 void mono_threads_platform_register (MonoThreadInfo *info) MONO_INTERNAL; //ok
 250 void mono_threads_platform_free (MonoThreadInfo *info) MONO_INTERNAL;
 251 void mono_threads_core_interrupt (MonoThreadInfo *info) MONO_INTERNAL;
 252 void mono_threads_core_abort_syscall (MonoThreadInfo *info) MONO_INTERNAL;
 253 gboolean mono_threads_core_needs_abort_syscall (void) MONO_INTERNAL;
 254
 255 MonoNativeThreadId mono_native_thread_id_get (void) MONO_INTERNAL;
 256
 257 gboolean mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2) MONO_INTERNAL;
 258
 259 gboolean
 260 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg) MONO_INTERNAL;
 261
 262 #endif /* __MONO_THREADS_H__ */