mono/metadata/sgen-workers.h

   1 /*
   2  * sgen-workers.c: Worker threads for parallel and concurrent GC.
   3  *
   4  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
   5  * Copyright (C) 2012 Xamarin Inc
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License 2.0 as published by the Free Software Foundation;
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License 2.0 along with this library; if not, write to the Free
  18  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  */
  20
  21 #ifndef __MONO_SGEN_WORKER_H__
  22 #define __MONO_SGEN_WORKER_H__
  23
  24 typedef struct _WorkerData WorkerData;
  25 struct _WorkerData {
  26         int index;
  27         MonoNativeThreadId thread;
  28         void *major_collector_data;
  29
  30         SgenGrayQueue private_gray_queue; /* only read/written by worker thread */
  31 };
  32
  33 typedef void (*JobFunc) (WorkerData *worker_data, void *job_data);
  34
  35 typedef struct _JobQueueEntry JobQueueEntry;
  36 struct _JobQueueEntry {
  37         const char *name;
  38         JobFunc func;
  39         void *data;
  40
  41         volatile JobQueueEntry *next;
  42 };
  43
  44 void sgen_workers_init (int num_workers);
  45 void sgen_workers_start_all_workers (void);
  46 gboolean sgen_workers_have_started (void);
  47 void sgen_workers_ensure_awake (void);
  48 void sgen_workers_init_distribute_gray_queue (void);
  49 void sgen_workers_enqueue_job (const char *name, JobFunc func, void *data);
  50 void sgen_workers_wait_for_jobs_finished (void);
  51 void sgen_workers_distribute_gray_queue_sections (void);
  52 void sgen_workers_reset_data (void);
  53 void sgen_workers_join (void);
  54 gboolean sgen_workers_all_done (void);
  55 gboolean sgen_workers_are_working (void);
  56 SgenSectionGrayQueue* sgen_workers_get_distribute_section_gray_queue (void);
  57
  58 void sgen_workers_signal_start_nursery_collection_and_wait (void);
  59 void sgen_workers_signal_finish_nursery_collection (void);
  60
  61 #endif