2 * threadpool.c: global thread pool
5 * Dietmar Maurer (dietmar@ximian.com)
6 * Gonzalo Paniagua Javier (gonzalo@ximian.com)
8 * Copyright 2001-2003 Ximian, Inc (http://www.ximian.com)
9 * Copyright 2004-2010 Novell, Inc (http://www.novell.com)
10 * Copyright 2001 Xamarin Inc (http://www.xamarin.com)
16 #include <mono/metadata/profiler-private.h>
17 #include <mono/metadata/threads.h>
18 #include <mono/metadata/threads-types.h>
19 #include <mono/metadata/threadpool-internals.h>
20 #include <mono/metadata/exception.h>
21 #include <mono/metadata/environment.h>
22 #include <mono/metadata/mono-mlist.h>
23 #include <mono/metadata/mono-perfcounters.h>
24 #include <mono/metadata/socket-io.h>
25 #include <mono/metadata/mono-cq.h>
26 #include <mono/metadata/mono-wsq.h>
27 #include <mono/metadata/mono-ptr-array.h>
28 #include <mono/io-layer/io-layer.h>
29 #include <mono/utils/mono-time.h>
30 #include <mono/utils/mono-proclib.h>
31 #include <mono/utils/mono-semaphore.h>
33 #ifdef HAVE_SYS_TIME_H
36 #include <sys/types.h>
42 #ifdef HAVE_SYS_SOCKET_H
43 #include <sys/socket.h>
45 #include <mono/utils/mono-poll.h>
47 #include <sys/epoll.h>
50 #include <sys/event.h>
54 #ifndef DISABLE_SOCKETS
55 #include "mono/io-layer/socket-wrappers.h"
58 #include "threadpool.h"
60 #define THREAD_WANTS_A_BREAK(t) ((t->state & (ThreadState_StopRequested | \
61 ThreadState_SuspendRequested)) != 0)
63 #define SPIN_TRYLOCK(i) (InterlockedCompareExchange (&(i), 1, 0) == 0)
64 #define SPIN_LOCK(i) do { \
65 if (SPIN_TRYLOCK (i)) \
69 #define SPIN_UNLOCK(i) i = 0
70 #define SMALL_STACK (128 * (sizeof (gpointer) / 4) * 1024)
72 /* DEBUG: prints tp data every 2s */
75 /* mono_thread_pool_init called */
76 static volatile int tp_inited;
85 CRITICAL_SECTION io_lock; /* access to sock_to_state */
86 int inited; // 0 -> not initialized , 1->initializing, 2->initialized, 3->cleaned up
87 MonoGHashTable *sock_to_state;
91 void (*modify) (gpointer event_data, int fd, int operation, int events, gboolean is_new);
92 void (*wait) (gpointer sock_data);
93 void (*shutdown) (gpointer event_data);
96 static SocketIOData socket_io_data;
98 /* Keep in sync with the System.MonoAsyncCall class which provides GC tracking */
101 MonoMethodMessage *msg;
102 MonoMethod *cb_method;
103 MonoDelegate *cb_target;
111 MonoCQ *queue; /* GC root */
113 volatile gint waiting; /* threads waiting for a work item */
116 volatile gint pool_status; /* 0 -> not initialized, 1 -> initialized, 2 -> cleaning up */
117 /* min, max, n and busy -> Interlocked */
118 volatile gint min_threads;
119 volatile gint max_threads;
120 volatile gint nthreads;
121 volatile gint busy_threads;
123 void (*async_invoke) (gpointer data);
124 void *pc_nitems; /* Performance counter for total number of items in added */
125 void *pc_nthreads; /* Performance counter for total number of active threads */
127 volatile gint destroy_thread;
128 volatile gint ignore_times; /* Used when there's a thread being created or destroyed */
129 volatile gint sp_lock; /* spin lock used to protect ignore_times */
130 volatile gint64 last_check;
131 volatile gint64 time_sum;
137 static ThreadPool async_tp;
138 static ThreadPool async_io_tp;
140 static void async_invoke_thread (gpointer data);
141 static MonoObject *mono_async_invoke (ThreadPool *tp, MonoAsyncResult *ares);
142 static void threadpool_free_queue (ThreadPool *tp);
143 static void threadpool_append_job (ThreadPool *tp, MonoObject *ar);
144 static void threadpool_append_jobs (ThreadPool *tp, MonoObject **jobs, gint njobs);
145 static void threadpool_init (ThreadPool *tp, int min_threads, int max_threads, void (*async_invoke) (gpointer));
146 static void threadpool_start_idle_threads (ThreadPool *tp);
147 static void threadpool_kill_idle_threads (ThreadPool *tp);
148 static gboolean threadpool_start_thread (ThreadPool *tp);
149 static void monitor_thread (gpointer data);
150 static void socket_io_cleanup (SocketIOData *data);
151 static MonoObject *get_io_event (MonoMList **list, gint event);
152 static int get_events_from_list (MonoMList *list);
153 static int get_event_from_state (MonoSocketAsyncResult *state);
155 static MonoClass *async_call_klass;
156 static MonoClass *socket_async_call_klass;
157 static MonoClass *process_async_call_klass;
159 static GPtrArray *wsqs;
160 CRITICAL_SECTION wsqs_lock;
163 static MonoThreadPoolFunc tp_start_func;
164 static MonoThreadPoolFunc tp_finish_func;
165 static gpointer tp_hooks_user_data;
166 static MonoThreadPoolItemFunc tp_item_begin_func;
167 static MonoThreadPoolItemFunc tp_item_end_func;
168 static gpointer tp_item_user_data;
178 AIO_OP_RECV_JUST_CALLBACK,
179 AIO_OP_SEND_JUST_CALLBACK,
183 AIO_OP_ACCEPTRECEIVE,
184 AIO_OP_RECEIVE_BUFFERS,
189 #include <mono/metadata/tpool-poll.c>
191 #include <mono/metadata/tpool-epoll.c>
192 #elif defined(USE_KQUEUE_FOR_THREADPOOL)
193 #include <mono/metadata/tpool-kqueue.c>
196 * Functions to check whenever a class is given system class. We need to cache things in MonoDomain since some of the
197 * assemblies can be unloaded.
201 is_system_type (MonoDomain *domain, MonoClass *klass)
203 if (domain->system_image == NULL)
204 domain->system_image = mono_image_loaded ("System");
206 return klass->image == domain->system_image;
210 is_corlib_type (MonoDomain *domain, MonoClass *klass)
212 return klass->image == mono_defaults.corlib;
216 * Note that we call it is_socket_type() where 'socket' refers to the image
217 * that contains the System.Net.Sockets.Socket type.
220 is_socket_type (MonoDomain *domain, MonoClass *klass)
222 return is_system_type (domain, klass);
225 #define check_type_cached(domain, ASSEMBLY, _class, _namespace, _name, loc) do { \
227 return *loc == _class; \
228 if (is_##ASSEMBLY##_type (domain, _class) && !strcmp (_name, _class->name) && !strcmp (_namespace, _class->name_space)) { \
235 #define check_corlib_type_cached(domain, _class, _namespace, _name, loc) check_type_cached (domain, corlib, _class, _namespace, _name, loc)
237 #define check_socket_type_cached(domain, _class, _namespace, _name, loc) check_type_cached (domain, socket, _class, _namespace, _name, loc)
239 #define check_system_type_cached(domain, _class, _namespace, _name, loc) check_type_cached (domain, system, _class, _namespace, _name, loc)
242 is_corlib_asyncresult (MonoDomain *domain, MonoClass *klass)
244 check_corlib_type_cached (domain, klass, "System.Runtime.Remoting.Messaging", "AsyncResult", &domain->corlib_asyncresult_class);
248 is_socket (MonoDomain *domain, MonoClass *klass)
250 check_socket_type_cached (domain, klass, "System.Net.Sockets", "Socket", &domain->socket_class);
254 is_socketasyncresult (MonoDomain *domain, MonoClass *klass)
256 return (klass->nested_in &&
257 is_socket (domain, klass->nested_in) &&
258 !strcmp (klass->name, "SocketAsyncResult"));
262 is_socketasynccall (MonoDomain *domain, MonoClass *klass)
264 return (klass->nested_in &&
265 is_socket (domain, klass->nested_in) &&
266 !strcmp (klass->name, "SocketAsyncCall"));
270 is_appdomainunloaded_exception (MonoDomain *domain, MonoClass *klass)
272 check_corlib_type_cached (domain, klass, "System", "AppDomainUnloadedException", &domain->ad_unloaded_ex_class);
276 is_sd_process (MonoDomain *domain, MonoClass *klass)
278 check_system_type_cached (domain, klass, "System.Diagnostics", "Process", &domain->process_class);
282 is_sdp_asyncreadhandler (MonoDomain *domain, MonoClass *klass)
285 return (klass->nested_in &&
286 is_sd_process (domain, klass->nested_in) &&
287 !strcmp (klass->name, "AsyncReadHandler"));
291 #ifdef DISABLE_SOCKETS
293 #define socket_io_cleanup(x)
296 get_event_from_state (MonoSocketAsyncResult *state)
298 g_assert_not_reached ();
303 get_events_from_list (MonoMList *list)
311 socket_io_cleanup (SocketIOData *data)
313 EnterCriticalSection (&data->io_lock);
314 if (data->inited != 2) {
315 LeaveCriticalSection (&data->io_lock);
319 data->shutdown (data->event_data);
320 LeaveCriticalSection (&data->io_lock);
324 get_event_from_state (MonoSocketAsyncResult *state)
326 switch (state->operation) {
329 case AIO_OP_RECV_JUST_CALLBACK:
330 case AIO_OP_RECEIVEFROM:
331 case AIO_OP_READPIPE:
332 case AIO_OP_ACCEPTRECEIVE:
333 case AIO_OP_RECEIVE_BUFFERS:
336 case AIO_OP_SEND_JUST_CALLBACK:
339 case AIO_OP_SEND_BUFFERS:
340 case AIO_OP_DISCONNECT:
342 default: /* Should never happen */
343 g_message ("get_event_from_state: unknown value in switch!!!");
349 get_events_from_list (MonoMList *list)
351 MonoSocketAsyncResult *state;
354 while (list && (state = (MonoSocketAsyncResult *)mono_mlist_get_data (list))) {
355 events |= get_event_from_state (state);
356 list = mono_mlist_next (list);
362 #define ICALL_RECV(x) ves_icall_System_Net_Sockets_Socket_Receive_internal (\
363 (SOCKET)(gssize)x->handle, x->buffer, x->offset, x->size,\
364 x->socket_flags, &x->error);
366 #define ICALL_SEND(x) ves_icall_System_Net_Sockets_Socket_Send_internal (\
367 (SOCKET)(gssize)x->handle, x->buffer, x->offset, x->size,\
368 x->socket_flags, &x->error);
370 #endif /* !DISABLE_SOCKETS */
373 threadpool_jobs_inc (MonoObject *obj)
376 InterlockedIncrement (&obj->vtable->domain->threadpool_jobs);
380 threadpool_jobs_dec (MonoObject *obj)
388 domain = obj->vtable->domain;
389 remaining_jobs = InterlockedDecrement (&domain->threadpool_jobs);
390 if (remaining_jobs == 0 && domain->cleanup_semaphore) {
391 ReleaseSemaphore (domain->cleanup_semaphore, 1, NULL);
398 get_io_event (MonoMList **list, gint event)
408 state = mono_mlist_get_data (current);
409 if (get_event_from_state ((MonoSocketAsyncResult *) state) == event)
414 current = mono_mlist_next (current);
419 mono_mlist_set_next (prev, mono_mlist_next (current));
421 *list = mono_mlist_next (*list);
429 * select/poll wake up when a socket is closed, but epoll just removes
430 * the socket from its internal list without notification.
433 mono_thread_pool_remove_socket (int sock)
436 MonoSocketAsyncResult *state;
439 if (socket_io_data.inited == 0)
442 EnterCriticalSection (&socket_io_data.io_lock);
443 if (socket_io_data.sock_to_state == NULL) {
444 LeaveCriticalSection (&socket_io_data.io_lock);
447 list = mono_g_hash_table_lookup (socket_io_data.sock_to_state, GINT_TO_POINTER (sock));
449 mono_g_hash_table_remove (socket_io_data.sock_to_state, GINT_TO_POINTER (sock));
450 LeaveCriticalSection (&socket_io_data.io_lock);
453 state = (MonoSocketAsyncResult *) mono_mlist_get_data (list);
454 if (state->operation == AIO_OP_RECEIVE)
455 state->operation = AIO_OP_RECV_JUST_CALLBACK;
456 else if (state->operation == AIO_OP_SEND)
457 state->operation = AIO_OP_SEND_JUST_CALLBACK;
459 ares = get_io_event (&list, MONO_POLLIN);
460 threadpool_append_job (&async_io_tp, ares);
462 ares = get_io_event (&list, MONO_POLLOUT);
463 threadpool_append_job (&async_io_tp, ares);
469 init_event_system (SocketIOData *data)
472 if (data->event_system == EPOLL_BACKEND) {
473 data->event_data = tp_epoll_init (data);
474 if (data->event_data == NULL) {
475 if (g_getenv ("MONO_DEBUG"))
476 g_message ("Falling back to poll()");
477 data->event_system = POLL_BACKEND;
480 #elif defined(USE_KQUEUE_FOR_THREADPOOL)
481 if (data->event_system == KQUEUE_BACKEND)
482 data->event_data = tp_kqueue_init (data);
484 if (data->event_system == POLL_BACKEND)
485 data->event_data = tp_poll_init (data);
489 socket_io_init (SocketIOData *data)
493 if (data->inited >= 2) // 2 -> initialized, 3-> cleaned up
496 inited = InterlockedCompareExchange (&data->inited, 1, 0);
499 if (data->inited >= 2)
505 EnterCriticalSection (&data->io_lock);
506 data->sock_to_state = mono_g_hash_table_new_type (g_direct_hash, g_direct_equal, MONO_HASH_VALUE_GC);
508 data->event_system = EPOLL_BACKEND;
509 #elif defined(USE_KQUEUE_FOR_THREADPOOL)
510 data->event_system = KQUEUE_BACKEND;
512 data->event_system = POLL_BACKEND;
514 if (g_getenv ("MONO_DISABLE_AIO") != NULL)
515 data->event_system = POLL_BACKEND;
517 init_event_system (data);
518 mono_thread_create_internal (mono_get_root_domain (), data->wait, data, TRUE, SMALL_STACK);
519 LeaveCriticalSection (&data->io_lock);
521 threadpool_start_thread (&async_io_tp);
525 socket_io_add (MonoAsyncResult *ares, MonoSocketAsyncResult *state)
528 SocketIOData *data = &socket_io_data;
533 socket_io_init (&socket_io_data);
534 if (mono_runtime_is_shutting_down () || data->inited == 3 || data->sock_to_state == NULL)
536 if (async_tp.pool_status == 2)
539 MONO_OBJECT_SETREF (state, ares, ares);
541 fd = GPOINTER_TO_INT (state->handle);
542 EnterCriticalSection (&data->io_lock);
543 if (data->sock_to_state == NULL) {
544 LeaveCriticalSection (&data->io_lock);
547 list = mono_g_hash_table_lookup (data->sock_to_state, GINT_TO_POINTER (fd));
549 list = mono_mlist_alloc ((MonoObject*)state);
552 list = mono_mlist_append (list, (MonoObject*)state);
556 mono_g_hash_table_replace (data->sock_to_state, state->handle, list);
557 ievt = get_events_from_list (list);
558 LeaveCriticalSection (&data->io_lock);
559 data->modify (data->event_data, fd, state->operation, ievt, is_new);
562 #ifndef DISABLE_SOCKETS
564 socket_io_filter (MonoObject *target, MonoObject *state)
567 MonoSocketAsyncResult *sock_res;
571 if (target == NULL || state == NULL)
574 domain = target->vtable->domain;
575 klass = target->vtable->klass;
576 if (socket_async_call_klass == NULL && is_socketasynccall (domain, klass))
577 socket_async_call_klass = klass;
579 if (process_async_call_klass == NULL && is_sdp_asyncreadhandler (domain, klass))
580 process_async_call_klass = klass;
582 if (klass != socket_async_call_klass && klass != process_async_call_klass)
585 sock_res = (MonoSocketAsyncResult *) state;
586 op = sock_res->operation;
587 if (op < AIO_OP_FIRST || op >= AIO_OP_LAST)
592 #endif /* !DISABLE_SOCKETS */
594 /* Returns the exception thrown when invoking, if any */
596 mono_async_invoke (ThreadPool *tp, MonoAsyncResult *ares)
598 ASyncCall *ac = (ASyncCall *)ares->object_data;
599 MonoObject *res, *exc = NULL;
600 MonoArray *out_args = NULL;
601 HANDLE wait_event = NULL;
603 if (ares->execution_context) {
604 /* use captured ExecutionContext (if available) */
605 MONO_OBJECT_SETREF (ares, original_context, mono_thread_get_execution_context ());
606 mono_thread_set_execution_context (ares->execution_context);
608 ares->original_context = NULL;
612 /* Fast path from ThreadPool.*QueueUserWorkItem */
613 void *pa = ares->async_state;
614 res = mono_runtime_delegate_invoke (ares->async_delegate, &pa, &exc);
616 MonoObject *cb_exc = NULL;
619 res = mono_message_invoke (ares->async_delegate, ac->msg, &exc, &out_args);
620 MONO_OBJECT_SETREF (ac, res, res);
621 MONO_OBJECT_SETREF (ac, msg->exc, exc);
622 MONO_OBJECT_SETREF (ac, out_args, out_args);
624 mono_monitor_enter ((MonoObject *) ares);
626 if (ares->handle != NULL)
627 wait_event = mono_wait_handle_get_handle ((MonoWaitHandle *) ares->handle);
628 mono_monitor_exit ((MonoObject *) ares);
629 /* notify listeners */
630 if (wait_event != NULL)
631 SetEvent (wait_event);
633 /* call async callback if cb_method != null*/
634 if (ac != NULL && ac->cb_method) {
637 mono_runtime_invoke (ac->cb_method, ac->cb_target, pa, &cb_exc);
644 /* restore original thread execution context if flow isn't suppressed, i.e. non null */
645 if (ares->original_context) {
646 mono_thread_set_execution_context (ares->original_context);
647 ares->original_context = NULL;
653 threadpool_start_idle_threads (ThreadPool *tp)
658 stack_size = (!tp->is_io) ? 0 : SMALL_STACK;
662 if (n >= tp->min_threads)
664 if (InterlockedCompareExchange (&tp->nthreads, n + 1, n) == n)
667 #ifndef DISABLE_PERFCOUNTERS
668 mono_perfcounter_update_value (tp->pc_nthreads, TRUE, 1);
670 mono_thread_create_internal (mono_get_root_domain (), tp->async_invoke, tp, TRUE, stack_size);
676 threadpool_init (ThreadPool *tp, int min_threads, int max_threads, void (*async_invoke) (gpointer))
678 memset (tp, 0, sizeof (ThreadPool));
679 tp->min_threads = min_threads;
680 tp->max_threads = max_threads;
681 tp->async_invoke = async_invoke;
682 tp->queue = mono_cq_create ();
683 MONO_SEM_INIT (&tp->new_job, 0);
686 #ifndef DISABLE_PERFCOUNTERS
688 init_perf_counter (const char *category, const char *counter)
690 MonoString *category_str;
691 MonoString *counter_str;
697 if (category == NULL || counter == NULL)
699 root = mono_get_root_domain ();
700 category_str = mono_string_new (root, category);
701 counter_str = mono_string_new (root, counter);
702 machine = mono_string_new (root, ".");
703 return mono_perfcounter_get_impl (category_str, counter_str, NULL, machine, &type, &custom);
709 print_pool_info (ThreadPool *tp)
712 // if (tp->tail - tp->head == 0)
715 g_print ("Pool status? %d\n", InterlockedCompareExchange (&tp->pool_status, 0, 0));
716 g_print ("Min. threads: %d\n", InterlockedCompareExchange (&tp->min_threads, 0, 0));
717 g_print ("Max. threads: %d\n", InterlockedCompareExchange (&tp->max_threads, 0, 0));
718 g_print ("nthreads: %d\n", InterlockedCompareExchange (&tp->nthreads, 0, 0));
719 g_print ("busy threads: %d\n", InterlockedCompareExchange (&tp->busy_threads, 0, 0));
720 g_print ("Waiting: %d\n", InterlockedCompareExchange (&tp->waiting, 0, 0));
721 g_print ("Queued: %d\n", (tp->tail - tp->head));
722 if (tp == &async_tp) {
724 EnterCriticalSection (&wsqs_lock);
725 for (i = 0; i < wsqs->len; i++) {
726 g_print ("\tWSQ %d: %d\n", i, mono_wsq_count (g_ptr_array_index (wsqs, i)));
728 LeaveCriticalSection (&wsqs_lock);
730 g_print ("\tSockets: %d\n", mono_g_hash_table_size (socket_io_data.sock_to_state));
732 g_print ("-------------\n");
736 signal_handler (int signo)
741 g_print ("\n-----Non-IO-----\n");
742 print_pool_info (tp);
744 g_print ("\n-----IO-----\n");
745 print_pool_info (tp);
751 monitor_thread (gpointer unused)
753 ThreadPool *pools [2];
754 MonoInternalThread *thread;
759 pools [0] = &async_tp;
760 pools [1] = &async_io_tp;
761 thread = mono_thread_internal_current ();
762 ves_icall_System_Threading_Thread_SetName_internal (thread, mono_string_new (mono_domain_get (), "Threadpool monitor"));
767 ts = mono_msec_ticks ();
768 if (SleepEx (ms, TRUE) == 0)
770 ms -= (mono_msec_ticks () - ts);
771 if (mono_runtime_is_shutting_down ())
773 if (THREAD_WANTS_A_BREAK (thread))
774 mono_thread_interruption_checkpoint ();
777 if (mono_runtime_is_shutting_down ())
780 for (i = 0; i < 2; i++) {
785 need_one = (mono_cq_count (tp->queue) > 0);
786 if (!need_one && !tp->is_io) {
787 EnterCriticalSection (&wsqs_lock);
788 for (i = 0; wsqs != NULL && i < wsqs->len; i++) {
790 wsq = g_ptr_array_index (wsqs, i);
791 if (mono_wsq_count (wsq) != 0) {
796 LeaveCriticalSection (&wsqs_lock);
799 threadpool_start_thread (tp);
805 mono_thread_pool_init ()
807 gint threads_per_cpu = 1;
809 gint cpu_count = mono_cpu_count ();
815 result = InterlockedCompareExchange (&tp_inited, 1, 0);
824 MONO_GC_REGISTER_ROOT_FIXED (socket_io_data.sock_to_state);
825 InitializeCriticalSection (&socket_io_data.io_lock);
826 if (g_getenv ("MONO_THREADS_PER_CPU") != NULL) {
827 threads_per_cpu = atoi (g_getenv ("MONO_THREADS_PER_CPU"));
828 if (threads_per_cpu < 1)
832 thread_count = MIN (cpu_count * threads_per_cpu, 100 * cpu_count);
833 threadpool_init (&async_tp, thread_count, MAX (100 * cpu_count, thread_count), async_invoke_thread);
834 threadpool_init (&async_io_tp, cpu_count * 2, cpu_count * 4, async_invoke_thread);
835 async_io_tp.is_io = TRUE;
837 async_call_klass = mono_class_from_name (mono_defaults.corlib, "System", "MonoAsyncCall");
838 g_assert (async_call_klass);
840 InitializeCriticalSection (&wsqs_lock);
841 wsqs = g_ptr_array_sized_new (MAX (100 * cpu_count, thread_count));
844 #ifndef DISABLE_PERFCOUNTERS
845 async_tp.pc_nitems = init_perf_counter ("Mono Threadpool", "Work Items Added");
846 g_assert (async_tp.pc_nitems);
848 async_io_tp.pc_nitems = init_perf_counter ("Mono Threadpool", "IO Work Items Added");
849 g_assert (async_io_tp.pc_nitems);
851 async_tp.pc_nthreads = init_perf_counter ("Mono Threadpool", "# of Threads");
852 g_assert (async_tp.pc_nthreads);
854 async_io_tp.pc_nthreads = init_perf_counter ("Mono Threadpool", "# of IO Threads");
855 g_assert (async_io_tp.pc_nthreads);
859 signal (SIGALRM, signal_handler);
864 static MonoAsyncResult *
865 create_simple_asyncresult (MonoObject *target, MonoObject *state)
867 MonoDomain *domain = mono_domain_get ();
868 MonoAsyncResult *ares;
870 /* Don't call mono_async_result_new() to avoid capturing the context */
871 ares = (MonoAsyncResult *) mono_object_new (domain, mono_defaults.asyncresult_class);
872 MONO_OBJECT_SETREF (ares, async_delegate, target);
873 MONO_OBJECT_SETREF (ares, async_state, state);
878 icall_append_io_job (MonoObject *target, MonoSocketAsyncResult *state)
880 MonoAsyncResult *ares;
882 ares = create_simple_asyncresult (target, (MonoObject *) state);
883 socket_io_add (ares, state);
887 mono_thread_pool_add (MonoObject *target, MonoMethodMessage *msg, MonoDelegate *async_callback,
890 MonoDomain *domain = mono_domain_get ();
891 MonoAsyncResult *ares;
894 ac = (ASyncCall*)mono_object_new (domain, async_call_klass);
895 MONO_OBJECT_SETREF (ac, msg, msg);
896 MONO_OBJECT_SETREF (ac, state, state);
898 if (async_callback) {
899 ac->cb_method = mono_get_delegate_invoke (((MonoObject *)async_callback)->vtable->klass);
900 MONO_OBJECT_SETREF (ac, cb_target, async_callback);
903 ares = mono_async_result_new (domain, NULL, ac->state, NULL, (MonoObject*)ac);
904 MONO_OBJECT_SETREF (ares, async_delegate, target);
906 #ifndef DISABLE_SOCKETS
907 if (socket_io_filter (target, state)) {
908 socket_io_add (ares, (MonoSocketAsyncResult *) state);
912 threadpool_append_job (&async_tp, (MonoObject *) ares);
917 mono_thread_pool_finish (MonoAsyncResult *ares, MonoArray **out_args, MonoObject **exc)
925 /* check if already finished */
926 mono_monitor_enter ((MonoObject *) ares);
928 if (ares->endinvoke_called) {
929 *exc = (MonoObject *) mono_get_exception_invalid_operation (NULL);
930 mono_monitor_exit ((MonoObject *) ares);
934 ares->endinvoke_called = 1;
935 /* wait until we are really finished */
936 if (!ares->completed) {
937 if (ares->handle == NULL) {
938 wait_event = CreateEvent (NULL, TRUE, FALSE, NULL);
939 g_assert(wait_event != 0);
940 MONO_OBJECT_SETREF (ares, handle, (MonoObject *) mono_wait_handle_new (mono_object_domain (ares), wait_event));
942 wait_event = mono_wait_handle_get_handle ((MonoWaitHandle *) ares->handle);
944 mono_monitor_exit ((MonoObject *) ares);
945 WaitForSingleObjectEx (wait_event, INFINITE, TRUE);
947 mono_monitor_exit ((MonoObject *) ares);
950 ac = (ASyncCall *) ares->object_data;
951 g_assert (ac != NULL);
952 *exc = ac->msg->exc; /* FIXME: GC add write barrier */
953 *out_args = ac->out_args;
959 threadpool_kill_idle_threads (ThreadPool *tp)
963 n = (gint) InterlockedCompareExchange (&tp->max_threads, 0, -1);
966 MONO_SEM_POST (&tp->new_job);
971 mono_thread_pool_cleanup (void)
973 if (InterlockedExchange (&async_io_tp.pool_status, 2) == 1) {
974 socket_io_cleanup (&socket_io_data); /* Empty when DISABLE_SOCKETS is defined */
975 threadpool_kill_idle_threads (&async_io_tp);
978 if (async_io_tp.queue != NULL) {
979 MONO_SEM_DESTROY (&async_io_tp.new_job);
980 threadpool_free_queue (&async_io_tp);
984 if (InterlockedExchange (&async_tp.pool_status, 2) == 1) {
985 threadpool_kill_idle_threads (&async_tp);
986 threadpool_free_queue (&async_tp);
990 EnterCriticalSection (&wsqs_lock);
993 g_ptr_array_free (wsqs, TRUE);
995 LeaveCriticalSection (&wsqs_lock);
996 MONO_SEM_DESTROY (&async_tp.new_job);
1001 threadpool_start_thread (ThreadPool *tp)
1006 stack_size = (!tp->is_io) ? 0 : SMALL_STACK;
1007 while (!mono_runtime_is_shutting_down () && (n = tp->nthreads) < tp->max_threads) {
1008 if (InterlockedCompareExchange (&tp->nthreads, n + 1, n) == n) {
1009 #ifndef DISABLE_PERFCOUNTERS
1010 mono_perfcounter_update_value (tp->pc_nthreads, TRUE, 1);
1012 mono_thread_create_internal (mono_get_root_domain (), tp->async_invoke, tp, TRUE, stack_size);
1021 pulse_on_new_job (ThreadPool *tp)
1024 MONO_SEM_POST (&tp->new_job);
1028 icall_append_job (MonoObject *ar)
1030 threadpool_append_jobs (&async_tp, &ar, 1);
1034 threadpool_append_job (ThreadPool *tp, MonoObject *ar)
1036 threadpool_append_jobs (tp, &ar, 1);
1040 threadpool_append_jobs (ThreadPool *tp, MonoObject **jobs, gint njobs)
1042 static int job_counter;
1046 if (mono_runtime_is_shutting_down ())
1049 if (tp->pool_status == 0 && InterlockedCompareExchange (&tp->pool_status, 1, 0) == 0) {
1051 mono_thread_create_internal (mono_get_root_domain (), monitor_thread, NULL, TRUE, SMALL_STACK);
1052 threadpool_start_thread (tp);
1054 /* Create on demand up to min_threads to avoid startup penalty for apps that don't use
1055 * the threadpool that much
1056 * mono_thread_create_internal (mono_get_root_domain (), threadpool_start_idle_threads, tp, TRUE, SMALL_STACK);
1060 for (i = 0; i < njobs; i++) {
1062 if (ar == NULL || mono_domain_is_unloading (ar->vtable->domain))
1063 continue; /* Might happen when cleaning domain jobs */
1064 if (!tp->is_io && (InterlockedIncrement (&job_counter) % 10) == 0) {
1065 MonoAsyncResult *o = (MonoAsyncResult *) ar;
1066 o->add_time = mono_100ns_ticks ();
1068 threadpool_jobs_inc (ar);
1069 #ifndef DISABLE_PERFCOUNTERS
1070 mono_perfcounter_update_value (tp->pc_nitems, TRUE, 1);
1072 if (!tp->is_io && mono_wsq_local_push (ar))
1075 mono_cq_enqueue (tp->queue, ar);
1078 for (i = 0; tp->waiting > 0 && i < MIN(njobs, tp->max_threads); i++)
1079 pulse_on_new_job (tp);
1083 threadpool_clear_queue (ThreadPool *tp, MonoDomain *domain)
1089 while (mono_cq_dequeue (tp->queue, &obj)) {
1092 if (obj->vtable->domain != domain)
1093 other = mono_mlist_prepend (other, obj);
1094 threadpool_jobs_dec (obj);
1098 threadpool_append_job (tp, (MonoObject *) mono_mlist_get_data (other));
1099 other = mono_mlist_next (other);
1104 remove_sockstate_for_domain (gpointer key, gpointer value, gpointer user_data)
1106 MonoMList *list = value;
1107 gboolean remove = FALSE;
1109 MonoObject *data = mono_mlist_get_data (list);
1110 if (mono_object_domain (data) == user_data) {
1112 mono_mlist_set_data (list, NULL);
1114 list = mono_mlist_next (list);
1116 //FIXME is there some sort of additional unregistration we need to perform here?
1121 * Clean up the threadpool of all domain jobs.
1122 * Can only be called as part of the domain unloading process as
1123 * it will wait for all jobs to be visible to the interruption code.
1126 mono_thread_pool_remove_domain_jobs (MonoDomain *domain, int timeout)
1130 guint32 start_time = 0;
1132 g_assert (domain->state == MONO_APPDOMAIN_UNLOADING);
1134 threadpool_clear_queue (&async_tp, domain);
1135 threadpool_clear_queue (&async_io_tp, domain);
1137 EnterCriticalSection (&socket_io_data.io_lock);
1138 if (socket_io_data.sock_to_state)
1139 mono_g_hash_table_foreach_remove (socket_io_data.sock_to_state, remove_sockstate_for_domain, domain);
1141 LeaveCriticalSection (&socket_io_data.io_lock);
1144 * There might be some threads out that could be about to execute stuff from the given domain.
1145 * We avoid that by setting up a semaphore to be pulsed by the thread that reaches zero.
1147 sem_handle = CreateSemaphore (NULL, 0, 1, NULL);
1149 domain->cleanup_semaphore = sem_handle;
1151 * The memory barrier here is required to have global ordering between assigning to cleanup_semaphone
1152 * and reading threadpool_jobs.
1153 * Otherwise this thread could read a stale version of threadpool_jobs and wait forever.
1155 mono_memory_write_barrier ();
1157 if (domain->threadpool_jobs && timeout != -1)
1158 start_time = mono_msec_ticks ();
1159 while (domain->threadpool_jobs) {
1160 WaitForSingleObject (sem_handle, timeout);
1161 if (timeout != -1 && (mono_msec_ticks () - start_time) > timeout) {
1167 domain->cleanup_semaphore = NULL;
1168 CloseHandle (sem_handle);
1173 threadpool_free_queue (ThreadPool *tp)
1175 mono_cq_destroy (tp->queue);
1180 mono_thread_pool_is_queue_array (MonoArray *o)
1182 // gpointer obj = o;
1184 // FIXME: need some fix in sgen code.
1194 EnterCriticalSection (&wsqs_lock);
1195 wsq = mono_wsq_create ();
1197 LeaveCriticalSection (&wsqs_lock);
1200 for (i = 0; i < wsqs->len; i++) {
1201 if (g_ptr_array_index (wsqs, i) == NULL) {
1202 wsqs->pdata [i] = wsq;
1203 LeaveCriticalSection (&wsqs_lock);
1207 g_ptr_array_add (wsqs, wsq);
1208 LeaveCriticalSection (&wsqs_lock);
1213 remove_wsq (MonoWSQ *wsq)
1220 EnterCriticalSection (&wsqs_lock);
1222 LeaveCriticalSection (&wsqs_lock);
1225 g_ptr_array_remove_fast (wsqs, wsq);
1228 * Only clean this up when shutting down, any other case will error out
1229 * if we're removing a queue that still has work items.
1231 if (mono_runtime_is_shutting_down ()) {
1232 while (mono_wsq_local_pop (&data)) {
1233 threadpool_jobs_dec (data);
1237 mono_wsq_destroy (wsq);
1238 LeaveCriticalSection (&wsqs_lock);
1242 try_steal (MonoWSQ *local_wsq, gpointer *data, gboolean retry)
1247 if (wsqs == NULL || data == NULL || *data != NULL)
1252 if (mono_runtime_is_shutting_down ())
1255 EnterCriticalSection (&wsqs_lock);
1256 for (i = 0; wsqs != NULL && i < wsqs->len; i++) {
1259 wsq = wsqs->pdata [i];
1260 if (wsq == local_wsq || mono_wsq_count (wsq) == 0)
1262 mono_wsq_try_steal (wsqs->pdata [i], data, ms);
1263 if (*data != NULL) {
1264 LeaveCriticalSection (&wsqs_lock);
1268 LeaveCriticalSection (&wsqs_lock);
1270 } while (retry && ms < 11);
1274 dequeue_or_steal (ThreadPool *tp, gpointer *data, MonoWSQ *local_wsq)
1276 if (mono_runtime_is_shutting_down ())
1278 mono_cq_dequeue (tp->queue, (MonoObject **) data);
1279 if (!tp->is_io && !*data)
1280 try_steal (local_wsq, data, FALSE);
1281 return (*data != NULL);
1285 process_idle_times (ThreadPool *tp, gint64 t)
1289 gboolean compute_avg;
1293 if (tp->ignore_times || t <= 0)
1296 compute_avg = FALSE;
1297 ticks = mono_100ns_ticks ();
1299 SPIN_LOCK (tp->sp_lock);
1300 if (tp->ignore_times) {
1301 SPIN_UNLOCK (tp->sp_lock);
1306 if (tp->last_check == 0)
1307 tp->last_check = ticks;
1308 else if (tp->last_check > 0 && (ticks - tp->last_check) > 5000000) {
1309 tp->ignore_times = 1;
1312 SPIN_UNLOCK (tp->sp_lock);
1317 //printf ("Items: %d Time elapsed: %.3fs\n", tp->n_sum, (ticks - tp->last_check) / 10000.0);
1318 tp->last_check = ticks;
1320 avg = tp->time_sum / tp->n_sum;
1321 if (tp->averages [1] == 0) {
1322 tp->averages [1] = avg;
1324 per1 = ((100 * (ABS (avg - tp->averages [1]))) / tp->averages [1]);
1326 if (avg > tp->averages [1]) {
1327 if (tp->averages [1] < tp->averages [0]) {
1332 } else if (avg < tp->averages [1] && tp->averages [1] < tp->averages [0]) {
1337 min = tp->min_threads;
1339 if ((n - min) < min && tp->busy_threads == n)
1343 if (new_threads != 0) {
1344 printf ("n: %d per1: %lld avg=%lld avg1=%lld avg0=%lld\n", new_threads, per1, avg, tp->averages [1], tp->averages [0]);
1352 tp->averages [0] = tp->averages [1];
1353 tp->averages [1] = avg;
1354 tp->ignore_times = 0;
1356 if (new_threads == -1) {
1357 if (tp->destroy_thread == 0 && InterlockedCompareExchange (&tp->destroy_thread, 1, 0) == 0)
1358 pulse_on_new_job (tp);
1363 should_i_die (ThreadPool *tp)
1365 gboolean result = FALSE;
1366 if (tp->destroy_thread == 1 && InterlockedCompareExchange (&tp->destroy_thread, 0, 1) == 1)
1367 result = (tp->nthreads > tp->min_threads);
1372 async_invoke_thread (gpointer data)
1375 MonoInternalThread *thread;
1386 thread = mono_thread_internal_current ();
1388 mono_profiler_thread_start (thread->tid);
1389 name = (tp->is_io) ? "IO Threadpool worker" : "Threadpool worker";
1390 mono_thread_set_name_internal (thread, mono_string_new (mono_domain_get (), name), FALSE);
1393 tp_start_func (tp_hooks_user_data);
1397 MonoAsyncResult *ar;
1399 gboolean is_io_task;
1404 ar = (MonoAsyncResult *) data;
1406 InterlockedIncrement (&tp->busy_threads);
1407 domain = ((MonoObject *)ar)->vtable->domain;
1408 #ifndef DISABLE_SOCKETS
1409 klass = ((MonoObject *) data)->vtable->klass;
1410 is_io_task = !is_corlib_asyncresult (domain, klass);
1413 MonoSocketAsyncResult *state = (MonoSocketAsyncResult *) data;
1414 is_socket = is_socketasyncresult (domain, klass);
1416 switch (state->operation) {
1417 case AIO_OP_RECEIVE:
1418 state->total = ICALL_RECV (state);
1421 state->total = ICALL_SEND (state);
1426 /* worker threads invokes methods in different domains,
1427 * so we need to set the right domain here */
1430 if (mono_domain_is_unloading (domain) || mono_runtime_is_shutting_down ()) {
1431 threadpool_jobs_dec ((MonoObject *)ar);
1434 InterlockedDecrement (&tp->busy_threads);
1436 mono_thread_push_appdomain_ref (domain);
1437 if (threadpool_jobs_dec ((MonoObject *)ar)) {
1440 mono_thread_pop_appdomain_ref ();
1441 InterlockedDecrement (&tp->busy_threads);
1445 if (mono_domain_set (domain, FALSE)) {
1448 if (tp_item_begin_func)
1449 tp_item_begin_func (tp_item_user_data);
1451 if (!is_io_task && ar->add_time > 0)
1452 process_idle_times (tp, ar->add_time);
1453 exc = mono_async_invoke (tp, ar);
1454 if (tp_item_end_func)
1455 tp_item_end_func (tp_item_user_data);
1457 mono_internal_thread_unhandled_exception (exc);
1458 if (is_socket && tp->is_io) {
1459 MonoSocketAsyncResult *state = (MonoSocketAsyncResult *) data;
1461 if (state->completed && state->callback) {
1462 MonoAsyncResult *cb_ares;
1463 cb_ares = create_simple_asyncresult ((MonoObject *) state->callback,
1464 (MonoObject *) state);
1465 icall_append_job ((MonoObject *) cb_ares);
1468 mono_domain_set (mono_get_root_domain (), TRUE);
1470 mono_thread_pop_appdomain_ref ();
1471 InterlockedDecrement (&tp->busy_threads);
1472 /* If the callee changes the background status, set it back to TRUE */
1473 mono_thread_clr_state (thread , ~ThreadState_Background);
1474 if (!mono_thread_test_state (thread , ThreadState_Background))
1475 ves_icall_System_Threading_Thread_SetState (thread, ThreadState_Background);
1481 must_die = should_i_die (tp);
1482 if (!must_die && (tp->is_io || !mono_wsq_local_pop (&data)))
1483 dequeue_or_steal (tp, &data, wsq);
1486 while (!must_die && !data && n_naps < 4) {
1489 InterlockedIncrement (&tp->waiting);
1491 // Another thread may have added a job into its wsq since the last call to dequeue_or_steal
1492 // Check all the queues again before entering the wait loop
1493 dequeue_or_steal (tp, &data, wsq);
1495 InterlockedDecrement (&tp->waiting);
1499 mono_gc_set_skip_thread (TRUE);
1501 #if defined(__OpenBSD__)
1502 while (mono_cq_count (tp->queue) == 0 && (res = mono_sem_wait (&tp->new_job, TRUE)) == -1) {// && errno == EINTR) {
1504 while (mono_cq_count (tp->queue) == 0 && (res = mono_sem_timedwait (&tp->new_job, 2000, TRUE)) == -1) {// && errno == EINTR) {
1506 if (mono_runtime_is_shutting_down ())
1508 if (THREAD_WANTS_A_BREAK (thread))
1509 mono_thread_interruption_checkpoint ();
1511 InterlockedDecrement (&tp->waiting);
1513 mono_gc_set_skip_thread (FALSE);
1515 if (mono_runtime_is_shutting_down ())
1517 must_die = should_i_die (tp);
1518 dequeue_or_steal (tp, &data, wsq);
1522 if (!data && !tp->is_io && !mono_runtime_is_shutting_down ()) {
1523 mono_wsq_local_pop (&data);
1524 if (data && must_die) {
1525 InterlockedCompareExchange (&tp->destroy_thread, 1, 0);
1526 pulse_on_new_job (tp);
1535 down = mono_runtime_is_shutting_down ();
1536 if (!down && nt <= tp->min_threads)
1538 if (down || InterlockedCompareExchange (&tp->nthreads, nt - 1, nt) == nt) {
1539 #ifndef DISABLE_PERFCOUNTERS
1540 mono_perfcounter_update_value (tp->pc_nthreads, TRUE, -1);
1546 mono_profiler_thread_end (thread->tid);
1549 tp_finish_func (tp_hooks_user_data);
1556 g_assert_not_reached ();
1560 ves_icall_System_Threading_ThreadPool_GetAvailableThreads (gint *workerThreads, gint *completionPortThreads)
1562 *workerThreads = async_tp.max_threads - async_tp.busy_threads;
1563 *completionPortThreads = async_io_tp.max_threads - async_io_tp.busy_threads;
1567 ves_icall_System_Threading_ThreadPool_GetMaxThreads (gint *workerThreads, gint *completionPortThreads)
1569 *workerThreads = async_tp.max_threads;
1570 *completionPortThreads = async_io_tp.max_threads;
1574 ves_icall_System_Threading_ThreadPool_GetMinThreads (gint *workerThreads, gint *completionPortThreads)
1576 *workerThreads = async_tp.min_threads;
1577 *completionPortThreads = async_io_tp.min_threads;
1581 ves_icall_System_Threading_ThreadPool_SetMinThreads (gint workerThreads, gint completionPortThreads)
1584 gint max_io_threads;
1586 max_threads = async_tp.max_threads;
1587 if (workerThreads <= 0 || workerThreads > max_threads)
1590 max_io_threads = async_io_tp.max_threads;
1591 if (completionPortThreads <= 0 || completionPortThreads > max_io_threads)
1594 InterlockedExchange (&async_tp.min_threads, workerThreads);
1595 InterlockedExchange (&async_io_tp.min_threads, completionPortThreads);
1596 if (workerThreads > async_tp.nthreads)
1597 mono_thread_create_internal (mono_get_root_domain (), threadpool_start_idle_threads, &async_tp, TRUE, SMALL_STACK);
1598 if (completionPortThreads > async_io_tp.nthreads)
1599 mono_thread_create_internal (mono_get_root_domain (), threadpool_start_idle_threads, &async_io_tp, TRUE, SMALL_STACK);
1604 ves_icall_System_Threading_ThreadPool_SetMaxThreads (gint workerThreads, gint completionPortThreads)
1607 gint min_io_threads;
1610 cpu_count = mono_cpu_count ();
1611 min_threads = async_tp.min_threads;
1612 if (workerThreads < min_threads || workerThreads < cpu_count)
1615 /* We don't really have the concept of completion ports. Do we care here? */
1616 min_io_threads = async_io_tp.min_threads;
1617 if (completionPortThreads < min_io_threads || completionPortThreads < cpu_count)
1620 InterlockedExchange (&async_tp.max_threads, workerThreads);
1621 InterlockedExchange (&async_io_tp.max_threads, completionPortThreads);
1626 * mono_install_threadpool_thread_hooks
1627 * @start_func: the function to be called right after a new threadpool thread is created. Can be NULL.
1628 * @finish_func: the function to be called right before a thredpool thread is exiting. Can be NULL.
1629 * @user_data: argument passed to @start_func and @finish_func.
1631 * @start_fun will be called right after a threadpool thread is created and @finish_func right before a threadpool thread exits.
1632 * The calls will be made from the thread itself.
1635 mono_install_threadpool_thread_hooks (MonoThreadPoolFunc start_func, MonoThreadPoolFunc finish_func, gpointer user_data)
1637 tp_start_func = start_func;
1638 tp_finish_func = finish_func;
1639 tp_hooks_user_data = user_data;
1643 * mono_install_threadpool_item_hooks
1644 * @begin_func: the function to be called before a threadpool work item processing starts.
1645 * @end_func: the function to be called after a threadpool work item is finished.
1646 * @user_data: argument passed to @begin_func and @end_func.
1648 * The calls will be made from the thread itself and from the same AppDomain
1649 * where the work item was executed.
1653 mono_install_threadpool_item_hooks (MonoThreadPoolItemFunc begin_func, MonoThreadPoolItemFunc end_func, gpointer user_data)
1655 tp_item_begin_func = begin_func;
1656 tp_item_end_func = end_func;
1657 tp_item_user_data = user_data;
1661 mono_internal_thread_unhandled_exception (MonoObject* exc)
1663 if (mono_runtime_unhandled_exception_policy_get () == MONO_UNHANDLED_POLICY_CURRENT) {
1667 klass = exc->vtable->klass;
1668 unloaded = is_appdomainunloaded_exception (exc->vtable->domain, klass);
1669 if (!unloaded && klass != mono_defaults.threadabortexception_class) {
1670 mono_unhandled_exception (exc);
1671 if (mono_environment_exitcode_get () == 1)
1674 if (klass == mono_defaults.threadabortexception_class)
1675 mono_thread_internal_reset_abort (mono_thread_internal_current ());