/*-
* Copyright (c) 2001, 2003, 2006, 2007, 2008, 2020 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Nathan J. Williams, by Jason R. Thorpe, and by Andrew Doran.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* To track threads waiting for mutexes to be released, we use lockless
* lists built on atomic operations and memory barriers.
*
* A simple spinlock would be faster and make the code easier to
* follow, but spinlocks are problematic in userspace. If a thread is
* preempted by the kernel while holding a spinlock, any other thread
* attempting to acquire that spinlock will needlessly busy wait.
*
* There is no good way to know that the holding thread is no longer
* running, nor to request a wake-up once it has begun running again.
* Of more concern, threads in the SCHED_FIFO class do not have a
* limited time quantum and so could spin forever, preventing the
* thread holding the spinlock from getting CPU time: it would never
* be released.
*/
int
pthread_mutex_init(pthread_mutex_t *ptm, const pthread_mutexattr_t *attr)
{
uintptr_t type, proto, val, ceil;
#if 0
/*
* Always initialize the mutex structure, maybe be used later
* and the cost should be minimal.
*/
if (__predict_false(__uselibcstub))
return __libc_mutex_init_stub(ptm, attr);
#endif
/* We want function call overhead. */
NOINLINE static void
pthread__mutex_pause(void)
{
pthread__smt_pause();
}
/*
* Spin while the holder is running. 'lwpctl' gives us the true
* status of the thread.
*/
NOINLINE static void *
pthread__mutex_spin(pthread_mutex_t *ptm, pthread_t owner)
{
pthread_t thread;
unsigned int count, i;
for (count = 2;; owner = ptm->ptm_owner) {
thread = (pthread_t)MUTEX_OWNER(owner);
if (thread == NULL)
break;
if (thread->pt_lwpctl->lc_curcpu == LWPCTL_CPU_NONE)
break;
if (count < 128)
count += count;
for (i = count; i != 0; i--)
pthread__mutex_pause();
}
return owner;
}
NOINLINE static int
pthread__mutex_lock_slow(pthread_mutex_t *ptm, const struct timespec *ts)
{
void *newval, *owner, *next;
struct waiter waiter;
pthread_t self;
int serrno;
int error;
for (;;) {
/* If it has become free, try to acquire it again. */
if (MUTEX_OWNER(owner) == 0) {
newval = (void *)((uintptr_t)self | (uintptr_t)owner);
next = atomic_cas_ptr(&ptm->ptm_owner, owner, newval);
if (__predict_false(next != owner)) {
owner = next;
continue;
}
errno = serrno;
#ifndef PTHREAD__ATOMIC_IS_MEMBAR
membar_enter();
#endif
return 0;
} else if (MUTEX_OWNER(owner) != (uintptr_t)self) {
/* Spin while the owner is running. */
owner = pthread__mutex_spin(ptm, owner);
if (MUTEX_OWNER(owner) == 0) {
continue;
}
}
/*
* Nope, still held. Add thread to the list of waiters.
* Issue a memory barrier to ensure stores to 'waiter'
* are visible before we enter the list.
*/
waiter.next = ptm->ptm_waiters;
waiter.lid = self->pt_lid;
#ifndef PTHREAD__ATOMIC_IS_MEMBAR
membar_producer();
#endif
next = atomic_cas_ptr(&ptm->ptm_waiters, waiter.next, &waiter);
if (next != waiter.next) {
owner = ptm->ptm_owner;
continue;
}
/*
* If the mutex has become free since entering self onto the
* waiters list, need to wake everybody up (including self)
* and retry. It's possible to race with an unlocking
* thread, so self may have already been awoken.
*/
#ifndef PTHREAD__ATOMIC_IS_MEMBAR
membar_enter();
#endif
if (MUTEX_OWNER(ptm->ptm_owner) == 0) {
pthread__mutex_wakeup(self,
atomic_swap_ptr(&ptm->ptm_waiters, NULL));
}
/*
* We must not proceed until told that we are no longer
* waiting (via waiter.lid being set to zero). Otherwise
* it's unsafe to re-enter "waiter" onto the waiters list.
*/
while (waiter.lid != 0) {
error = _lwp_park(CLOCK_REALTIME, TIMER_ABSTIME,
__UNCONST(ts), 0, NULL, NULL);
if (error < 0 && errno == ETIMEDOUT) {
/* Remove self from waiters list */
pthread__mutex_wakeup(self,
atomic_swap_ptr(&ptm->ptm_waiters, NULL));
/*
* Might have raced with another thread to
* do the wakeup. In any case there will be
* a wakeup for sure. Eat it and wait for
* waiter.lid to clear.
*/
while (waiter.lid != 0) {
(void)_lwp_park(CLOCK_MONOTONIC, 0,
NULL, 0, NULL, NULL);
}
val = atomic_cas_ptr(&ptm->ptm_owner, self, newval);
if (__predict_false(val != self)) {
bool weown = (MUTEX_OWNER(val) == (uintptr_t)self);
if (__SIMPLELOCK_LOCKED_P(&ptm->ptm_errorcheck)) {
if (!weown) {
error = EPERM;
newval = val;
} else {
newval = NULL;
}
} else if (MUTEX_RECURSIVE(val)) {
if (!weown) {
error = EPERM;
newval = val;
} else if (ptm->ptm_recursed) {
ptm->ptm_recursed--;
newval = val;
} else {
newval = (pthread_t)MUTEX_RECURSIVE_BIT;
}
} else {
pthread__error(EPERM,
"Unlocking unlocked mutex", (val != NULL));
pthread__error(EPERM,
"Unlocking mutex owned by another thread", weown);
newval = NULL;
}
/*
* Release the mutex. If there appear to be waiters, then
* wake them up.
*/
if (newval != val) {
val = atomic_swap_ptr(&ptm->ptm_owner, newval);
if (__predict_false(MUTEX_PROTECT(val))) {
/* restore elevated priority */
(void)_sched_protect(-1);
}
}
}
/*
* Finally, wake any waiters and return.
*/
#ifndef PTHREAD__ATOMIC_IS_MEMBAR
membar_enter();
#endif
if (MUTEX_OWNER(newval) == 0 && ptm->ptm_waiters != NULL) {
pthread__mutex_wakeup(self,
atomic_swap_ptr(&ptm->ptm_waiters, NULL));
}
return error;
}
/*
* pthread__mutex_wakeup: unpark threads waiting for us
*/
/*
* Pull waiters from the queue and add to our list. Use a memory
* barrier to ensure that we safely read the value of waiter->next
* before the awoken thread sees waiter->lid being cleared.
*/
membar_datadep_consumer(); /* for alpha */
for (nlid = 0; cur != NULL; cur = next) {
if (nlid == mlid) {
(void)_lwp_unpark_all(lids, nlid, NULL);
nlid = 0;
}
next = cur->next;
pthread__assert(cur->lid != 0);
lids[nlid++] = cur->lid;
membar_exit();
cur->lid = 0;
/* No longer safe to touch 'cur' */
}
if (nlid == 1) {
(void)_lwp_unpark(lids[0], NULL);
} else if (nlid > 1) {
(void)_lwp_unpark_all(lids, nlid, NULL);
}
}
int
pthread_mutexattr_init(pthread_mutexattr_t *attr)
{
#if 0
if (__predict_false(__uselibcstub))
return __libc_mutexattr_init_stub(attr);
#endif
switch(pshared) {
case PTHREAD_PROCESS_PRIVATE:
return 0;
case PTHREAD_PROCESS_SHARED:
return ENOSYS;
}
return EINVAL;
}
#endif
/*
* In order to avoid unnecessary contention on interlocking mutexes, we try
* to defer waking up threads until we unlock the mutex. The threads will
* be woken up when the calling thread (self) releases the mutex.
*/
void
pthread__mutex_deferwake(pthread_t self, pthread_mutex_t *ptm,
struct pthread__waiter *head)
{
struct pthread__waiter *tail, *n, *o;