summaryrefslogtreecommitdiff
path: root/src/charon/processing/event_queue.c
blob: 40bcb1ed8f1070214c0f08a342decd8b338c552a (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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
/**
 * @file event_queue.c
 *
 * @brief Implementation of event_queue_t
 *
 */

/*
 * Copyright (C) 2005-2006 Martin Willi
 * Copyright (C) 2005 Jan Hutter
 * 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 <pthread.h>
#include <stdlib.h>

#include "event_queue.h"

#include <library.h>
#include <utils/linked_list.h>



typedef struct event_t event_t;

/**
 * Event containing a job and a schedule time
 */
struct event_t {
	/**
	 * Time to fire the event.
	 */
	timeval_t time;

	/**
	 * Every event has its assigned job.
	 */
	job_t * job;
};

/**
 * destroy an event and its job
 */
static void event_destroy(event_t *event)
{
	event->job->destroy(event->job);
	free(event);
}

typedef struct private_event_queue_t private_event_queue_t;

/**
 * Private Variables and Functions of event_queue_t class.
 */
struct private_event_queue_t {
	/**
	 * Public part.
	 */
 	event_queue_t public;

	/**
	 * The events are stored in a linked list of type linked_list_t.
	 */
	linked_list_t *list;

	/**
	 * Access to linked_list is locked through this mutex.
	 */
	pthread_mutex_t mutex;

	/**
	 * If the queue is empty or an event has not to be fired
	 * a thread has to wait.
	 * 
	 * This condvar is used to wake up such a thread.
	 */
	pthread_cond_t condvar;
};

/**
 * Returns the difference of to timeval structs in milliseconds
 */
static long time_difference(struct timeval *end_time, struct timeval *start_time)
{
	time_t s;
	suseconds_t us;
	
	s = (end_time->tv_sec - start_time->tv_sec);
	us = (end_time->tv_usec - start_time->tv_usec);
	return ((s * 1000) + us/1000);
}

/**
 * Implements event_queue_t.get_count
 */
static int get_count(private_event_queue_t *this)
{
	int count;
	pthread_mutex_lock(&(this->mutex));
	count = this->list->get_count(this->list);
	pthread_mutex_unlock(&(this->mutex));
	return count;
}

/**
 * Implements event_queue_t.get
 */
static job_t *get(private_event_queue_t *this)
{
	timespec_t timeout;
	timeval_t current_time;
	event_t * next_event;
	job_t *job;
	int oldstate;
	
	pthread_mutex_lock(&(this->mutex));
	
	while (TRUE)
	{
		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->get_first(this->list, (void **)&next_event);
		
		gettimeofday(&current_time, NULL);
		long difference = time_difference(&current_time,&(next_event->time));
		if (difference <= 0)
		{
			timeout.tv_sec = next_event->time.tv_sec;
			timeout.tv_nsec = next_event->time.tv_usec * 1000;
			
			/* 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_timedwait(&(this->condvar), &(this->mutex), &timeout);
			
			/* reset cancellation, remove mutex-unlock handler (without executing) */
			pthread_setcancelstate(oldstate, NULL);
			pthread_cleanup_pop(0);
		}
		else
		{
			/* event available */
			this->list->remove_first(this->list, (void **)&next_event);
			job = next_event->job;
			free(next_event);
			break;
		}
	}
	pthread_cond_signal( &(this->condvar));
	pthread_mutex_unlock(&(this->mutex));
	
	return job;
}

/**
 * Implements function add_absolute of event_queue_t.
 * See #event_queue_s.add_absolute for description.
 */
static void add_absolute(private_event_queue_t *this, job_t *job, timeval_t time)
{
	event_t *event;
	event_t *current_event;
	iterator_t *iterator;
	
	/* create event */
	event = malloc_thing(event_t);
	event->time = time;
	event->job = job;

	pthread_mutex_lock(&(this->mutex));

	/* while just used to break out */
	while(TRUE)
	{
		if (this->list->get_count(this->list) == 0)
		{
			this->list->insert_first(this->list,event);
			break;
		}

		/* check last entry */
		this->list->get_last(this->list,(void **) &current_event);

		if (time_difference(&(event->time), &(current_event->time)) >= 0)
		{
			/* my event has to be fired after the last event in list */
			this->list->insert_last(this->list,event);
			break;
		}

		/* check first entry */
		this->list->get_first(this->list,(void **) &current_event);

		if (time_difference(&(event->time), &(current_event->time)) < 0)
		{
			/* my event has to be fired before the first event in list */
			this->list->insert_first(this->list,event);
			break;
		}
		
		iterator = this->list->create_iterator(this->list,TRUE);
		iterator->iterate(iterator, (void**)&current_event);
		/* first element has not to be checked (already done) */
		while(iterator->iterate(iterator, (void**)&current_event))
		{
			if (time_difference(&(event->time), &(current_event->time)) <= 0)
			{
				/* my event has to be fired before the current event in list */
				iterator->insert_before(iterator,event);
				break;
			}
		}
		iterator->destroy(iterator);
		break;
	}

	pthread_cond_signal( &(this->condvar));
	pthread_mutex_unlock(&(this->mutex));
}

/**
 * Implements  event_queue_t.add_relative.
 */
static void add_relative(event_queue_t *this, job_t *job, u_int32_t ms)
{
	timeval_t current_time;
	timeval_t time;
	
	time_t s = ms / 1000;
	suseconds_t us = (ms - s * 1000) * 1000;
	
	gettimeofday(&current_time, NULL);
	
	time.tv_usec = (current_time.tv_usec + us) % 1000000;
	time.tv_sec = current_time.tv_sec + (current_time.tv_usec + us)/1000000 + s;
	
	this->add_absolute(this, job, time);
}


/**
 * Implements event_queue_t.destroy.
 */
static void event_queue_destroy(private_event_queue_t *this)
{
	this->list->destroy_function(this->list, (void*)event_destroy);
	free(this);
}

/*
 * Documented in header
 */
event_queue_t *event_queue_create()
{
	private_event_queue_t *this = malloc_thing(private_event_queue_t);

	this->public.get_count = (int (*) (event_queue_t *event_queue)) get_count;
	this->public.get = (job_t *(*) (event_queue_t *event_queue)) get;
	this->public.add_absolute = (void (*) (event_queue_t *event_queue, job_t *job, timeval_t time)) add_absolute;
	this->public.add_relative = (void (*) (event_queue_t *event_queue, job_t *job, u_int32_t ms)) add_relative;
	this->public.destroy = (void (*) (event_queue_t *event_queue)) event_queue_destroy;

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

	return (&this->public);
}