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 #include <mono/utils/mono-threads-coop.h>
  19
  20 #include <glib.h>
  21 #include <config.h>
  22 #ifdef HOST_WIN32
  23
  24 #include <windows.h>
  25
  26 typedef DWORD MonoNativeThreadId;
  27 typedef HANDLE MonoNativeThreadHandle; /* unused */
  28
  29 typedef DWORD mono_native_thread_return_t;
  30
  31 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (tid)
  32 #define MONO_UINT_TO_NATIVE_THREAD_ID(tid) ((MonoNativeThreadId)(tid))
  33
  34 #else
  35
  36 #include <pthread.h>
  37
  38 #if defined(__MACH__)
  39 #include <mono/utils/mach-support.h>
  40
  41 typedef thread_port_t MonoNativeThreadHandle;
  42
  43 #else
  44
  45 #include <unistd.h>
  46
  47 typedef pid_t MonoNativeThreadHandle;
  48
  49 #endif /* defined(__MACH__) */
  50
  51 typedef pthread_t MonoNativeThreadId;
  52
  53 typedef void* mono_native_thread_return_t;
  54
  55 #define MONO_NATIVE_THREAD_ID_TO_UINT(tid) (gsize)(tid)
  56 #define MONO_UINT_TO_NATIVE_THREAD_ID(tid) (MonoNativeThreadId)(gsize)(tid)
  57
  58 #endif /* #ifdef HOST_WIN32 */
  59
  60 /*
  61 THREAD_INFO_TYPE is a way to make the mono-threads module parametric - or sort of.
  62 The GC using mono-threads might extend the MonoThreadInfo struct to add its own
  63 data, this avoid a pointer indirection on what is on a lot of hot paths.
  64
  65 But extending MonoThreadInfo has de disavantage that all functions here return type
  66 would require a cast, something like the following:
  67
  68 typedef struct {
  69         MonoThreadInfo info;
  70         int stuff;
  71 }  MyThreadInfo;
  72
  73 ...
  74 ((MyThreadInfo*)mono_thread_info_current ())->stuff = 1;
  75
  76 While porting sgen to use mono-threads, the number of casts required was too much and
  77 code ended up looking horrible. So we use this cute little hack. The idea is that
  78 whomever is including this header can set the expected type to be used by functions here
  79 and reduce the number of casts drastically.
  80
  81 */
  82 #ifndef THREAD_INFO_TYPE
  83 #define THREAD_INFO_TYPE MonoThreadInfo
  84 #endif
  85
  86 /* Mono Threads internal configuration knows*/
  87
  88 /* Logging - enable them below if you need specific logging for the category you need */
  89 #define MOSTLY_ASYNC_SAFE_PRINTF(...) do { \
  90         char __buff[1024];      __buff [0] = '\0'; \
  91         g_snprintf (__buff, sizeof (__buff), __VA_ARGS__);      \
  92         write (1, __buff, strlen (__buff));     \
  93 } while (0)
  94
  95
  96 #if 1
  97 #define THREADS_DEBUG(...)
  98 #else
  99 #define THREADS_DEBUG MOSTLY_ASYNC_SAFE_PRINTF
 100 #endif
 101
 102 #if 1
 103 #define THREADS_STW_DEBUG(...)
 104 #else
 105 #define THREADS_STW_DEBUG MOSTLY_ASYNC_SAFE_PRINTF
 106 #endif
 107
 108 #if 1
 109 #define THREADS_SUSPEND_DEBUG(...)
 110 #else
 111 #define THREADS_SUSPEND_DEBUG MOSTLY_ASYNC_SAFE_PRINTF
 112 #endif
 113
 114 #if 1
 115 #define THREADS_STATE_MACHINE_DEBUG(...)
 116 #else
 117 #define THREADS_STATE_MACHINE_DEBUG MOSTLY_ASYNC_SAFE_PRINTF
 118 #endif
 119
 120 #if 1
 121 #define THREADS_INTERRUPT_DEBUG(...)
 122 #else
 123 #define THREADS_INTERRUPT_DEBUG MOSTLY_ASYNC_SAFE_PRINTF
 124 #endif
 125
 126 /* If this is defined, use the signals backed on Mach. Debug only as signals can't be made usable on OSX. */
 127 // #define USE_SIGNALS_ON_MACH
 128
 129
 130 #if defined (USE_COOP_GC)
 131 #define USE_COOP_BACKEND
 132 #define MONO_THREADS_PLATFORM_REQUIRES_UNIFIED_SUSPEND 1
 133
 134 #elif defined (_POSIX_VERSION) || defined (__native_client__)
 135 #define MONO_THREADS_PLATFORM_REQUIRES_UNIFIED_SUSPEND 0
 136
 137 #if defined (__MACH__) && !defined (USE_SIGNALS_ON_MACH)
 138 #define USE_MACH_BACKEND
 139 #else
 140 #define USE_POSIX_BACKEND
 141 #endif
 142
 143 #elif HOST_WIN32
 144 #define MONO_THREADS_PLATFORM_REQUIRES_UNIFIED_SUSPEND 0
 145 #define USE_WINDOWS_BACKEND
 146
 147 #endif
 148
 149 enum {
 150         STATE_STARTING                          = 0x00,
 151         STATE_RUNNING                           = 0x01,
 152         STATE_DETACHED                          = 0x02,
 153
 154         STATE_ASYNC_SUSPENDED                   = 0x03,
 155         STATE_SELF_SUSPENDED                    = 0x04,
 156         STATE_ASYNC_SUSPEND_REQUESTED   = 0x05,
 157         STATE_SELF_SUSPEND_REQUESTED    = 0x06,
 158         STATE_BLOCKING                                  = 0x07,
 159         STATE_BLOCKING_AND_SUSPENDED    = 0x8,
 160
 161         STATE_MAX                                               = 0x08,
 162
 163         THREAD_STATE_MASK                       = 0x00FF,
 164         THREAD_SUSPEND_COUNT_MASK       = 0xFF00,
 165         THREAD_SUSPEND_COUNT_SHIFT      = 8,
 166         THREAD_SUSPEND_COUNT_MAX        = 0xFF,
 167
 168         SELF_SUSPEND_STATE_INDEX = 0,
 169         ASYNC_SUSPEND_STATE_INDEX = 1,
 170 };
 171
 172 /*
 173  * This enum tells which async thread service corresponds to which bit.
 174  */
 175 typedef enum {
 176         MONO_SERVICE_REQUEST_SAMPLE = 1,
 177 } MonoAsyncJob;
 178
 179 typedef struct _MonoThreadInfoInterruptToken MonoThreadInfoInterruptToken;
 180
 181 typedef struct {
 182         MonoLinkedListSetNode node;
 183         guint32 small_id; /*Used by hazard pointers */
 184         MonoNativeThreadHandle native_handle; /* Valid on mach and android */
 185         int thread_state;
 186
 187         /*Tells if this thread was created by the runtime or not.*/
 188         gboolean runtime_thread;
 189
 190         /* Tells if this thread should be ignored or not by runtime services such as GC and profiling */
 191         gboolean tools_thread;
 192
 193         /* Max stack bounds, all valid addresses must be between [stack_start_limit, stack_end[ */
 194         void *stack_start_limit, *stack_end;
 195
 196         /* suspend machinery, fields protected by suspend_semaphore */
 197         MonoSemType suspend_semaphore;
 198         int suspend_count;
 199
 200         MonoSemType resume_semaphore;
 201
 202         /* only needed by the posix backend */
 203 #if defined(USE_POSIX_BACKEND)
 204         MonoSemType finish_resume_semaphore;
 205         gboolean syscall_break_signal;
 206         gboolean suspend_can_continue;
 207         int signal;
 208
 209 #endif
 210
 211         /*In theory, only the posix backend needs this, but having it on mach/win32 simplifies things a lot.*/
 212         MonoThreadUnwindState thread_saved_state [2]; //0 is self suspend, 1 is async suspend.
 213
 214         /*async call machinery, thread MUST be suspended before accessing those fields*/
 215         void (*async_target)(void*);
 216         void *user_data;
 217
 218         /*
 219         If true, this thread is running a critical region of code and cannot be suspended.
 220         A critical session is implicitly started when you call mono_thread_info_safe_suspend_sync
 221         and is ended when you call either mono_thread_info_resume or mono_thread_info_finish_suspend.
 222         */
 223         gboolean inside_critical_region;
 224
 225         /*
 226          * If TRUE, the thread is in async context. Code can use this information to avoid async-unsafe
 227          * operations like locking without having to pass an 'async' parameter around.
 228          */
 229         gboolean is_async_context;
 230
 231         gboolean create_suspended;
 232
 233         /* Semaphore used to implement CREATE_SUSPENDED */
 234         MonoSemType create_suspended_sem;
 235
 236         /*
 237          * Values of TLS variables for this thread.
 238          * This can be used to obtain the values of TLS variable for threads
 239          * other than the current one.
 240          */
 241         gpointer tls [TLS_KEY_NUM];
 242
 243         /* IO layer handle for this thread */
 244         /* Set when the thread is started, or in _wapi_thread_duplicate () */
 245         HANDLE handle;
 246
 247         /* 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.
 248          * Use the mono_threads_add_async_job and mono_threads_consume_async_jobs APIs to modify this flag.
 249          * In the future the signaling should be part of the API, but for now, it's only for massaging the bits.
 250          */
 251         volatile gint32 service_requests;
 252
 253         void *jit_data;
 254
 255         MonoThreadInfoInterruptToken *interrupt_token;
 256 } MonoThreadInfo;
 257
 258 typedef struct {
 259         void* (*thread_register)(THREAD_INFO_TYPE *info, void *baseaddr);
 260         /*
 261         This callback is called with @info still on the thread list.
 262         This call is made while holding the suspend lock, so don't do callbacks.
 263         SMR remains functional as its small_id has not been reclaimed.
 264         */
 265         void (*thread_unregister)(THREAD_INFO_TYPE *info);
 266         /*
 267         This callback is called right before thread_unregister. This is called
 268         without any locks held so it's the place for complicated cleanup.
 269
 270         The thread must remain operational between this call and thread_unregister.
 271         It must be possible to successfully suspend it after thread_unregister completes.
 272         */
 273         void (*thread_detach)(THREAD_INFO_TYPE *info);
 274         void (*thread_attach)(THREAD_INFO_TYPE *info);
 275         gboolean (*mono_method_is_critical) (void *method);
 276         gboolean (*mono_thread_in_critical_region) (THREAD_INFO_TYPE *info);
 277 } MonoThreadInfoCallbacks;
 278
 279 typedef struct {
 280         void (*setup_async_callback) (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data);
 281         gboolean (*thread_state_init_from_sigctx) (MonoThreadUnwindState *state, void *sigctx);
 282         gboolean (*thread_state_init_from_handle) (MonoThreadUnwindState *tctx, MonoThreadInfo *info);
 283         void (*thread_state_init) (MonoThreadUnwindState *tctx);
 284 } MonoThreadInfoRuntimeCallbacks;
 285
 286 //Not using 0 and 1 to ensure callbacks are not returning bad data
 287 typedef enum {
 288         MonoResumeThread = 0x1234,
 289         KeepSuspended = 0x4321,
 290 } SuspendThreadResult;
 291
 292 typedef SuspendThreadResult (*MonoSuspendThreadCallback) (THREAD_INFO_TYPE *info, gpointer user_data);
 293
 294 static inline gboolean
 295 mono_threads_filter_tools_threads (THREAD_INFO_TYPE *info)
 296 {
 297         return !((MonoThreadInfo*)info)->tools_thread;
 298 }
 299
 300 /*
 301 Requires the world to be stoped
 302 */
 303 #define FOREACH_THREAD(thread) MONO_LLS_FOREACH_FILTERED (mono_thread_info_list_head (), thread, mono_threads_filter_tools_threads, THREAD_INFO_TYPE*)
 304 #define END_FOREACH_THREAD MONO_LLS_END_FOREACH
 305
 306 /*
 307 Snapshot iteration.
 308 */
 309 #define FOREACH_THREAD_SAFE(thread) MONO_LLS_FOREACH_FILTERED_SAFE (mono_thread_info_list_head (), thread, mono_threads_filter_tools_threads, THREAD_INFO_TYPE*)
 310 #define END_FOREACH_THREAD_SAFE MONO_LLS_END_FOREACH_SAFE
 311
 312 #define mono_thread_info_get_tid(info) ((MonoNativeThreadId)((MonoThreadInfo*)info)->node.key)
 313 #define mono_thread_info_set_tid(info, val) do { ((MonoThreadInfo*)(info))->node.key = (uintptr_t)(val); } while (0)
 314
 315 /*
 316  * @thread_info_size is sizeof (GcThreadInfo), a struct the GC defines to make it possible to have
 317  * a single block with info from both camps.
 318  */
 319 void
 320 mono_threads_init (MonoThreadInfoCallbacks *callbacks, size_t thread_info_size);
 321
 322 void
 323 mono_threads_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks);
 324
 325 MonoThreadInfoRuntimeCallbacks *
 326 mono_threads_get_runtime_callbacks (void);
 327
 328 int
 329 mono_thread_info_register_small_id (void);
 330
 331 THREAD_INFO_TYPE *
 332 mono_thread_info_attach (void *baseptr);
 333
 334 void
 335 mono_thread_info_detach (void);
 336
 337 gboolean
 338 mono_thread_info_is_exiting (void);
 339
 340 THREAD_INFO_TYPE *
 341 mono_thread_info_current (void);
 342
 343 THREAD_INFO_TYPE*
 344 mono_thread_info_current_unchecked (void);
 345
 346 int
 347 mono_thread_info_get_small_id (void);
 348
 349 MonoLinkedListSet*
 350 mono_thread_info_list_head (void);
 351
 352 THREAD_INFO_TYPE*
 353 mono_thread_info_lookup (MonoNativeThreadId id);
 354
 355 THREAD_INFO_TYPE*
 356 mono_thread_info_safe_suspend_sync (MonoNativeThreadId tid, gboolean interrupt_kernel);
 357
 358 gboolean
 359 mono_thread_info_resume (MonoNativeThreadId tid);
 360
 361 void
 362 mono_thread_info_set_name (MonoNativeThreadId tid, const char *name);
 363
 364 void
 365 mono_thread_info_safe_suspend_and_run (MonoNativeThreadId id, gboolean interrupt_kernel, MonoSuspendThreadCallback callback, gpointer user_data);
 366
 367 //XXX new API, fix the world
 368 void
 369 mono_thread_info_begin_self_suspend (void);
 370
 371 void
 372 mono_thread_info_end_self_suspend (void);
 373
 374 //END of new API
 375
 376 gboolean
 377 mono_thread_info_unified_management_enabled (void);
 378
 379 void
 380 mono_thread_info_setup_async_call (THREAD_INFO_TYPE *info, void (*target_func)(void*), void *user_data);
 381
 382 void
 383 mono_thread_info_suspend_lock (void);
 384
 385 void
 386 mono_thread_info_suspend_unlock (void);
 387
 388 void
 389 mono_thread_info_abort_socket_syscall_for_close (MonoNativeThreadId tid);
 390
 391 void
 392 mono_thread_info_set_is_async_context (gboolean async_context);
 393
 394 gboolean
 395 mono_thread_info_is_async_context (void);
 396
 397 void
 398 mono_thread_info_get_stack_bounds (guint8 **staddr, size_t *stsize);
 399
 400 gboolean
 401 mono_thread_info_yield (void);
 402
 403 gpointer
 404 mono_thread_info_tls_get (THREAD_INFO_TYPE *info, MonoTlsKey key);
 405
 406 void
 407 mono_thread_info_tls_set (THREAD_INFO_TYPE *info, MonoTlsKey key, gpointer value);
 408
 409 void
 410 mono_thread_info_exit (void);
 411
 412 HANDLE
 413 mono_thread_info_open_handle (void);
 414
 415 void
 416 mono_thread_info_install_interrupt (void (*callback) (gpointer data), gpointer data, gboolean *interrupted);
 417
 418 void
 419 mono_thread_info_uninstall_interrupt (gboolean *interrupted);
 420
 421 MonoThreadInfoInterruptToken*
 422 mono_thread_info_prepare_interrupt (THREAD_INFO_TYPE *info);
 423
 424 void
 425 mono_thread_info_finish_interrupt (MonoThreadInfoInterruptToken *token);
 426
 427 void
 428 mono_thread_info_self_interrupt (void);
 429
 430 void
 431 mono_thread_info_clear_self_interrupt (void);
 432
 433 gboolean
 434 mono_thread_info_is_interrupt_state (THREAD_INFO_TYPE *info);
 435
 436 void
 437 mono_thread_info_describe_interrupt_token (THREAD_INFO_TYPE *info, GString *text);
 438
 439 gboolean
 440 mono_thread_info_is_live (THREAD_INFO_TYPE *info);
 441
 442 HANDLE
 443 mono_threads_create_thread (LPTHREAD_START_ROUTINE start, gpointer arg, guint32 stack_size, guint32 creation_flags, MonoNativeThreadId *out_tid);
 444
 445 int
 446 mono_threads_get_max_stack_size (void);
 447
 448 HANDLE
 449 mono_threads_open_thread_handle (HANDLE handle, MonoNativeThreadId tid);
 450
 451 /*
 452 This is the async job submission/consumption API.
 453 XXX: This is a PROVISIONAL API only meant to be used by the statistical profiler.
 454 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.
 455 */
 456 gboolean
 457 mono_threads_add_async_job (THREAD_INFO_TYPE *info, MonoAsyncJob job);
 458
 459 MonoAsyncJob
 460 mono_threads_consume_async_jobs (void);
 461
 462 MONO_API void
 463 mono_threads_attach_tools_thread (void);
 464
 465
 466 #if !defined(HOST_WIN32)
 467
 468 /*Use this instead of pthread_kill */
 469 int
 470 mono_threads_pthread_kill (THREAD_INFO_TYPE *info, int signum);
 471
 472 #endif /* !defined(HOST_WIN32) */
 473
 474 /* Plartform specific functions DON'T use them */
 475 void mono_threads_init_platform (void); //ok
 476 gboolean mono_threads_core_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel);
 477 gboolean mono_threads_core_resume (THREAD_INFO_TYPE *info);
 478 void mono_threads_platform_register (THREAD_INFO_TYPE *info); //ok
 479 void mono_threads_platform_free (THREAD_INFO_TYPE *info);
 480 void mono_threads_core_abort_syscall (THREAD_INFO_TYPE *info);
 481 gboolean mono_threads_core_needs_abort_syscall (void);
 482 HANDLE mono_threads_core_create_thread (LPTHREAD_START_ROUTINE start, gpointer arg, guint32 stack_size, guint32 creation_flags, MonoNativeThreadId *out_tid);
 483 void mono_threads_core_resume_created (THREAD_INFO_TYPE *info, MonoNativeThreadId tid);
 484 void mono_threads_core_get_stack_bounds (guint8 **staddr, size_t *stsize);
 485 gboolean mono_threads_core_yield (void);
 486 void mono_threads_core_exit (int exit_code);
 487 void mono_threads_core_unregister (THREAD_INFO_TYPE *info);
 488 HANDLE mono_threads_core_open_handle (void);
 489 HANDLE mono_threads_core_open_thread_handle (HANDLE handle, MonoNativeThreadId tid);
 490 void mono_threads_core_set_name (MonoNativeThreadId tid, const char *name);
 491
 492 void mono_threads_core_begin_global_suspend (void);
 493 void mono_threads_core_end_global_suspend (void);
 494
 495 /* Internal API between mono-threads and its backends. */
 496
 497 /* Backend functions - a backend must implement all of the following */
 498 /*
 499 This is called very early in the runtime, it cannot access any runtime facilities.
 500
 501 */
 502 void mono_threads_init_platform (void); //ok
 503
 504 /*
 505 This begins async suspend. This function must do the following:
 506
 507 -Ensure the target will EINTR any syscalls if @interrupt_kernel is true
 508 -Call mono_threads_transition_finish_async_suspend as part of its async suspend.
 509 -Register the thread for pending suspend with mono_threads_add_to_pending_operation_set if needed.
 510
 511 If begin suspend fails the thread must be left uninterrupted and resumed.
 512 */
 513 gboolean mono_threads_core_begin_async_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel);
 514
 515 /*
 516 This verifies the outcome of an async suspend operation.
 517
 518 Some targets, such as posix, verify suspend results assynchronously. Suspend results must be
 519 available (in a non blocking way) after mono_threads_wait_pending_operations completes.
 520 */
 521 gboolean mono_threads_core_check_suspend_result (THREAD_INFO_TYPE *info);
 522
 523 /*
 524 This begins async resume. This function must do the following:
 525
 526 - Install an async target if one was requested.
 527 - Notify the target to resume.
 528 - Register the thread for pending ack with mono_threads_add_to_pending_operation_set if needed.
 529 */
 530 gboolean mono_threads_core_begin_async_resume (THREAD_INFO_TYPE *info);
 531
 532 void mono_threads_platform_register (THREAD_INFO_TYPE *info); //ok
 533 void mono_threads_platform_free (THREAD_INFO_TYPE *info);
 534 void mono_threads_core_abort_syscall (THREAD_INFO_TYPE *info);
 535 gboolean mono_threads_core_needs_abort_syscall (void);
 536 HANDLE mono_threads_core_create_thread (LPTHREAD_START_ROUTINE start, gpointer arg, guint32 stack_size, guint32 creation_flags, MonoNativeThreadId *out_tid);
 537 void mono_threads_core_resume_created (THREAD_INFO_TYPE *info, MonoNativeThreadId tid);
 538 void mono_threads_core_get_stack_bounds (guint8 **staddr, size_t *stsize);
 539 gboolean mono_threads_core_yield (void);
 540 void mono_threads_core_exit (int exit_code);
 541 void mono_threads_core_unregister (THREAD_INFO_TYPE *info);
 542 HANDLE mono_threads_core_open_handle (void);
 543 HANDLE mono_threads_core_open_thread_handle (HANDLE handle, MonoNativeThreadId tid);
 544 void mono_threads_core_set_name (MonoNativeThreadId tid, const char *name);
 545
 546 MonoNativeThreadId mono_native_thread_id_get (void);
 547
 548 gboolean mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2);
 549
 550 gboolean
 551 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg);
 552
 553 /*Mach specific internals */
 554 void mono_threads_init_dead_letter (void);
 555 void mono_threads_install_dead_letter (void);
 556
 557 /* mono-threads internal API used by the backends. */
 558 /*
 559 This tells the suspend initiator that we completed suspend and will now be waiting for resume.
 560 */
 561 void mono_threads_notify_initiator_of_suspend (THREAD_INFO_TYPE* info);
 562 /*
 563 This tells the resume initiator that we completed resume duties and will return to runnable state.
 564 */
 565 void mono_threads_notify_initiator_of_resume (THREAD_INFO_TYPE* info);
 566
 567 /*
 568 This tells the resume initiator that we completed abort duties and will return to previous state.
 569 */
 570 void mono_threads_notify_initiator_of_abort (THREAD_INFO_TYPE* info);
 571
 572 /* Thread state machine functions */
 573
 574 typedef enum {
 575         ResumeError,
 576         ResumeOk,
 577         ResumeInitSelfResume,
 578         ResumeInitAsyncResume,
 579         ResumeInitBlockingResume,
 580 } MonoResumeResult;
 581
 582 typedef enum {
 583         SelfSuspendResumed,
 584         SelfSuspendWait,
 585         SelfSuspendNotifyAndWait,
 586 } MonoSelfSupendResult;
 587
 588 typedef enum {
 589         AsyncSuspendAlreadySuspended,
 590         AsyncSuspendWait,
 591         AsyncSuspendInitSuspend,
 592 } MonoRequestAsyncSuspendResult;
 593
 594 typedef enum {
 595         DoBlockingContinue, //in blocking mode, continue
 596         DoBlockingPollAndRetry, //async suspend raced blocking and won, pool and retry
 597 } MonoDoBlockingResult;
 598
 599 typedef enum {
 600         DoneBlockingAborted, //blocking was aborted and not properly restored, poll the state
 601         DoneBlockingOk, //exited blocking fine
 602         DoneBlockingWait, //thread should end suspended
 603 } MonoDoneBlockingResult;
 604
 605
 606 typedef enum {
 607         AbortBlockingIgnore, //Ignore
 608         AbortBlockingIgnoreAndPoll, //Ignore and pool
 609         AbortBlockingOk, //Abort worked
 610         AbortBlockingOkAndPool, //Abort worked, but pool before
 611 } MonoAbortBlockingResult;
 612
 613
 614 void mono_threads_transition_attach (THREAD_INFO_TYPE* info);
 615 gboolean mono_threads_transition_detach (THREAD_INFO_TYPE *info);
 616 void mono_threads_transition_request_self_suspension (THREAD_INFO_TYPE *info);
 617 MonoRequestAsyncSuspendResult mono_threads_transition_request_async_suspension (THREAD_INFO_TYPE *info);
 618 MonoSelfSupendResult mono_threads_transition_state_poll (THREAD_INFO_TYPE *info);
 619 MonoResumeResult mono_threads_transition_request_resume (THREAD_INFO_TYPE* info);
 620 gboolean mono_threads_transition_finish_async_suspend (THREAD_INFO_TYPE* info);
 621 void mono_threads_transition_async_suspend_compensation (THREAD_INFO_TYPE* info);
 622 MonoDoBlockingResult mono_threads_transition_do_blocking (THREAD_INFO_TYPE* info);
 623 MonoDoneBlockingResult mono_threads_transition_done_blocking (THREAD_INFO_TYPE* info);
 624 MonoAbortBlockingResult mono_threads_transition_abort_blocking (THREAD_INFO_TYPE* info);
 625
 626 MonoThreadUnwindState* mono_thread_info_get_suspend_state (THREAD_INFO_TYPE *info);
 627
 628
 629 void mono_thread_info_wait_for_resume (THREAD_INFO_TYPE *info);
 630 /* Advanced suspend API, used for suspending multiple threads as once. */
 631 gboolean mono_thread_info_is_running (THREAD_INFO_TYPE *info);
 632 gboolean mono_thread_info_is_live (THREAD_INFO_TYPE *info);
 633 int mono_thread_info_suspend_count (THREAD_INFO_TYPE *info);
 634 int mono_thread_info_current_state (THREAD_INFO_TYPE *info);
 635
 636 gboolean mono_thread_info_in_critical_location (THREAD_INFO_TYPE *info);
 637 gboolean mono_thread_info_begin_suspend (THREAD_INFO_TYPE *info, gboolean interrupt_kernel);
 638 gboolean mono_thread_info_begin_resume (THREAD_INFO_TYPE *info);
 639
 640
 641 void mono_threads_add_to_pending_operation_set (THREAD_INFO_TYPE* info); //XXX rename to something to reflect the fact that this is used for both suspend and resume
 642 gboolean mono_threads_wait_pending_operations (void);
 643 void mono_threads_begin_global_suspend (void);
 644 void mono_threads_end_global_suspend (void);
 645
 646 #endif /* __MONO_THREADS_H__ */