Adjust use of lll_futex_* macros.
[kopensolaris-gnu/glibc.git] / nptl / pthread_cond_wait.c
1 /* Copyright (C) 2003, 2004, 2006, 2007 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3    Contributed by Martin Schwidefsky <schwidefsky@de.ibm.com>, 2003.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 2.1 of the License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with the GNU C Library; if not, write to the Free
17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18    02111-1307 USA.  */
19
20 #include <endian.h>
21 #include <errno.h>
22 #include <sysdep.h>
23 #include <lowlevellock.h>
24 #include <pthread.h>
25 #include <pthreadP.h>
26
27 #include <shlib-compat.h>
28
29
30 struct _condvar_cleanup_buffer
31 {
32   int oldtype;
33   pthread_cond_t *cond;
34   pthread_mutex_t *mutex;
35   unsigned int bc_seq;
36 };
37
38
39 void
40 __attribute__ ((visibility ("hidden")))
41 __condvar_cleanup (void *arg)
42 {
43   struct _condvar_cleanup_buffer *cbuffer =
44     (struct _condvar_cleanup_buffer *) arg;
45   unsigned int destroying;
46
47   /* We are going to modify shared data.  */
48   lll_mutex_lock (cbuffer->cond->__data.__lock);
49
50   if (cbuffer->bc_seq == cbuffer->cond->__data.__broadcast_seq)
51     {
52       /* This thread is not waiting anymore.  Adjust the sequence counters
53          appropriately.  We do not increment WAKEUP_SEQ if this would
54          bump it over the value of TOTAL_SEQ.  This can happen if a thread
55          was woken and then canceled.  */
56       if (cbuffer->cond->__data.__wakeup_seq
57           < cbuffer->cond->__data.__total_seq)
58         {
59           ++cbuffer->cond->__data.__wakeup_seq;
60           ++cbuffer->cond->__data.__futex;
61         }
62       ++cbuffer->cond->__data.__woken_seq;
63     }
64
65   cbuffer->cond->__data.__nwaiters -= 1 << COND_NWAITERS_SHIFT;
66
67   /* If pthread_cond_destroy was called on this variable already,
68      notify the pthread_cond_destroy caller all waiters have left
69      and it can be successfully destroyed.  */
70   destroying = 0;
71   if (cbuffer->cond->__data.__total_seq == -1ULL
72       && cbuffer->cond->__data.__nwaiters < (1 << COND_NWAITERS_SHIFT))
73     {
74       lll_futex_wake (&cbuffer->cond->__data.__nwaiters, 1,
75                       // XYZ check mutex flag
76                       LLL_SHARED);
77       destroying = 1;
78     }
79
80   /* We are done.  */
81   lll_mutex_unlock (cbuffer->cond->__data.__lock);
82
83   /* Wake everybody to make sure no condvar signal gets lost.  */
84   if (! destroying)
85     lll_futex_wake (&cbuffer->cond->__data.__futex, INT_MAX,
86                     // XYZ check mutex flag
87                     LLL_SHARED);
88
89   /* Get the mutex before returning unless asynchronous cancellation
90      is in effect.  */
91   __pthread_mutex_cond_lock (cbuffer->mutex);
92 }
93
94
95 int
96 __pthread_cond_wait (cond, mutex)
97      pthread_cond_t *cond;
98      pthread_mutex_t *mutex;
99 {
100   struct _pthread_cleanup_buffer buffer;
101   struct _condvar_cleanup_buffer cbuffer;
102   int err;
103
104   /* Make sure we are along.  */
105   lll_mutex_lock (cond->__data.__lock);
106
107   /* Now we can release the mutex.  */
108   err = __pthread_mutex_unlock_usercnt (mutex, 0);
109   if (__builtin_expect (err, 0))
110     {
111       lll_mutex_unlock (cond->__data.__lock);
112       return err;
113     }
114
115   /* We have one new user of the condvar.  */
116   ++cond->__data.__total_seq;
117   ++cond->__data.__futex;
118   cond->__data.__nwaiters += 1 << COND_NWAITERS_SHIFT;
119
120   /* Remember the mutex we are using here.  If there is already a
121      different address store this is a bad user bug.  Do not store
122      anything for pshared condvars.  */
123   if (cond->__data.__mutex != (void *) ~0l)
124     cond->__data.__mutex = mutex;
125
126   /* Prepare structure passed to cancellation handler.  */
127   cbuffer.cond = cond;
128   cbuffer.mutex = mutex;
129
130   /* Before we block we enable cancellation.  Therefore we have to
131      install a cancellation handler.  */
132   __pthread_cleanup_push (&buffer, __condvar_cleanup, &cbuffer);
133
134   /* The current values of the wakeup counter.  The "woken" counter
135      must exceed this value.  */
136   unsigned long long int val;
137   unsigned long long int seq;
138   val = seq = cond->__data.__wakeup_seq;
139   /* Remember the broadcast counter.  */
140   cbuffer.bc_seq = cond->__data.__broadcast_seq;
141
142   do
143     {
144       unsigned int futex_val = cond->__data.__futex;
145
146       /* Prepare to wait.  Release the condvar futex.  */
147       lll_mutex_unlock (cond->__data.__lock);
148
149       /* Enable asynchronous cancellation.  Required by the standard.  */
150       cbuffer.oldtype = __pthread_enable_asynccancel ();
151
152       /* Wait until woken by signal or broadcast.  */
153       lll_futex_wait (&cond->__data.__futex, futex_val,
154                       // XYZ check mutex flag
155                       LLL_SHARED);
156
157       /* Disable asynchronous cancellation.  */
158       __pthread_disable_asynccancel (cbuffer.oldtype);
159
160       /* We are going to look at shared data again, so get the lock.  */
161       lll_mutex_lock (cond->__data.__lock);
162
163       /* If a broadcast happened, we are done.  */
164       if (cbuffer.bc_seq != cond->__data.__broadcast_seq)
165         goto bc_out;
166
167       /* Check whether we are eligible for wakeup.  */
168       val = cond->__data.__wakeup_seq;
169     }
170   while (val == seq || cond->__data.__woken_seq == val);
171
172   /* Another thread woken up.  */
173   ++cond->__data.__woken_seq;
174
175  bc_out:
176
177   cond->__data.__nwaiters -= 1 << COND_NWAITERS_SHIFT;
178
179   /* If pthread_cond_destroy was called on this varaible already,
180      notify the pthread_cond_destroy caller all waiters have left
181      and it can be successfully destroyed.  */
182   if (cond->__data.__total_seq == -1ULL
183       && cond->__data.__nwaiters < (1 << COND_NWAITERS_SHIFT))
184     lll_futex_wake (&cond->__data.__nwaiters, 1,
185                     // XYZ check mutex flag
186                     LLL_SHARED);
187
188   /* We are done with the condvar.  */
189   lll_mutex_unlock (cond->__data.__lock);
190
191   /* The cancellation handling is back to normal, remove the handler.  */
192   __pthread_cleanup_pop (&buffer, 0);
193
194   /* Get the mutex before returning.  */
195   return __pthread_mutex_cond_lock (mutex);
196 }
197
198 versioned_symbol (libpthread, __pthread_cond_wait, pthread_cond_wait,
199                   GLIBC_2_3_2);