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