3 * Microsoft threadpool runtime support
6 * Ludovic Henry (ludovic.henry@xamarin.com)
8 * Copyright 2015 Xamarin, Inc (http://www.xamarin.com)
9 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
13 // Copyright (c) Microsoft. All rights reserved.
14 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
17 // - src/vm/comthreadpool.cpp
18 // - src/vm/win32threadpoolcpp
19 // - src/vm/threadpoolrequest.cpp
20 // - src/vm/hillclimbing.cpp
22 // Ported from C++ to C and adjusted to Mono runtime
25 #define _USE_MATH_DEFINES // needed by MSVC to define math constants
30 #include <mono/metadata/class-internals.h>
31 #include <mono/metadata/exception.h>
32 #include <mono/metadata/gc-internals.h>
33 #include <mono/metadata/object.h>
34 #include <mono/metadata/object-internals.h>
35 #include <mono/metadata/threadpool.h>
36 #include <mono/metadata/threadpool-worker.h>
37 #include <mono/metadata/threadpool-io.h>
38 #include <mono/metadata/w32event.h>
39 #include <mono/utils/atomic.h>
40 #include <mono/utils/mono-compiler.h>
41 #include <mono/utils/mono-complex.h>
42 #include <mono/utils/mono-lazy-init.h>
43 #include <mono/utils/mono-logger.h>
44 #include <mono/utils/mono-logger-internals.h>
45 #include <mono/utils/mono-proclib.h>
46 #include <mono/utils/mono-threads.h>
47 #include <mono/utils/mono-time.h>
48 #include <mono/utils/refcount.h>
49 #include <mono/utils/mono-os-wait.h>
53 /* Number of outstanding jobs */
54 gint32 outstanding_request;
55 /* Number of currently executing jobs */
56 gint32 threadpool_jobs;
57 /* Signalled when threadpool_jobs + outstanding_request is 0 */
58 /* Protected by threadpool.domains_lock */
59 MonoCoopCond cleanup_cond;
64 gint16 starting; /* starting, but not yet in worker_callback */
65 gint16 working; /* executing worker_callback */
73 GPtrArray *domains; // ThreadPoolDomain* []
74 MonoCoopMutex domains_lock;
76 ThreadPoolCounter counters;
82 static mono_lazy_init_t status = MONO_LAZY_INIT_STATUS_NOT_INITIALIZED;
84 static ThreadPool threadpool;
86 #define COUNTER_ATOMIC(var,block) \
88 ThreadPoolCounter __old; \
90 (var) = __old = COUNTER_READ (); \
92 if (!(counter._.starting >= 0)) \
93 g_error ("%s: counter._.starting = %d, but should be >= 0", __func__, counter._.starting); \
94 if (!(counter._.working >= 0)) \
95 g_error ("%s: counter._.working = %d, but should be >= 0", __func__, counter._.working); \
96 } while (InterlockedCompareExchange (&threadpool.counters.as_gint32, (var).as_gint32, __old.as_gint32) != __old.as_gint32); \
99 static inline ThreadPoolCounter
102 ThreadPoolCounter counter;
103 counter.as_gint32 = InterlockedRead (&threadpool.counters.as_gint32);
110 mono_coop_mutex_lock (&threadpool.domains_lock);
114 domains_unlock (void)
116 mono_coop_mutex_unlock (&threadpool.domains_lock);
120 destroy (gpointer unused)
122 g_ptr_array_free (threadpool.domains, TRUE);
123 mono_coop_mutex_destroy (&threadpool.domains_lock);
127 worker_callback (void);
132 g_assert (sizeof (ThreadPoolCounter) == sizeof (gint32));
134 mono_refcount_init (&threadpool, destroy);
136 threadpool.domains = g_ptr_array_new ();
137 mono_coop_mutex_init (&threadpool.domains_lock);
139 threadpool.limit_io_min = mono_cpu_count ();
140 threadpool.limit_io_max = CLAMP (threadpool.limit_io_min * 100, MIN (threadpool.limit_io_min, 200), MAX (threadpool.limit_io_min, 200));
142 mono_threadpool_worker_init (worker_callback);
148 mono_threadpool_worker_cleanup ();
150 mono_refcount_dec (&threadpool);
154 mono_threadpool_enqueue_work_item (MonoDomain *domain, MonoObject *work_item, MonoError *error)
156 static MonoClass *threadpool_class = NULL;
157 static MonoMethod *unsafe_queue_custom_work_item_method = NULL;
158 MonoDomain *current_domain;
163 g_assert (work_item);
165 if (!threadpool_class)
166 threadpool_class = mono_class_load_from_name (mono_defaults.corlib, "System.Threading", "ThreadPool");
168 if (!unsafe_queue_custom_work_item_method)
169 unsafe_queue_custom_work_item_method = mono_class_get_method_from_name (threadpool_class, "UnsafeQueueCustomWorkItem", 2);
170 g_assert (unsafe_queue_custom_work_item_method);
174 args [0] = (gpointer) work_item;
175 args [1] = (gpointer) &f;
177 current_domain = mono_domain_get ();
178 if (current_domain == domain) {
179 mono_runtime_invoke_checked (unsafe_queue_custom_work_item_method, NULL, args, error);
180 return_val_if_nok (error, FALSE);
182 mono_thread_push_appdomain_ref (domain);
183 if (mono_domain_set (domain, FALSE)) {
184 mono_runtime_invoke_checked (unsafe_queue_custom_work_item_method, NULL, args, error);
185 if (!is_ok (error)) {
186 mono_thread_pop_appdomain_ref ();
189 mono_domain_set (current_domain, TRUE);
191 mono_thread_pop_appdomain_ref ();
196 /* LOCKING: domains_lock must be held. */
197 static ThreadPoolDomain *
198 tpdomain_create (MonoDomain *domain)
200 ThreadPoolDomain *tpdomain;
202 tpdomain = g_new0 (ThreadPoolDomain, 1);
203 tpdomain->domain = domain;
204 mono_coop_cond_init (&tpdomain->cleanup_cond);
206 g_ptr_array_add (threadpool.domains, tpdomain);
211 /* LOCKING: domains_lock must be held. */
213 tpdomain_remove (ThreadPoolDomain *tpdomain)
216 return g_ptr_array_remove (threadpool.domains, tpdomain);
219 /* LOCKING: domains_lock must be held */
220 static ThreadPoolDomain *
221 tpdomain_get (MonoDomain *domain)
227 for (i = 0; i < threadpool.domains->len; ++i) {
228 ThreadPoolDomain *tpdomain;
230 tpdomain = (ThreadPoolDomain *)g_ptr_array_index (threadpool.domains, i);
231 if (tpdomain->domain == domain)
239 tpdomain_free (ThreadPoolDomain *tpdomain)
244 /* LOCKING: domains_lock must be held */
245 static ThreadPoolDomain *
246 tpdomain_get_next (ThreadPoolDomain *current)
248 ThreadPoolDomain *tpdomain = NULL;
251 len = threadpool.domains->len;
253 gint i, current_idx = -1;
255 for (i = 0; i < len; ++i) {
256 if (current == g_ptr_array_index (threadpool.domains, i)) {
262 for (i = current_idx + 1; i < len + current_idx + 1; ++i) {
263 ThreadPoolDomain *tmp = (ThreadPoolDomain *)g_ptr_array_index (threadpool.domains, i % len);
264 if (tmp->outstanding_request > 0) {
275 try_invoke_perform_wait_callback (MonoObject** exc, MonoError *error)
277 HANDLE_FUNCTION_ENTER ();
279 MonoObject *res = mono_runtime_try_invoke (mono_defaults.threadpool_perform_wait_callback_method, NULL, NULL, exc, error);
280 HANDLE_FUNCTION_RETURN_VAL (res);
284 worker_callback (void)
287 ThreadPoolDomain *tpdomain, *previous_tpdomain;
288 ThreadPoolCounter counter;
289 MonoInternalThread *thread;
291 if (!mono_refcount_tryinc (&threadpool))
294 thread = mono_thread_internal_current ();
296 COUNTER_ATOMIC (counter, {
297 if (!(counter._.working < 32767 /* G_MAXINT16 */))
298 g_error ("%s: counter._.working = %d, but should be < 32767", __func__, counter._.working);
300 counter._.starting --;
301 counter._.working ++;
304 if (mono_runtime_is_shutting_down ()) {
305 COUNTER_ATOMIC (counter, {
306 counter._.working --;
309 mono_refcount_dec (&threadpool);
314 * This is needed so there is always an lmf frame in the runtime invoke call below,
315 * so ThreadAbortExceptions are caught even if the thread is in native code.
317 mono_defaults.threadpool_perform_wait_callback_method->save_lmf = TRUE;
321 previous_tpdomain = NULL;
323 while (!mono_runtime_is_shutting_down ()) {
324 gboolean retire = FALSE;
326 if (thread->state & (ThreadState_AbortRequested | ThreadState_SuspendRequested)) {
328 if (mono_thread_interruption_checkpoint ()) {
335 tpdomain = tpdomain_get_next (previous_tpdomain);
339 tpdomain->outstanding_request --;
340 g_assert (tpdomain->outstanding_request >= 0);
342 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_THREADPOOL, "[%p] worker running in domain %p (outstanding requests %d)",
343 GUINT_TO_POINTER (MONO_NATIVE_THREAD_ID_TO_UINT (mono_native_thread_id_get ())), tpdomain->domain, tpdomain->outstanding_request);
345 g_assert (tpdomain->threadpool_jobs >= 0);
346 tpdomain->threadpool_jobs ++;
350 MonoString *thread_name = mono_string_new_checked (mono_get_root_domain (), "Threadpool worker", &error);
351 mono_error_assert_ok (&error);
352 mono_thread_set_name_internal (thread, thread_name, FALSE, TRUE, &error);
353 mono_error_assert_ok (&error);
355 mono_thread_clr_state (thread, (MonoThreadState)~ThreadState_Background);
356 if (!mono_thread_test_state (thread , ThreadState_Background))
357 ves_icall_System_Threading_Thread_SetState (thread, ThreadState_Background);
359 mono_thread_push_appdomain_ref (tpdomain->domain);
360 if (mono_domain_set (tpdomain->domain, FALSE)) {
361 MonoObject *exc = NULL, *res;
363 res = try_invoke_perform_wait_callback (&exc, &error);
364 if (exc || !mono_error_ok(&error)) {
366 exc = (MonoObject *) mono_error_convert_to_exception (&error);
368 mono_error_cleanup (&error);
369 mono_thread_internal_unhandled_exception (exc);
370 } else if (res && *(MonoBoolean*) mono_object_unbox (res) == FALSE) {
374 mono_domain_set (mono_get_root_domain (), TRUE);
376 mono_thread_pop_appdomain_ref ();
380 tpdomain->threadpool_jobs --;
381 g_assert (tpdomain->threadpool_jobs >= 0);
383 if (tpdomain->outstanding_request + tpdomain->threadpool_jobs == 0 && mono_domain_is_unloading (tpdomain->domain)) {
386 removed = tpdomain_remove (tpdomain);
389 mono_coop_cond_signal (&tpdomain->cleanup_cond);
396 previous_tpdomain = tpdomain;
401 COUNTER_ATOMIC (counter, {
402 counter._.working --;
405 mono_refcount_dec (&threadpool);
409 mono_threadpool_cleanup (void)
411 #ifndef DISABLE_SOCKETS
412 mono_threadpool_io_cleanup ();
414 mono_lazy_cleanup (&status, cleanup);
418 mono_threadpool_begin_invoke (MonoDomain *domain, MonoObject *target, MonoMethod *method, gpointer *params, MonoError *error)
420 static MonoClass *async_call_klass = NULL;
421 MonoMethodMessage *message;
422 MonoAsyncResult *async_result;
423 MonoAsyncCall *async_call;
424 MonoDelegate *async_callback = NULL;
425 MonoObject *state = NULL;
427 if (!async_call_klass)
428 async_call_klass = mono_class_load_from_name (mono_defaults.corlib, "System", "MonoAsyncCall");
432 message = mono_method_call_message_new (method, params, mono_get_delegate_invoke (method->klass), (params != NULL) ? (&async_callback) : NULL, (params != NULL) ? (&state) : NULL, error);
433 return_val_if_nok (error, NULL);
435 async_call = (MonoAsyncCall*) mono_object_new_checked (domain, async_call_klass, error);
436 return_val_if_nok (error, NULL);
438 MONO_OBJECT_SETREF (async_call, msg, message);
439 MONO_OBJECT_SETREF (async_call, state, state);
441 if (async_callback) {
442 MONO_OBJECT_SETREF (async_call, cb_method, mono_get_delegate_invoke (((MonoObject*) async_callback)->vtable->klass));
443 MONO_OBJECT_SETREF (async_call, cb_target, async_callback);
446 async_result = mono_async_result_new (domain, NULL, async_call->state, NULL, (MonoObject*) async_call, error);
447 return_val_if_nok (error, NULL);
448 MONO_OBJECT_SETREF (async_result, async_delegate, target);
450 mono_threadpool_enqueue_work_item (domain, (MonoObject*) async_result, error);
451 return_val_if_nok (error, NULL);
457 mono_threadpool_end_invoke (MonoAsyncResult *ares, MonoArray **out_args, MonoObject **exc, MonoError *error)
468 /* check if already finished */
469 mono_monitor_enter ((MonoObject*) ares);
471 if (ares->endinvoke_called) {
472 mono_error_set_invalid_operation(error, "Delegate EndInvoke method called more than once");
473 mono_monitor_exit ((MonoObject*) ares);
477 ares->endinvoke_called = 1;
479 /* wait until we are really finished */
480 if (ares->completed) {
481 mono_monitor_exit ((MonoObject *) ares);
485 wait_event = mono_wait_handle_get_handle ((MonoWaitHandle*) ares->handle);
487 wait_event = mono_w32event_create (TRUE, FALSE);
488 g_assert(wait_event);
489 MonoWaitHandle *wait_handle = mono_wait_handle_new (mono_object_domain (ares), wait_event, error);
490 if (!is_ok (error)) {
491 mono_w32event_close (wait_event);
494 MONO_OBJECT_SETREF (ares, handle, (MonoObject*) wait_handle);
496 mono_monitor_exit ((MonoObject*) ares);
499 mono_win32_wait_for_single_object_ex (wait_event, INFINITE, TRUE);
501 mono_w32handle_wait_one (wait_event, MONO_INFINITE_WAIT, TRUE);
506 ac = (MonoAsyncCall*) ares->object_data;
509 *exc = ac->msg->exc; /* FIXME: GC add write barrier */
510 *out_args = ac->out_args;
515 mono_threadpool_remove_domain_jobs (MonoDomain *domain, int timeout)
518 ThreadPoolDomain *tpdomain;
522 g_assert (timeout >= -1);
524 g_assert (mono_domain_is_unloading (domain));
527 end = mono_msec_ticks () + timeout;
529 #ifndef DISABLE_SOCKETS
530 mono_threadpool_io_remove_domain_jobs (domain);
532 if (mono_msec_ticks () > end)
538 * Wait for all threads which execute jobs in the domain to exit.
539 * The is_unloading () check in worker_request () ensures that
540 * no new jobs are added after we enter the lock below.
543 if (!mono_lazy_is_initialized (&status))
546 mono_refcount_inc (&threadpool);
550 tpdomain = tpdomain_get (domain);
553 mono_refcount_dec (&threadpool);
559 while (tpdomain->outstanding_request + tpdomain->threadpool_jobs > 0) {
561 mono_coop_cond_wait (&tpdomain->cleanup_cond, &threadpool.domains_lock);
566 now = mono_msec_ticks();
572 res = mono_coop_cond_timedwait (&tpdomain->cleanup_cond, &threadpool.domains_lock, end - now);
580 /* Remove from the list the worker threads look at */
581 tpdomain_remove (tpdomain);
585 mono_coop_cond_destroy (&tpdomain->cleanup_cond);
586 tpdomain_free (tpdomain);
588 mono_refcount_dec (&threadpool);
594 mono_threadpool_suspend (void)
596 if (mono_lazy_is_initialized (&status))
597 mono_threadpool_worker_set_suspended (TRUE);
601 mono_threadpool_resume (void)
603 if (mono_lazy_is_initialized (&status))
604 mono_threadpool_worker_set_suspended (FALSE);
608 ves_icall_System_Threading_ThreadPool_GetAvailableThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
610 ThreadPoolCounter counter;
612 if (!worker_threads || !completion_port_threads)
615 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
617 *completion_port_threads = 0;
621 counter = COUNTER_READ ();
623 *worker_threads = MAX (0, mono_threadpool_worker_get_max () - counter._.working);
624 *completion_port_threads = threadpool.limit_io_max;
626 mono_refcount_dec (&threadpool);
630 ves_icall_System_Threading_ThreadPool_GetMinThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
632 if (!worker_threads || !completion_port_threads)
635 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
637 *completion_port_threads = 0;
641 *worker_threads = mono_threadpool_worker_get_min ();
642 *completion_port_threads = threadpool.limit_io_min;
644 mono_refcount_dec (&threadpool);
648 ves_icall_System_Threading_ThreadPool_GetMaxThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
650 if (!worker_threads || !completion_port_threads)
653 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
655 *completion_port_threads = 0;
659 *worker_threads = mono_threadpool_worker_get_max ();
660 *completion_port_threads = threadpool.limit_io_max;
662 mono_refcount_dec (&threadpool);
666 ves_icall_System_Threading_ThreadPool_SetMinThreadsNative (gint32 worker_threads, gint32 completion_port_threads)
668 if (completion_port_threads <= 0 || completion_port_threads > threadpool.limit_io_max)
671 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool))
674 if (!mono_threadpool_worker_set_min (worker_threads)) {
675 mono_refcount_dec (&threadpool);
679 threadpool.limit_io_min = completion_port_threads;
681 mono_refcount_dec (&threadpool);
686 ves_icall_System_Threading_ThreadPool_SetMaxThreadsNative (gint32 worker_threads, gint32 completion_port_threads)
688 gint cpu_count = mono_cpu_count ();
690 if (completion_port_threads < threadpool.limit_io_min || completion_port_threads < cpu_count)
693 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool))
696 if (!mono_threadpool_worker_set_max (worker_threads)) {
697 mono_refcount_dec (&threadpool);
701 threadpool.limit_io_max = completion_port_threads;
703 mono_refcount_dec (&threadpool);
708 ves_icall_System_Threading_ThreadPool_InitializeVMTp (MonoBoolean *enable_worker_tracking)
710 if (enable_worker_tracking) {
711 // TODO implement some kind of switch to have the possibily to use it
712 *enable_worker_tracking = FALSE;
715 mono_lazy_initialize (&status, initialize);
719 ves_icall_System_Threading_ThreadPool_NotifyWorkItemComplete (void)
721 if (mono_domain_is_unloading (mono_domain_get ()) || mono_runtime_is_shutting_down ())
724 return mono_threadpool_worker_notify_completed ();
728 ves_icall_System_Threading_ThreadPool_NotifyWorkItemProgressNative (void)
730 mono_threadpool_worker_notify_completed ();
734 ves_icall_System_Threading_ThreadPool_ReportThreadStatus (MonoBoolean is_working)
738 mono_error_set_not_implemented (&error, "");
739 mono_error_set_pending_exception (&error);
743 ves_icall_System_Threading_ThreadPool_RequestWorkerThread (void)
746 ThreadPoolDomain *tpdomain;
747 ThreadPoolCounter counter;
749 domain = mono_domain_get ();
750 if (mono_domain_is_unloading (domain))
753 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
754 /* threadpool has been destroyed, we are shutting down */
760 tpdomain = tpdomain_get (domain);
762 /* synchronize with mono_threadpool_remove_domain_jobs */
763 if (mono_domain_is_unloading (domain)) {
765 mono_refcount_dec (&threadpool);
769 tpdomain = tpdomain_create (domain);
774 tpdomain->outstanding_request ++;
775 g_assert (tpdomain->outstanding_request >= 1);
779 COUNTER_ATOMIC (counter, {
780 if (counter._.starting == 16) {
781 mono_refcount_dec (&threadpool);
785 counter._.starting ++;
788 mono_threadpool_worker_request ();
790 mono_refcount_dec (&threadpool);
794 MonoBoolean G_GNUC_UNUSED
795 ves_icall_System_Threading_ThreadPool_PostQueuedCompletionStatus (MonoNativeOverlapped *native_overlapped)
797 /* This copy the behavior of the current Mono implementation */
799 mono_error_set_not_implemented (&error, "");
800 mono_error_set_pending_exception (&error);
804 MonoBoolean G_GNUC_UNUSED
805 ves_icall_System_Threading_ThreadPool_BindIOCompletionCallbackNative (gpointer file_handle)
807 /* This copy the behavior of the current Mono implementation */
811 MonoBoolean G_GNUC_UNUSED
812 ves_icall_System_Threading_ThreadPool_IsThreadPoolHosted (void)