2 * sgen-thread-pool.c: Threadpool for all concurrent GC work.
4 * Copyright (C) 2015 Xamarin Inc
6 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
12 #include "mono/sgen/sgen-gc.h"
13 #include "mono/sgen/sgen-thread-pool.h"
14 #include "mono/sgen/sgen-pointer-queue.h"
15 #include "mono/utils/mono-os-mutex.h"
16 #ifndef SGEN_WITHOUT_MONO
17 #include "mono/utils/mono-threads.h"
20 static mono_mutex_t lock
;
21 static mono_cond_t work_cond
;
22 static mono_cond_t done_cond
;
24 static MonoNativeThreadId thread
;
26 /* Only accessed with the lock held. */
27 static SgenPointerQueue job_queue
;
29 static SgenThreadPoolThreadInitFunc thread_init_func
;
30 static SgenThreadPoolIdleJobFunc idle_job_func
;
31 static SgenThreadPoolContinueIdleJobFunc continue_idle_job_func
;
33 static volatile gboolean threadpool_shutdown
;
34 static volatile gboolean thread_finished
;
42 /* Assumes that the lock is held. */
43 static SgenThreadPoolJob
*
44 get_job_and_set_in_progress (void)
46 for (size_t i
= 0; i
< job_queue
.next_slot
; ++i
) {
47 SgenThreadPoolJob
*job
= (SgenThreadPoolJob
*)job_queue
.data
[i
];
48 if (job
->state
== STATE_WAITING
) {
49 job
->state
= STATE_IN_PROGRESS
;
56 /* Assumes that the lock is held. */
58 find_job_in_queue (SgenThreadPoolJob
*job
)
60 for (ssize_t i
= 0; i
< job_queue
.next_slot
; ++i
) {
61 if (job_queue
.data
[i
] == job
)
67 /* Assumes that the lock is held. */
69 remove_job (SgenThreadPoolJob
*job
)
72 SGEN_ASSERT (0, job
->state
== STATE_DONE
, "Why are we removing a job that's not done?");
73 index
= find_job_in_queue (job
);
74 SGEN_ASSERT (0, index
>= 0, "Why is the job we're trying to remove not in the queue?");
75 job_queue
.data
[index
] = NULL
;
76 sgen_pointer_queue_remove_nulls (&job_queue
);
77 sgen_thread_pool_job_free (job
);
81 continue_idle_job (void)
83 if (!continue_idle_job_func
)
85 return continue_idle_job_func ();
88 static mono_native_thread_return_t
89 thread_func (void *thread_data
)
91 thread_init_func (thread_data
);
93 mono_os_mutex_lock (&lock
);
96 * It's important that we check the continue idle flag with the lock held.
97 * Suppose we didn't check with the lock held, and the result is FALSE. The
98 * main thread might then set continue idle and signal us before we can take
99 * the lock, and we'd lose the signal.
101 gboolean do_idle
= continue_idle_job ();
102 SgenThreadPoolJob
*job
= get_job_and_set_in_progress ();
104 if (!job
&& !do_idle
&& !threadpool_shutdown
) {
106 * pthread_cond_wait() can return successfully despite the condition
107 * not being signalled, so we have to run this in a loop until we
108 * really have work to do.
110 mono_os_cond_wait (&work_cond
, &lock
);
114 mono_os_mutex_unlock (&lock
);
117 job
->func (thread_data
, job
);
119 mono_os_mutex_lock (&lock
);
121 SGEN_ASSERT (0, job
->state
== STATE_IN_PROGRESS
, "The job should still be in progress.");
122 job
->state
= STATE_DONE
;
125 * Only the main GC thread will ever wait on the done condition, so we don't
128 mono_os_cond_signal (&done_cond
);
129 } else if (do_idle
) {
130 SGEN_ASSERT (0, idle_job_func
, "Why do we have idle work when there's no idle job function?");
132 idle_job_func (thread_data
);
133 do_idle
= continue_idle_job ();
134 } while (do_idle
&& !job_queue
.next_slot
);
136 mono_os_mutex_lock (&lock
);
139 mono_os_cond_signal (&done_cond
);
141 SGEN_ASSERT (0, threadpool_shutdown
, "Why did we unlock if no jobs and not shutting down?");
142 mono_os_mutex_lock (&lock
);
143 thread_finished
= TRUE
;
144 mono_os_cond_signal (&done_cond
);
145 mono_os_mutex_unlock (&lock
);
150 return (mono_native_thread_return_t
)0;
154 sgen_thread_pool_init (int num_threads
, SgenThreadPoolThreadInitFunc init_func
, SgenThreadPoolIdleJobFunc idle_func
, SgenThreadPoolContinueIdleJobFunc continue_idle_func
, void **thread_datas
)
156 SGEN_ASSERT (0, num_threads
== 1, "We only support 1 thread pool thread for now.");
158 mono_os_mutex_init (&lock
);
159 mono_os_cond_init (&work_cond
);
160 mono_os_cond_init (&done_cond
);
162 thread_init_func
= init_func
;
163 idle_job_func
= idle_func
;
164 continue_idle_job_func
= continue_idle_func
;
166 mono_native_thread_create (&thread
, thread_func
, thread_datas
? thread_datas
[0] : NULL
);
170 sgen_thread_pool_shutdown (void)
175 mono_os_mutex_lock (&lock
);
176 threadpool_shutdown
= TRUE
;
177 mono_os_cond_signal (&work_cond
);
178 while (!thread_finished
)
179 mono_os_cond_wait (&done_cond
, &lock
);
180 mono_os_mutex_unlock (&lock
);
182 mono_os_mutex_destroy (&lock
);
183 mono_os_cond_destroy (&work_cond
);
184 mono_os_cond_destroy (&done_cond
);
188 sgen_thread_pool_job_alloc (const char *name
, SgenThreadPoolJobFunc func
, size_t size
)
190 SgenThreadPoolJob
*job
= (SgenThreadPoolJob
*)sgen_alloc_internal_dynamic (size
, INTERNAL_MEM_THREAD_POOL_JOB
, TRUE
);
193 job
->state
= STATE_WAITING
;
199 sgen_thread_pool_job_free (SgenThreadPoolJob
*job
)
201 sgen_free_internal_dynamic (job
, job
->size
, INTERNAL_MEM_THREAD_POOL_JOB
);
205 sgen_thread_pool_job_enqueue (SgenThreadPoolJob
*job
)
207 mono_os_mutex_lock (&lock
);
209 sgen_pointer_queue_add (&job_queue
, job
);
211 * FIXME: We could check whether there is a job in progress. If there is, there's
212 * no need to signal the condition, at least as long as we have only one thread.
214 mono_os_cond_signal (&work_cond
);
216 mono_os_mutex_unlock (&lock
);
220 sgen_thread_pool_job_wait (SgenThreadPoolJob
*job
)
222 SGEN_ASSERT (0, job
, "Where's the job?");
224 mono_os_mutex_lock (&lock
);
226 while (find_job_in_queue (job
) >= 0)
227 mono_os_cond_wait (&done_cond
, &lock
);
229 mono_os_mutex_unlock (&lock
);
233 sgen_thread_pool_idle_signal (void)
235 SGEN_ASSERT (0, idle_job_func
, "Why are we signaling idle without an idle function?");
237 mono_os_mutex_lock (&lock
);
239 if (continue_idle_job_func ())
240 mono_os_cond_signal (&work_cond
);
242 mono_os_mutex_unlock (&lock
);
246 sgen_thread_pool_idle_wait (void)
248 SGEN_ASSERT (0, idle_job_func
, "Why are we waiting for idle without an idle function?");
250 mono_os_mutex_lock (&lock
);
252 while (continue_idle_job_func ())
253 mono_os_cond_wait (&done_cond
, &lock
);
255 mono_os_mutex_unlock (&lock
);
259 sgen_thread_pool_wait_for_all_jobs (void)
261 mono_os_mutex_lock (&lock
);
263 while (!sgen_pointer_queue_is_empty (&job_queue
))
264 mono_os_cond_wait (&done_cond
, &lock
);
266 mono_os_mutex_unlock (&lock
);
270 sgen_thread_pool_is_thread_pool_thread (MonoNativeThreadId some_thread
)
272 return some_thread
== thread
;