f5fd08c099703dacd56950269adf3cdb616b45d2
[musl] / src / thread / pthread_cond_timedwait.c
1 #include "pthread_impl.h"
2
3 void __pthread_testcancel(void);
4 int __pthread_mutex_lock(pthread_mutex_t *);
5 int __pthread_mutex_unlock(pthread_mutex_t *);
6 int __pthread_setcancelstate(int, int *);
7
8 /*
9  * struct waiter
10  *
11  * Waiter objects have automatic storage on the waiting thread, and
12  * are used in building a linked list representing waiters currently
13  * waiting on the condition variable or a group of waiters woken
14  * together by a broadcast or signal; in the case of signal, this is a
15  * degenerate list of one member.
16  *
17  * Waiter lists attached to the condition variable itself are
18  * protected by the lock on the cv. Detached waiter lists are never
19  * modified again, but can only be traversed in reverse order, and are
20  * protected by the "barrier" locks in each node, which are unlocked
21  * in turn to control wake order.
22  *
23  * Since process-shared cond var semantics do not necessarily allow
24  * one thread to see another's automatic storage (they may be in
25  * different processes), the waiter list is not used for the
26  * process-shared case, but the structure is still used to store data
27  * needed by the cancellation cleanup handler.
28  */
29
30 struct waiter {
31         struct waiter *prev, *next;
32         int state, barrier;
33         int *notify;
34 };
35
36 /* Self-synchronized-destruction-safe lock functions */
37
38 static inline void lock(volatile int *l)
39 {
40         if (a_cas(l, 0, 1)) {
41                 a_cas(l, 1, 2);
42                 do __wait(l, 0, 2, 1);
43                 while (a_cas(l, 0, 2));
44         }
45 }
46
47 static inline void unlock(volatile int *l)
48 {
49         if (a_swap(l, 0)==2)
50                 __wake(l, 1, 1);
51 }
52
53 static inline void unlock_requeue(volatile int *l, volatile int *r, int w)
54 {
55         a_store(l, 0);
56         if (w) __wake(l, 1, 1);
57         else __syscall(SYS_futex, l, FUTEX_REQUEUE|128, 0, 1, r) != -ENOSYS
58                 || __syscall(SYS_futex, l, FUTEX_REQUEUE, 0, 1, r);
59 }
60
61 enum {
62         WAITING,
63         SIGNALED,
64         LEAVING,
65 };
66
67 int __pthread_cond_timedwait(pthread_cond_t *restrict c, pthread_mutex_t *restrict m, const struct timespec *restrict ts)
68 {
69         struct waiter node = { 0 };
70         int e, seq, *fut, clock = c->_c_clock, cs, shared=0, oldstate, tmp;
71
72         if ((m->_m_type&15) && (m->_m_lock&INT_MAX) != __pthread_self()->tid)
73                 return EPERM;
74
75         if (ts && ts->tv_nsec >= 1000000000UL)
76                 return EINVAL;
77
78         __pthread_testcancel();
79
80         if (c->_c_shared) {
81                 shared = 1;
82                 fut = &c->_c_seq;
83                 seq = c->_c_seq;
84                 a_inc(&c->_c_waiters);
85         } else {
86                 lock(&c->_c_lock);
87
88                 seq = node.barrier = 2;
89                 fut = &node.barrier;
90                 node.state = WAITING;
91                 node.next = c->_c_head;
92                 c->_c_head = &node;
93                 if (!c->_c_tail) c->_c_tail = &node;
94                 else node.next->prev = &node;
95
96                 unlock(&c->_c_lock);
97         }
98
99         __pthread_mutex_unlock(m);
100
101         __pthread_setcancelstate(PTHREAD_CANCEL_MASKED, &cs);
102
103         do e = __timedwait_cp(fut, seq, clock, ts, !shared);
104         while (*fut==seq && (!e || e==EINTR));
105         if (e == EINTR) e = 0;
106
107         if (shared) {
108                 /* Suppress cancellation if a signal was potentially
109                  * consumed; this is a legitimate form of spurious
110                  * wake even if not. */
111                 if (e == ECANCELED && c->_c_seq != seq) e = 0;
112                 if (a_fetch_add(&c->_c_waiters, -1) == -0x7fffffff)
113                         __wake(&c->_c_waiters, 1, 0);
114                 oldstate = WAITING;
115                 goto relock;
116         }
117
118         oldstate = a_cas(&node.state, WAITING, LEAVING);
119
120         if (oldstate == WAITING) {
121                 /* Access to cv object is valid because this waiter was not
122                  * yet signaled and a new signal/broadcast cannot return
123                  * after seeing a LEAVING waiter without getting notified
124                  * via the futex notify below. */
125
126                 lock(&c->_c_lock);
127                 
128                 if (c->_c_head == &node) c->_c_head = node.next;
129                 else if (node.prev) node.prev->next = node.next;
130                 if (c->_c_tail == &node) c->_c_tail = node.prev;
131                 else if (node.next) node.next->prev = node.prev;
132                 
133                 unlock(&c->_c_lock);
134
135                 if (node.notify) {
136                         if (a_fetch_add(node.notify, -1)==1)
137                                 __wake(node.notify, 1, 1);
138                 }
139         } else {
140                 /* Lock barrier first to control wake order. */
141                 lock(&node.barrier);
142         }
143
144 relock:
145         /* Errors locking the mutex override any existing error or
146          * cancellation, since the caller must see them to know the
147          * state of the mutex. */
148         if ((tmp = pthread_mutex_lock(m))) e = tmp;
149
150         if (oldstate == WAITING) goto done;
151
152         if (!node.next) a_inc(&m->_m_waiters);
153
154         /* Unlock the barrier that's holding back the next waiter, and
155          * either wake it or requeue it to the mutex. */
156         if (node.prev)
157                 unlock_requeue(&node.prev->barrier, &m->_m_lock, m->_m_type & 128);
158         else
159                 a_dec(&m->_m_waiters);
160
161         /* Since a signal was consumed, cancellation is not permitted. */
162         if (e == ECANCELED) e = 0;
163
164 done:
165         __pthread_setcancelstate(cs, 0);
166
167         if (e == ECANCELED) {
168                 __pthread_testcancel();
169                 __pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, 0);
170         }
171
172         return e;
173 }
174
175 int __private_cond_signal(pthread_cond_t *c, int n)
176 {
177         struct waiter *p, *first=0;
178         int ref = 0, cur;
179
180         lock(&c->_c_lock);
181         for (p=c->_c_tail; n && p; p=p->prev) {
182                 if (a_cas(&p->state, WAITING, SIGNALED) != WAITING) {
183                         ref++;
184                         p->notify = &ref;
185                 } else {
186                         n--;
187                         if (!first) first=p;
188                 }
189         }
190         /* Split the list, leaving any remainder on the cv. */
191         if (p) {
192                 if (p->next) p->next->prev = 0;
193                 p->next = 0;
194         } else {
195                 c->_c_head = 0;
196         }
197         c->_c_tail = p;
198         unlock(&c->_c_lock);
199
200         /* Wait for any waiters in the LEAVING state to remove
201          * themselves from the list before returning or allowing
202          * signaled threads to proceed. */
203         while ((cur = ref)) __wait(&ref, 0, cur, 1);
204
205         /* Allow first signaled waiter, if any, to proceed. */
206         if (first) unlock(&first->barrier);
207
208         return 0;
209 }
210
211 weak_alias(__pthread_cond_timedwait, pthread_cond_timedwait);