mono/sgen/sgen-workers.c

   1 /*
   2  * sgen-workers.c: Worker threads for parallel and concurrent GC.
   3  *
   4  * Copyright 2001-2003 Ximian, Inc
   5  * Copyright 2003-2010 Novell, Inc.
   6  * Copyright (C) 2012 Xamarin Inc
   7  *
   8  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
   9  */
  10
  11 #include "config.h"
  12 #ifdef HAVE_SGEN_GC
  13
  14 #include <string.h>
  15
  16 #include "mono/sgen/sgen-gc.h"
  17 #include "mono/sgen/sgen-workers.h"
  18 #include "mono/sgen/sgen-thread-pool.h"
  19 #include "mono/utils/mono-membar.h"
  20 #include "mono/sgen/sgen-client.h"
  21
  22 static int workers_num;
  23 static volatile gboolean forced_stop;
  24 static WorkerData *workers_data;
  25 static SgenWorkerCallback worker_init_cb;
  26
  27 /*
  28  * When using multiple workers, we need to have the last worker
  29  * enqueue the preclean jobs (if there are any). This lock ensures
  30  * that when the last worker takes it, all the other workers have
  31  * gracefully finished, so it can restart them.
  32  */
  33 static mono_mutex_t finished_lock;
  34
  35 static SgenSectionGrayQueue workers_distribute_gray_queue;
  36 static gboolean workers_distribute_gray_queue_inited;
  37
  38 /*
  39  * Allowed transitions:
  40  *
  41  * | from \ to          | NOT WORKING | WORKING | WORK ENQUEUED |
  42  * |--------------------+-------------+---------+---------------+
  43  * | NOT WORKING        | -           | -       | main / worker |
  44  * | WORKING            | worker      | -       | main / worker |
  45  * | WORK ENQUEUED      | -           | worker  | -             |
  46  *
  47  * The WORK ENQUEUED state guarantees that the worker thread will inspect the queue again at
  48  * least once.  Only after looking at the queue will it go back to WORKING, and then,
  49  * eventually, to NOT WORKING.  After enqueuing work the main thread transitions the state
  50  * to WORK ENQUEUED.  Signalling the worker thread to wake up is only necessary if the old
  51  * state was NOT WORKING.
  52  */
  53
  54 enum {
  55         STATE_NOT_WORKING,
  56         STATE_WORKING,
  57         STATE_WORK_ENQUEUED
  58 };
  59
  60 typedef gint32 State;
  61
  62 static SgenObjectOperations * volatile idle_func_object_ops;
  63 /*
  64  * finished_callback is called only when the workers finish work normally (when they
  65  * are not forced to finish). The callback is used to enqueue preclean jobs.
  66  */
  67 static volatile SgenWorkersFinishCallback finish_callback;
  68
  69 static guint64 stat_workers_num_finished;
  70
  71 static gboolean
  72 set_state (WorkerData *data, State old_state, State new_state)
  73 {
  74         SGEN_ASSERT (0, old_state != new_state, "Why are we transitioning to the same state?");
  75         if (new_state == STATE_NOT_WORKING)
  76                 SGEN_ASSERT (0, old_state == STATE_WORKING, "We can only transition to NOT WORKING from WORKING");
  77         else if (new_state == STATE_WORKING)
  78                 SGEN_ASSERT (0, old_state == STATE_WORK_ENQUEUED, "We can only transition to WORKING from WORK ENQUEUED");
  79         if (new_state == STATE_NOT_WORKING || new_state == STATE_WORKING)
  80                 SGEN_ASSERT (6, sgen_thread_pool_is_thread_pool_thread (mono_native_thread_id_get ()), "Only the worker thread is allowed to transition to NOT_WORKING or WORKING");
  81
  82         return InterlockedCompareExchange (&data->state, new_state, old_state) == old_state;
  83 }
  84
  85 static gboolean
  86 state_is_working_or_enqueued (State state)
  87 {
  88         return state == STATE_WORKING || state == STATE_WORK_ENQUEUED;
  89 }
  90
  91 static void
  92 sgen_workers_ensure_awake (void)
  93 {
  94         int i;
  95         gboolean need_signal = FALSE;
  96
  97         for (i = 0; i < workers_num; i++) {
  98                 State old_state;
  99                 gboolean did_set_state;
 100
 101                 do {
 102                         old_state = workers_data [i].state;
 103
 104                         if (old_state == STATE_WORK_ENQUEUED)
 105                                 break;
 106
 107                         did_set_state = set_state (&workers_data [i], old_state, STATE_WORK_ENQUEUED);
 108                 } while (!did_set_state);
 109
 110                 if (!state_is_working_or_enqueued (old_state))
 111                         need_signal = TRUE;
 112         }
 113
 114         if (need_signal)
 115                 sgen_thread_pool_idle_signal ();
 116 }
 117
 118 static void
 119 worker_try_finish (WorkerData *data)
 120 {
 121         State old_state;
 122         int i, working = 0;
 123
 124         ++stat_workers_num_finished;
 125
 126         mono_os_mutex_lock (&finished_lock);
 127
 128         for (i = 0; i < workers_num; i++) {
 129                 if (state_is_working_or_enqueued (workers_data [i].state))
 130                         working++;
 131         }
 132
 133         if (working == 1) {
 134                 SgenWorkersFinishCallback callback = finish_callback;
 135                 /* We are the last one left. Enqueue preclean job if we have one and awake everybody */
 136                 SGEN_ASSERT (0, data->state != STATE_NOT_WORKING, "How did we get from doing idle work to NOT WORKING without setting it ourselves?");
 137                 if (callback) {
 138                         finish_callback = NULL;
 139                         callback ();
 140                         /* Make sure each worker has a chance of seeing the enqueued jobs */
 141                         sgen_workers_ensure_awake ();
 142                         SGEN_ASSERT (0, data->state == STATE_WORK_ENQUEUED, "Why did we fail to set our own state to ENQUEUED");
 143                         goto work_available;
 144                 }
 145         }
 146
 147         do {
 148                 old_state = data->state;
 149
 150                 SGEN_ASSERT (0, old_state != STATE_NOT_WORKING, "How did we get from doing idle work to NOT WORKING without setting it ourselves?");
 151                 if (old_state == STATE_WORK_ENQUEUED)
 152                         goto work_available;
 153                 SGEN_ASSERT (0, old_state == STATE_WORKING, "What other possibility is there?");
 154         } while (!set_state (data, old_state, STATE_NOT_WORKING));
 155
 156         mono_os_mutex_unlock (&finished_lock);
 157
 158         binary_protocol_worker_finish (sgen_timestamp (), forced_stop);
 159
 160         sgen_gray_object_queue_trim_free_list (&data->private_gray_queue);
 161         return;
 162
 163 work_available:
 164         mono_os_mutex_unlock (&finished_lock);
 165 }
 166
 167 void
 168 sgen_workers_enqueue_job (SgenThreadPoolJob *job, gboolean enqueue)
 169 {
 170         if (!enqueue) {
 171                 job->func (NULL, job);
 172                 sgen_thread_pool_job_free (job);
 173                 return;
 174         }
 175
 176         sgen_thread_pool_job_enqueue (job);
 177 }
 178
 179 void
 180 sgen_workers_wait_for_jobs_finished (void)
 181 {
 182         sgen_thread_pool_wait_for_all_jobs ();
 183         /*
 184          * If the idle task was never triggered or it finished before the last job did and
 185          * then didn't get triggered again, we might end up in the situation of having
 186          * something in the gray queue yet the idle task not working.  The easiest way to
 187          * make sure this doesn't stay that way is to just trigger it again after all jobs
 188          * have finished.
 189          */
 190         sgen_workers_ensure_awake ();
 191 }
 192
 193 static gboolean
 194 workers_get_work (WorkerData *data)
 195 {
 196         SgenMajorCollector *major;
 197
 198         g_assert (sgen_gray_object_queue_is_empty (&data->private_gray_queue));
 199
 200         /* If we're concurrent, steal from the workers distribute gray queue. */
 201         major = sgen_get_major_collector ();
 202         if (major->is_concurrent) {
 203                 GrayQueueSection *section = sgen_section_gray_queue_dequeue (&workers_distribute_gray_queue);
 204                 if (section) {
 205                         sgen_gray_object_enqueue_section (&data->private_gray_queue, section);
 206                         return TRUE;
 207                 }
 208         }
 209
 210         /* Nobody to steal from */
 211         g_assert (sgen_gray_object_queue_is_empty (&data->private_gray_queue));
 212         return FALSE;
 213 }
 214
 215 static void
 216 concurrent_enqueue_check (GCObject *obj)
 217 {
 218         g_assert (sgen_concurrent_collection_in_progress ());
 219         g_assert (!sgen_ptr_in_nursery (obj));
 220         g_assert (SGEN_LOAD_VTABLE (obj));
 221 }
 222
 223 static void
 224 init_private_gray_queue (WorkerData *data)
 225 {
 226         sgen_gray_object_queue_init (&data->private_gray_queue,
 227                         sgen_get_major_collector ()->is_concurrent ? concurrent_enqueue_check : NULL,
 228                         FALSE);
 229 }
 230
 231 static void
 232 thread_pool_init_func (void *data_untyped)
 233 {
 234         WorkerData *data = (WorkerData *)data_untyped;
 235         SgenMajorCollector *major = sgen_get_major_collector ();
 236
 237         sgen_client_thread_register_worker ();
 238
 239         if (!major->is_concurrent)
 240                 return;
 241
 242         init_private_gray_queue (data);
 243
 244         if (worker_init_cb)
 245                 worker_init_cb (data);
 246 }
 247
 248 static gboolean
 249 continue_idle_func (void *data_untyped)
 250 {
 251         if (data_untyped) {
 252                 WorkerData *data = (WorkerData *)data_untyped;
 253                 return state_is_working_or_enqueued (data->state);
 254         } else {
 255                 /* Return if any of the threads is working */
 256                 return !sgen_workers_all_done ();
 257         }
 258 }
 259
 260 static void
 261 marker_idle_func (void *data_untyped)
 262 {
 263         WorkerData *data = (WorkerData *)data_untyped;
 264
 265         SGEN_ASSERT (0, continue_idle_func (data_untyped), "Why are we called when we're not supposed to work?");
 266         SGEN_ASSERT (0, sgen_concurrent_collection_in_progress (), "The worker should only mark in concurrent collections.");
 267
 268         if (data->state == STATE_WORK_ENQUEUED) {
 269                 set_state (data, STATE_WORK_ENQUEUED, STATE_WORKING);
 270                 SGEN_ASSERT (0, data->state != STATE_NOT_WORKING, "How did we get from WORK ENQUEUED to NOT WORKING?");
 271         }
 272
 273         if (!forced_stop && (!sgen_gray_object_queue_is_empty (&data->private_gray_queue) || workers_get_work (data))) {
 274                 ScanCopyContext ctx = CONTEXT_FROM_OBJECT_OPERATIONS (idle_func_object_ops, &data->private_gray_queue);
 275
 276                 SGEN_ASSERT (0, !sgen_gray_object_queue_is_empty (&data->private_gray_queue), "How is our gray queue empty if we just got work?");
 277
 278                 sgen_drain_gray_stack (ctx);
 279         } else {
 280                 worker_try_finish (data);
 281         }
 282 }
 283
 284 static void
 285 init_distribute_gray_queue (void)
 286 {
 287         if (workers_distribute_gray_queue_inited) {
 288                 g_assert (sgen_section_gray_queue_is_empty (&workers_distribute_gray_queue));
 289                 g_assert (workers_distribute_gray_queue.locked);
 290                 return;
 291         }
 292
 293         sgen_section_gray_queue_init (&workers_distribute_gray_queue, TRUE,
 294                         sgen_get_major_collector ()->is_concurrent ? concurrent_enqueue_check : NULL);
 295         workers_distribute_gray_queue_inited = TRUE;
 296 }
 297
 298 void
 299 sgen_workers_init_distribute_gray_queue (void)
 300 {
 301         SGEN_ASSERT (0, sgen_get_major_collector ()->is_concurrent,
 302                         "Why should we init the distribute gray queue if we don't need it?");
 303         init_distribute_gray_queue ();
 304 }
 305
 306 void
 307 sgen_workers_init (int num_workers, SgenWorkerCallback callback)
 308 {
 309         int i;
 310         void **workers_data_ptrs = (void **)alloca(num_workers * sizeof(void *));
 311
 312         if (!sgen_get_major_collector ()->is_concurrent) {
 313                 sgen_thread_pool_init (num_workers, thread_pool_init_func, NULL, NULL, NULL);
 314                 return;
 315         }
 316
 317         mono_os_mutex_init (&finished_lock);
 318         //g_print ("initing %d workers\n", num_workers);
 319
 320         workers_num = num_workers;
 321
 322         workers_data = (WorkerData *)sgen_alloc_internal_dynamic (sizeof (WorkerData) * num_workers, INTERNAL_MEM_WORKER_DATA, TRUE);
 323         memset (workers_data, 0, sizeof (WorkerData) * num_workers);
 324
 325         init_distribute_gray_queue ();
 326
 327         for (i = 0; i < num_workers; ++i)
 328                 workers_data_ptrs [i] = (void *) &workers_data [i];
 329
 330         worker_init_cb = callback;
 331
 332         sgen_thread_pool_init (num_workers, thread_pool_init_func, marker_idle_func, continue_idle_func, workers_data_ptrs);
 333
 334         mono_counters_register ("# workers finished", MONO_COUNTER_GC | MONO_COUNTER_ULONG, &stat_workers_num_finished);
 335 }
 336
 337 void
 338 sgen_workers_stop_all_workers (void)
 339 {
 340         finish_callback = NULL;
 341         mono_memory_write_barrier ();
 342         forced_stop = TRUE;
 343
 344         sgen_thread_pool_wait_for_all_jobs ();
 345         sgen_thread_pool_idle_wait ();
 346         SGEN_ASSERT (0, sgen_workers_all_done (), "Can only signal enqueue work when in no work state");
 347 }
 348
 349 void
 350 sgen_workers_start_all_workers (SgenObjectOperations *object_ops, SgenWorkersFinishCallback callback)
 351 {
 352         forced_stop = FALSE;
 353         idle_func_object_ops = object_ops;
 354         finish_callback = callback;
 355         mono_memory_write_barrier ();
 356
 357         sgen_workers_ensure_awake ();
 358 }
 359
 360 void
 361 sgen_workers_join (void)
 362 {
 363         int i;
 364
 365         sgen_thread_pool_wait_for_all_jobs ();
 366         sgen_thread_pool_idle_wait ();
 367         SGEN_ASSERT (0, sgen_workers_all_done (), "Can only signal enqueue work when in no work state");
 368
 369         /* At this point all the workers have stopped. */
 370
 371         SGEN_ASSERT (0, sgen_section_gray_queue_is_empty (&workers_distribute_gray_queue), "Why is there still work left to do?");
 372         for (i = 0; i < workers_num; ++i)
 373                 SGEN_ASSERT (0, sgen_gray_object_queue_is_empty (&workers_data [i].private_gray_queue), "Why is there still work left to do?");
 374 }
 375
 376 /*
 377  * Can only be called if the workers are stopped.
 378  * If we're stopped, there are also no pending jobs.
 379  */
 380 gboolean
 381 sgen_workers_have_idle_work (void)
 382 {
 383         int i;
 384
 385         SGEN_ASSERT (0, forced_stop && sgen_workers_all_done (), "Checking for idle work should only happen if the workers are stopped.");
 386
 387         if (!sgen_section_gray_queue_is_empty (&workers_distribute_gray_queue))
 388                 return TRUE;
 389
 390         for (i = 0; i < workers_num; ++i) {
 391                 if (!sgen_gray_object_queue_is_empty (&workers_data [i].private_gray_queue))
 392                         return TRUE;
 393         }
 394
 395         return FALSE;
 396 }
 397
 398 gboolean
 399 sgen_workers_all_done (void)
 400 {
 401         int i;
 402
 403         for (i = 0; i < workers_num; i++) {
 404                 if (state_is_working_or_enqueued (workers_data [i].state))
 405                         return FALSE;
 406         }
 407         return TRUE;
 408 }
 409
 410 /* Must only be used for debugging */
 411 gboolean
 412 sgen_workers_are_working (void)
 413 {
 414         return !sgen_workers_all_done ();
 415 }
 416
 417 void
 418 sgen_workers_assert_gray_queue_is_empty (void)
 419 {
 420         SGEN_ASSERT (0, sgen_section_gray_queue_is_empty (&workers_distribute_gray_queue), "Why is the workers gray queue not empty?");
 421 }
 422
 423 void
 424 sgen_workers_take_from_queue_and_awake (SgenGrayQueue *queue)
 425 {
 426         gboolean wake = FALSE;
 427
 428         for (;;) {
 429                 GrayQueueSection *section = sgen_gray_object_dequeue_section (queue);
 430                 if (!section)
 431                         break;
 432                 sgen_section_gray_queue_enqueue (&workers_distribute_gray_queue, section);
 433                 wake = TRUE;
 434         }
 435
 436         if (wake) {
 437                 SGEN_ASSERT (0, sgen_concurrent_collection_in_progress (), "Why is there work to take when there's no concurrent collection in progress?");
 438                 sgen_workers_ensure_awake ();
 439         }
 440 }
 441
 442 SgenObjectOperations*
 443 sgen_workers_get_idle_func_object_ops (void)
 444 {
 445         return idle_func_object_ops;
 446 }
 447
 448 /*
 449  * If we have a single worker, splitting into multiple jobs makes no sense. With
 450  * more than one worker, we split into a larger number of jobs so that, in case
 451  * the work load is uneven, a worker that finished quickly can take up more jobs
 452  * than another one.
 453  */
 454 int
 455 sgen_workers_get_job_split_count (void)
 456 {
 457         return (workers_num > 1) ? workers_num * 4 : 1;
 458 }
 459
 460 void
 461 sgen_workers_foreach (SgenWorkerCallback callback)
 462 {
 463         int i;
 464
 465         for (i = 0; i < workers_num; i++)
 466                 callback (&workers_data [i]);
 467 }
 468
 469 #endif