pthread_mutex.c revision 1.66 1 1.66 ad /* $NetBSD: pthread_mutex.c,v 1.66 2020/01/13 18:22:56 ad Exp $ */
2 1.2 thorpej
3 1.2 thorpej /*-
4 1.44 ad * Copyright (c) 2001, 2003, 2006, 2007, 2008 The NetBSD Foundation, Inc.
5 1.2 thorpej * All rights reserved.
6 1.2 thorpej *
7 1.2 thorpej * This code is derived from software contributed to The NetBSD Foundation
8 1.27 ad * by Nathan J. Williams, by Jason R. Thorpe, and by Andrew Doran.
9 1.2 thorpej *
10 1.2 thorpej * Redistribution and use in source and binary forms, with or without
11 1.2 thorpej * modification, are permitted provided that the following conditions
12 1.2 thorpej * are met:
13 1.2 thorpej * 1. Redistributions of source code must retain the above copyright
14 1.2 thorpej * notice, this list of conditions and the following disclaimer.
15 1.2 thorpej * 2. Redistributions in binary form must reproduce the above copyright
16 1.2 thorpej * notice, this list of conditions and the following disclaimer in the
17 1.2 thorpej * documentation and/or other materials provided with the distribution.
18 1.2 thorpej *
19 1.2 thorpej * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.2 thorpej * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.2 thorpej * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.2 thorpej * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.2 thorpej * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.2 thorpej * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.2 thorpej * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.2 thorpej * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.2 thorpej * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.2 thorpej * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.2 thorpej * POSSIBILITY OF SUCH DAMAGE.
30 1.2 thorpej */
31 1.2 thorpej
32 1.49 ad /*
33 1.49 ad * To track threads waiting for mutexes to be released, we use lockless
34 1.49 ad * lists built on atomic operations and memory barriers.
35 1.49 ad *
36 1.49 ad * A simple spinlock would be faster and make the code easier to
37 1.49 ad * follow, but spinlocks are problematic in userspace. If a thread is
38 1.49 ad * preempted by the kernel while holding a spinlock, any other thread
39 1.49 ad * attempting to acquire that spinlock will needlessly busy wait.
40 1.49 ad *
41 1.49 ad * There is no good way to know that the holding thread is no longer
42 1.49 ad * running, nor to request a wake-up once it has begun running again.
43 1.49 ad * Of more concern, threads in the SCHED_FIFO class do not have a
44 1.49 ad * limited time quantum and so could spin forever, preventing the
45 1.49 ad * thread holding the spinlock from getting CPU time: it would never
46 1.49 ad * be released.
47 1.49 ad */
48 1.49 ad
49 1.2 thorpej #include <sys/cdefs.h>
50 1.66 ad __RCSID("$NetBSD: pthread_mutex.c,v 1.66 2020/01/13 18:22:56 ad Exp $");
51 1.40 ad
52 1.40 ad #include <sys/types.h>
53 1.44 ad #include <sys/lwpctl.h>
54 1.60 christos #include <sys/sched.h>
55 1.51 matt #include <sys/lock.h>
56 1.10 lukem
57 1.2 thorpej #include <errno.h>
58 1.2 thorpej #include <limits.h>
59 1.2 thorpej #include <stdlib.h>
60 1.56 christos #include <time.h>
61 1.6 scw #include <string.h>
62 1.44 ad #include <stdio.h>
63 1.2 thorpej
64 1.2 thorpej #include "pthread.h"
65 1.2 thorpej #include "pthread_int.h"
66 1.56 christos #include "reentrant.h"
67 1.2 thorpej
68 1.44 ad #define MUTEX_WAITERS_BIT ((uintptr_t)0x01)
69 1.44 ad #define MUTEX_RECURSIVE_BIT ((uintptr_t)0x02)
70 1.44 ad #define MUTEX_DEFERRED_BIT ((uintptr_t)0x04)
71 1.60 christos #define MUTEX_PROTECT_BIT ((uintptr_t)0x08)
72 1.60 christos #define MUTEX_THREAD ((uintptr_t)~0x0f)
73 1.44 ad
74 1.44 ad #define MUTEX_HAS_WAITERS(x) ((uintptr_t)(x) & MUTEX_WAITERS_BIT)
75 1.44 ad #define MUTEX_RECURSIVE(x) ((uintptr_t)(x) & MUTEX_RECURSIVE_BIT)
76 1.60 christos #define MUTEX_PROTECT(x) ((uintptr_t)(x) & MUTEX_PROTECT_BIT)
77 1.44 ad #define MUTEX_OWNER(x) ((uintptr_t)(x) & MUTEX_THREAD)
78 1.44 ad
79 1.60 christos #define MUTEX_GET_TYPE(x) \
80 1.60 christos ((int)(((uintptr_t)(x) & 0x000000ff) >> 0))
81 1.60 christos #define MUTEX_SET_TYPE(x, t) \
82 1.60 christos (x) = (void *)(((uintptr_t)(x) & ~0x000000ff) | ((t) << 0))
83 1.60 christos #define MUTEX_GET_PROTOCOL(x) \
84 1.60 christos ((int)(((uintptr_t)(x) & 0x0000ff00) >> 8))
85 1.60 christos #define MUTEX_SET_PROTOCOL(x, p) \
86 1.60 christos (x) = (void *)(((uintptr_t)(x) & ~0x0000ff00) | ((p) << 8))
87 1.60 christos #define MUTEX_GET_CEILING(x) \
88 1.60 christos ((int)(((uintptr_t)(x) & 0x00ff0000) >> 16))
89 1.60 christos #define MUTEX_SET_CEILING(x, c) \
90 1.60 christos (x) = (void *)(((uintptr_t)(x) & ~0x00ff0000) | ((c) << 16))
91 1.60 christos
92 1.44 ad #if __GNUC_PREREQ__(3, 0)
93 1.44 ad #define NOINLINE __attribute ((noinline))
94 1.44 ad #else
95 1.44 ad #define NOINLINE /* nothing */
96 1.44 ad #endif
97 1.44 ad
98 1.44 ad static void pthread__mutex_wakeup(pthread_t, pthread_mutex_t *);
99 1.60 christos static int pthread__mutex_lock_slow(pthread_mutex_t *,
100 1.60 christos const struct timespec *);
101 1.44 ad static int pthread__mutex_unlock_slow(pthread_mutex_t *);
102 1.44 ad static void pthread__mutex_pause(void);
103 1.2 thorpej
104 1.39 ad int _pthread_mutex_held_np(pthread_mutex_t *);
105 1.39 ad pthread_t _pthread_mutex_owner_np(pthread_mutex_t *);
106 1.39 ad
107 1.39 ad __weak_alias(pthread_mutex_held_np,_pthread_mutex_held_np)
108 1.39 ad __weak_alias(pthread_mutex_owner_np,_pthread_mutex_owner_np)
109 1.39 ad
110 1.2 thorpej __strong_alias(__libc_mutex_init,pthread_mutex_init)
111 1.2 thorpej __strong_alias(__libc_mutex_lock,pthread_mutex_lock)
112 1.2 thorpej __strong_alias(__libc_mutex_trylock,pthread_mutex_trylock)
113 1.2 thorpej __strong_alias(__libc_mutex_unlock,pthread_mutex_unlock)
114 1.2 thorpej __strong_alias(__libc_mutex_destroy,pthread_mutex_destroy)
115 1.4 thorpej
116 1.4 thorpej __strong_alias(__libc_mutexattr_init,pthread_mutexattr_init)
117 1.4 thorpej __strong_alias(__libc_mutexattr_destroy,pthread_mutexattr_destroy)
118 1.5 thorpej __strong_alias(__libc_mutexattr_settype,pthread_mutexattr_settype)
119 1.2 thorpej
120 1.2 thorpej int
121 1.44 ad pthread_mutex_init(pthread_mutex_t *ptm, const pthread_mutexattr_t *attr)
122 1.2 thorpej {
123 1.60 christos uintptr_t type, proto, val, ceil;
124 1.2 thorpej
125 1.65 christos #if 0
126 1.65 christos /*
127 1.65 christos * Always initialize the mutex structure, maybe be used later
128 1.65 christos * and the cost should be minimal.
129 1.65 christos */
130 1.56 christos if (__predict_false(__uselibcstub))
131 1.56 christos return __libc_mutex_init_stub(ptm, attr);
132 1.65 christos #endif
133 1.56 christos
134 1.60 christos if (attr == NULL) {
135 1.44 ad type = PTHREAD_MUTEX_NORMAL;
136 1.60 christos proto = PTHREAD_PRIO_NONE;
137 1.60 christos ceil = 0;
138 1.60 christos } else {
139 1.60 christos val = (uintptr_t)attr->ptma_private;
140 1.2 thorpej
141 1.60 christos type = MUTEX_GET_TYPE(val);
142 1.60 christos proto = MUTEX_GET_PROTOCOL(val);
143 1.60 christos ceil = MUTEX_GET_CEILING(val);
144 1.60 christos }
145 1.44 ad switch (type) {
146 1.44 ad case PTHREAD_MUTEX_ERRORCHECK:
147 1.51 matt __cpu_simple_lock_set(&ptm->ptm_errorcheck);
148 1.44 ad ptm->ptm_owner = NULL;
149 1.44 ad break;
150 1.44 ad case PTHREAD_MUTEX_RECURSIVE:
151 1.51 matt __cpu_simple_lock_clear(&ptm->ptm_errorcheck);
152 1.44 ad ptm->ptm_owner = (void *)MUTEX_RECURSIVE_BIT;
153 1.44 ad break;
154 1.44 ad default:
155 1.51 matt __cpu_simple_lock_clear(&ptm->ptm_errorcheck);
156 1.44 ad ptm->ptm_owner = NULL;
157 1.44 ad break;
158 1.2 thorpej }
159 1.60 christos switch (proto) {
160 1.60 christos case PTHREAD_PRIO_PROTECT:
161 1.60 christos val = (uintptr_t)ptm->ptm_owner;
162 1.60 christos val |= MUTEX_PROTECT_BIT;
163 1.60 christos ptm->ptm_owner = (void *)val;
164 1.60 christos break;
165 1.2 thorpej
166 1.60 christos }
167 1.44 ad ptm->ptm_magic = _PT_MUTEX_MAGIC;
168 1.44 ad ptm->ptm_waiters = NULL;
169 1.45 ad ptm->ptm_recursed = 0;
170 1.60 christos ptm->ptm_ceiling = (unsigned char)ceil;
171 1.2 thorpej
172 1.2 thorpej return 0;
173 1.2 thorpej }
174 1.2 thorpej
175 1.2 thorpej int
176 1.44 ad pthread_mutex_destroy(pthread_mutex_t *ptm)
177 1.2 thorpej {
178 1.2 thorpej
179 1.56 christos if (__predict_false(__uselibcstub))
180 1.56 christos return __libc_mutex_destroy_stub(ptm);
181 1.56 christos
182 1.14 nathanw pthread__error(EINVAL, "Invalid mutex",
183 1.44 ad ptm->ptm_magic == _PT_MUTEX_MAGIC);
184 1.14 nathanw pthread__error(EBUSY, "Destroying locked mutex",
185 1.44 ad MUTEX_OWNER(ptm->ptm_owner) == 0);
186 1.2 thorpej
187 1.44 ad ptm->ptm_magic = _PT_MUTEX_DEAD;
188 1.2 thorpej return 0;
189 1.2 thorpej }
190 1.2 thorpej
191 1.2 thorpej int
192 1.44 ad pthread_mutex_lock(pthread_mutex_t *ptm)
193 1.2 thorpej {
194 1.27 ad pthread_t self;
195 1.44 ad void *val;
196 1.2 thorpej
197 1.56 christos if (__predict_false(__uselibcstub))
198 1.56 christos return __libc_mutex_lock_stub(ptm);
199 1.56 christos
200 1.27 ad self = pthread__self();
201 1.44 ad val = atomic_cas_ptr(&ptm->ptm_owner, NULL, self);
202 1.44 ad if (__predict_true(val == NULL)) {
203 1.44 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
204 1.44 ad membar_enter();
205 1.44 ad #endif
206 1.44 ad return 0;
207 1.2 thorpej }
208 1.60 christos return pthread__mutex_lock_slow(ptm, NULL);
209 1.60 christos }
210 1.60 christos
211 1.60 christos int
212 1.60 christos pthread_mutex_timedlock(pthread_mutex_t* ptm, const struct timespec *ts)
213 1.60 christos {
214 1.60 christos pthread_t self;
215 1.60 christos void *val;
216 1.60 christos
217 1.60 christos self = pthread__self();
218 1.60 christos val = atomic_cas_ptr(&ptm->ptm_owner, NULL, self);
219 1.60 christos if (__predict_true(val == NULL)) {
220 1.60 christos #ifndef PTHREAD__ATOMIC_IS_MEMBAR
221 1.60 christos membar_enter();
222 1.60 christos #endif
223 1.60 christos return 0;
224 1.60 christos }
225 1.60 christos return pthread__mutex_lock_slow(ptm, ts);
226 1.44 ad }
227 1.2 thorpej
228 1.44 ad /* We want function call overhead. */
229 1.44 ad NOINLINE static void
230 1.44 ad pthread__mutex_pause(void)
231 1.44 ad {
232 1.2 thorpej
233 1.44 ad pthread__smt_pause();
234 1.2 thorpej }
235 1.2 thorpej
236 1.44 ad /*
237 1.44 ad * Spin while the holder is running. 'lwpctl' gives us the true
238 1.66 ad * status of the thread.
239 1.44 ad */
240 1.44 ad NOINLINE static void *
241 1.44 ad pthread__mutex_spin(pthread_mutex_t *ptm, pthread_t owner)
242 1.44 ad {
243 1.44 ad pthread_t thread;
244 1.44 ad unsigned int count, i;
245 1.44 ad
246 1.44 ad for (count = 2;; owner = ptm->ptm_owner) {
247 1.44 ad thread = (pthread_t)MUTEX_OWNER(owner);
248 1.44 ad if (thread == NULL)
249 1.44 ad break;
250 1.66 ad if (thread->pt_lwpctl->lc_curcpu == LWPCTL_CPU_NONE)
251 1.44 ad break;
252 1.44 ad if (count < 128)
253 1.44 ad count += count;
254 1.44 ad for (i = count; i != 0; i--)
255 1.44 ad pthread__mutex_pause();
256 1.44 ad }
257 1.2 thorpej
258 1.44 ad return owner;
259 1.44 ad }
260 1.44 ad
261 1.66 ad NOINLINE static bool
262 1.59 rmind pthread__mutex_setwaiters(pthread_t self, pthread_mutex_t *ptm)
263 1.59 rmind {
264 1.66 ad void *owner, *next;
265 1.59 rmind
266 1.59 rmind /*
267 1.59 rmind * Note that the mutex can become unlocked before we set
268 1.59 rmind * the waiters bit. If that happens it's not safe to sleep
269 1.59 rmind * as we may never be awoken: we must remove the current
270 1.59 rmind * thread from the waiters list and try again.
271 1.59 rmind *
272 1.59 rmind * Because we are doing this atomically, we can't remove
273 1.59 rmind * one waiter: we must remove all waiters and awken them,
274 1.59 rmind * then sleep in _lwp_park() until we have been awoken.
275 1.59 rmind *
276 1.59 rmind * Issue a memory barrier to ensure that we are reading
277 1.59 rmind * the value of ptm_owner/pt_mutexwait after we have entered
278 1.59 rmind * the waiters list (the CAS itself must be atomic).
279 1.59 rmind */
280 1.66 ad for (owner = ptm->ptm_owner;; owner = next) {
281 1.66 ad if (MUTEX_OWNER(owner) == 0) {
282 1.66 ad pthread__mutex_wakeup(self, ptm);
283 1.66 ad return true;
284 1.66 ad }
285 1.66 ad if (MUTEX_HAS_WAITERS(owner)) {
286 1.66 ad return false;
287 1.59 rmind }
288 1.66 ad next = atomic_cas_ptr(&ptm->ptm_owner, owner,
289 1.66 ad (void *)((uintptr_t)owner | MUTEX_WAITERS_BIT));
290 1.59 rmind }
291 1.59 rmind }
292 1.59 rmind
293 1.44 ad NOINLINE static int
294 1.60 christos pthread__mutex_lock_slow(pthread_mutex_t *ptm, const struct timespec *ts)
295 1.2 thorpej {
296 1.44 ad void *waiters, *new, *owner, *next;
297 1.44 ad pthread_t self;
298 1.57 christos int serrno;
299 1.60 christos int error;
300 1.2 thorpej
301 1.14 nathanw pthread__error(EINVAL, "Invalid mutex",
302 1.44 ad ptm->ptm_magic == _PT_MUTEX_MAGIC);
303 1.44 ad
304 1.44 ad owner = ptm->ptm_owner;
305 1.44 ad self = pthread__self();
306 1.13 nathanw
307 1.44 ad /* Recursive or errorcheck? */
308 1.44 ad if (MUTEX_OWNER(owner) == (uintptr_t)self) {
309 1.44 ad if (MUTEX_RECURSIVE(owner)) {
310 1.45 ad if (ptm->ptm_recursed == INT_MAX)
311 1.44 ad return EAGAIN;
312 1.45 ad ptm->ptm_recursed++;
313 1.44 ad return 0;
314 1.29 ad }
315 1.51 matt if (__SIMPLELOCK_LOCKED_P(&ptm->ptm_errorcheck))
316 1.44 ad return EDEADLK;
317 1.44 ad }
318 1.29 ad
319 1.60 christos /* priority protect */
320 1.60 christos if (MUTEX_PROTECT(owner) && _sched_protect(ptm->ptm_ceiling) == -1) {
321 1.60 christos return errno;
322 1.60 christos }
323 1.57 christos serrno = errno;
324 1.44 ad for (;; owner = ptm->ptm_owner) {
325 1.44 ad /* Spin while the owner is running. */
326 1.63 christos if (MUTEX_OWNER(owner) != (uintptr_t)self)
327 1.63 christos owner = pthread__mutex_spin(ptm, owner);
328 1.44 ad
329 1.44 ad /* If it has become free, try to acquire it again. */
330 1.44 ad if (MUTEX_OWNER(owner) == 0) {
331 1.47 ad do {
332 1.44 ad new = (void *)
333 1.44 ad ((uintptr_t)self | (uintptr_t)owner);
334 1.44 ad next = atomic_cas_ptr(&ptm->ptm_owner, owner,
335 1.44 ad new);
336 1.44 ad if (next == owner) {
337 1.57 christos errno = serrno;
338 1.44 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
339 1.44 ad membar_enter();
340 1.44 ad #endif
341 1.44 ad return 0;
342 1.44 ad }
343 1.47 ad owner = next;
344 1.47 ad } while (MUTEX_OWNER(owner) == 0);
345 1.44 ad /*
346 1.44 ad * We have lost the race to acquire the mutex.
347 1.44 ad * The new owner could be running on another
348 1.44 ad * CPU, in which case we should spin and avoid
349 1.44 ad * the overhead of blocking.
350 1.44 ad */
351 1.47 ad continue;
352 1.44 ad }
353 1.21 chs
354 1.2 thorpej /*
355 1.44 ad * Nope, still held. Add thread to the list of waiters.
356 1.50 ad * Issue a memory barrier to ensure mutexwait/mutexnext
357 1.44 ad * are visible before we enter the waiters list.
358 1.2 thorpej */
359 1.50 ad self->pt_mutexwait = 1;
360 1.44 ad for (waiters = ptm->ptm_waiters;; waiters = next) {
361 1.50 ad self->pt_mutexnext = waiters;
362 1.44 ad membar_producer();
363 1.44 ad next = atomic_cas_ptr(&ptm->ptm_waiters, waiters, self);
364 1.44 ad if (next == waiters)
365 1.44 ad break;
366 1.44 ad }
367 1.66 ad
368 1.59 rmind /* Set the waiters bit and block. */
369 1.66 ad membar_sync();
370 1.66 ad if (pthread__mutex_setwaiters(self, ptm)) {
371 1.66 ad continue;
372 1.66 ad }
373 1.21 chs
374 1.29 ad /*
375 1.44 ad * We may have been awoken by the current thread above,
376 1.44 ad * or will be awoken by the current holder of the mutex.
377 1.44 ad * The key requirement is that we must not proceed until
378 1.50 ad * told that we are no longer waiting (via pt_mutexwait
379 1.44 ad * being set to zero). Otherwise it is unsafe to re-enter
380 1.44 ad * the thread onto the waiters list.
381 1.29 ad */
382 1.66 ad membar_sync();
383 1.50 ad while (self->pt_mutexwait) {
384 1.64 kre error = _lwp_park(CLOCK_REALTIME, TIMER_ABSTIME,
385 1.64 kre __UNCONST(ts), self->pt_unpark,
386 1.64 kre __UNVOLATILE(&ptm->ptm_waiters),
387 1.50 ad __UNVOLATILE(&ptm->ptm_waiters));
388 1.50 ad self->pt_unpark = 0;
389 1.60 christos if (__predict_true(error != -1)) {
390 1.60 christos continue;
391 1.60 christos }
392 1.60 christos if (errno == ETIMEDOUT && self->pt_mutexwait) {
393 1.60 christos /*Remove self from waiters list*/
394 1.60 christos pthread__mutex_wakeup(self, ptm);
395 1.60 christos /*priority protect*/
396 1.60 christos if (MUTEX_PROTECT(owner))
397 1.60 christos (void)_sched_protect(-1);
398 1.60 christos return ETIMEDOUT;
399 1.60 christos }
400 1.44 ad }
401 1.2 thorpej }
402 1.2 thorpej }
403 1.2 thorpej
404 1.2 thorpej int
405 1.44 ad pthread_mutex_trylock(pthread_mutex_t *ptm)
406 1.2 thorpej {
407 1.27 ad pthread_t self;
408 1.46 ad void *val, *new, *next;
409 1.2 thorpej
410 1.56 christos if (__predict_false(__uselibcstub))
411 1.56 christos return __libc_mutex_trylock_stub(ptm);
412 1.56 christos
413 1.27 ad self = pthread__self();
414 1.44 ad val = atomic_cas_ptr(&ptm->ptm_owner, NULL, self);
415 1.44 ad if (__predict_true(val == NULL)) {
416 1.44 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
417 1.44 ad membar_enter();
418 1.44 ad #endif
419 1.44 ad return 0;
420 1.44 ad }
421 1.27 ad
422 1.46 ad if (MUTEX_RECURSIVE(val)) {
423 1.46 ad if (MUTEX_OWNER(val) == 0) {
424 1.46 ad new = (void *)((uintptr_t)self | (uintptr_t)val);
425 1.46 ad next = atomic_cas_ptr(&ptm->ptm_owner, val, new);
426 1.46 ad if (__predict_true(next == val)) {
427 1.46 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
428 1.46 ad membar_enter();
429 1.46 ad #endif
430 1.46 ad return 0;
431 1.46 ad }
432 1.46 ad }
433 1.46 ad if (MUTEX_OWNER(val) == (uintptr_t)self) {
434 1.46 ad if (ptm->ptm_recursed == INT_MAX)
435 1.46 ad return EAGAIN;
436 1.46 ad ptm->ptm_recursed++;
437 1.46 ad return 0;
438 1.46 ad }
439 1.2 thorpej }
440 1.2 thorpej
441 1.44 ad return EBUSY;
442 1.2 thorpej }
443 1.2 thorpej
444 1.2 thorpej int
445 1.44 ad pthread_mutex_unlock(pthread_mutex_t *ptm)
446 1.2 thorpej {
447 1.27 ad pthread_t self;
448 1.44 ad void *value;
449 1.44 ad
450 1.56 christos if (__predict_false(__uselibcstub))
451 1.56 christos return __libc_mutex_unlock_stub(ptm);
452 1.56 christos
453 1.44 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
454 1.44 ad membar_exit();
455 1.44 ad #endif
456 1.44 ad self = pthread__self();
457 1.66 ad value = atomic_cas_ptr(&ptm->ptm_owner, self, NULL);
458 1.54 matt if (__predict_true(value == self)) {
459 1.54 matt pthread__smt_wake();
460 1.44 ad return 0;
461 1.54 matt }
462 1.44 ad return pthread__mutex_unlock_slow(ptm);
463 1.44 ad }
464 1.44 ad
465 1.44 ad NOINLINE static int
466 1.44 ad pthread__mutex_unlock_slow(pthread_mutex_t *ptm)
467 1.44 ad {
468 1.44 ad pthread_t self, owner, new;
469 1.44 ad int weown, error, deferred;
470 1.13 nathanw
471 1.14 nathanw pthread__error(EINVAL, "Invalid mutex",
472 1.44 ad ptm->ptm_magic == _PT_MUTEX_MAGIC);
473 1.44 ad
474 1.44 ad self = pthread__self();
475 1.44 ad owner = ptm->ptm_owner;
476 1.44 ad weown = (MUTEX_OWNER(owner) == (uintptr_t)self);
477 1.44 ad deferred = (int)((uintptr_t)owner & MUTEX_DEFERRED_BIT);
478 1.44 ad error = 0;
479 1.44 ad
480 1.51 matt if (__SIMPLELOCK_LOCKED_P(&ptm->ptm_errorcheck)) {
481 1.44 ad if (!weown) {
482 1.44 ad error = EPERM;
483 1.44 ad new = owner;
484 1.44 ad } else {
485 1.44 ad new = NULL;
486 1.44 ad }
487 1.44 ad } else if (MUTEX_RECURSIVE(owner)) {
488 1.44 ad if (!weown) {
489 1.44 ad error = EPERM;
490 1.44 ad new = owner;
491 1.45 ad } else if (ptm->ptm_recursed) {
492 1.45 ad ptm->ptm_recursed--;
493 1.44 ad new = owner;
494 1.44 ad } else {
495 1.44 ad new = (pthread_t)MUTEX_RECURSIVE_BIT;
496 1.44 ad }
497 1.44 ad } else {
498 1.44 ad pthread__error(EPERM,
499 1.44 ad "Unlocking unlocked mutex", (owner != NULL));
500 1.44 ad pthread__error(EPERM,
501 1.44 ad "Unlocking mutex owned by another thread", weown);
502 1.44 ad new = NULL;
503 1.44 ad }
504 1.2 thorpej
505 1.2 thorpej /*
506 1.44 ad * Release the mutex. If there appear to be waiters, then
507 1.44 ad * wake them up.
508 1.2 thorpej */
509 1.44 ad if (new != owner) {
510 1.44 ad owner = atomic_swap_ptr(&ptm->ptm_owner, new);
511 1.60 christos if (__predict_false(MUTEX_PROTECT(owner))) {
512 1.60 christos /* restore elevated priority */
513 1.60 christos (void)_sched_protect(-1);
514 1.60 christos }
515 1.44 ad if (MUTEX_HAS_WAITERS(owner) != 0) {
516 1.44 ad pthread__mutex_wakeup(self, ptm);
517 1.2 thorpej return 0;
518 1.2 thorpej }
519 1.44 ad }
520 1.44 ad
521 1.44 ad /*
522 1.44 ad * There were no waiters, but we may have deferred waking
523 1.44 ad * other threads until mutex unlock - we must wake them now.
524 1.44 ad */
525 1.44 ad if (!deferred)
526 1.44 ad return error;
527 1.44 ad
528 1.44 ad if (self->pt_nwaiters == 1) {
529 1.44 ad /*
530 1.44 ad * If the calling thread is about to block, defer
531 1.44 ad * unparking the target until _lwp_park() is called.
532 1.44 ad */
533 1.44 ad if (self->pt_willpark && self->pt_unpark == 0) {
534 1.44 ad self->pt_unpark = self->pt_waiters[0];
535 1.44 ad } else {
536 1.44 ad (void)_lwp_unpark(self->pt_waiters[0],
537 1.45 ad __UNVOLATILE(&ptm->ptm_waiters));
538 1.15 nathanw }
539 1.44 ad } else {
540 1.44 ad (void)_lwp_unpark_all(self->pt_waiters, self->pt_nwaiters,
541 1.45 ad __UNVOLATILE(&ptm->ptm_waiters));
542 1.2 thorpej }
543 1.44 ad self->pt_nwaiters = 0;
544 1.2 thorpej
545 1.44 ad return error;
546 1.44 ad }
547 1.44 ad
548 1.55 yamt /*
549 1.55 yamt * pthread__mutex_wakeup: unpark threads waiting for us
550 1.55 yamt *
551 1.55 yamt * unpark threads on the ptm->ptm_waiters list and self->pt_waiters.
552 1.55 yamt */
553 1.55 yamt
554 1.44 ad static void
555 1.44 ad pthread__mutex_wakeup(pthread_t self, pthread_mutex_t *ptm)
556 1.44 ad {
557 1.44 ad pthread_t thread, next;
558 1.44 ad ssize_t n, rv;
559 1.27 ad
560 1.66 ad /* Take ownership of the current set of waiters. */
561 1.44 ad thread = atomic_swap_ptr(&ptm->ptm_waiters, NULL);
562 1.66 ad membar_datadep_consumer(); /* for alpha */
563 1.54 matt pthread__smt_wake();
564 1.44 ad
565 1.44 ad for (;;) {
566 1.44 ad /*
567 1.44 ad * Pull waiters from the queue and add to our list.
568 1.44 ad * Use a memory barrier to ensure that we safely
569 1.50 ad * read the value of pt_mutexnext before 'thread'
570 1.50 ad * sees pt_mutexwait being cleared.
571 1.44 ad */
572 1.44 ad for (n = self->pt_nwaiters, self->pt_nwaiters = 0;
573 1.44 ad n < pthread__unpark_max && thread != NULL;
574 1.44 ad thread = next) {
575 1.50 ad next = thread->pt_mutexnext;
576 1.44 ad if (thread != self) {
577 1.44 ad self->pt_waiters[n++] = thread->pt_lid;
578 1.44 ad membar_sync();
579 1.44 ad }
580 1.50 ad thread->pt_mutexwait = 0;
581 1.44 ad /* No longer safe to touch 'thread' */
582 1.44 ad }
583 1.44 ad
584 1.44 ad switch (n) {
585 1.44 ad case 0:
586 1.44 ad return;
587 1.44 ad case 1:
588 1.44 ad /*
589 1.44 ad * If the calling thread is about to block,
590 1.44 ad * defer unparking the target until _lwp_park()
591 1.44 ad * is called.
592 1.44 ad */
593 1.44 ad if (self->pt_willpark && self->pt_unpark == 0) {
594 1.44 ad self->pt_unpark = self->pt_waiters[0];
595 1.44 ad return;
596 1.44 ad }
597 1.44 ad rv = (ssize_t)_lwp_unpark(self->pt_waiters[0],
598 1.45 ad __UNVOLATILE(&ptm->ptm_waiters));
599 1.44 ad if (rv != 0 && errno != EALREADY && errno != EINTR &&
600 1.44 ad errno != ESRCH) {
601 1.44 ad pthread__errorfunc(__FILE__, __LINE__,
602 1.44 ad __func__, "_lwp_unpark failed");
603 1.44 ad }
604 1.44 ad return;
605 1.44 ad default:
606 1.44 ad rv = _lwp_unpark_all(self->pt_waiters, (size_t)n,
607 1.45 ad __UNVOLATILE(&ptm->ptm_waiters));
608 1.44 ad if (rv != 0 && errno != EINTR) {
609 1.44 ad pthread__errorfunc(__FILE__, __LINE__,
610 1.44 ad __func__, "_lwp_unpark_all failed");
611 1.44 ad }
612 1.44 ad break;
613 1.44 ad }
614 1.44 ad }
615 1.2 thorpej }
616 1.55 yamt
617 1.2 thorpej int
618 1.2 thorpej pthread_mutexattr_init(pthread_mutexattr_t *attr)
619 1.2 thorpej {
620 1.56 christos if (__predict_false(__uselibcstub))
621 1.56 christos return __libc_mutexattr_init_stub(attr);
622 1.2 thorpej
623 1.2 thorpej attr->ptma_magic = _PT_MUTEXATTR_MAGIC;
624 1.44 ad attr->ptma_private = (void *)PTHREAD_MUTEX_DEFAULT;
625 1.2 thorpej return 0;
626 1.2 thorpej }
627 1.2 thorpej
628 1.2 thorpej int
629 1.2 thorpej pthread_mutexattr_destroy(pthread_mutexattr_t *attr)
630 1.2 thorpej {
631 1.56 christos if (__predict_false(__uselibcstub))
632 1.56 christos return __libc_mutexattr_destroy_stub(attr);
633 1.2 thorpej
634 1.14 nathanw pthread__error(EINVAL, "Invalid mutex attribute",
635 1.14 nathanw attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
636 1.2 thorpej
637 1.2 thorpej return 0;
638 1.2 thorpej }
639 1.2 thorpej
640 1.2 thorpej int
641 1.2 thorpej pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *typep)
642 1.2 thorpej {
643 1.60 christos
644 1.14 nathanw pthread__error(EINVAL, "Invalid mutex attribute",
645 1.14 nathanw attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
646 1.2 thorpej
647 1.60 christos *typep = MUTEX_GET_TYPE(attr->ptma_private);
648 1.2 thorpej return 0;
649 1.2 thorpej }
650 1.2 thorpej
651 1.2 thorpej int
652 1.2 thorpej pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type)
653 1.2 thorpej {
654 1.60 christos
655 1.56 christos if (__predict_false(__uselibcstub))
656 1.56 christos return __libc_mutexattr_settype_stub(attr, type);
657 1.2 thorpej
658 1.14 nathanw pthread__error(EINVAL, "Invalid mutex attribute",
659 1.14 nathanw attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
660 1.13 nathanw
661 1.2 thorpej switch (type) {
662 1.2 thorpej case PTHREAD_MUTEX_NORMAL:
663 1.2 thorpej case PTHREAD_MUTEX_ERRORCHECK:
664 1.2 thorpej case PTHREAD_MUTEX_RECURSIVE:
665 1.60 christos MUTEX_SET_TYPE(attr->ptma_private, type);
666 1.60 christos return 0;
667 1.60 christos default:
668 1.60 christos return EINVAL;
669 1.60 christos }
670 1.60 christos }
671 1.60 christos
672 1.60 christos int
673 1.60 christos pthread_mutexattr_getprotocol(const pthread_mutexattr_t *attr, int*proto)
674 1.60 christos {
675 1.60 christos
676 1.60 christos pthread__error(EINVAL, "Invalid mutex attribute",
677 1.60 christos attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
678 1.60 christos
679 1.60 christos *proto = MUTEX_GET_PROTOCOL(attr->ptma_private);
680 1.60 christos return 0;
681 1.60 christos }
682 1.60 christos
683 1.60 christos int
684 1.60 christos pthread_mutexattr_setprotocol(pthread_mutexattr_t* attr, int proto)
685 1.60 christos {
686 1.60 christos
687 1.60 christos pthread__error(EINVAL, "Invalid mutex attribute",
688 1.60 christos attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
689 1.60 christos
690 1.60 christos switch (proto) {
691 1.60 christos case PTHREAD_PRIO_NONE:
692 1.60 christos case PTHREAD_PRIO_PROTECT:
693 1.60 christos MUTEX_SET_PROTOCOL(attr->ptma_private, proto);
694 1.44 ad return 0;
695 1.60 christos case PTHREAD_PRIO_INHERIT:
696 1.60 christos return ENOTSUP;
697 1.2 thorpej default:
698 1.2 thorpej return EINVAL;
699 1.2 thorpej }
700 1.2 thorpej }
701 1.2 thorpej
702 1.60 christos int
703 1.60 christos pthread_mutexattr_getprioceiling(const pthread_mutexattr_t *attr, int *ceil)
704 1.60 christos {
705 1.60 christos
706 1.60 christos pthread__error(EINVAL, "Invalid mutex attribute",
707 1.60 christos attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
708 1.60 christos
709 1.60 christos *ceil = MUTEX_GET_CEILING(attr->ptma_private);
710 1.60 christos return 0;
711 1.60 christos }
712 1.60 christos
713 1.60 christos int
714 1.60 christos pthread_mutexattr_setprioceiling(pthread_mutexattr_t *attr, int ceil)
715 1.60 christos {
716 1.60 christos
717 1.60 christos pthread__error(EINVAL, "Invalid mutex attribute",
718 1.60 christos attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
719 1.60 christos
720 1.60 christos if (ceil & ~0xff)
721 1.60 christos return EINVAL;
722 1.60 christos
723 1.60 christos MUTEX_SET_CEILING(attr->ptma_private, ceil);
724 1.60 christos return 0;
725 1.60 christos }
726 1.60 christos
727 1.60 christos #ifdef _PTHREAD_PSHARED
728 1.60 christos int
729 1.60 christos pthread_mutexattr_getpshared(const pthread_mutexattr_t * __restrict attr,
730 1.60 christos int * __restrict pshared)
731 1.60 christos {
732 1.60 christos
733 1.60 christos *pshared = PTHREAD_PROCESS_PRIVATE;
734 1.60 christos return 0;
735 1.60 christos }
736 1.60 christos
737 1.60 christos int
738 1.60 christos pthread_mutexattr_setpshared(pthread_mutexattr_t *attr, int pshared)
739 1.60 christos {
740 1.60 christos
741 1.60 christos switch(pshared) {
742 1.60 christos case PTHREAD_PROCESS_PRIVATE:
743 1.60 christos return 0;
744 1.60 christos case PTHREAD_PROCESS_SHARED:
745 1.60 christos return ENOSYS;
746 1.60 christos }
747 1.60 christos return EINVAL;
748 1.60 christos }
749 1.60 christos #endif
750 1.60 christos
751 1.55 yamt /*
752 1.55 yamt * pthread__mutex_deferwake: try to defer unparking threads in self->pt_waiters
753 1.55 yamt *
754 1.55 yamt * In order to avoid unnecessary contention on the interlocking mutex,
755 1.55 yamt * we defer waking up threads until we unlock the mutex. The threads will
756 1.55 yamt * be woken up when the calling thread (self) releases the first mutex with
757 1.55 yamt * MUTEX_DEFERRED_BIT set. It likely be the mutex 'ptm', but no problem
758 1.55 yamt * even if it isn't.
759 1.55 yamt */
760 1.55 yamt
761 1.50 ad void
762 1.50 ad pthread__mutex_deferwake(pthread_t self, pthread_mutex_t *ptm)
763 1.33 ad {
764 1.33 ad
765 1.50 ad if (__predict_false(ptm == NULL ||
766 1.50 ad MUTEX_OWNER(ptm->ptm_owner) != (uintptr_t)self)) {
767 1.50 ad (void)_lwp_unpark_all(self->pt_waiters, self->pt_nwaiters,
768 1.50 ad __UNVOLATILE(&ptm->ptm_waiters));
769 1.50 ad self->pt_nwaiters = 0;
770 1.50 ad } else {
771 1.50 ad atomic_or_ulong((volatile unsigned long *)
772 1.50 ad (uintptr_t)&ptm->ptm_owner,
773 1.50 ad (unsigned long)MUTEX_DEFERRED_BIT);
774 1.50 ad }
775 1.33 ad }
776 1.33 ad
777 1.39 ad int
778 1.61 skrll pthread_mutex_getprioceiling(const pthread_mutex_t *ptm, int *ceil)
779 1.60 christos {
780 1.62 skrll *ceil = ptm->ptm_ceiling;
781 1.60 christos return 0;
782 1.60 christos }
783 1.60 christos
784 1.60 christos int
785 1.60 christos pthread_mutex_setprioceiling(pthread_mutex_t *ptm, int ceil, int *old_ceil)
786 1.60 christos {
787 1.60 christos int error;
788 1.60 christos
789 1.60 christos error = pthread_mutex_lock(ptm);
790 1.60 christos if (error == 0) {
791 1.62 skrll *old_ceil = ptm->ptm_ceiling;
792 1.60 christos /*check range*/
793 1.62 skrll ptm->ptm_ceiling = ceil;
794 1.60 christos pthread_mutex_unlock(ptm);
795 1.60 christos }
796 1.60 christos return error;
797 1.60 christos }
798 1.60 christos
799 1.60 christos int
800 1.44 ad _pthread_mutex_held_np(pthread_mutex_t *ptm)
801 1.39 ad {
802 1.39 ad
803 1.44 ad return MUTEX_OWNER(ptm->ptm_owner) == (uintptr_t)pthread__self();
804 1.39 ad }
805 1.39 ad
806 1.39 ad pthread_t
807 1.44 ad _pthread_mutex_owner_np(pthread_mutex_t *ptm)
808 1.39 ad {
809 1.39 ad
810 1.44 ad return (pthread_t)MUTEX_OWNER(ptm->ptm_owner);
811 1.39 ad }
812