e2f030dc159135210d50d80fd1e60a5799e7291a
[mono.git] / 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         gint32 state;
19         SgenGrayQueue private_gray_queue; /* only read/written by worker thread */
20         /*
21          * Workers allocate major objects only from here. It has same structure as the
22          * global one. This is normally accessed from the worker_block_free_list_key.
23          * We hold it here so we can clear free lists from all threads before sweep
24          * starts.
25          */
26         gpointer free_block_lists;
27 };
28
29 typedef void (*SgenWorkersFinishCallback) (void);
30 typedef void (*SgenWorkerCallback) (WorkerData *data);
31
32 void sgen_workers_init (int num_workers, SgenWorkerCallback callback);
33 void sgen_workers_stop_all_workers (void);
34 void sgen_workers_set_num_active_workers (int num_workers);
35 void sgen_workers_start_all_workers (SgenObjectOperations *object_ops_nopar, SgenObjectOperations *object_ops_par, SgenWorkersFinishCallback finish_job);
36 void sgen_workers_init_distribute_gray_queue (void);
37 void sgen_workers_enqueue_job (SgenThreadPoolJob *job, gboolean enqueue);
38 void sgen_workers_distribute_gray_queue_sections (void);
39 void sgen_workers_reset_data (void);
40 void sgen_workers_join (void);
41 gboolean sgen_workers_have_idle_work (void);
42 gboolean sgen_workers_all_done (void);
43 gboolean sgen_workers_are_working (void);
44 void sgen_workers_assert_gray_queue_is_empty (void);
45 void sgen_workers_take_from_queue (SgenGrayQueue *queue);
46 SgenObjectOperations* sgen_workers_get_idle_func_object_ops (void);
47 int sgen_workers_get_job_split_count (void);
48 void sgen_workers_foreach (SgenWorkerCallback callback);
49
50 #endif