(pthread_cond_init, pthread_cond_destroy,
[kopensolaris-gnu/glibc.git] / linuxthreads / condvar.c
1 /* Linuxthreads - a simple clone()-based implementation of Posix        */
2 /* threads for Linux.                                                   */
3 /* Copyright (C) 1996 Xavier Leroy (Xavier.Leroy@inria.fr)              */
4 /* and Pavel Krauz (krauz@fsid.cvut.cz).                                */
5 /*                                                                      */
6 /* This program is free software; you can redistribute it and/or        */
7 /* modify it under the terms of the GNU Library General Public License  */
8 /* as published by the Free Software Foundation; either version 2       */
9 /* of the License, or (at your option) any later version.               */
10 /*                                                                      */
11 /* This program is distributed in the hope that it will be useful,      */
12 /* but WITHOUT ANY WARRANTY; without even the implied warranty of       */
13 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        */
14 /* GNU Library General Public License for more details.                 */
15
16 /* Condition variables */
17
18 #include <errno.h>
19 #include <sched.h>
20 #include <stddef.h>
21 #include <sys/time.h>
22 #include "pthread.h"
23 #include "internals.h"
24 #include "spinlock.h"
25 #include "queue.h"
26 #include "restart.h"
27
28 int __pthread_cond_init(pthread_cond_t *cond,
29                         const pthread_condattr_t *cond_attr)
30 {
31   __pthread_init_lock(&cond->__c_lock);
32   cond->__c_waiting = NULL;
33   return 0;
34 }
35 strong_alias (__pthread_cond_init, pthread_cond_init)
36
37 int __pthread_cond_destroy(pthread_cond_t *cond)
38 {
39   if (cond->__c_waiting != NULL) return EBUSY;
40   return 0;
41 }
42 strong_alias (__pthread_cond_destroy, pthread_cond_destroy)
43
44 /* Function called by pthread_cancel to remove the thread from
45    waiting on a condition variable queue. */
46
47 static int cond_extricate_func(void *obj, pthread_descr th)
48 {
49   volatile pthread_descr self = thread_self();
50   pthread_cond_t *cond = obj;
51   int did_remove = 0;
52
53   __pthread_lock(&cond->__c_lock, self);
54   did_remove = remove_from_queue(&cond->__c_waiting, th);
55   __pthread_unlock(&cond->__c_lock);
56
57   return did_remove;
58 }
59
60 int __pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
61 {
62   volatile pthread_descr self = thread_self();
63   pthread_extricate_if extr;
64   int already_canceled = 0;
65   int spurious_wakeup_count;
66
67   /* Check whether the mutex is locked and owned by this thread.  */
68   if (mutex->__m_kind != PTHREAD_MUTEX_TIMED_NP
69       && mutex->__m_kind != PTHREAD_MUTEX_ADAPTIVE_NP
70       && mutex->__m_owner != self)
71     return EINVAL;
72
73   /* Set up extrication interface */
74   extr.pu_object = cond;
75   extr.pu_extricate_func = cond_extricate_func;
76
77   /* Register extrication interface */
78   THREAD_SETMEM(self, p_condvar_avail, 0);
79   __pthread_set_own_extricate_if(self, &extr);
80
81   /* Atomically enqueue thread for waiting, but only if it is not
82      canceled. If the thread is canceled, then it will fall through the
83      suspend call below, and then call pthread_exit without
84      having to worry about whether it is still on the condition variable queue.
85      This depends on pthread_cancel setting p_canceled before calling the
86      extricate function. */
87
88   __pthread_lock(&cond->__c_lock, self);
89   if (!(THREAD_GETMEM(self, p_canceled)
90       && THREAD_GETMEM(self, p_cancelstate) == PTHREAD_CANCEL_ENABLE))
91     enqueue(&cond->__c_waiting, self);
92   else
93     already_canceled = 1;
94   __pthread_unlock(&cond->__c_lock);
95
96   if (already_canceled) {
97     __pthread_set_own_extricate_if(self, 0);
98     __pthread_do_exit(PTHREAD_CANCELED, CURRENT_STACK_FRAME);
99   }
100
101   pthread_mutex_unlock(mutex);
102
103   spurious_wakeup_count = 0;
104   while (1)
105     {
106       suspend(self);
107       if (THREAD_GETMEM(self, p_condvar_avail) == 0
108           && (THREAD_GETMEM(self, p_woken_by_cancel) == 0
109               || THREAD_GETMEM(self, p_cancelstate) != PTHREAD_CANCEL_ENABLE))
110         {
111           /* Count resumes that don't belong to us. */
112           spurious_wakeup_count++;
113           continue;
114         }
115       break;
116     }
117
118   __pthread_set_own_extricate_if(self, 0);
119
120   /* Check for cancellation again, to provide correct cancellation
121      point behavior */
122
123   if (THREAD_GETMEM(self, p_woken_by_cancel)
124       && THREAD_GETMEM(self, p_cancelstate) == PTHREAD_CANCEL_ENABLE) {
125     THREAD_SETMEM(self, p_woken_by_cancel, 0);
126     pthread_mutex_lock(mutex);
127     __pthread_do_exit(PTHREAD_CANCELED, CURRENT_STACK_FRAME);
128   }
129
130   /* Put back any resumes we caught that don't belong to us. */
131   while (spurious_wakeup_count--)
132     restart(self);
133
134   pthread_mutex_lock(mutex);
135   return 0;
136 }
137 strong_alias (__pthread_cond_wait, pthread_cond_wait)
138
139 static int
140 pthread_cond_timedwait_relative(pthread_cond_t *cond,
141                                 pthread_mutex_t *mutex,
142                                 const struct timespec * abstime)
143 {
144   volatile pthread_descr self = thread_self();
145   int already_canceled = 0;
146   pthread_extricate_if extr;
147   int spurious_wakeup_count;
148
149   /* Check whether the mutex is locked and owned by this thread.  */
150   if (mutex->__m_kind != PTHREAD_MUTEX_TIMED_NP
151       && mutex->__m_kind != PTHREAD_MUTEX_ADAPTIVE_NP
152       && mutex->__m_owner != self)
153     return EINVAL;
154
155   /* Set up extrication interface */
156   extr.pu_object = cond;
157   extr.pu_extricate_func = cond_extricate_func;
158
159   /* Register extrication interface */
160   THREAD_SETMEM(self, p_condvar_avail, 0);
161   __pthread_set_own_extricate_if(self, &extr);
162
163   /* Enqueue to wait on the condition and check for cancellation. */
164   __pthread_lock(&cond->__c_lock, self);
165   if (!(THREAD_GETMEM(self, p_canceled)
166       && THREAD_GETMEM(self, p_cancelstate) == PTHREAD_CANCEL_ENABLE))
167     enqueue(&cond->__c_waiting, self);
168   else
169     already_canceled = 1;
170   __pthread_unlock(&cond->__c_lock);
171
172   if (already_canceled) {
173     __pthread_set_own_extricate_if(self, 0);
174     __pthread_do_exit(PTHREAD_CANCELED, CURRENT_STACK_FRAME);
175   }
176
177   pthread_mutex_unlock(mutex);
178
179   spurious_wakeup_count = 0;
180   while (1)
181     {
182       if (!timedsuspend(self, abstime)) {
183         int was_on_queue;
184
185         /* __pthread_lock will queue back any spurious restarts that
186            may happen to it. */
187
188         __pthread_lock(&cond->__c_lock, self);
189         was_on_queue = remove_from_queue(&cond->__c_waiting, self);
190         __pthread_unlock(&cond->__c_lock);
191
192         if (was_on_queue) {
193           __pthread_set_own_extricate_if(self, 0);
194           pthread_mutex_lock(mutex);
195           return ETIMEDOUT;
196         }
197
198         /* Eat the outstanding restart() from the signaller */
199         suspend(self);
200       }
201
202       if (THREAD_GETMEM(self, p_condvar_avail) == 0
203           && (THREAD_GETMEM(self, p_woken_by_cancel) == 0
204               || THREAD_GETMEM(self, p_cancelstate) != PTHREAD_CANCEL_ENABLE))
205         {
206           /* Count resumes that don't belong to us. */
207           spurious_wakeup_count++;
208           continue;
209         }
210       break;
211     }
212
213   __pthread_set_own_extricate_if(self, 0);
214
215   /* The remaining logic is the same as in other cancellable waits,
216      such as pthread_join sem_wait or pthread_cond wait. */
217
218   if (THREAD_GETMEM(self, p_woken_by_cancel)
219       && THREAD_GETMEM(self, p_cancelstate) == PTHREAD_CANCEL_ENABLE) {
220     THREAD_SETMEM(self, p_woken_by_cancel, 0);
221     pthread_mutex_lock(mutex);
222     __pthread_do_exit(PTHREAD_CANCELED, CURRENT_STACK_FRAME);
223   }
224
225   /* Put back any resumes we caught that don't belong to us. */
226   while (spurious_wakeup_count--)
227     restart(self);
228
229   pthread_mutex_lock(mutex);
230   return 0;
231 }
232
233 int pthread_cond_timedwait(pthread_cond_t *cond, pthread_mutex_t *mutex,
234                            const struct timespec * abstime)
235 {
236   /* Indirect call through pointer! */
237   return pthread_cond_timedwait_relative(cond, mutex, abstime);
238 }
239
240 int __pthread_cond_signal(pthread_cond_t *cond)
241 {
242   pthread_descr th;
243
244   __pthread_lock(&cond->__c_lock, NULL);
245   th = dequeue(&cond->__c_waiting);
246   __pthread_unlock(&cond->__c_lock);
247   if (th != NULL) {
248     th->p_condvar_avail = 1;
249     WRITE_MEMORY_BARRIER();
250     restart(th);
251   }
252   return 0;
253 }
254 strong_alias (__pthread_cond_signal, pthread_cond_signal)
255
256 int __pthread_cond_broadcast(pthread_cond_t *cond)
257 {
258   pthread_descr tosignal, th;
259
260   __pthread_lock(&cond->__c_lock, NULL);
261   /* Copy the current state of the waiting queue and empty it */
262   tosignal = cond->__c_waiting;
263   cond->__c_waiting = NULL;
264   __pthread_unlock(&cond->__c_lock);
265   /* Now signal each process in the queue */
266   while ((th = dequeue(&tosignal)) != NULL) {
267     th->p_condvar_avail = 1;
268     WRITE_MEMORY_BARRIER();
269     restart(th);
270   }
271   return 0;
272 }
273 strong_alias (__pthread_cond_broadcast, pthread_cond_broadcast)
274
275 int __pthread_condattr_init(pthread_condattr_t *attr)
276 {
277   return 0;
278 }
279 strong_alias (__pthread_condattr_init, pthread_condattr_init)
280
281 int __pthread_condattr_destroy(pthread_condattr_t *attr)
282 {
283   return 0;
284 }
285 strong_alias (__pthread_condattr_destroy, pthread_condattr_destroy)
286
287 int pthread_condattr_getpshared (const pthread_condattr_t *attr, int *pshared)
288 {
289   *pshared = PTHREAD_PROCESS_PRIVATE;
290   return 0;
291 }
292
293 int pthread_condattr_setpshared (pthread_condattr_t *attr, int pshared)
294 {
295   if (pshared != PTHREAD_PROCESS_PRIVATE && pshared != PTHREAD_PROCESS_SHARED)
296     return EINVAL;
297
298   /* For now it is not possible to shared a conditional variable.  */
299   if (pshared != PTHREAD_PROCESS_PRIVATE)
300     return ENOSYS;
301
302   return 0;
303 }