mono/sgen/sgen-workers.c

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