/* Copyright (C) 2002-2019 Free Software Foundation, Inc.
This file is part of the GNU C Library.
Contributed by Ulrich Drepper <firstname.lastname@example.org>, 2002.
The GNU C Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The GNU C Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with the GNU C Library; if not, see
/* See pthread_rwlock_common.c for an overview. */
__pthread_rwlock_tryrdlock (pthread_rwlock_t *rwlock)
/* For tryrdlock, we could speculate that we will succeed and go ahead and
register as a reader. However, if we misspeculate, we have to do the
same steps as a timed-out rdlock, which will increase contention.
Therefore, there is a trade-off between being able to use a combinable
read-modify-write operation and a CAS loop as used below; we pick the
latter because it simplifies the code, and should perform better when
tryrdlock is used in cases where writers are infrequent.
Because POSIX does not require a failed trylock to "synchronize memory",
relaxed MO is sufficient here and on the failure path of the CAS
unsigned int r = atomic_load_relaxed (&rwlock->__data.__readers);
unsigned int rnew;
if ((r & PTHREAD_RWLOCK_WRPHASE) == 0)
/* If we are in a read phase, try to acquire unless there is a
primary writer and we prefer writers and there will be no
recursive read locks. */
if (((r & PTHREAD_RWLOCK_WRLOCKED) != 0)
rnew = r + (1 << PTHREAD_RWLOCK_READER_SHIFT);
/* If there is a writer that has acquired the lock and we are in
a write phase, fail. */
if ((r & PTHREAD_RWLOCK_WRLOCKED) != 0)
/* If we do not care about potentially waiting writers, just
try to acquire. */
rnew = (r + (1 << PTHREAD_RWLOCK_READER_SHIFT))
/* If we could have caused an overflow or take effect during an
overflow, we just can / need to return EAGAIN. There is no need to
have actually modified the number of readers because we could have
done that and cleaned up immediately. */
if (rnew >= PTHREAD_RWLOCK_READER_OVERFLOW)
/* If the CAS fails, we retry; this prevents that tryrdlock fails spuriously
(i.e., fails to acquire the lock although there is no writer), which is
fine for C++14 but not currently allowed by POSIX.
However, because tryrdlock must not appear to block, we should avoid
starving this CAS loop due to constant changes to __readers:
While normal rdlock readers that won't be able to acquire will just block
(and we expect timeouts on timedrdlock to be longer than one retry of the
CAS loop), we can have concurrently failing tryrdlock calls due to
readers or writers that acquire and release in the meantime. Using
randomized exponential back-off to make a live-lock unlikely should be
Acquire MO so we synchronize with prior writers. */
while (!atomic_compare_exchange_weak_acquire (&rwlock->__data.__readers,
if ((r & PTHREAD_RWLOCK_WRPHASE) != 0)
/* Same as in __pthread_rwlock_rdlock_full:
We started the read phase, so we are also responsible for
updating the write-phase futex. Relaxed MO is sufficient.
We have to do the same steps as a writer would when handing over the
read phase to use because other readers cannot distinguish between
us and the writer.
Note that __pthread_rwlock_tryrdlock callers will not have to be
woken up because they will either see the read phase started by us
or they will try to start it themselves; however, callers of
__pthread_rwlock_rdlock_full just increase the reader count and then
check what state the lock is in, so they cannot distinguish between
us and a writer that acquired and released the lock in the
if ((atomic_exchange_relaxed (&rwlock->__data.__wrphase_futex, 0)
& PTHREAD_RWLOCK_FUTEX_USED) != 0)
int private = __pthread_rwlock_get_private (rwlock);
futex_wake (&rwlock->__data.__wrphase_futex, INT_MAX, private);
strong_alias (__pthread_rwlock_tryrdlock, pthread_rwlock_tryrdlock)