2 * threadpool.c: Microsoft threadpool runtime support
5 * Ludovic Henry (ludovic.henry@xamarin.com)
7 * Copyright 2015 Xamarin, Inc (http://www.xamarin.com)
8 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
12 // Copyright (c) Microsoft. All rights reserved.
13 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
16 // - src/vm/comthreadpool.cpp
17 // - src/vm/win32threadpoolcpp
18 // - src/vm/threadpoolrequest.cpp
19 // - src/vm/hillclimbing.cpp
21 // Ported from C++ to C and adjusted to Mono runtime
24 #define _USE_MATH_DEFINES // needed by MSVC to define math constants
29 #include <mono/metadata/class-internals.h>
30 #include <mono/metadata/exception.h>
31 #include <mono/metadata/gc-internals.h>
32 #include <mono/metadata/object.h>
33 #include <mono/metadata/object-internals.h>
34 #include <mono/metadata/threadpool.h>
35 #include <mono/metadata/threadpool-worker.h>
36 #include <mono/metadata/threadpool-io.h>
37 #include <mono/metadata/w32event.h>
38 #include <mono/utils/atomic.h>
39 #include <mono/utils/mono-compiler.h>
40 #include <mono/utils/mono-complex.h>
41 #include <mono/utils/mono-lazy-init.h>
42 #include <mono/utils/mono-logger.h>
43 #include <mono/utils/mono-logger-internals.h>
44 #include <mono/utils/mono-proclib.h>
45 #include <mono/utils/mono-threads.h>
46 #include <mono/utils/mono-time.h>
47 #include <mono/utils/refcount.h>
51 /* Number of outstanding jobs */
52 gint32 outstanding_request;
53 /* Number of currently executing jobs */
54 gint32 threadpool_jobs;
55 /* Signalled when threadpool_jobs + outstanding_request is 0 */
56 /* Protected by threadpool.domains_lock */
57 MonoCoopCond cleanup_cond;
62 gint16 starting; /* starting, but not yet in worker_callback */
63 gint16 working; /* executing worker_callback */
71 GPtrArray *domains; // ThreadPoolDomain* []
72 MonoCoopMutex domains_lock;
74 GPtrArray *threads; // MonoInternalThread* []
75 MonoCoopMutex threads_lock;
76 MonoCoopCond threads_exit_cond;
78 ThreadPoolCounter counters;
84 static mono_lazy_init_t status = MONO_LAZY_INIT_STATUS_NOT_INITIALIZED;
86 static ThreadPool threadpool;
88 #define COUNTER_ATOMIC(var,block) \
90 ThreadPoolCounter __old; \
92 (var) = __old = COUNTER_READ (); \
94 if (!(counter._.starting >= 0)) \
95 g_error ("%s: counter._.starting = %d, but should be >= 0", __func__, counter._.starting); \
96 if (!(counter._.working >= 0)) \
97 g_error ("%s: counter._.working = %d, but should be >= 0", __func__, counter._.working); \
98 } while (InterlockedCompareExchange (&threadpool.counters.as_gint32, (var).as_gint32, __old.as_gint32) != __old.as_gint32); \
101 static inline ThreadPoolCounter
104 ThreadPoolCounter counter;
105 counter.as_gint32 = InterlockedRead (&threadpool.counters.as_gint32);
112 mono_coop_mutex_lock (&threadpool.domains_lock);
116 domains_unlock (void)
118 mono_coop_mutex_unlock (&threadpool.domains_lock);
122 destroy (gpointer unused)
125 g_ptr_array_free (threadpool.domains, TRUE);
126 mono_coop_mutex_destroy (&threadpool.domains_lock);
128 g_ptr_array_free (threadpool.threads, TRUE);
129 mono_coop_mutex_destroy (&threadpool.threads_lock);
130 mono_coop_cond_destroy (&threadpool.threads_exit_cond);
137 g_assert (sizeof (ThreadPoolCounter) == sizeof (gint32));
139 mono_refcount_init (&threadpool, destroy);
141 threadpool.domains = g_ptr_array_new ();
142 mono_coop_mutex_init (&threadpool.domains_lock);
144 threadpool.threads = g_ptr_array_new ();
145 mono_coop_mutex_init (&threadpool.threads_lock);
146 mono_coop_cond_init (&threadpool.threads_exit_cond);
148 threadpool.limit_io_min = mono_cpu_count ();
149 threadpool.limit_io_max = CLAMP (threadpool.limit_io_min * 100, MIN (threadpool.limit_io_min, 200), MAX (threadpool.limit_io_min, 200));
151 mono_threadpool_worker_init ();
158 MonoInternalThread *current;
160 /* we make the assumption along the code that we are
161 * cleaning up only if the runtime is shutting down */
162 g_assert (mono_runtime_is_shutting_down ());
164 current = mono_thread_internal_current ();
166 mono_coop_mutex_lock (&threadpool.threads_lock);
168 /* stop all threadpool.threads */
169 for (i = 0; i < threadpool.threads->len; ++i) {
170 MonoInternalThread *thread = (MonoInternalThread*) g_ptr_array_index (threadpool.threads, i);
171 if (thread != current)
172 mono_thread_internal_abort (thread);
175 mono_coop_mutex_unlock (&threadpool.threads_lock);
178 /* give a chance to the other threads to exit */
179 mono_thread_info_yield ();
181 mono_coop_mutex_lock (&threadpool.threads_lock);
184 if (threadpool.threads->len == 0)
187 if (threadpool.threads->len == 1 && g_ptr_array_index (threadpool.threads, 0) == current) {
188 /* We are waiting on ourselves */
192 mono_coop_cond_wait (&threadpool.threads_exit_cond, &threadpool.threads_lock);
195 mono_coop_mutex_unlock (&threadpool.threads_lock);
198 mono_threadpool_worker_cleanup ();
200 mono_refcount_dec (&threadpool);
204 mono_threadpool_enqueue_work_item (MonoDomain *domain, MonoObject *work_item, MonoError *error)
206 static MonoClass *threadpool_class = NULL;
207 static MonoMethod *unsafe_queue_custom_work_item_method = NULL;
208 MonoDomain *current_domain;
212 mono_error_init (error);
213 g_assert (work_item);
215 if (!threadpool_class)
216 threadpool_class = mono_class_load_from_name (mono_defaults.corlib, "System.Threading", "ThreadPool");
218 if (!unsafe_queue_custom_work_item_method)
219 unsafe_queue_custom_work_item_method = mono_class_get_method_from_name (threadpool_class, "UnsafeQueueCustomWorkItem", 2);
220 g_assert (unsafe_queue_custom_work_item_method);
224 args [0] = (gpointer) work_item;
225 args [1] = (gpointer) &f;
227 current_domain = mono_domain_get ();
228 if (current_domain == domain) {
229 mono_runtime_invoke_checked (unsafe_queue_custom_work_item_method, NULL, args, error);
230 return_val_if_nok (error, FALSE);
232 mono_thread_push_appdomain_ref (domain);
233 if (mono_domain_set (domain, FALSE)) {
234 mono_runtime_invoke_checked (unsafe_queue_custom_work_item_method, NULL, args, error);
235 if (!is_ok (error)) {
236 mono_thread_pop_appdomain_ref ();
239 mono_domain_set (current_domain, TRUE);
241 mono_thread_pop_appdomain_ref ();
246 /* LOCKING: domains_lock must be held */
248 tpdomain_add (ThreadPoolDomain *tpdomain)
254 len = threadpool.domains->len;
255 for (i = 0; i < len; ++i) {
256 if (g_ptr_array_index (threadpool.domains, i) == tpdomain)
261 g_ptr_array_add (threadpool.domains, tpdomain);
264 /* LOCKING: domains_lock must be held. */
266 tpdomain_remove (ThreadPoolDomain *tpdomain)
269 return g_ptr_array_remove (threadpool.domains, tpdomain);
272 /* LOCKING: domains_lock must be held */
273 static ThreadPoolDomain *
274 tpdomain_get (MonoDomain *domain, gboolean create)
277 ThreadPoolDomain *tpdomain;
281 for (i = 0; i < threadpool.domains->len; ++i) {
282 ThreadPoolDomain *tpdomain;
284 tpdomain = (ThreadPoolDomain *)g_ptr_array_index (threadpool.domains, i);
285 if (tpdomain->domain == domain)
292 tpdomain = g_new0 (ThreadPoolDomain, 1);
293 tpdomain->domain = domain;
294 mono_coop_cond_init (&tpdomain->cleanup_cond);
296 tpdomain_add (tpdomain);
302 tpdomain_free (ThreadPoolDomain *tpdomain)
307 /* LOCKING: domains_lock must be held */
308 static ThreadPoolDomain *
309 tpdomain_get_next (ThreadPoolDomain *current)
311 ThreadPoolDomain *tpdomain = NULL;
314 len = threadpool.domains->len;
316 guint i, current_idx = -1;
318 for (i = 0; i < len; ++i) {
319 if (current == g_ptr_array_index (threadpool.domains, i)) {
324 g_assert (current_idx != (guint)-1);
326 for (i = current_idx + 1; i < len + current_idx + 1; ++i) {
327 ThreadPoolDomain *tmp = (ThreadPoolDomain *)g_ptr_array_index (threadpool.domains, i % len);
328 if (tmp->outstanding_request > 0) {
339 try_invoke_perform_wait_callback (MonoObject** exc, MonoError *error)
341 HANDLE_FUNCTION_ENTER ();
342 mono_error_init (error);
343 MonoObject *res = mono_runtime_try_invoke (mono_defaults.threadpool_perform_wait_callback_method, NULL, NULL, exc, error);
344 HANDLE_FUNCTION_RETURN_VAL (res);
348 worker_callback (gpointer unused)
351 ThreadPoolDomain *tpdomain, *previous_tpdomain;
352 ThreadPoolCounter counter;
353 MonoInternalThread *thread;
355 thread = mono_thread_internal_current ();
357 COUNTER_ATOMIC (counter, {
358 if (!(counter._.working < 32767 /* G_MAXINT16 */))
359 g_error ("%s: counter._.working = %d, but should be < 32767", __func__, counter._.working);
361 counter._.starting --;
362 counter._.working ++;
365 if (mono_runtime_is_shutting_down ()) {
366 COUNTER_ATOMIC (counter, {
367 counter._.working --;
370 mono_refcount_dec (&threadpool);
374 mono_coop_mutex_lock (&threadpool.threads_lock);
375 g_ptr_array_add (threadpool.threads, thread);
376 mono_coop_mutex_unlock (&threadpool.threads_lock);
379 * This is needed so there is always an lmf frame in the runtime invoke call below,
380 * so ThreadAbortExceptions are caught even if the thread is in native code.
382 mono_defaults.threadpool_perform_wait_callback_method->save_lmf = TRUE;
386 previous_tpdomain = NULL;
388 while (!mono_runtime_is_shutting_down ()) {
389 gboolean retire = FALSE;
391 if ((thread->state & (ThreadState_AbortRequested | ThreadState_SuspendRequested)) != 0) {
393 mono_thread_interruption_checkpoint ();
397 tpdomain = tpdomain_get_next (previous_tpdomain);
401 tpdomain->outstanding_request --;
402 g_assert (tpdomain->outstanding_request >= 0);
404 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_THREADPOOL, "[%p] worker running in domain %p (outstanding requests %d)",
405 mono_native_thread_id_get (), tpdomain->domain, tpdomain->outstanding_request);
407 g_assert (tpdomain->threadpool_jobs >= 0);
408 tpdomain->threadpool_jobs ++;
412 mono_thread_set_name_internal (thread, mono_string_new (mono_get_root_domain (), "Threadpool worker"), FALSE, TRUE, &error);
413 mono_error_assert_ok (&error);
415 mono_thread_clr_state (thread, (MonoThreadState)~ThreadState_Background);
416 if (!mono_thread_test_state (thread , ThreadState_Background))
417 ves_icall_System_Threading_Thread_SetState (thread, ThreadState_Background);
419 mono_thread_push_appdomain_ref (tpdomain->domain);
420 if (mono_domain_set (tpdomain->domain, FALSE)) {
421 MonoObject *exc = NULL, *res;
423 res = try_invoke_perform_wait_callback (&exc, &error);
424 if (exc || !mono_error_ok(&error)) {
426 exc = (MonoObject *) mono_error_convert_to_exception (&error);
428 mono_error_cleanup (&error);
429 mono_thread_internal_unhandled_exception (exc);
430 } else if (res && *(MonoBoolean*) mono_object_unbox (res) == FALSE) {
434 mono_domain_set (mono_get_root_domain (), TRUE);
436 mono_thread_pop_appdomain_ref ();
440 tpdomain->threadpool_jobs --;
441 g_assert (tpdomain->threadpool_jobs >= 0);
443 if (tpdomain->outstanding_request + tpdomain->threadpool_jobs == 0 && mono_domain_is_unloading (tpdomain->domain)) {
446 removed = tpdomain_remove (tpdomain);
449 mono_coop_cond_signal (&tpdomain->cleanup_cond);
456 previous_tpdomain = tpdomain;
461 mono_coop_mutex_lock (&threadpool.threads_lock);
463 g_ptr_array_remove_fast (threadpool.threads, thread);
465 mono_coop_cond_signal (&threadpool.threads_exit_cond);
467 mono_coop_mutex_unlock (&threadpool.threads_lock);
469 COUNTER_ATOMIC (counter, {
470 counter._.working --;
473 mono_refcount_dec (&threadpool);
477 mono_threadpool_cleanup (void)
479 #ifndef DISABLE_SOCKETS
480 mono_threadpool_io_cleanup ();
482 mono_lazy_cleanup (&status, cleanup);
486 mono_threadpool_begin_invoke (MonoDomain *domain, MonoObject *target, MonoMethod *method, gpointer *params, MonoError *error)
488 static MonoClass *async_call_klass = NULL;
489 MonoMethodMessage *message;
490 MonoAsyncResult *async_result;
491 MonoAsyncCall *async_call;
492 MonoDelegate *async_callback = NULL;
493 MonoObject *state = NULL;
495 if (!async_call_klass)
496 async_call_klass = mono_class_load_from_name (mono_defaults.corlib, "System", "MonoAsyncCall");
498 mono_lazy_initialize (&status, initialize);
500 mono_error_init (error);
502 message = mono_method_call_message_new (method, params, mono_get_delegate_invoke (method->klass), (params != NULL) ? (&async_callback) : NULL, (params != NULL) ? (&state) : NULL, error);
503 return_val_if_nok (error, NULL);
505 async_call = (MonoAsyncCall*) mono_object_new_checked (domain, async_call_klass, error);
506 return_val_if_nok (error, NULL);
508 MONO_OBJECT_SETREF (async_call, msg, message);
509 MONO_OBJECT_SETREF (async_call, state, state);
511 if (async_callback) {
512 MONO_OBJECT_SETREF (async_call, cb_method, mono_get_delegate_invoke (((MonoObject*) async_callback)->vtable->klass));
513 MONO_OBJECT_SETREF (async_call, cb_target, async_callback);
516 async_result = mono_async_result_new (domain, NULL, async_call->state, NULL, (MonoObject*) async_call, error);
517 return_val_if_nok (error, NULL);
518 MONO_OBJECT_SETREF (async_result, async_delegate, target);
520 mono_threadpool_enqueue_work_item (domain, (MonoObject*) async_result, error);
521 return_val_if_nok (error, NULL);
527 mono_threadpool_end_invoke (MonoAsyncResult *ares, MonoArray **out_args, MonoObject **exc, MonoError *error)
531 mono_error_init (error);
538 /* check if already finished */
539 mono_monitor_enter ((MonoObject*) ares);
541 if (ares->endinvoke_called) {
542 mono_error_set_invalid_operation(error, "Delegate EndInvoke method called more than once");
543 mono_monitor_exit ((MonoObject*) ares);
547 ares->endinvoke_called = 1;
549 /* wait until we are really finished */
550 if (ares->completed) {
551 mono_monitor_exit ((MonoObject *) ares);
555 wait_event = mono_wait_handle_get_handle ((MonoWaitHandle*) ares->handle);
557 wait_event = mono_w32event_create (TRUE, FALSE);
558 g_assert(wait_event);
559 MonoWaitHandle *wait_handle = mono_wait_handle_new (mono_object_domain (ares), wait_event, error);
560 if (!is_ok (error)) {
561 mono_w32event_close (wait_event);
564 MONO_OBJECT_SETREF (ares, handle, (MonoObject*) wait_handle);
566 mono_monitor_exit ((MonoObject*) ares);
569 WaitForSingleObjectEx (wait_event, INFINITE, TRUE);
571 mono_w32handle_wait_one (wait_event, MONO_INFINITE_WAIT, TRUE);
576 ac = (MonoAsyncCall*) ares->object_data;
579 *exc = ac->msg->exc; /* FIXME: GC add write barrier */
580 *out_args = ac->out_args;
585 mono_threadpool_remove_domain_jobs (MonoDomain *domain, int timeout)
588 ThreadPoolDomain *tpdomain;
592 g_assert (timeout >= -1);
594 g_assert (mono_domain_is_unloading (domain));
597 end = mono_msec_ticks () + timeout;
599 #ifndef DISABLE_SOCKETS
600 mono_threadpool_io_remove_domain_jobs (domain);
602 if (mono_msec_ticks () > end)
608 * Wait for all threads which execute jobs in the domain to exit.
609 * The is_unloading () check in worker_request () ensures that
610 * no new jobs are added after we enter the lock below.
613 if (!mono_lazy_is_initialized (&status))
616 mono_refcount_inc (&threadpool);
620 tpdomain = tpdomain_get (domain, FALSE);
623 mono_refcount_dec (&threadpool);
629 while (tpdomain->outstanding_request + tpdomain->threadpool_jobs > 0) {
631 mono_coop_cond_wait (&tpdomain->cleanup_cond, &threadpool.domains_lock);
636 now = mono_msec_ticks();
642 res = mono_coop_cond_timedwait (&tpdomain->cleanup_cond, &threadpool.domains_lock, end - now);
650 /* Remove from the list the worker threads look at */
651 tpdomain_remove (tpdomain);
655 mono_coop_cond_destroy (&tpdomain->cleanup_cond);
656 tpdomain_free (tpdomain);
658 mono_refcount_dec (&threadpool);
664 mono_threadpool_suspend (void)
666 if (mono_lazy_is_initialized (&status))
667 mono_threadpool_worker_set_suspended (TRUE);
671 mono_threadpool_resume (void)
673 if (mono_lazy_is_initialized (&status))
674 mono_threadpool_worker_set_suspended (FALSE);
678 ves_icall_System_Threading_ThreadPool_GetAvailableThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
680 ThreadPoolCounter counter;
682 if (!worker_threads || !completion_port_threads)
685 mono_lazy_initialize (&status, initialize);
687 counter = COUNTER_READ ();
689 *worker_threads = MAX (0, mono_threadpool_worker_get_max () - counter._.working);
690 *completion_port_threads = threadpool.limit_io_max;
694 ves_icall_System_Threading_ThreadPool_GetMinThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
696 if (!worker_threads || !completion_port_threads)
699 mono_lazy_initialize (&status, initialize);
701 *worker_threads = mono_threadpool_worker_get_min ();
702 *completion_port_threads = threadpool.limit_io_min;
706 ves_icall_System_Threading_ThreadPool_GetMaxThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
708 if (!worker_threads || !completion_port_threads)
711 mono_lazy_initialize (&status, initialize);
713 *worker_threads = mono_threadpool_worker_get_max ();
714 *completion_port_threads = threadpool.limit_io_max;
718 ves_icall_System_Threading_ThreadPool_SetMinThreadsNative (gint32 worker_threads, gint32 completion_port_threads)
720 mono_lazy_initialize (&status, initialize);
722 if (completion_port_threads <= 0 || completion_port_threads > threadpool.limit_io_max)
725 if (!mono_threadpool_worker_set_min (worker_threads))
728 threadpool.limit_io_min = completion_port_threads;
734 ves_icall_System_Threading_ThreadPool_SetMaxThreadsNative (gint32 worker_threads, gint32 completion_port_threads)
736 gint cpu_count = mono_cpu_count ();
738 mono_lazy_initialize (&status, initialize);
740 if (completion_port_threads < threadpool.limit_io_min || completion_port_threads < cpu_count)
743 if (!mono_threadpool_worker_set_max (worker_threads))
746 threadpool.limit_io_max = completion_port_threads;
752 ves_icall_System_Threading_ThreadPool_InitializeVMTp (MonoBoolean *enable_worker_tracking)
754 if (enable_worker_tracking) {
755 // TODO implement some kind of switch to have the possibily to use it
756 *enable_worker_tracking = FALSE;
759 mono_lazy_initialize (&status, initialize);
763 ves_icall_System_Threading_ThreadPool_NotifyWorkItemComplete (void)
765 if (mono_domain_is_unloading (mono_domain_get ()) || mono_runtime_is_shutting_down ())
768 return mono_threadpool_worker_notify_completed ();
772 ves_icall_System_Threading_ThreadPool_NotifyWorkItemProgressNative (void)
774 mono_threadpool_worker_notify_completed ();
778 ves_icall_System_Threading_ThreadPool_ReportThreadStatus (MonoBoolean is_working)
782 mono_error_set_not_implemented (&error, "");
783 mono_error_set_pending_exception (&error);
787 ves_icall_System_Threading_ThreadPool_RequestWorkerThread (void)
790 ThreadPoolDomain *tpdomain;
791 ThreadPoolCounter counter;
793 domain = mono_domain_get ();
794 if (mono_domain_is_unloading (domain))
797 if (!mono_refcount_tryinc (&threadpool)) {
798 /* threadpool has been destroyed, we are shutting down */
804 /* synchronize with mono_threadpool_remove_domain_jobs */
805 if (mono_domain_is_unloading (domain)) {
807 mono_refcount_dec (&threadpool);
811 tpdomain = tpdomain_get (domain, TRUE);
814 tpdomain->outstanding_request ++;
815 g_assert (tpdomain->outstanding_request >= 1);
819 COUNTER_ATOMIC (counter, {
820 if (counter._.starting == 16) {
821 mono_refcount_dec (&threadpool);
825 counter._.starting ++;
828 mono_threadpool_worker_enqueue (worker_callback, NULL);
830 /* we do not decrement the threadpool refcount,
831 * as it's going to be done in the worker_callback */
836 MonoBoolean G_GNUC_UNUSED
837 ves_icall_System_Threading_ThreadPool_PostQueuedCompletionStatus (MonoNativeOverlapped *native_overlapped)
839 /* This copy the behavior of the current Mono implementation */
841 mono_error_set_not_implemented (&error, "");
842 mono_error_set_pending_exception (&error);
846 MonoBoolean G_GNUC_UNUSED
847 ves_icall_System_Threading_ThreadPool_BindIOCompletionCallbackNative (gpointer file_handle)
849 /* This copy the behavior of the current Mono implementation */
853 MonoBoolean G_GNUC_UNUSED
854 ves_icall_System_Threading_ThreadPool_IsThreadPoolHosted (void)