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 ThreadPoolCounter counters;
80 static mono_lazy_init_t status = MONO_LAZY_INIT_STATUS_NOT_INITIALIZED;
82 static ThreadPool threadpool;
84 #define COUNTER_ATOMIC(var,block) \
86 ThreadPoolCounter __old; \
88 (var) = __old = COUNTER_READ (); \
90 if (!(counter._.starting >= 0)) \
91 g_error ("%s: counter._.starting = %d, but should be >= 0", __func__, counter._.starting); \
92 if (!(counter._.working >= 0)) \
93 g_error ("%s: counter._.working = %d, but should be >= 0", __func__, counter._.working); \
94 } while (InterlockedCompareExchange (&threadpool.counters.as_gint32, (var).as_gint32, __old.as_gint32) != __old.as_gint32); \
97 static inline ThreadPoolCounter
100 ThreadPoolCounter counter;
101 counter.as_gint32 = InterlockedRead (&threadpool.counters.as_gint32);
108 mono_coop_mutex_lock (&threadpool.domains_lock);
112 domains_unlock (void)
114 mono_coop_mutex_unlock (&threadpool.domains_lock);
118 destroy (gpointer unused)
120 g_ptr_array_free (threadpool.domains, TRUE);
121 mono_coop_mutex_destroy (&threadpool.domains_lock);
127 g_assert (sizeof (ThreadPoolCounter) == sizeof (gint32));
129 mono_refcount_init (&threadpool, destroy);
131 threadpool.domains = g_ptr_array_new ();
132 mono_coop_mutex_init (&threadpool.domains_lock);
134 threadpool.limit_io_min = mono_cpu_count ();
135 threadpool.limit_io_max = CLAMP (threadpool.limit_io_min * 100, MIN (threadpool.limit_io_min, 200), MAX (threadpool.limit_io_min, 200));
137 mono_threadpool_worker_init ();
143 mono_threadpool_worker_cleanup ();
145 mono_refcount_dec (&threadpool);
149 mono_threadpool_enqueue_work_item (MonoDomain *domain, MonoObject *work_item, MonoError *error)
151 static MonoClass *threadpool_class = NULL;
152 static MonoMethod *unsafe_queue_custom_work_item_method = NULL;
153 MonoDomain *current_domain;
157 mono_error_init (error);
158 g_assert (work_item);
160 if (!threadpool_class)
161 threadpool_class = mono_class_load_from_name (mono_defaults.corlib, "System.Threading", "ThreadPool");
163 if (!unsafe_queue_custom_work_item_method)
164 unsafe_queue_custom_work_item_method = mono_class_get_method_from_name (threadpool_class, "UnsafeQueueCustomWorkItem", 2);
165 g_assert (unsafe_queue_custom_work_item_method);
169 args [0] = (gpointer) work_item;
170 args [1] = (gpointer) &f;
172 current_domain = mono_domain_get ();
173 if (current_domain == domain) {
174 mono_runtime_invoke_checked (unsafe_queue_custom_work_item_method, NULL, args, error);
175 return_val_if_nok (error, FALSE);
177 mono_thread_push_appdomain_ref (domain);
178 if (mono_domain_set (domain, FALSE)) {
179 mono_runtime_invoke_checked (unsafe_queue_custom_work_item_method, NULL, args, error);
180 if (!is_ok (error)) {
181 mono_thread_pop_appdomain_ref ();
184 mono_domain_set (current_domain, TRUE);
186 mono_thread_pop_appdomain_ref ();
191 /* LOCKING: domains_lock must be held. */
192 static ThreadPoolDomain *
193 tpdomain_create (MonoDomain *domain)
195 ThreadPoolDomain *tpdomain;
197 tpdomain = g_new0 (ThreadPoolDomain, 1);
198 tpdomain->domain = domain;
199 mono_coop_cond_init (&tpdomain->cleanup_cond);
201 g_ptr_array_add (threadpool.domains, tpdomain);
206 /* LOCKING: domains_lock must be held. */
208 tpdomain_remove (ThreadPoolDomain *tpdomain)
211 return g_ptr_array_remove (threadpool.domains, tpdomain);
214 /* LOCKING: domains_lock must be held */
215 static ThreadPoolDomain *
216 tpdomain_get (MonoDomain *domain)
222 for (i = 0; i < threadpool.domains->len; ++i) {
223 ThreadPoolDomain *tpdomain;
225 tpdomain = (ThreadPoolDomain *)g_ptr_array_index (threadpool.domains, i);
226 if (tpdomain->domain == domain)
234 tpdomain_free (ThreadPoolDomain *tpdomain)
239 /* LOCKING: domains_lock must be held */
240 static ThreadPoolDomain *
241 tpdomain_get_next (ThreadPoolDomain *current)
243 ThreadPoolDomain *tpdomain = NULL;
246 len = threadpool.domains->len;
248 gint i, current_idx = -1;
250 for (i = 0; i < len; ++i) {
251 if (current == g_ptr_array_index (threadpool.domains, i)) {
257 for (i = current_idx + 1; i < len + current_idx + 1; ++i) {
258 ThreadPoolDomain *tmp = (ThreadPoolDomain *)g_ptr_array_index (threadpool.domains, i % len);
259 if (tmp->outstanding_request > 0) {
270 try_invoke_perform_wait_callback (MonoObject** exc, MonoError *error)
272 HANDLE_FUNCTION_ENTER ();
273 mono_error_init (error);
274 MonoObject *res = mono_runtime_try_invoke (mono_defaults.threadpool_perform_wait_callback_method, NULL, NULL, exc, error);
275 HANDLE_FUNCTION_RETURN_VAL (res);
279 worker_callback (gpointer unused)
282 ThreadPoolDomain *tpdomain, *previous_tpdomain;
283 ThreadPoolCounter counter;
284 MonoInternalThread *thread;
286 if (!mono_refcount_tryinc (&threadpool))
289 thread = mono_thread_internal_current ();
291 COUNTER_ATOMIC (counter, {
292 if (!(counter._.working < 32767 /* G_MAXINT16 */))
293 g_error ("%s: counter._.working = %d, but should be < 32767", __func__, counter._.working);
295 counter._.starting --;
296 counter._.working ++;
299 if (mono_runtime_is_shutting_down ()) {
300 COUNTER_ATOMIC (counter, {
301 counter._.working --;
304 mono_refcount_dec (&threadpool);
309 * This is needed so there is always an lmf frame in the runtime invoke call below,
310 * so ThreadAbortExceptions are caught even if the thread is in native code.
312 mono_defaults.threadpool_perform_wait_callback_method->save_lmf = TRUE;
316 previous_tpdomain = NULL;
318 while (!mono_runtime_is_shutting_down ()) {
319 gboolean retire = FALSE;
321 if (thread->state & (ThreadState_AbortRequested | ThreadState_SuspendRequested)) {
323 if (mono_thread_interruption_checkpoint ()) {
330 tpdomain = tpdomain_get_next (previous_tpdomain);
334 tpdomain->outstanding_request --;
335 g_assert (tpdomain->outstanding_request >= 0);
337 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_THREADPOOL, "[%p] worker running in domain %p (outstanding requests %d)",
338 mono_native_thread_id_get (), tpdomain->domain, tpdomain->outstanding_request);
340 g_assert (tpdomain->threadpool_jobs >= 0);
341 tpdomain->threadpool_jobs ++;
345 mono_thread_set_name_internal (thread, mono_string_new (mono_get_root_domain (), "Threadpool worker"), FALSE, TRUE, &error);
346 mono_error_assert_ok (&error);
348 mono_thread_clr_state (thread, (MonoThreadState)~ThreadState_Background);
349 if (!mono_thread_test_state (thread , ThreadState_Background))
350 ves_icall_System_Threading_Thread_SetState (thread, ThreadState_Background);
352 mono_thread_push_appdomain_ref (tpdomain->domain);
353 if (mono_domain_set (tpdomain->domain, FALSE)) {
354 MonoObject *exc = NULL, *res;
356 res = try_invoke_perform_wait_callback (&exc, &error);
357 if (exc || !mono_error_ok(&error)) {
359 exc = (MonoObject *) mono_error_convert_to_exception (&error);
361 mono_error_cleanup (&error);
362 mono_thread_internal_unhandled_exception (exc);
363 } else if (res && *(MonoBoolean*) mono_object_unbox (res) == FALSE) {
367 mono_domain_set (mono_get_root_domain (), TRUE);
369 mono_thread_pop_appdomain_ref ();
373 tpdomain->threadpool_jobs --;
374 g_assert (tpdomain->threadpool_jobs >= 0);
376 if (tpdomain->outstanding_request + tpdomain->threadpool_jobs == 0 && mono_domain_is_unloading (tpdomain->domain)) {
379 removed = tpdomain_remove (tpdomain);
382 mono_coop_cond_signal (&tpdomain->cleanup_cond);
389 previous_tpdomain = tpdomain;
394 COUNTER_ATOMIC (counter, {
395 counter._.working --;
398 mono_refcount_dec (&threadpool);
402 mono_threadpool_cleanup (void)
404 #ifndef DISABLE_SOCKETS
405 mono_threadpool_io_cleanup ();
407 mono_lazy_cleanup (&status, cleanup);
411 mono_threadpool_begin_invoke (MonoDomain *domain, MonoObject *target, MonoMethod *method, gpointer *params, MonoError *error)
413 static MonoClass *async_call_klass = NULL;
414 MonoMethodMessage *message;
415 MonoAsyncResult *async_result;
416 MonoAsyncCall *async_call;
417 MonoDelegate *async_callback = NULL;
418 MonoObject *state = NULL;
420 if (!async_call_klass)
421 async_call_klass = mono_class_load_from_name (mono_defaults.corlib, "System", "MonoAsyncCall");
423 mono_error_init (error);
425 message = mono_method_call_message_new (method, params, mono_get_delegate_invoke (method->klass), (params != NULL) ? (&async_callback) : NULL, (params != NULL) ? (&state) : NULL, error);
426 return_val_if_nok (error, NULL);
428 async_call = (MonoAsyncCall*) mono_object_new_checked (domain, async_call_klass, error);
429 return_val_if_nok (error, NULL);
431 MONO_OBJECT_SETREF (async_call, msg, message);
432 MONO_OBJECT_SETREF (async_call, state, state);
434 if (async_callback) {
435 MONO_OBJECT_SETREF (async_call, cb_method, mono_get_delegate_invoke (((MonoObject*) async_callback)->vtable->klass));
436 MONO_OBJECT_SETREF (async_call, cb_target, async_callback);
439 async_result = mono_async_result_new (domain, NULL, async_call->state, NULL, (MonoObject*) async_call, error);
440 return_val_if_nok (error, NULL);
441 MONO_OBJECT_SETREF (async_result, async_delegate, target);
443 mono_threadpool_enqueue_work_item (domain, (MonoObject*) async_result, error);
444 return_val_if_nok (error, NULL);
450 mono_threadpool_end_invoke (MonoAsyncResult *ares, MonoArray **out_args, MonoObject **exc, MonoError *error)
454 mono_error_init (error);
461 /* check if already finished */
462 mono_monitor_enter ((MonoObject*) ares);
464 if (ares->endinvoke_called) {
465 mono_error_set_invalid_operation(error, "Delegate EndInvoke method called more than once");
466 mono_monitor_exit ((MonoObject*) ares);
470 ares->endinvoke_called = 1;
472 /* wait until we are really finished */
473 if (ares->completed) {
474 mono_monitor_exit ((MonoObject *) ares);
478 wait_event = mono_wait_handle_get_handle ((MonoWaitHandle*) ares->handle);
480 wait_event = mono_w32event_create (TRUE, FALSE);
481 g_assert(wait_event);
482 MonoWaitHandle *wait_handle = mono_wait_handle_new (mono_object_domain (ares), wait_event, error);
483 if (!is_ok (error)) {
484 mono_w32event_close (wait_event);
487 MONO_OBJECT_SETREF (ares, handle, (MonoObject*) wait_handle);
489 mono_monitor_exit ((MonoObject*) ares);
492 WaitForSingleObjectEx (wait_event, INFINITE, TRUE);
494 mono_w32handle_wait_one (wait_event, MONO_INFINITE_WAIT, TRUE);
499 ac = (MonoAsyncCall*) ares->object_data;
502 *exc = ac->msg->exc; /* FIXME: GC add write barrier */
503 *out_args = ac->out_args;
508 mono_threadpool_remove_domain_jobs (MonoDomain *domain, int timeout)
511 ThreadPoolDomain *tpdomain;
515 g_assert (timeout >= -1);
517 g_assert (mono_domain_is_unloading (domain));
520 end = mono_msec_ticks () + timeout;
522 #ifndef DISABLE_SOCKETS
523 mono_threadpool_io_remove_domain_jobs (domain);
525 if (mono_msec_ticks () > end)
531 * Wait for all threads which execute jobs in the domain to exit.
532 * The is_unloading () check in worker_request () ensures that
533 * no new jobs are added after we enter the lock below.
536 if (!mono_lazy_is_initialized (&status))
539 mono_refcount_inc (&threadpool);
543 tpdomain = tpdomain_get (domain);
546 mono_refcount_dec (&threadpool);
552 while (tpdomain->outstanding_request + tpdomain->threadpool_jobs > 0) {
554 mono_coop_cond_wait (&tpdomain->cleanup_cond, &threadpool.domains_lock);
559 now = mono_msec_ticks();
565 res = mono_coop_cond_timedwait (&tpdomain->cleanup_cond, &threadpool.domains_lock, end - now);
573 /* Remove from the list the worker threads look at */
574 tpdomain_remove (tpdomain);
578 mono_coop_cond_destroy (&tpdomain->cleanup_cond);
579 tpdomain_free (tpdomain);
581 mono_refcount_dec (&threadpool);
587 mono_threadpool_suspend (void)
589 if (mono_lazy_is_initialized (&status))
590 mono_threadpool_worker_set_suspended (TRUE);
594 mono_threadpool_resume (void)
596 if (mono_lazy_is_initialized (&status))
597 mono_threadpool_worker_set_suspended (FALSE);
601 ves_icall_System_Threading_ThreadPool_GetAvailableThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
603 ThreadPoolCounter counter;
605 if (!worker_threads || !completion_port_threads)
608 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
610 *completion_port_threads = 0;
614 counter = COUNTER_READ ();
616 *worker_threads = MAX (0, mono_threadpool_worker_get_max () - counter._.working);
617 *completion_port_threads = threadpool.limit_io_max;
619 mono_refcount_dec (&threadpool);
623 ves_icall_System_Threading_ThreadPool_GetMinThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
625 if (!worker_threads || !completion_port_threads)
628 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
630 *completion_port_threads = 0;
634 *worker_threads = mono_threadpool_worker_get_min ();
635 *completion_port_threads = threadpool.limit_io_min;
637 mono_refcount_dec (&threadpool);
641 ves_icall_System_Threading_ThreadPool_GetMaxThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
643 if (!worker_threads || !completion_port_threads)
646 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
648 *completion_port_threads = 0;
652 *worker_threads = mono_threadpool_worker_get_max ();
653 *completion_port_threads = threadpool.limit_io_max;
655 mono_refcount_dec (&threadpool);
659 ves_icall_System_Threading_ThreadPool_SetMinThreadsNative (gint32 worker_threads, gint32 completion_port_threads)
661 if (completion_port_threads <= 0 || completion_port_threads > threadpool.limit_io_max)
664 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool))
667 if (!mono_threadpool_worker_set_min (worker_threads)) {
668 mono_refcount_dec (&threadpool);
672 threadpool.limit_io_min = completion_port_threads;
674 mono_refcount_dec (&threadpool);
679 ves_icall_System_Threading_ThreadPool_SetMaxThreadsNative (gint32 worker_threads, gint32 completion_port_threads)
681 gint cpu_count = mono_cpu_count ();
683 if (completion_port_threads < threadpool.limit_io_min || completion_port_threads < cpu_count)
686 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool))
689 if (!mono_threadpool_worker_set_max (worker_threads)) {
690 mono_refcount_dec (&threadpool);
694 threadpool.limit_io_max = completion_port_threads;
696 mono_refcount_dec (&threadpool);
701 ves_icall_System_Threading_ThreadPool_InitializeVMTp (MonoBoolean *enable_worker_tracking)
703 if (enable_worker_tracking) {
704 // TODO implement some kind of switch to have the possibily to use it
705 *enable_worker_tracking = FALSE;
708 mono_lazy_initialize (&status, initialize);
712 ves_icall_System_Threading_ThreadPool_NotifyWorkItemComplete (void)
714 if (mono_domain_is_unloading (mono_domain_get ()) || mono_runtime_is_shutting_down ())
717 return mono_threadpool_worker_notify_completed ();
721 ves_icall_System_Threading_ThreadPool_NotifyWorkItemProgressNative (void)
723 mono_threadpool_worker_notify_completed ();
727 ves_icall_System_Threading_ThreadPool_ReportThreadStatus (MonoBoolean is_working)
731 mono_error_set_not_implemented (&error, "");
732 mono_error_set_pending_exception (&error);
736 ves_icall_System_Threading_ThreadPool_RequestWorkerThread (void)
739 ThreadPoolDomain *tpdomain;
740 ThreadPoolCounter counter;
742 domain = mono_domain_get ();
743 if (mono_domain_is_unloading (domain))
746 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
747 /* threadpool has been destroyed, we are shutting down */
753 tpdomain = tpdomain_get (domain);
755 /* synchronize with mono_threadpool_remove_domain_jobs */
756 if (mono_domain_is_unloading (domain)) {
758 mono_refcount_dec (&threadpool);
762 tpdomain = tpdomain_create (domain);
767 tpdomain->outstanding_request ++;
768 g_assert (tpdomain->outstanding_request >= 1);
772 COUNTER_ATOMIC (counter, {
773 if (counter._.starting == 16) {
774 mono_refcount_dec (&threadpool);
778 counter._.starting ++;
781 mono_threadpool_worker_enqueue (worker_callback, NULL);
783 mono_refcount_dec (&threadpool);
787 MonoBoolean G_GNUC_UNUSED
788 ves_icall_System_Threading_ThreadPool_PostQueuedCompletionStatus (MonoNativeOverlapped *native_overlapped)
790 /* This copy the behavior of the current Mono implementation */
792 mono_error_set_not_implemented (&error, "");
793 mono_error_set_pending_exception (&error);
797 MonoBoolean G_GNUC_UNUSED
798 ves_icall_System_Threading_ThreadPool_BindIOCompletionCallbackNative (gpointer file_handle)
800 /* This copy the behavior of the current Mono implementation */
804 MonoBoolean G_GNUC_UNUSED
805 ves_icall_System_Threading_ThreadPool_IsThreadPoolHosted (void)