summaryrefslogtreecommitdiff
path: root/src/eog-job-scheduler.c
blob: 4b7471b92cd501ef4662ec86412e6570a65681db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/* Eye Of Gnome - Jobs scheduler
 *
 * Copyright (C) 2013 The Free Software Foundation
 *
 * Author: Javier Sánchez <jsanchez@deskblue.com>
 *
 * Based on code (ev-job-scheduler.h) by:
 *      - Carlos Garcia Campos <carlosgc@gnome.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#include "eog-job-scheduler.h"
#include "eog-jobs.h"

#include "eog-debug.h"

/* sync thread tools */
static GCond  job_queue_cond;
static GMutex job_queue_mutex;

/* priority queues */
static GQueue queue_high   = G_QUEUE_INIT;
static GQueue queue_medium = G_QUEUE_INIT;
static GQueue queue_low    = G_QUEUE_INIT;

static GQueue *job_queue[EOG_JOB_N_PRIORITIES] = {
	&queue_high,
	&queue_medium,
	&queue_low
};

static void      eog_job_scheduler_enqueue_job (EogJob         *job,
						EogJobPriority  priority);
static EogJob   *eog_job_scheduler_dequeue_job (void);
static gpointer  eog_job_scheduler             (gpointer        data);
static void      eog_job_process               (EogJob         *job);


static void
eog_job_scheduler_enqueue_job (EogJob         *job,
			       EogJobPriority  priority)
{
	/* show info for debugging */
	eog_debug_message (DEBUG_JOBS,
			   "ENQUEUED %s (%p) with priority %d",
			   EOG_GET_TYPE_NAME (job),
			   job,
			   priority);

	/* --- enter critical section --- */
	g_mutex_lock (&job_queue_mutex);

	g_queue_push_tail (job_queue[priority], job);
	g_cond_broadcast  (&job_queue_cond);

	/* --- leave critical section --- */
	g_mutex_unlock (&job_queue_mutex);
}

static EogJob *
eog_job_scheduler_dequeue_job (void)
{
	EogJob *job;
	gint    priority;

	/* initialization */
	job = NULL;

	while (!job) {
		/* --- enter critical section --- */
		g_mutex_lock (&job_queue_mutex);

		/* try to retrieve the next job from priority queue */
		for (priority = EOG_JOB_PRIORITY_HIGH; priority < EOG_JOB_N_PRIORITIES; priority++) {
			job = (EogJob *) g_queue_pop_head (job_queue[priority]);

			if (job)
				break;
		}

		/* show info for debugging */
		eog_debug_message (DEBUG_JOBS,
				   (job ? "DEQUEUED %s (%p)" : "No jobs in queue"),
				   EOG_GET_TYPE_NAME (job),
				   job);

		/* if there is no job, wait for it */
		if (!job) {
			eog_debug_message (DEBUG_JOBS,
					   "Wating for jobs ...");

			g_cond_wait    (&job_queue_cond,
					&job_queue_mutex);
			g_mutex_unlock (&job_queue_mutex);
			continue;
		}

		/* --- leave critical section --- */
		g_mutex_unlock (&job_queue_mutex);
	}

	return job;
}

static gpointer
eog_job_scheduler (gpointer data)
{
	EogJob *job;

	while (TRUE) {
		/* retrieve the next job */
		job = eog_job_scheduler_dequeue_job ();

		/* execute the job */
		eog_job_process (job);

		/* free executed job */
		g_object_unref  (job);
	}

	return NULL;
}

static void
eog_job_process (EogJob *job)
{
	g_return_if_fail (EOG_IS_JOB (job));

	/* nothing to do if job was cancelled */
	if (eog_job_is_cancelled (job))
		return;

	/* show info for debugging */
	eog_debug_message (DEBUG_JOBS,
			   "PROCESSING a %s (%p)",
			   EOG_GET_TYPE_NAME (job),
			   job);

	/* process the current job */
	eog_job_run (job);
}

void
eog_job_scheduler_init ()
{
	g_thread_new ("EogJobScheduler",
		      eog_job_scheduler,
		      NULL);
}

void
eog_job_scheduler_add_job (EogJob *job)
{
	g_return_if_fail (EOG_IS_JOB (job));

	/* make sure the job isn't destroyed */
	g_object_ref (job);

	/* enqueue the job */
	eog_job_scheduler_enqueue_job (job, EOG_JOB_PRIORITY_LOW);
}

void
eog_job_scheduler_add_job_with_priority (EogJob         *job,
					 EogJobPriority  priority)
{
	g_return_if_fail (EOG_IS_JOB (job));

	/* make sure the job isn't destroyed */
	g_object_ref (job);

	/* enqueue the job */
	eog_job_scheduler_enqueue_job (job, priority);
}