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