- logger in utils
[strongswan.git] / Source / charon / queues / job_queue.c
1 /**
2 * @file job_queue.c
3 *
4 * @brief Job-Queue based on linked_list_t
5 *
6 */
7
8 /*
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 */
22
23 #include <stdlib.h>
24 #include <pthread.h>
25
26 #include "job_queue.h"
27
28 #include "../utils/allocator.h"
29 #include "../utils/linked_list.h"
30
31 /**
32 * @brief Private Variables and Functions of job_queue class
33 *
34 */
35 typedef struct private_job_queue_s private_job_queue_t;
36
37
38 struct private_job_queue_s {
39 job_queue_t public;
40
41 /**
42 * The jobs are stored in a linked list
43 */
44 linked_list_t *list;
45 /**
46 * access to linked_list is locked through this mutex
47 */
48 pthread_mutex_t mutex;
49
50 /**
51 * If the queue is empty a thread has to wait
52 * This condvar is used to wake up such a thread
53 */
54 pthread_cond_t condvar;
55 };
56
57
58 /**
59 * @brief implements function get_count of job_queue_t
60 */
61 static int get_count(private_job_queue_t *this)
62 {
63 int count;
64 pthread_mutex_lock(&(this->mutex));
65 count = this->list->get_count(this->list);
66 pthread_mutex_unlock(&(this->mutex));
67 return count;
68 }
69
70 /**
71 * @brief implements function get of job_queue_t
72 */
73 static status_t get(private_job_queue_t *this, job_t **job)
74 {
75 int oldstate;
76 pthread_mutex_lock(&(this->mutex));
77 /* go to wait while no jobs available */
78 while(this->list->get_count(this->list) == 0)
79 {
80 /* add mutex unlock handler for cancellation, enable cancellation */
81 pthread_cleanup_push((void(*)(void*))pthread_mutex_unlock, (void*)&(this->mutex));
82 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, &oldstate);
83
84 pthread_cond_wait( &(this->condvar), &(this->mutex));
85
86 /* reset cancellation, remove mutex-unlock handler (without executing) */
87 pthread_setcancelstate(oldstate, NULL);
88 pthread_cleanup_pop(0);
89 }
90 this->list->remove_first(this->list,(void **) job);
91 pthread_mutex_unlock(&(this->mutex));
92 return SUCCESS;
93 }
94
95 /**
96 * @brief implements function add of job_queue_t
97 */
98 static status_t add(private_job_queue_t *this, job_t *job)
99 {
100 pthread_mutex_lock(&(this->mutex));
101 this->list->insert_last(this->list,job);
102 pthread_cond_signal( &(this->condvar));
103 pthread_mutex_unlock(&(this->mutex));
104 return SUCCESS;
105 }
106
107 /**
108 * @brief implements function destroy of job_queue_t
109 *
110 */
111 static status_t job_queue_destroy (private_job_queue_t *this)
112 {
113 while (this->list->get_count(this->list) > 0)
114 {
115 job_t *job;
116 if (this->list->remove_first(this->list,(void *) &job) != SUCCESS)
117 {
118 this->list->destroy(this->list);
119 break;
120 }
121 job->destroy(job);
122 }
123 this->list->destroy(this->list);
124
125 pthread_mutex_destroy(&(this->mutex));
126
127 pthread_cond_destroy(&(this->condvar));
128
129 allocator_free(this);
130 return SUCCESS;
131 }
132
133 /*
134 *
135 * Documented in header
136 */
137 job_queue_t *job_queue_create()
138 {
139 linked_list_t *linked_list = linked_list_create();
140 if (linked_list == NULL)
141 {
142 return NULL;
143 }
144
145 private_job_queue_t *this = allocator_alloc_thing(private_job_queue_t);
146 if (this == NULL)
147 {
148 linked_list->destroy(linked_list);
149 return NULL;
150 }
151
152 this->public.get_count = (int(*)(job_queue_t*))get_count;
153 this->public.get = (status_t(*)(job_queue_t*, job_t**))get;
154 this->public.add = (status_t(*)(job_queue_t*, job_t*))add;
155 this->public.destroy = (status_t(*)(job_queue_t*))job_queue_destroy;
156
157 this->list = linked_list;
158 pthread_mutex_init(&(this->mutex), NULL);
159 pthread_cond_init(&(this->condvar), NULL);
160
161 return (&this->public);
162 }