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>
52 /* Number of outstanding jobs */
53 gint32 outstanding_request;
54 /* Number of currently executing jobs */
55 gint32 threadpool_jobs;
56 /* Signalled when threadpool_jobs + outstanding_request is 0 */
57 /* Protected by threadpool.domains_lock */
58 MonoCoopCond cleanup_cond;
63 gint16 starting; /* starting, but not yet in worker_callback */
64 gint16 working; /* executing worker_callback */
72 GPtrArray *domains; // ThreadPoolDomain* []
73 MonoCoopMutex domains_lock;
75 ThreadPoolCounter counters;
81 static mono_lazy_init_t status = MONO_LAZY_INIT_STATUS_NOT_INITIALIZED;
83 static ThreadPool threadpool;
85 #define COUNTER_ATOMIC(var,block) \
87 ThreadPoolCounter __old; \
89 (var) = __old = COUNTER_READ (); \
91 if (!(counter._.starting >= 0)) \
92 g_error ("%s: counter._.starting = %d, but should be >= 0", __func__, counter._.starting); \
93 if (!(counter._.working >= 0)) \
94 g_error ("%s: counter._.working = %d, but should be >= 0", __func__, counter._.working); \
95 } while (InterlockedCompareExchange (&threadpool.counters.as_gint32, (var).as_gint32, __old.as_gint32) != __old.as_gint32); \
98 static inline ThreadPoolCounter
101 ThreadPoolCounter counter;
102 counter.as_gint32 = InterlockedRead (&threadpool.counters.as_gint32);
109 mono_coop_mutex_lock (&threadpool.domains_lock);
113 domains_unlock (void)
115 mono_coop_mutex_unlock (&threadpool.domains_lock);
119 destroy (gpointer unused)
121 g_ptr_array_free (threadpool.domains, TRUE);
122 mono_coop_mutex_destroy (&threadpool.domains_lock);
128 g_assert (sizeof (ThreadPoolCounter) == sizeof (gint32));
130 mono_refcount_init (&threadpool, destroy);
132 threadpool.domains = g_ptr_array_new ();
133 mono_coop_mutex_init (&threadpool.domains_lock);
135 threadpool.limit_io_min = mono_cpu_count ();
136 threadpool.limit_io_max = CLAMP (threadpool.limit_io_min * 100, MIN (threadpool.limit_io_min, 200), MAX (threadpool.limit_io_min, 200));
138 mono_threadpool_worker_init ();
144 mono_threadpool_worker_cleanup ();
146 mono_refcount_dec (&threadpool);
150 mono_threadpool_enqueue_work_item (MonoDomain *domain, MonoObject *work_item, MonoError *error)
152 static MonoClass *threadpool_class = NULL;
153 static MonoMethod *unsafe_queue_custom_work_item_method = NULL;
154 MonoDomain *current_domain;
159 g_assert (work_item);
161 if (!threadpool_class)
162 threadpool_class = mono_class_load_from_name (mono_defaults.corlib, "System.Threading", "ThreadPool");
164 if (!unsafe_queue_custom_work_item_method)
165 unsafe_queue_custom_work_item_method = mono_class_get_method_from_name (threadpool_class, "UnsafeQueueCustomWorkItem", 2);
166 g_assert (unsafe_queue_custom_work_item_method);
170 args [0] = (gpointer) work_item;
171 args [1] = (gpointer) &f;
173 current_domain = mono_domain_get ();
174 if (current_domain == domain) {
175 mono_runtime_invoke_checked (unsafe_queue_custom_work_item_method, NULL, args, error);
176 return_val_if_nok (error, FALSE);
178 mono_thread_push_appdomain_ref (domain);
179 if (mono_domain_set (domain, FALSE)) {
180 mono_runtime_invoke_checked (unsafe_queue_custom_work_item_method, NULL, args, error);
181 if (!is_ok (error)) {
182 mono_thread_pop_appdomain_ref ();
185 mono_domain_set (current_domain, TRUE);
187 mono_thread_pop_appdomain_ref ();
192 /* LOCKING: domains_lock must be held. */
193 static ThreadPoolDomain *
194 tpdomain_create (MonoDomain *domain)
196 ThreadPoolDomain *tpdomain;
198 tpdomain = g_new0 (ThreadPoolDomain, 1);
199 tpdomain->domain = domain;
200 mono_coop_cond_init (&tpdomain->cleanup_cond);
202 g_ptr_array_add (threadpool.domains, tpdomain);
207 /* LOCKING: domains_lock must be held. */
209 tpdomain_remove (ThreadPoolDomain *tpdomain)
212 return g_ptr_array_remove (threadpool.domains, tpdomain);
215 /* LOCKING: domains_lock must be held */
216 static ThreadPoolDomain *
217 tpdomain_get (MonoDomain *domain)
223 for (i = 0; i < threadpool.domains->len; ++i) {
224 ThreadPoolDomain *tpdomain;
226 tpdomain = (ThreadPoolDomain *)g_ptr_array_index (threadpool.domains, i);
227 if (tpdomain->domain == domain)
235 tpdomain_free (ThreadPoolDomain *tpdomain)
240 /* LOCKING: domains_lock must be held */
241 static ThreadPoolDomain *
242 tpdomain_get_next (ThreadPoolDomain *current)
244 ThreadPoolDomain *tpdomain = NULL;
247 len = threadpool.domains->len;
249 gint i, current_idx = -1;
251 for (i = 0; i < len; ++i) {
252 if (current == g_ptr_array_index (threadpool.domains, i)) {
258 for (i = current_idx + 1; i < len + current_idx + 1; ++i) {
259 ThreadPoolDomain *tmp = (ThreadPoolDomain *)g_ptr_array_index (threadpool.domains, i % len);
260 if (tmp->outstanding_request > 0) {
271 try_invoke_perform_wait_callback (MonoObject** exc, MonoError *error)
273 HANDLE_FUNCTION_ENTER ();
275 MonoObject *res = mono_runtime_try_invoke (mono_defaults.threadpool_perform_wait_callback_method, NULL, NULL, exc, error);
276 HANDLE_FUNCTION_RETURN_VAL (res);
280 worker_callback (gpointer unused)
283 ThreadPoolDomain *tpdomain, *previous_tpdomain;
284 ThreadPoolCounter counter;
285 MonoInternalThread *thread;
287 if (!mono_refcount_tryinc (&threadpool))
290 thread = mono_thread_internal_current ();
292 COUNTER_ATOMIC (counter, {
293 if (!(counter._.working < 32767 /* G_MAXINT16 */))
294 g_error ("%s: counter._.working = %d, but should be < 32767", __func__, counter._.working);
296 counter._.starting --;
297 counter._.working ++;
300 if (mono_runtime_is_shutting_down ()) {
301 COUNTER_ATOMIC (counter, {
302 counter._.working --;
305 mono_refcount_dec (&threadpool);
310 * This is needed so there is always an lmf frame in the runtime invoke call below,
311 * so ThreadAbortExceptions are caught even if the thread is in native code.
313 mono_defaults.threadpool_perform_wait_callback_method->save_lmf = TRUE;
317 previous_tpdomain = NULL;
319 while (!mono_runtime_is_shutting_down ()) {
320 gboolean retire = FALSE;
322 if (thread->state & (ThreadState_AbortRequested | ThreadState_SuspendRequested)) {
324 if (mono_thread_interruption_checkpoint ()) {
331 tpdomain = tpdomain_get_next (previous_tpdomain);
335 tpdomain->outstanding_request --;
336 g_assert (tpdomain->outstanding_request >= 0);
338 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_THREADPOOL, "[%p] worker running in domain %p (outstanding requests %d)",
339 mono_native_thread_id_get (), tpdomain->domain, tpdomain->outstanding_request);
341 g_assert (tpdomain->threadpool_jobs >= 0);
342 tpdomain->threadpool_jobs ++;
346 mono_thread_set_name_internal (thread, mono_string_new (mono_get_root_domain (), "Threadpool worker"), FALSE, TRUE, &error);
347 mono_error_assert_ok (&error);
349 mono_thread_clr_state (thread, (MonoThreadState)~ThreadState_Background);
350 if (!mono_thread_test_state (thread , ThreadState_Background))
351 ves_icall_System_Threading_Thread_SetState (thread, ThreadState_Background);
353 mono_thread_push_appdomain_ref (tpdomain->domain);
354 if (mono_domain_set (tpdomain->domain, FALSE)) {
355 MonoObject *exc = NULL, *res;
357 res = try_invoke_perform_wait_callback (&exc, &error);
358 if (exc || !mono_error_ok(&error)) {
360 exc = (MonoObject *) mono_error_convert_to_exception (&error);
362 mono_error_cleanup (&error);
363 mono_thread_internal_unhandled_exception (exc);
364 } else if (res && *(MonoBoolean*) mono_object_unbox (res) == FALSE) {
368 mono_domain_set (mono_get_root_domain (), TRUE);
370 mono_thread_pop_appdomain_ref ();
374 tpdomain->threadpool_jobs --;
375 g_assert (tpdomain->threadpool_jobs >= 0);
377 if (tpdomain->outstanding_request + tpdomain->threadpool_jobs == 0 && mono_domain_is_unloading (tpdomain->domain)) {
380 removed = tpdomain_remove (tpdomain);
383 mono_coop_cond_signal (&tpdomain->cleanup_cond);
390 previous_tpdomain = tpdomain;
395 COUNTER_ATOMIC (counter, {
396 counter._.working --;
399 mono_refcount_dec (&threadpool);
403 mono_threadpool_cleanup (void)
405 #ifndef DISABLE_SOCKETS
406 mono_threadpool_io_cleanup ();
408 mono_lazy_cleanup (&status, cleanup);
412 mono_threadpool_begin_invoke (MonoDomain *domain, MonoObject *target, MonoMethod *method, gpointer *params, MonoError *error)
414 static MonoClass *async_call_klass = NULL;
415 MonoMethodMessage *message;
416 MonoAsyncResult *async_result;
417 MonoAsyncCall *async_call;
418 MonoDelegate *async_callback = NULL;
419 MonoObject *state = NULL;
421 if (!async_call_klass)
422 async_call_klass = mono_class_load_from_name (mono_defaults.corlib, "System", "MonoAsyncCall");
426 message = mono_method_call_message_new (method, params, mono_get_delegate_invoke (method->klass), (params != NULL) ? (&async_callback) : NULL, (params != NULL) ? (&state) : NULL, error);
427 return_val_if_nok (error, NULL);
429 async_call = (MonoAsyncCall*) mono_object_new_checked (domain, async_call_klass, error);
430 return_val_if_nok (error, NULL);
432 MONO_OBJECT_SETREF (async_call, msg, message);
433 MONO_OBJECT_SETREF (async_call, state, state);
435 if (async_callback) {
436 MONO_OBJECT_SETREF (async_call, cb_method, mono_get_delegate_invoke (((MonoObject*) async_callback)->vtable->klass));
437 MONO_OBJECT_SETREF (async_call, cb_target, async_callback);
440 async_result = mono_async_result_new (domain, NULL, async_call->state, NULL, (MonoObject*) async_call, error);
441 return_val_if_nok (error, NULL);
442 MONO_OBJECT_SETREF (async_result, async_delegate, target);
444 mono_threadpool_enqueue_work_item (domain, (MonoObject*) async_result, error);
445 return_val_if_nok (error, NULL);
451 mono_threadpool_end_invoke (MonoAsyncResult *ares, MonoArray **out_args, MonoObject **exc, MonoError *error)
462 /* check if already finished */
463 mono_monitor_enter ((MonoObject*) ares);
465 if (ares->endinvoke_called) {
466 mono_error_set_invalid_operation(error, "Delegate EndInvoke method called more than once");
467 mono_monitor_exit ((MonoObject*) ares);
471 ares->endinvoke_called = 1;
473 /* wait until we are really finished */
474 if (ares->completed) {
475 mono_monitor_exit ((MonoObject *) ares);
479 wait_event = mono_wait_handle_get_handle ((MonoWaitHandle*) ares->handle);
481 wait_event = mono_w32event_create (TRUE, FALSE);
482 g_assert(wait_event);
483 MonoWaitHandle *wait_handle = mono_wait_handle_new (mono_object_domain (ares), wait_event, error);
484 if (!is_ok (error)) {
485 mono_w32event_close (wait_event);
488 MONO_OBJECT_SETREF (ares, handle, (MonoObject*) wait_handle);
490 mono_monitor_exit ((MonoObject*) ares);
493 WaitForSingleObjectEx (wait_event, INFINITE, TRUE);
495 mono_w32handle_wait_one (wait_event, MONO_INFINITE_WAIT, TRUE);
500 ac = (MonoAsyncCall*) ares->object_data;
503 *exc = ac->msg->exc; /* FIXME: GC add write barrier */
504 *out_args = ac->out_args;
509 mono_threadpool_remove_domain_jobs (MonoDomain *domain, int timeout)
512 ThreadPoolDomain *tpdomain;
516 g_assert (timeout >= -1);
518 g_assert (mono_domain_is_unloading (domain));
521 end = mono_msec_ticks () + timeout;
523 #ifndef DISABLE_SOCKETS
524 mono_threadpool_io_remove_domain_jobs (domain);
526 if (mono_msec_ticks () > end)
532 * Wait for all threads which execute jobs in the domain to exit.
533 * The is_unloading () check in worker_request () ensures that
534 * no new jobs are added after we enter the lock below.
537 if (!mono_lazy_is_initialized (&status))
540 mono_refcount_inc (&threadpool);
544 tpdomain = tpdomain_get (domain);
547 mono_refcount_dec (&threadpool);
553 while (tpdomain->outstanding_request + tpdomain->threadpool_jobs > 0) {
555 mono_coop_cond_wait (&tpdomain->cleanup_cond, &threadpool.domains_lock);
560 now = mono_msec_ticks();
566 res = mono_coop_cond_timedwait (&tpdomain->cleanup_cond, &threadpool.domains_lock, end - now);
574 /* Remove from the list the worker threads look at */
575 tpdomain_remove (tpdomain);
579 mono_coop_cond_destroy (&tpdomain->cleanup_cond);
580 tpdomain_free (tpdomain);
582 mono_refcount_dec (&threadpool);
588 mono_threadpool_suspend (void)
590 if (mono_lazy_is_initialized (&status))
591 mono_threadpool_worker_set_suspended (TRUE);
595 mono_threadpool_resume (void)
597 if (mono_lazy_is_initialized (&status))
598 mono_threadpool_worker_set_suspended (FALSE);
602 ves_icall_System_Threading_ThreadPool_GetAvailableThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
604 ThreadPoolCounter counter;
606 if (!worker_threads || !completion_port_threads)
609 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
611 *completion_port_threads = 0;
615 counter = COUNTER_READ ();
617 *worker_threads = MAX (0, mono_threadpool_worker_get_max () - counter._.working);
618 *completion_port_threads = threadpool.limit_io_max;
620 mono_refcount_dec (&threadpool);
624 ves_icall_System_Threading_ThreadPool_GetMinThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
626 if (!worker_threads || !completion_port_threads)
629 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
631 *completion_port_threads = 0;
635 *worker_threads = mono_threadpool_worker_get_min ();
636 *completion_port_threads = threadpool.limit_io_min;
638 mono_refcount_dec (&threadpool);
642 ves_icall_System_Threading_ThreadPool_GetMaxThreadsNative (gint32 *worker_threads, gint32 *completion_port_threads)
644 if (!worker_threads || !completion_port_threads)
647 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
649 *completion_port_threads = 0;
653 *worker_threads = mono_threadpool_worker_get_max ();
654 *completion_port_threads = threadpool.limit_io_max;
656 mono_refcount_dec (&threadpool);
660 ves_icall_System_Threading_ThreadPool_SetMinThreadsNative (gint32 worker_threads, gint32 completion_port_threads)
662 if (completion_port_threads <= 0 || completion_port_threads > threadpool.limit_io_max)
665 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool))
668 if (!mono_threadpool_worker_set_min (worker_threads)) {
669 mono_refcount_dec (&threadpool);
673 threadpool.limit_io_min = completion_port_threads;
675 mono_refcount_dec (&threadpool);
680 ves_icall_System_Threading_ThreadPool_SetMaxThreadsNative (gint32 worker_threads, gint32 completion_port_threads)
682 gint cpu_count = mono_cpu_count ();
684 if (completion_port_threads < threadpool.limit_io_min || completion_port_threads < cpu_count)
687 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool))
690 if (!mono_threadpool_worker_set_max (worker_threads)) {
691 mono_refcount_dec (&threadpool);
695 threadpool.limit_io_max = completion_port_threads;
697 mono_refcount_dec (&threadpool);
702 ves_icall_System_Threading_ThreadPool_InitializeVMTp (MonoBoolean *enable_worker_tracking)
704 if (enable_worker_tracking) {
705 // TODO implement some kind of switch to have the possibily to use it
706 *enable_worker_tracking = FALSE;
709 mono_lazy_initialize (&status, initialize);
713 ves_icall_System_Threading_ThreadPool_NotifyWorkItemComplete (void)
715 if (mono_domain_is_unloading (mono_domain_get ()) || mono_runtime_is_shutting_down ())
718 return mono_threadpool_worker_notify_completed ();
722 ves_icall_System_Threading_ThreadPool_NotifyWorkItemProgressNative (void)
724 mono_threadpool_worker_notify_completed ();
728 ves_icall_System_Threading_ThreadPool_ReportThreadStatus (MonoBoolean is_working)
732 mono_error_set_not_implemented (&error, "");
733 mono_error_set_pending_exception (&error);
737 ves_icall_System_Threading_ThreadPool_RequestWorkerThread (void)
740 ThreadPoolDomain *tpdomain;
741 ThreadPoolCounter counter;
743 domain = mono_domain_get ();
744 if (mono_domain_is_unloading (domain))
747 if (!mono_lazy_initialize (&status, initialize) || !mono_refcount_tryinc (&threadpool)) {
748 /* threadpool has been destroyed, we are shutting down */
754 tpdomain = tpdomain_get (domain);
756 /* synchronize with mono_threadpool_remove_domain_jobs */
757 if (mono_domain_is_unloading (domain)) {
759 mono_refcount_dec (&threadpool);
763 tpdomain = tpdomain_create (domain);
768 tpdomain->outstanding_request ++;
769 g_assert (tpdomain->outstanding_request >= 1);
773 COUNTER_ATOMIC (counter, {
774 if (counter._.starting == 16) {
775 mono_refcount_dec (&threadpool);
779 counter._.starting ++;
782 mono_threadpool_worker_enqueue (worker_callback, NULL);
784 mono_refcount_dec (&threadpool);
788 MonoBoolean G_GNUC_UNUSED
789 ves_icall_System_Threading_ThreadPool_PostQueuedCompletionStatus (MonoNativeOverlapped *native_overlapped)
791 /* This copy the behavior of the current Mono implementation */
793 mono_error_set_not_implemented (&error, "");
794 mono_error_set_pending_exception (&error);
798 MonoBoolean G_GNUC_UNUSED
799 ves_icall_System_Threading_ThreadPool_BindIOCompletionCallbackNative (gpointer file_handle)
801 /* This copy the behavior of the current Mono implementation */
805 MonoBoolean G_GNUC_UNUSED
806 ves_icall_System_Threading_ThreadPool_IsThreadPoolHosted (void)