mono/sgen/sgen-workers.h

   1 /**
   2  * \file
   3  * Worker threads for parallel and concurrent GC.
   4  *
   5  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
   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 #ifndef __MONO_SGEN_WORKER_H__
  12 #define __MONO_SGEN_WORKER_H__
  13
  14 #include "mono/sgen/sgen-thread-pool.h"
  15
  16 typedef struct _WorkerData WorkerData;
  17 struct _WorkerData {
  18         /*
  19          * Threadpool threads receive as their starting argument a WorkerData.
  20          * tp_data is meant for use inside the sgen thread pool and must be first.
  21          */
  22         SgenThreadPoolData tp_data;
  23         gint32 state;
  24         SgenGrayQueue private_gray_queue; /* only read/written by worker thread */
  25         /*
  26          * Workers allocate major objects only from here. It has same structure as the
  27          * global one. This is normally accessed from the worker_block_free_list_key.
  28          * We hold it here so we can clear free lists from all threads before sweep
  29          * starts.
  30          */
  31         gpointer free_block_lists;
  32 };
  33
  34 typedef void (*SgenWorkersFinishCallback) (void);
  35 typedef void (*SgenWorkerCallback) (WorkerData *data);
  36
  37 void sgen_workers_init (int num_workers, SgenWorkerCallback callback);
  38 void sgen_workers_shutdown (void);
  39 void sgen_workers_stop_all_workers (void);
  40 void sgen_workers_set_num_active_workers (int num_workers);
  41 void sgen_workers_start_all_workers (SgenObjectOperations *object_ops_nopar, SgenObjectOperations *object_ops_par, SgenWorkersFinishCallback finish_job);
  42 void sgen_workers_init_distribute_gray_queue (void);
  43 void sgen_workers_enqueue_job (SgenThreadPoolJob *job, gboolean enqueue);
  44 void sgen_workers_distribute_gray_queue_sections (void);
  45 void sgen_workers_reset_data (void);
  46 void sgen_workers_join (void);
  47 gboolean sgen_workers_have_idle_work (void);
  48 gboolean sgen_workers_all_done (void);
  49 gboolean sgen_workers_are_working (void);
  50 void sgen_workers_assert_gray_queue_is_empty (void);
  51 void sgen_workers_take_from_queue (SgenGrayQueue *queue);
  52 SgenObjectOperations* sgen_workers_get_idle_func_object_ops (void);
  53 int sgen_workers_get_job_split_count (void);
  54 void sgen_workers_foreach (SgenWorkerCallback callback);
  55 gboolean sgen_workers_is_worker_thread (MonoNativeThreadId id);
  56
  57 #endif