pthread_mutex.c revision 1.78 1 1.78 ad /* $NetBSD: pthread_mutex.c,v 1.78 2020/06/01 11:44:59 ad Exp $ */
2 1.2 thorpej
3 1.2 thorpej /*-
4 1.77 ad * Copyright (c) 2001, 2003, 2006, 2007, 2008, 2020 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.78 ad __RCSID("$NetBSD: pthread_mutex.c,v 1.78 2020/06/01 11:44:59 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.60 christos #define MUTEX_PROTECT_BIT ((uintptr_t)0x08)
71 1.60 christos #define MUTEX_THREAD ((uintptr_t)~0x0f)
72 1.44 ad
73 1.44 ad #define MUTEX_HAS_WAITERS(x) ((uintptr_t)(x) & MUTEX_WAITERS_BIT)
74 1.44 ad #define MUTEX_RECURSIVE(x) ((uintptr_t)(x) & MUTEX_RECURSIVE_BIT)
75 1.60 christos #define MUTEX_PROTECT(x) ((uintptr_t)(x) & MUTEX_PROTECT_BIT)
76 1.44 ad #define MUTEX_OWNER(x) ((uintptr_t)(x) & MUTEX_THREAD)
77 1.44 ad
78 1.60 christos #define MUTEX_GET_TYPE(x) \
79 1.60 christos ((int)(((uintptr_t)(x) & 0x000000ff) >> 0))
80 1.60 christos #define MUTEX_SET_TYPE(x, t) \
81 1.60 christos (x) = (void *)(((uintptr_t)(x) & ~0x000000ff) | ((t) << 0))
82 1.60 christos #define MUTEX_GET_PROTOCOL(x) \
83 1.60 christos ((int)(((uintptr_t)(x) & 0x0000ff00) >> 8))
84 1.60 christos #define MUTEX_SET_PROTOCOL(x, p) \
85 1.60 christos (x) = (void *)(((uintptr_t)(x) & ~0x0000ff00) | ((p) << 8))
86 1.60 christos #define MUTEX_GET_CEILING(x) \
87 1.60 christos ((int)(((uintptr_t)(x) & 0x00ff0000) >> 16))
88 1.60 christos #define MUTEX_SET_CEILING(x, c) \
89 1.60 christos (x) = (void *)(((uintptr_t)(x) & ~0x00ff0000) | ((c) << 16))
90 1.60 christos
91 1.44 ad #if __GNUC_PREREQ__(3, 0)
92 1.44 ad #define NOINLINE __attribute ((noinline))
93 1.44 ad #else
94 1.44 ad #define NOINLINE /* nothing */
95 1.44 ad #endif
96 1.44 ad
97 1.44 ad static void pthread__mutex_wakeup(pthread_t, pthread_mutex_t *);
98 1.60 christos static int pthread__mutex_lock_slow(pthread_mutex_t *,
99 1.60 christos const struct timespec *);
100 1.44 ad static void pthread__mutex_pause(void);
101 1.2 thorpej
102 1.39 ad int _pthread_mutex_held_np(pthread_mutex_t *);
103 1.39 ad pthread_t _pthread_mutex_owner_np(pthread_mutex_t *);
104 1.39 ad
105 1.39 ad __weak_alias(pthread_mutex_held_np,_pthread_mutex_held_np)
106 1.39 ad __weak_alias(pthread_mutex_owner_np,_pthread_mutex_owner_np)
107 1.39 ad
108 1.2 thorpej __strong_alias(__libc_mutex_init,pthread_mutex_init)
109 1.2 thorpej __strong_alias(__libc_mutex_lock,pthread_mutex_lock)
110 1.2 thorpej __strong_alias(__libc_mutex_trylock,pthread_mutex_trylock)
111 1.2 thorpej __strong_alias(__libc_mutex_unlock,pthread_mutex_unlock)
112 1.2 thorpej __strong_alias(__libc_mutex_destroy,pthread_mutex_destroy)
113 1.4 thorpej
114 1.4 thorpej __strong_alias(__libc_mutexattr_init,pthread_mutexattr_init)
115 1.4 thorpej __strong_alias(__libc_mutexattr_destroy,pthread_mutexattr_destroy)
116 1.5 thorpej __strong_alias(__libc_mutexattr_settype,pthread_mutexattr_settype)
117 1.2 thorpej
118 1.2 thorpej int
119 1.44 ad pthread_mutex_init(pthread_mutex_t *ptm, const pthread_mutexattr_t *attr)
120 1.2 thorpej {
121 1.60 christos uintptr_t type, proto, val, ceil;
122 1.2 thorpej
123 1.76 kamil #if 0
124 1.65 christos /*
125 1.65 christos * Always initialize the mutex structure, maybe be used later
126 1.65 christos * and the cost should be minimal.
127 1.65 christos */
128 1.56 christos if (__predict_false(__uselibcstub))
129 1.56 christos return __libc_mutex_init_stub(ptm, attr);
130 1.76 kamil #endif
131 1.56 christos
132 1.72 kamil pthread__error(EINVAL, "Invalid mutes attribute",
133 1.72 kamil attr == NULL || attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
134 1.72 kamil
135 1.60 christos if (attr == NULL) {
136 1.44 ad type = PTHREAD_MUTEX_NORMAL;
137 1.60 christos proto = PTHREAD_PRIO_NONE;
138 1.60 christos ceil = 0;
139 1.60 christos } else {
140 1.60 christos val = (uintptr_t)attr->ptma_private;
141 1.2 thorpej
142 1.60 christos type = MUTEX_GET_TYPE(val);
143 1.60 christos proto = MUTEX_GET_PROTOCOL(val);
144 1.60 christos ceil = MUTEX_GET_CEILING(val);
145 1.60 christos }
146 1.44 ad switch (type) {
147 1.44 ad case PTHREAD_MUTEX_ERRORCHECK:
148 1.51 matt __cpu_simple_lock_set(&ptm->ptm_errorcheck);
149 1.44 ad ptm->ptm_owner = NULL;
150 1.44 ad break;
151 1.44 ad case PTHREAD_MUTEX_RECURSIVE:
152 1.51 matt __cpu_simple_lock_clear(&ptm->ptm_errorcheck);
153 1.44 ad ptm->ptm_owner = (void *)MUTEX_RECURSIVE_BIT;
154 1.44 ad break;
155 1.44 ad default:
156 1.51 matt __cpu_simple_lock_clear(&ptm->ptm_errorcheck);
157 1.44 ad ptm->ptm_owner = NULL;
158 1.44 ad break;
159 1.2 thorpej }
160 1.60 christos switch (proto) {
161 1.60 christos case PTHREAD_PRIO_PROTECT:
162 1.60 christos val = (uintptr_t)ptm->ptm_owner;
163 1.60 christos val |= MUTEX_PROTECT_BIT;
164 1.60 christos ptm->ptm_owner = (void *)val;
165 1.60 christos break;
166 1.2 thorpej
167 1.60 christos }
168 1.44 ad ptm->ptm_magic = _PT_MUTEX_MAGIC;
169 1.44 ad ptm->ptm_waiters = NULL;
170 1.45 ad ptm->ptm_recursed = 0;
171 1.60 christos ptm->ptm_ceiling = (unsigned char)ceil;
172 1.2 thorpej
173 1.2 thorpej return 0;
174 1.2 thorpej }
175 1.2 thorpej
176 1.2 thorpej int
177 1.44 ad pthread_mutex_destroy(pthread_mutex_t *ptm)
178 1.2 thorpej {
179 1.2 thorpej
180 1.56 christos if (__predict_false(__uselibcstub))
181 1.56 christos return __libc_mutex_destroy_stub(ptm);
182 1.56 christos
183 1.14 nathanw pthread__error(EINVAL, "Invalid mutex",
184 1.44 ad ptm->ptm_magic == _PT_MUTEX_MAGIC);
185 1.14 nathanw pthread__error(EBUSY, "Destroying locked mutex",
186 1.44 ad MUTEX_OWNER(ptm->ptm_owner) == 0);
187 1.2 thorpej
188 1.44 ad ptm->ptm_magic = _PT_MUTEX_DEAD;
189 1.2 thorpej return 0;
190 1.2 thorpej }
191 1.2 thorpej
192 1.2 thorpej int
193 1.44 ad pthread_mutex_lock(pthread_mutex_t *ptm)
194 1.2 thorpej {
195 1.27 ad pthread_t self;
196 1.44 ad void *val;
197 1.2 thorpej
198 1.56 christos if (__predict_false(__uselibcstub))
199 1.56 christos return __libc_mutex_lock_stub(ptm);
200 1.56 christos
201 1.70 kamil pthread__error(EINVAL, "Invalid mutex",
202 1.70 kamil ptm->ptm_magic == _PT_MUTEX_MAGIC);
203 1.70 kamil
204 1.27 ad self = pthread__self();
205 1.44 ad val = atomic_cas_ptr(&ptm->ptm_owner, NULL, self);
206 1.44 ad if (__predict_true(val == NULL)) {
207 1.44 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
208 1.44 ad membar_enter();
209 1.44 ad #endif
210 1.44 ad return 0;
211 1.2 thorpej }
212 1.60 christos return pthread__mutex_lock_slow(ptm, NULL);
213 1.60 christos }
214 1.60 christos
215 1.60 christos int
216 1.60 christos pthread_mutex_timedlock(pthread_mutex_t* ptm, const struct timespec *ts)
217 1.60 christos {
218 1.60 christos pthread_t self;
219 1.60 christos void *val;
220 1.60 christos
221 1.70 kamil pthread__error(EINVAL, "Invalid mutex",
222 1.70 kamil ptm->ptm_magic == _PT_MUTEX_MAGIC);
223 1.70 kamil
224 1.60 christos self = pthread__self();
225 1.60 christos val = atomic_cas_ptr(&ptm->ptm_owner, NULL, self);
226 1.60 christos if (__predict_true(val == NULL)) {
227 1.60 christos #ifndef PTHREAD__ATOMIC_IS_MEMBAR
228 1.60 christos membar_enter();
229 1.60 christos #endif
230 1.60 christos return 0;
231 1.60 christos }
232 1.60 christos return pthread__mutex_lock_slow(ptm, ts);
233 1.44 ad }
234 1.2 thorpej
235 1.44 ad /* We want function call overhead. */
236 1.44 ad NOINLINE static void
237 1.44 ad pthread__mutex_pause(void)
238 1.44 ad {
239 1.2 thorpej
240 1.44 ad pthread__smt_pause();
241 1.2 thorpej }
242 1.2 thorpej
243 1.44 ad /*
244 1.44 ad * Spin while the holder is running. 'lwpctl' gives us the true
245 1.66 ad * status of the thread.
246 1.44 ad */
247 1.44 ad NOINLINE static void *
248 1.44 ad pthread__mutex_spin(pthread_mutex_t *ptm, pthread_t owner)
249 1.44 ad {
250 1.44 ad pthread_t thread;
251 1.44 ad unsigned int count, i;
252 1.44 ad
253 1.44 ad for (count = 2;; owner = ptm->ptm_owner) {
254 1.44 ad thread = (pthread_t)MUTEX_OWNER(owner);
255 1.44 ad if (thread == NULL)
256 1.44 ad break;
257 1.66 ad if (thread->pt_lwpctl->lc_curcpu == LWPCTL_CPU_NONE)
258 1.44 ad break;
259 1.44 ad if (count < 128)
260 1.44 ad count += count;
261 1.44 ad for (i = count; i != 0; i--)
262 1.44 ad pthread__mutex_pause();
263 1.44 ad }
264 1.2 thorpej
265 1.44 ad return owner;
266 1.44 ad }
267 1.44 ad
268 1.44 ad NOINLINE static int
269 1.60 christos pthread__mutex_lock_slow(pthread_mutex_t *ptm, const struct timespec *ts)
270 1.2 thorpej {
271 1.77 ad void *waiters, *newval, *owner, *next;
272 1.44 ad pthread_t self;
273 1.57 christos int serrno;
274 1.60 christos int error;
275 1.2 thorpej
276 1.44 ad owner = ptm->ptm_owner;
277 1.44 ad self = pthread__self();
278 1.77 ad serrno = errno;
279 1.77 ad
280 1.77 ad pthread__assert(!self->pt_willpark);
281 1.13 nathanw
282 1.44 ad /* Recursive or errorcheck? */
283 1.44 ad if (MUTEX_OWNER(owner) == (uintptr_t)self) {
284 1.44 ad if (MUTEX_RECURSIVE(owner)) {
285 1.45 ad if (ptm->ptm_recursed == INT_MAX)
286 1.44 ad return EAGAIN;
287 1.45 ad ptm->ptm_recursed++;
288 1.44 ad return 0;
289 1.29 ad }
290 1.51 matt if (__SIMPLELOCK_LOCKED_P(&ptm->ptm_errorcheck))
291 1.44 ad return EDEADLK;
292 1.44 ad }
293 1.29 ad
294 1.60 christos /* priority protect */
295 1.60 christos if (MUTEX_PROTECT(owner) && _sched_protect(ptm->ptm_ceiling) == -1) {
296 1.77 ad error = errno;
297 1.77 ad errno = serrno;
298 1.77 ad return error;
299 1.60 christos }
300 1.44 ad
301 1.77 ad for (;;) {
302 1.44 ad /* If it has become free, try to acquire it again. */
303 1.44 ad if (MUTEX_OWNER(owner) == 0) {
304 1.77 ad newval = (void *)((uintptr_t)self | (uintptr_t)owner);
305 1.77 ad next = atomic_cas_ptr(&ptm->ptm_owner, owner, newval);
306 1.77 ad if (__predict_false(next != owner)) {
307 1.77 ad owner = next;
308 1.77 ad continue;
309 1.77 ad }
310 1.77 ad errno = serrno;
311 1.44 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
312 1.77 ad membar_enter();
313 1.44 ad #endif
314 1.77 ad return 0;
315 1.77 ad } else if (MUTEX_OWNER(owner) != (uintptr_t)self) {
316 1.77 ad /* Spin while the owner is running. */
317 1.77 ad owner = pthread__mutex_spin(ptm, owner);
318 1.77 ad if (MUTEX_OWNER(owner) == 0) {
319 1.77 ad continue;
320 1.77 ad }
321 1.44 ad }
322 1.21 chs
323 1.2 thorpej /*
324 1.44 ad * Nope, still held. Add thread to the list of waiters.
325 1.50 ad * Issue a memory barrier to ensure mutexwait/mutexnext
326 1.44 ad * are visible before we enter the waiters list.
327 1.2 thorpej */
328 1.50 ad self->pt_mutexwait = 1;
329 1.44 ad for (waiters = ptm->ptm_waiters;; waiters = next) {
330 1.50 ad self->pt_mutexnext = waiters;
331 1.77 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
332 1.44 ad membar_producer();
333 1.77 ad #endif
334 1.44 ad next = atomic_cas_ptr(&ptm->ptm_waiters, waiters, self);
335 1.44 ad if (next == waiters)
336 1.44 ad break;
337 1.44 ad }
338 1.66 ad
339 1.77 ad /*
340 1.77 ad * Try to set the waiters bit. If the mutex has become free
341 1.77 ad * since entering self onto the waiters list, need to wake
342 1.77 ad * everybody up (including self) and retry. It's possible
343 1.77 ad * to race with the unlocking thread, so self may have
344 1.77 ad * already been awoken.
345 1.77 ad */
346 1.77 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
347 1.66 ad membar_sync();
348 1.77 ad #endif
349 1.77 ad next = atomic_cas_ptr(&ptm->ptm_owner, owner,
350 1.77 ad (void *)((uintptr_t)owner | MUTEX_WAITERS_BIT));
351 1.77 ad if (next != owner) {
352 1.77 ad pthread__mutex_wakeup(self, ptm);
353 1.66 ad }
354 1.21 chs
355 1.29 ad /*
356 1.77 ad * We must not proceed until told that we are no longer
357 1.77 ad * waiting (via pt_mutexwait being set to zero). Otherwise
358 1.77 ad * it is unsafe to re-enter the thread onto the waiters
359 1.77 ad * list.
360 1.29 ad */
361 1.78 ad do {
362 1.78 ad pthread__assert(self->pt_nwaiters <= 1);
363 1.78 ad pthread__assert(self->pt_nwaiters != 0 ||
364 1.78 ad self->pt_waiters[0] == 0);
365 1.64 kre error = _lwp_park(CLOCK_REALTIME, TIMER_ABSTIME,
366 1.78 ad __UNCONST(ts), self->pt_waiters[0], NULL, NULL);
367 1.78 ad self->pt_waiters[0] = 0;
368 1.78 ad self->pt_nwaiters = 0;
369 1.78 ad if (error < 0 && errno == ETIMEDOUT) {
370 1.78 ad /* Remove self from waiters list */
371 1.60 christos pthread__mutex_wakeup(self, ptm);
372 1.78 ad /* Priority protect */
373 1.60 christos if (MUTEX_PROTECT(owner))
374 1.60 christos (void)_sched_protect(-1);
375 1.77 ad errno = serrno;
376 1.60 christos return ETIMEDOUT;
377 1.60 christos }
378 1.78 ad } while (self->pt_mutexwait);
379 1.77 ad owner = ptm->ptm_owner;
380 1.2 thorpej }
381 1.2 thorpej }
382 1.2 thorpej
383 1.2 thorpej int
384 1.44 ad pthread_mutex_trylock(pthread_mutex_t *ptm)
385 1.2 thorpej {
386 1.27 ad pthread_t self;
387 1.46 ad void *val, *new, *next;
388 1.2 thorpej
389 1.56 christos if (__predict_false(__uselibcstub))
390 1.56 christos return __libc_mutex_trylock_stub(ptm);
391 1.56 christos
392 1.70 kamil pthread__error(EINVAL, "Invalid mutex",
393 1.70 kamil ptm->ptm_magic == _PT_MUTEX_MAGIC);
394 1.70 kamil
395 1.27 ad self = pthread__self();
396 1.44 ad val = atomic_cas_ptr(&ptm->ptm_owner, NULL, self);
397 1.44 ad if (__predict_true(val == NULL)) {
398 1.44 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
399 1.44 ad membar_enter();
400 1.44 ad #endif
401 1.44 ad return 0;
402 1.44 ad }
403 1.27 ad
404 1.46 ad if (MUTEX_RECURSIVE(val)) {
405 1.46 ad if (MUTEX_OWNER(val) == 0) {
406 1.46 ad new = (void *)((uintptr_t)self | (uintptr_t)val);
407 1.46 ad next = atomic_cas_ptr(&ptm->ptm_owner, val, new);
408 1.46 ad if (__predict_true(next == val)) {
409 1.46 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
410 1.46 ad membar_enter();
411 1.46 ad #endif
412 1.46 ad return 0;
413 1.46 ad }
414 1.46 ad }
415 1.46 ad if (MUTEX_OWNER(val) == (uintptr_t)self) {
416 1.46 ad if (ptm->ptm_recursed == INT_MAX)
417 1.46 ad return EAGAIN;
418 1.46 ad ptm->ptm_recursed++;
419 1.46 ad return 0;
420 1.46 ad }
421 1.2 thorpej }
422 1.2 thorpej
423 1.44 ad return EBUSY;
424 1.2 thorpej }
425 1.2 thorpej
426 1.2 thorpej int
427 1.44 ad pthread_mutex_unlock(pthread_mutex_t *ptm)
428 1.2 thorpej {
429 1.27 ad pthread_t self;
430 1.77 ad void *val;
431 1.77 ad int error;
432 1.44 ad
433 1.56 christos if (__predict_false(__uselibcstub))
434 1.56 christos return __libc_mutex_unlock_stub(ptm);
435 1.56 christos
436 1.70 kamil pthread__error(EINVAL, "Invalid mutex",
437 1.70 kamil ptm->ptm_magic == _PT_MUTEX_MAGIC);
438 1.70 kamil
439 1.44 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
440 1.44 ad membar_exit();
441 1.44 ad #endif
442 1.77 ad error = 0;
443 1.44 ad self = pthread__self();
444 1.44 ad
445 1.77 ad val = atomic_cas_ptr(&ptm->ptm_owner, self, NULL);
446 1.77 ad if (__predict_false(val != self)) {
447 1.77 ad bool weown = (MUTEX_OWNER(val) == (uintptr_t)self);
448 1.77 ad void *newval = val;
449 1.77 ad if (__SIMPLELOCK_LOCKED_P(&ptm->ptm_errorcheck)) {
450 1.77 ad if (!weown) {
451 1.77 ad error = EPERM;
452 1.77 ad newval = val;
453 1.77 ad } else {
454 1.77 ad newval = NULL;
455 1.77 ad }
456 1.77 ad } else if (MUTEX_RECURSIVE(val)) {
457 1.77 ad if (!weown) {
458 1.77 ad error = EPERM;
459 1.77 ad newval = val;
460 1.77 ad } else if (ptm->ptm_recursed) {
461 1.77 ad ptm->ptm_recursed--;
462 1.77 ad newval = val;
463 1.77 ad } else {
464 1.77 ad newval = (pthread_t)MUTEX_RECURSIVE_BIT;
465 1.77 ad }
466 1.44 ad } else {
467 1.77 ad pthread__error(EPERM,
468 1.77 ad "Unlocking unlocked mutex", (val != NULL));
469 1.77 ad pthread__error(EPERM,
470 1.77 ad "Unlocking mutex owned by another thread", weown);
471 1.77 ad newval = NULL;
472 1.44 ad }
473 1.77 ad
474 1.77 ad /*
475 1.77 ad * Release the mutex. If there appear to be waiters, then
476 1.77 ad * wake them up.
477 1.77 ad */
478 1.77 ad if (newval != val) {
479 1.77 ad val = atomic_swap_ptr(&ptm->ptm_owner, newval);
480 1.77 ad if (__predict_false(MUTEX_PROTECT(val))) {
481 1.77 ad /* restore elevated priority */
482 1.77 ad (void)_sched_protect(-1);
483 1.77 ad }
484 1.44 ad }
485 1.44 ad }
486 1.2 thorpej
487 1.2 thorpej /*
488 1.77 ad * Finally, wake any waiters and return.
489 1.2 thorpej */
490 1.77 ad #ifndef PTHREAD__ATOMIC_IS_MEMBAR
491 1.77 ad membar_enter();
492 1.77 ad #endif
493 1.77 ad if (MUTEX_HAS_WAITERS(val)) {
494 1.77 ad pthread__mutex_wakeup(self, ptm);
495 1.68 ad } else if (self->pt_nwaiters > 0) {
496 1.77 ad pthread__clear_waiters(self);
497 1.2 thorpej }
498 1.44 ad return error;
499 1.44 ad }
500 1.44 ad
501 1.55 yamt /*
502 1.55 yamt * pthread__mutex_wakeup: unpark threads waiting for us
503 1.55 yamt *
504 1.55 yamt * unpark threads on the ptm->ptm_waiters list and self->pt_waiters.
505 1.55 yamt */
506 1.55 yamt
507 1.44 ad static void
508 1.44 ad pthread__mutex_wakeup(pthread_t self, pthread_mutex_t *ptm)
509 1.44 ad {
510 1.44 ad pthread_t thread, next;
511 1.27 ad
512 1.66 ad /* Take ownership of the current set of waiters. */
513 1.44 ad thread = atomic_swap_ptr(&ptm->ptm_waiters, NULL);
514 1.66 ad membar_datadep_consumer(); /* for alpha */
515 1.44 ad
516 1.77 ad /*
517 1.77 ad * Pull waiters from the queue and add to our list. Use a memory
518 1.77 ad * barrier to ensure that we safely read the value of pt_mutexnext
519 1.77 ad * before 'thread' sees pt_mutexwait being cleared.
520 1.77 ad */
521 1.77 ad while (thread != NULL) {
522 1.78 ad if (self->pt_nwaiters >= pthread__unpark_max) {
523 1.78 ad pthread__clear_waiters(self);
524 1.44 ad }
525 1.78 ad next = thread->pt_mutexnext;
526 1.78 ad self->pt_waiters[self->pt_nwaiters++] = thread->pt_lid;
527 1.78 ad membar_sync();
528 1.78 ad thread->pt_mutexwait = 0;
529 1.78 ad /* No longer safe to touch 'thread' */
530 1.78 ad thread = next;
531 1.44 ad }
532 1.78 ad pthread__clear_waiters(self);
533 1.2 thorpej }
534 1.55 yamt
535 1.2 thorpej int
536 1.2 thorpej pthread_mutexattr_init(pthread_mutexattr_t *attr)
537 1.2 thorpej {
538 1.76 kamil #if 0
539 1.56 christos if (__predict_false(__uselibcstub))
540 1.56 christos return __libc_mutexattr_init_stub(attr);
541 1.76 kamil #endif
542 1.2 thorpej
543 1.2 thorpej attr->ptma_magic = _PT_MUTEXATTR_MAGIC;
544 1.44 ad attr->ptma_private = (void *)PTHREAD_MUTEX_DEFAULT;
545 1.2 thorpej return 0;
546 1.2 thorpej }
547 1.2 thorpej
548 1.2 thorpej int
549 1.2 thorpej pthread_mutexattr_destroy(pthread_mutexattr_t *attr)
550 1.2 thorpej {
551 1.56 christos if (__predict_false(__uselibcstub))
552 1.56 christos return __libc_mutexattr_destroy_stub(attr);
553 1.2 thorpej
554 1.14 nathanw pthread__error(EINVAL, "Invalid mutex attribute",
555 1.14 nathanw attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
556 1.2 thorpej
557 1.69 kamil attr->ptma_magic = _PT_MUTEXATTR_DEAD;
558 1.69 kamil
559 1.2 thorpej return 0;
560 1.2 thorpej }
561 1.2 thorpej
562 1.2 thorpej int
563 1.2 thorpej pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *typep)
564 1.2 thorpej {
565 1.60 christos
566 1.14 nathanw pthread__error(EINVAL, "Invalid mutex attribute",
567 1.14 nathanw attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
568 1.2 thorpej
569 1.60 christos *typep = MUTEX_GET_TYPE(attr->ptma_private);
570 1.2 thorpej return 0;
571 1.2 thorpej }
572 1.2 thorpej
573 1.2 thorpej int
574 1.2 thorpej pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type)
575 1.2 thorpej {
576 1.60 christos
577 1.56 christos if (__predict_false(__uselibcstub))
578 1.56 christos return __libc_mutexattr_settype_stub(attr, type);
579 1.2 thorpej
580 1.14 nathanw pthread__error(EINVAL, "Invalid mutex attribute",
581 1.14 nathanw attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
582 1.13 nathanw
583 1.2 thorpej switch (type) {
584 1.2 thorpej case PTHREAD_MUTEX_NORMAL:
585 1.2 thorpej case PTHREAD_MUTEX_ERRORCHECK:
586 1.2 thorpej case PTHREAD_MUTEX_RECURSIVE:
587 1.60 christos MUTEX_SET_TYPE(attr->ptma_private, type);
588 1.60 christos return 0;
589 1.60 christos default:
590 1.60 christos return EINVAL;
591 1.60 christos }
592 1.60 christos }
593 1.60 christos
594 1.60 christos int
595 1.60 christos pthread_mutexattr_getprotocol(const pthread_mutexattr_t *attr, int*proto)
596 1.60 christos {
597 1.60 christos
598 1.60 christos pthread__error(EINVAL, "Invalid mutex attribute",
599 1.60 christos attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
600 1.60 christos
601 1.60 christos *proto = MUTEX_GET_PROTOCOL(attr->ptma_private);
602 1.60 christos return 0;
603 1.60 christos }
604 1.60 christos
605 1.60 christos int
606 1.60 christos pthread_mutexattr_setprotocol(pthread_mutexattr_t* attr, int proto)
607 1.60 christos {
608 1.60 christos
609 1.60 christos pthread__error(EINVAL, "Invalid mutex attribute",
610 1.60 christos attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
611 1.60 christos
612 1.60 christos switch (proto) {
613 1.60 christos case PTHREAD_PRIO_NONE:
614 1.60 christos case PTHREAD_PRIO_PROTECT:
615 1.60 christos MUTEX_SET_PROTOCOL(attr->ptma_private, proto);
616 1.44 ad return 0;
617 1.60 christos case PTHREAD_PRIO_INHERIT:
618 1.60 christos return ENOTSUP;
619 1.2 thorpej default:
620 1.2 thorpej return EINVAL;
621 1.2 thorpej }
622 1.2 thorpej }
623 1.2 thorpej
624 1.60 christos int
625 1.60 christos pthread_mutexattr_getprioceiling(const pthread_mutexattr_t *attr, int *ceil)
626 1.60 christos {
627 1.60 christos
628 1.60 christos pthread__error(EINVAL, "Invalid mutex attribute",
629 1.60 christos attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
630 1.60 christos
631 1.60 christos *ceil = MUTEX_GET_CEILING(attr->ptma_private);
632 1.60 christos return 0;
633 1.60 christos }
634 1.60 christos
635 1.60 christos int
636 1.60 christos pthread_mutexattr_setprioceiling(pthread_mutexattr_t *attr, int ceil)
637 1.60 christos {
638 1.60 christos
639 1.60 christos pthread__error(EINVAL, "Invalid mutex attribute",
640 1.60 christos attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
641 1.60 christos
642 1.60 christos if (ceil & ~0xff)
643 1.60 christos return EINVAL;
644 1.60 christos
645 1.60 christos MUTEX_SET_CEILING(attr->ptma_private, ceil);
646 1.60 christos return 0;
647 1.60 christos }
648 1.60 christos
649 1.60 christos #ifdef _PTHREAD_PSHARED
650 1.60 christos int
651 1.60 christos pthread_mutexattr_getpshared(const pthread_mutexattr_t * __restrict attr,
652 1.60 christos int * __restrict pshared)
653 1.60 christos {
654 1.60 christos
655 1.70 kamil pthread__error(EINVAL, "Invalid mutex attribute",
656 1.70 kamil attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
657 1.70 kamil
658 1.60 christos *pshared = PTHREAD_PROCESS_PRIVATE;
659 1.60 christos return 0;
660 1.60 christos }
661 1.60 christos
662 1.60 christos int
663 1.60 christos pthread_mutexattr_setpshared(pthread_mutexattr_t *attr, int pshared)
664 1.60 christos {
665 1.60 christos
666 1.70 kamil pthread__error(EINVAL, "Invalid mutex attribute",
667 1.70 kamil attr->ptma_magic == _PT_MUTEXATTR_MAGIC);
668 1.70 kamil
669 1.60 christos switch(pshared) {
670 1.60 christos case PTHREAD_PROCESS_PRIVATE:
671 1.60 christos return 0;
672 1.60 christos case PTHREAD_PROCESS_SHARED:
673 1.60 christos return ENOSYS;
674 1.60 christos }
675 1.60 christos return EINVAL;
676 1.60 christos }
677 1.60 christos #endif
678 1.60 christos
679 1.55 yamt /*
680 1.55 yamt * pthread__mutex_deferwake: try to defer unparking threads in self->pt_waiters
681 1.55 yamt *
682 1.77 ad * In order to avoid unnecessary contention on interlocking mutexes, we try
683 1.77 ad * to defer waking up threads until we unlock the mutex. The threads will
684 1.77 ad * be woken up when the calling thread (self) releases a mutex.
685 1.55 yamt */
686 1.50 ad void
687 1.50 ad pthread__mutex_deferwake(pthread_t self, pthread_mutex_t *ptm)
688 1.33 ad {
689 1.33 ad
690 1.50 ad if (__predict_false(ptm == NULL ||
691 1.50 ad MUTEX_OWNER(ptm->ptm_owner) != (uintptr_t)self)) {
692 1.77 ad pthread__clear_waiters(self);
693 1.50 ad }
694 1.33 ad }
695 1.33 ad
696 1.39 ad int
697 1.61 skrll pthread_mutex_getprioceiling(const pthread_mutex_t *ptm, int *ceil)
698 1.60 christos {
699 1.70 kamil
700 1.70 kamil pthread__error(EINVAL, "Invalid mutex",
701 1.70 kamil ptm->ptm_magic == _PT_MUTEX_MAGIC);
702 1.70 kamil
703 1.62 skrll *ceil = ptm->ptm_ceiling;
704 1.60 christos return 0;
705 1.60 christos }
706 1.60 christos
707 1.60 christos int
708 1.60 christos pthread_mutex_setprioceiling(pthread_mutex_t *ptm, int ceil, int *old_ceil)
709 1.60 christos {
710 1.60 christos int error;
711 1.60 christos
712 1.70 kamil pthread__error(EINVAL, "Invalid mutex",
713 1.70 kamil ptm->ptm_magic == _PT_MUTEX_MAGIC);
714 1.70 kamil
715 1.60 christos error = pthread_mutex_lock(ptm);
716 1.60 christos if (error == 0) {
717 1.62 skrll *old_ceil = ptm->ptm_ceiling;
718 1.60 christos /*check range*/
719 1.62 skrll ptm->ptm_ceiling = ceil;
720 1.60 christos pthread_mutex_unlock(ptm);
721 1.60 christos }
722 1.60 christos return error;
723 1.60 christos }
724 1.60 christos
725 1.60 christos int
726 1.44 ad _pthread_mutex_held_np(pthread_mutex_t *ptm)
727 1.39 ad {
728 1.39 ad
729 1.44 ad return MUTEX_OWNER(ptm->ptm_owner) == (uintptr_t)pthread__self();
730 1.39 ad }
731 1.39 ad
732 1.39 ad pthread_t
733 1.44 ad _pthread_mutex_owner_np(pthread_mutex_t *ptm)
734 1.39 ad {
735 1.39 ad
736 1.44 ad return (pthread_t)MUTEX_OWNER(ptm->ptm_owner);
737 1.39 ad }
738