Merge pull request #505 from roji/shutdown_flow
[mono.git] / 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 #define STEALABLE_STACK_SIZE    512
25
26
27 typedef struct _WorkerData WorkerData;
28 struct _WorkerData {
29         MonoNativeThreadId thread;
30         void *major_collector_data;
31
32         SgenGrayQueue private_gray_queue; /* only read/written by worker thread */
33
34         mono_mutex_t stealable_stack_mutex;
35         volatile int stealable_stack_fill;
36         char *stealable_stack [STEALABLE_STACK_SIZE];
37 };
38
39 typedef void (*JobFunc) (WorkerData *worker_data, void *job_data);
40
41 typedef struct _JobQueueEntry JobQueueEntry;
42 struct _JobQueueEntry {
43         JobFunc func;
44         void *data;
45
46         volatile JobQueueEntry *next;
47 };
48
49 void sgen_workers_init (int num_workers) MONO_INTERNAL;
50 void sgen_workers_start_all_workers (void) MONO_INTERNAL;
51 gboolean sgen_workers_have_started (void) MONO_INTERNAL;
52 void sgen_workers_wake_up_all (void) MONO_INTERNAL;
53 void sgen_workers_init_distribute_gray_queue (void) MONO_INTERNAL;
54 void sgen_workers_enqueue_job (JobFunc func, void *data) MONO_INTERNAL;
55 void sgen_workers_wait_for_jobs (void) MONO_INTERNAL;
56 void sgen_workers_start_marking (void) MONO_INTERNAL;
57 void sgen_workers_distribute_gray_queue_sections (void) MONO_INTERNAL;
58 void sgen_workers_reset_data (void) MONO_INTERNAL;
59 void sgen_workers_join (void) MONO_INTERNAL;
60 gboolean sgen_workers_all_done (void) MONO_INTERNAL;
61 SgenSectionGrayQueue* sgen_workers_get_distribute_section_gray_queue (void) MONO_INTERNAL;
62
63 #endif