aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/queues/job_queue.c
blob: fff453500bd43e202aecfe801c6e38b9f11ad08e (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
/**
 * @file job_queue.c
 *
 * @brief Job-Queue based on linked_list_t
 *
 */

/*
 * Copyright (C) 2005 Jan Hutter, Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * 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.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * 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.
 */

#include <stdlib.h>
#include <pthread.h>

#include "job_queue.h"

#include "../utils/allocator.h"
#include "../utils/linked_list.h"

/**
 * @brief Private Variables and Functions of job_queue class
 *
 */
typedef struct private_job_queue_s private_job_queue_t;


struct private_job_queue_s {
 	job_queue_t public;

	/**
	 * The jobs are stored in a linked list
	 */
	linked_list_t *list;
	/**
	 * access to linked_list is locked through this mutex
	 */
	pthread_mutex_t mutex;

	/**
	 * If the queue is empty a thread has to wait
	 * This condvar is used to wake up such a thread
	 */
	pthread_cond_t condvar;
};


/**
 * @brief implements function get_count of job_queue_t
 */
static int get_count(private_job_queue_t *this)
{
	int count;
	pthread_mutex_lock(&(this->mutex));
	count = this->list->get_count(this->list);
	pthread_mutex_unlock(&(this->mutex));
	return count;
}

/**
 * @brief implements function get of job_queue_t
 */
static status_t get(private_job_queue_t *this, job_t **job)
{
	int oldstate;
	pthread_mutex_lock(&(this->mutex));
	/* go to wait while no jobs available */
	while(this->list->get_count(this->list) == 0)
	{
		/* add mutex unlock handler for cancellation, enable cancellation */
		pthread_cleanup_push((void(*)(void*))pthread_mutex_unlock, (void*)&(this->mutex));
		pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &oldstate);

		pthread_cond_wait( &(this->condvar), &(this->mutex));

		/* reset cancellation, remove mutex-unlock handler (without executing) */
		pthread_setcancelstate(oldstate, NULL);
		pthread_cleanup_pop(0);
	}
	this->list->remove_first(this->list,(void **) job);
	pthread_mutex_unlock(&(this->mutex));
	return SUCCESS;
}

/**
 * @brief implements function add of job_queue_t
 */
static status_t add(private_job_queue_t *this, job_t *job)
{
	pthread_mutex_lock(&(this->mutex));
	this->list->insert_last(this->list,job);
	pthread_cond_signal( &(this->condvar));
	pthread_mutex_unlock(&(this->mutex));
	return SUCCESS;
}

/**
 * @brief implements function destroy of job_queue_t
 *
 */
static status_t job_queue_destroy (private_job_queue_t *this)
{
	while (this->list->get_count(this->list) > 0)
	{
		job_t *job;
		if (this->list->remove_first(this->list,(void *) &job) != SUCCESS)
		{
			this->list->destroy(this->list);
			break;
		}
		job->destroy_all(job);
	}
	this->list->destroy(this->list);

	pthread_mutex_destroy(&(this->mutex));

	pthread_cond_destroy(&(this->condvar));

	allocator_free(this);
	return SUCCESS;
}

/*
 *
 * Documented in header
 */
job_queue_t *job_queue_create()
{
	linked_list_t *linked_list = linked_list_create();
	if (linked_list == NULL)
	{
		return NULL;
	}

	private_job_queue_t *this = allocator_alloc_thing(private_job_queue_t);
	if (this == NULL)
	{
		linked_list->destroy(linked_list);
		return NULL;
	}

	this->public.get_count = (int(*)(job_queue_t*))get_count;
	this->public.get = (status_t(*)(job_queue_t*, job_t**))get;
	this->public.add = (status_t(*)(job_queue_t*, job_t*))add;
	this->public.destroy = (status_t(*)(job_queue_t*))job_queue_destroy;

	this->list = linked_list;
	pthread_mutex_init(&(this->mutex), NULL);
	pthread_cond_init(&(this->condvar), NULL);

	return (&this->public);
}