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 /*
  98  * This enum tells which async thread service corresponds to which bit.
  99  */
 100 typedef enum {
 101         MONO_SERVICE_REQUEST_SAMPLE = 1,
 102 } MonoAsyncJob;
 103
 104 #define mono_thread_info_run_state(info) (((MonoThreadInfo*)info)->thread_state & RUN_STATE_MASK)
 105 #define mono_thread_info_suspend_state(info) (((MonoThreadInfo*)info)->thread_state & SUSPEND_STATE_MASK)
 106
 107 typedef struct {
 108         MonoLinkedListSetNode node;
 109         guint32 small_id; /*Used by hazard pointers */
 110         MonoNativeThreadHandle native_handle; /* Valid on mach and android */
 111         int thread_state;
 112
 113         /*Tells if this thread was created by the runtime or not.*/
 114         gboolean runtime_thread;
 115
 116         /* Tells if this thread should be ignored or not by runtime services such as GC and profiling */
 117         gboolean tools_thread;
 118
 119         /* suspend machinery, fields protected by suspend_semaphore */
 120         MonoSemType suspend_semaphore;
 121         int suspend_count;
 122
 123         MonoSemType finish_resume_semaphore;
 124         MonoSemType resume_semaphore;
 125
 126         /* only needed by the posix backend */
 127 #if (defined(_POSIX_VERSION) || defined(__native_client__)) && !defined (__MACH__)
 128         MonoSemType begin_suspend_semaphore;
 129         gboolean syscall_break_signal;
 130         gboolean suspend_can_continue;
 131 #endif
 132
 133         /*In theory, only the posix backend needs this, but having it on mach/win32 simplifies things a lot.*/
 134         MonoThreadUnwindState suspend_state;
 135
 136         /*async call machinery, thread MUST be suspended before accessing those fields*/
 137         void (*async_target)(void*);
 138         void *user_data;
 139
 140         /*
 141         If true, this thread is running a critical region of code and cannot be suspended.
 142         A critical session is implicitly started when you call mono_thread_info_safe_suspend_sync
 143         and is ended when you call either mono_thread_info_resume or mono_thread_info_finish_suspend.
 144         */
 145         gboolean inside_critical_region;
 146
 147         /*
 148          * If TRUE, the thread is in async context. Code can use this information to avoid async-unsafe
 149          * operations like locking without having to pass an 'async' parameter around.
 150          */
 151         gboolean is_async_context;
 152
 153         gboolean create_suspended;
 154
 155         /* Semaphore used to implement CREATE_SUSPENDED */
 156         MonoSemType create_suspended_sem;
 157
 158         /*
 159          * Values of TLS variables for this thread.
 160          * This can be used to obtain the values of TLS variable for threads
 161          * other than the current one.
 162          */
 163         gpointer tls [TLS_KEY_NUM];
 164
 165         /* IO layer handle for this thread */
 166         /* Set when the thread is started, or in _wapi_thread_duplicate () */
 167         HANDLE handle;
 168
 169         /* Asynchronous service request. This flag is meant to be consumed by the multiplexing signal handlers to discover what sort of work they need to do.
 170          * Use the mono_threads_add_async_job and mono_threads_consume_async_jobs APIs to modify this flag.
 171          * In the future the signaling should be part of the API, but for now, it's only for massaging the bits.
 172          */
 173         volatile gint32 service_requests;
 174 } MonoThreadInfo;
 175
 176 typedef struct {
 177         void* (*thread_register)(THREAD_INFO_TYPE *info, void *baseaddr);
 178         /*
 179         This callback is called with @info still on the thread list.
 180         This call is made while holding the suspend lock, so don't do callbacks.
 181         SMR remains functional as its small_id has not been reclaimed.
 182         */
 183         void (*thread_unregister)(THREAD_INFO_TYPE *info);
 184         /*
 185         This callback is called right before thread_unregister. This is called
 186         without any locks held so it's the place for complicated cleanup.
 187
 188         The thread must remain operational between this call and thread_unregister.
 189         It must be possible to successfully suspend it after thread_unregister completes.
 190         */
 191         void (*thread_detach)(THREAD_INFO_TYPE *info);
 192         void (*thread_attach)(THREAD_INFO_TYPE *info);
 193         gboolean (*mono_method_is_critical) (void *method);
 194         void (*thread_exit)(void *retval);
 195 #ifndef HOST_WIN32
 196         int (*mono_gc_pthread_create) (pthread_t *new_thread, const pthread_attr_t *attr, void *(*start_routine)(void *), void *arg);
 197 #endif
 198 } MonoThreadInfoCallbacks;
 199
 200 typedef struct {
 201         void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
 202         gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
 203         gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoThreadInfo *info);
 204 } MonoThreadInfoRuntimeCallbacks;
 205
 206 static inline gboolean
 207 mono_threads_filter_tools_threads (THREAD_INFO_TYPE *info)
 208 {
 209         return !((MonoThreadInfo*)info)->tools_thread;
 210 }
 211
 212 /*
 213 Requires the world to be stoped
 214 */
 215 #define FOREACH_THREAD(thread) MONO_LLS_FOREACH_FILTERED (mono_thread_info_list_head (), thread, mono_threads_filter_tools_threads, THREAD_INFO_TYPE*)
 216 #define END_FOREACH_THREAD MONO_LLS_END_FOREACH
 217
 218 /*
 219 Snapshot iteration.
 220 */
 221 #define FOREACH_THREAD_SAFE(thread) MONO_LLS_FOREACH_FILTERED_SAFE (mono_thread_info_list_head (), thread, mono_threads_filter_tools_threads, THREAD_INFO_TYPE*)
 222 #define END_FOREACH_THREAD_SAFE MONO_LLS_END_FOREACH_SAFE
 223
 224 #define mono_thread_info_get_tid(info) ((MonoNativeThreadId)((MonoThreadInfo*)info)->node.key)
 225 #define mono_thread_info_set_tid(info, val) do { ((MonoThreadInfo*)(info))->node.key = (uintptr_t)(val); } while (0)
 226
 227 /*
 228  * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
 229  * a single block with info from both camps.
 230  */
 231 void
 232 mono_threads_init (MonoThreadInfoCallbacks *callbacks, size_t thread_info_size) MONO_INTERNAL;
 233
 234 void
 235 mono_threads_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks) MONO_INTERNAL;
 236
 237 MonoThreadInfoCallbacks *
 238 mono_threads_get_callbacks (void) MONO_INTERNAL;
 239
 240 MonoThreadInfoRuntimeCallbacks *
 241 mono_threads_get_runtime_callbacks (void) MONO_INTERNAL;
 242
 243 int
 244 mono_thread_info_register_small_id (void) MONO_INTERNAL;
 245
 246 THREAD_INFO_TYPE *
 247 mono_thread_info_attach (void *baseptr) MONO_INTERNAL;
 248
 249 void
 250 mono_thread_info_detach (void) MONO_INTERNAL;
 251
 252 gboolean
 253 mono_thread_info_is_exiting (void) MONO_INTERNAL;
 254
 255 THREAD_INFO_TYPE *
 256 mono_thread_info_current (void) MONO_INTERNAL;
 257
 258 int
 259 mono_thread_info_get_small_id (void) MONO_INTERNAL;
 260
 261 MonoLinkedListSet*
 262 mono_thread_info_list_head (void) MONO_INTERNAL;
 263
 264 THREAD_INFO_TYPE*
 265 mono_thread_info_lookup (MonoNativeThreadId id) MONO_INTERNAL;
 266
 267 THREAD_INFO_TYPE*
 268 mono_thread_info_safe_suspend_sync (MonoNativeThreadId tid, gboolean interrupt_kernel) MONO_INTERNAL;
 269
 270 gboolean
 271 mono_thread_info_resume (MonoNativeThreadId tid) MONO_INTERNAL;
 272
 273 void
 274 mono_thread_info_set_name (MonoNativeThreadId tid, const char *name) MONO_INTERNAL;
 275
 276 void
 277 mono_thread_info_finish_suspend (MonoThreadInfo *info) MONO_INTERNAL;
 278
 279 void
 280 mono_thread_info_finish_suspend_and_resume (MonoThreadInfo *info) MONO_INTERNAL;
 281
 282 void
 283 mono_thread_info_self_suspend (void) MONO_INTERNAL;
 284
 285 gboolean
 286 mono_thread_info_new_interrupt_enabled (void) MONO_INTERNAL;
 287
 288 void
 289 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data) MONO_INTERNAL;
 290
 291 void
 292 mono_thread_info_suspend_lock (void) MONO_INTERNAL;
 293
 294 void
 295 mono_thread_info_suspend_unlock (void) MONO_INTERNAL;
 296
 297 void
 298 mono_thread_info_disable_new_interrupt (gboolean disable) MONO_INTERNAL;
 299
 300 void
 301 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid) MONO_INTERNAL;
 302
 303 void
 304 mono_thread_info_set_is_async_context (gboolean async_context) MONO_INTERNAL;
 305
 306 gboolean
 307 mono_thread_info_is_async_context (void) MONO_INTERNAL;
 308
 309 void
 310 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
 311
 312 gboolean
 313 mono_thread_info_yield (void) MONO_INTERNAL;
 314
 315 gpointer
 316 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
 317
 318 void
 319 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
 320
 321 void
 322 mono_thread_info_exit (void);
 323
 324 HANDLE
 325 mono_thread_info_open_handle (void);
 326
 327 gpointer
 328 mono_thread_info_prepare_interrupt (HANDLE thread_handle);
 329
 330 void
 331 mono_thread_info_finish_interrupt (gpointer wait_handle);
 332
 333 void
 334 mono_thread_info_interrupt (HANDLE thread_handle);
 335
 336 void
 337 mono_thread_info_self_interrupt (void);
 338
 339 void
 340 mono_thread_info_clear_interruption (void);
 341
 342 HANDLE
 343 mono_threads_create_thread (LPTHREAD_START_ROUTINE start, gpointer arg, guint32 stack_size, guint32 creation_flags, MonoNativeThreadId *out_tid);
 344
 345 int
 346 mono_threads_get_max_stack_size (void) MONO_INTERNAL;
 347
 348 HANDLE
 349 mono_threads_open_thread_handle (HANDLE handle, MonoNativeThreadId tid) MONO_INTERNAL;
 350
 351 /*
 352 This is the async job submission/consumption API.
 353 XXX: This is a PROVISIONAL API only meant to be used by the statistical profiler.
 354 If you want to use/extend it anywhere else, understand that you'll have to do some API design work to better fit this puppy.
 355 */
 356 gboolean
 357 mono_threads_add_async_job (THREAD_INFO_TYPE *info, MonoAsyncJob job) MONO_INTERNAL;
 358
 359 MonoAsyncJob
 360 mono_threads_consume_async_jobs (void) MONO_INTERNAL;
 361
 362 void
 363 mono_threads_attach_tools_thread (void);
 364
 365
 366 #if !defined(HOST_WIN32)
 367
 368 /*Use this instead of pthread_kill */
 369 int
 370 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum) MONO_INTERNAL;
 371
 372 #endif /* !defined(HOST_WIN32) */
 373
 374 /* Plartform specific functions DON'T use them */
 375 void mono_threads_init_platform (void) MONO_INTERNAL; //ok
 376 gboolean mono_threads_core_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel) MONO_INTERNAL;
 377 gboolean mono_threads_core_resume (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 378 void mono_threads_platform_register (THREAD_INFO_TYPE *info) MONO_INTERNAL; //ok
 379 void mono_threads_platform_free (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 380 void mono_threads_core_interrupt (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 381 void mono_threads_core_abort_syscall (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 382 gboolean mono_threads_core_needs_abort_syscall (void) MONO_INTERNAL;
 383 HANDLE mono_threads_core_create_thread (LPTHREAD_START_ROUTINE start, gpointer arg, guint32 stack_size, guint32 creation_flags, MonoNativeThreadId *out_tid) MONO_INTERNAL;
 384 void mono_threads_core_resume_created (THREAD_INFO_TYPE *info, MonoNativeThreadId tid) MONO_INTERNAL;
 385 void mono_threads_core_get_stack_bounds (guint8 **staddr, size_t *stsize) MONO_INTERNAL;
 386 gboolean mono_threads_core_yield (void) MONO_INTERNAL;
 387 void mono_threads_core_exit (int exit_code) MONO_INTERNAL;
 388 void mono_threads_core_unregister (THREAD_INFO_TYPE *info) MONO_INTERNAL;
 389 HANDLE mono_threads_core_open_handle (void) MONO_INTERNAL;
 390 HANDLE mono_threads_core_open_thread_handle (HANDLE handle, MonoNativeThreadId tid) MONO_INTERNAL;
 391 void mono_threads_core_set_name (MonoNativeThreadId tid, const char *name) MONO_INTERNAL;
 392 gpointer mono_threads_core_prepare_interrupt (HANDLE thread_handle);
 393 void mono_threads_core_finish_interrupt (gpointer wait_handle);
 394 void mono_threads_core_self_interrupt (void);
 395 void mono_threads_core_clear_interruption (void);
 396
 397 MonoNativeThreadId mono_native_thread_id_get (void) MONO_INTERNAL;
 398
 399 gboolean mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2) MONO_INTERNAL;
 400
 401 gboolean
 402 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg) MONO_INTERNAL;
 403
 404 /*Mach specific internals */
 405 void mono_threads_init_dead_letter (void) MONO_INTERNAL;
 406 void mono_threads_install_dead_letter (void) MONO_INTERNAL;
 407
 408 #endif /* __MONO_THREADS_H__ */