2014-12-04 13:12:23 +00:00
|
|
|
/* futex operations for glibc-internal use. Linux version.
|
2019-01-01 00:11:28 +00:00
|
|
|
Copyright (C) 2014-2019 Free Software Foundation, Inc.
|
2014-12-04 13:12:23 +00:00
|
|
|
This file is part of the GNU C Library.
|
|
|
|
|
|
|
|
|
|
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
|
Prefer https to http for gnu.org and fsf.org URLs
Also, change sources.redhat.com to sourceware.org.
This patch was automatically generated by running the following shell
script, which uses GNU sed, and which avoids modifying files imported
from upstream:
sed -ri '
s,(http|ftp)(://(.*\.)?(gnu|fsf|sourceware)\.org($|[^.]|\.[^a-z])),https\2,g
s,(http|ftp)(://(.*\.)?)sources\.redhat\.com($|[^.]|\.[^a-z]),https\2sourceware.org\4,g
' \
$(find $(git ls-files) -prune -type f \
! -name '*.po' \
! -name 'ChangeLog*' \
! -path COPYING ! -path COPYING.LIB \
! -path manual/fdl-1.3.texi ! -path manual/lgpl-2.1.texi \
! -path manual/texinfo.tex ! -path scripts/config.guess \
! -path scripts/config.sub ! -path scripts/install-sh \
! -path scripts/mkinstalldirs ! -path scripts/move-if-change \
! -path INSTALL ! -path locale/programs/charmap-kw.h \
! -path po/libc.pot ! -path sysdeps/gnu/errlist.c \
! '(' -name configure \
-execdir test -f configure.ac -o -f configure.in ';' ')' \
! '(' -name preconfigure \
-execdir test -f preconfigure.ac ';' ')' \
-print)
and then by running 'make dist-prepare' to regenerate files built
from the altered files, and then executing the following to cleanup:
chmod a+x sysdeps/unix/sysv/linux/riscv/configure
# Omit irrelevant whitespace and comment-only changes,
# perhaps from a slightly-different Autoconf version.
git checkout -f \
sysdeps/csky/configure \
sysdeps/hppa/configure \
sysdeps/riscv/configure \
sysdeps/unix/sysv/linux/csky/configure
# Omit changes that caused a pre-commit check to fail like this:
# remote: *** error: sysdeps/powerpc/powerpc64/ppc-mcount.S: trailing lines
git checkout -f \
sysdeps/powerpc/powerpc64/ppc-mcount.S \
sysdeps/unix/sysv/linux/s390/s390-64/syscall.S
# Omit change that caused a pre-commit check to fail like this:
# remote: *** error: sysdeps/sparc/sparc64/multiarch/memcpy-ultra3.S: last line does not end in newline
git checkout -f sysdeps/sparc/sparc64/multiarch/memcpy-ultra3.S
2019-09-07 05:40:42 +00:00
|
|
|
<https://www.gnu.org/licenses/>. */
|
2014-12-04 13:12:23 +00:00
|
|
|
|
|
|
|
|
#ifndef FUTEX_INTERNAL_H
|
|
|
|
|
#define FUTEX_INTERNAL_H
|
|
|
|
|
|
|
|
|
|
#include <sysdeps/nptl/futex-internal.h>
|
|
|
|
|
#include <errno.h>
|
|
|
|
|
#include <lowlevellock-futex.h>
|
Add single-thread.h header
This patch move the single-thread syscall optimization defintions from
syscall-cancel.h to new header file single-thread.h and also move the
cancellation definitions from pthreadP.h to syscall-cancel.h.
The idea is just simplify the inclusion of both syscall-cancel.h and
single-thread.h (without the requirement of including all pthreadP.h
defintions).
No semantic changes expected, checked on a build for all major ABIs.
* nptl/pthreadP.h (CANCEL_ASYNC, CANCEL_RESET, LIBC_CANCEL_ASYNC,
LIBC_CANCEL_RESET, __libc_enable_asynccancel,
__libc_disable_asynccancel, __librt_enable_asynccancel,
__libc_disable_asynccancel, __librt_enable_asynccancel,
__librt_disable_asynccancel): Move to ...
* sysdeps/unix/sysv/linux/sysdep-cancel.h: ... here.
(SINGLE_THREAD_P, RTLD_SINGLE_THREAD_P): Move to ...
* sysdeps/unix/sysv/linux/single-thread.h: ... here.
* sysdeps/generic/single-thread.h: New file.
* sysdeps/unix/sysdep.h: Include single-thread.h.
* sysdeps/unix/sysv/linux/futex-internal.h: Include sysdep-cancel.h.
* sysdeps/unix/sysv/linux/lowlevellock-futex.h: Likewise.
2019-02-21 17:33:55 +00:00
|
|
|
#include <sysdep-cancel.h>
|
2014-12-04 13:12:23 +00:00
|
|
|
|
|
|
|
|
/* See sysdeps/nptl/futex-internal.h for documentation; this file only
|
|
|
|
|
contains Linux-specific comments.
|
|
|
|
|
|
|
|
|
|
The Linux kernel treats provides absolute timeouts based on the
|
|
|
|
|
CLOCK_REALTIME clock and relative timeouts measured against the
|
|
|
|
|
CLOCK_MONOTONIC clock.
|
|
|
|
|
|
|
|
|
|
We expect a Linux kernel version of 2.6.22 or more recent (since this
|
|
|
|
|
version, EINTR is not returned on spurious wake-ups anymore). */
|
|
|
|
|
|
|
|
|
|
/* FUTEX_SHARED is always supported by the Linux kernel. */
|
|
|
|
|
static __always_inline int
|
|
|
|
|
futex_supports_pshared (int pshared)
|
|
|
|
|
{
|
|
|
|
|
if (__glibc_likely (pshared == PTHREAD_PROCESS_PRIVATE))
|
|
|
|
|
return 0;
|
|
|
|
|
else if (pshared == PTHREAD_PROCESS_SHARED)
|
|
|
|
|
return 0;
|
|
|
|
|
else
|
|
|
|
|
return EINVAL;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/* See sysdeps/nptl/futex-internal.h for details. */
|
|
|
|
|
static __always_inline int
|
|
|
|
|
futex_wait (unsigned int *futex_word, unsigned int expected, int private)
|
|
|
|
|
{
|
|
|
|
|
int err = lll_futex_timed_wait (futex_word, expected, NULL, private);
|
|
|
|
|
switch (err)
|
|
|
|
|
{
|
|
|
|
|
case 0:
|
|
|
|
|
case -EAGAIN:
|
|
|
|
|
case -EINTR:
|
|
|
|
|
return -err;
|
|
|
|
|
|
|
|
|
|
case -ETIMEDOUT: /* Cannot have happened as we provided no timeout. */
|
|
|
|
|
case -EFAULT: /* Must have been caused by a glibc or application bug. */
|
|
|
|
|
case -EINVAL: /* Either due to wrong alignment or due to the timeout not
|
|
|
|
|
being normalized. Must have been caused by a glibc or
|
|
|
|
|
application bug. */
|
|
|
|
|
case -ENOSYS: /* Must have been caused by a glibc bug. */
|
|
|
|
|
/* No other errors are documented at this time. */
|
|
|
|
|
default:
|
|
|
|
|
futex_fatal_error ();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/* See sysdeps/nptl/futex-internal.h for details. */
|
|
|
|
|
static __always_inline int
|
|
|
|
|
futex_wait_cancelable (unsigned int *futex_word, unsigned int expected,
|
|
|
|
|
int private)
|
|
|
|
|
{
|
|
|
|
|
int oldtype;
|
|
|
|
|
oldtype = __pthread_enable_asynccancel ();
|
|
|
|
|
int err = lll_futex_timed_wait (futex_word, expected, NULL, private);
|
|
|
|
|
__pthread_disable_asynccancel (oldtype);
|
|
|
|
|
switch (err)
|
|
|
|
|
{
|
|
|
|
|
case 0:
|
|
|
|
|
case -EAGAIN:
|
|
|
|
|
case -EINTR:
|
|
|
|
|
return -err;
|
|
|
|
|
|
|
|
|
|
case -ETIMEDOUT: /* Cannot have happened as we provided no timeout. */
|
|
|
|
|
case -EFAULT: /* Must have been caused by a glibc or application bug. */
|
|
|
|
|
case -EINVAL: /* Either due to wrong alignment or due to the timeout not
|
|
|
|
|
being normalized. Must have been caused by a glibc or
|
|
|
|
|
application bug. */
|
|
|
|
|
case -ENOSYS: /* Must have been caused by a glibc bug. */
|
|
|
|
|
/* No other errors are documented at this time. */
|
|
|
|
|
default:
|
|
|
|
|
futex_fatal_error ();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/* See sysdeps/nptl/futex-internal.h for details. */
|
|
|
|
|
static __always_inline int
|
|
|
|
|
futex_reltimed_wait (unsigned int *futex_word, unsigned int expected,
|
|
|
|
|
const struct timespec *reltime, int private)
|
|
|
|
|
{
|
|
|
|
|
int err = lll_futex_timed_wait (futex_word, expected, reltime, private);
|
|
|
|
|
switch (err)
|
|
|
|
|
{
|
|
|
|
|
case 0:
|
|
|
|
|
case -EAGAIN:
|
|
|
|
|
case -EINTR:
|
|
|
|
|
case -ETIMEDOUT:
|
|
|
|
|
return -err;
|
|
|
|
|
|
|
|
|
|
case -EFAULT: /* Must have been caused by a glibc or application bug. */
|
|
|
|
|
case -EINVAL: /* Either due to wrong alignment or due to the timeout not
|
|
|
|
|
being normalized. Must have been caused by a glibc or
|
|
|
|
|
application bug. */
|
|
|
|
|
case -ENOSYS: /* Must have been caused by a glibc bug. */
|
|
|
|
|
/* No other errors are documented at this time. */
|
|
|
|
|
default:
|
|
|
|
|
futex_fatal_error ();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/* See sysdeps/nptl/futex-internal.h for details. */
|
|
|
|
|
static __always_inline int
|
|
|
|
|
futex_reltimed_wait_cancelable (unsigned int *futex_word,
|
|
|
|
|
unsigned int expected,
|
|
|
|
|
const struct timespec *reltime, int private)
|
|
|
|
|
{
|
|
|
|
|
int oldtype;
|
2018-05-10 20:24:56 +00:00
|
|
|
oldtype = LIBC_CANCEL_ASYNC ();
|
2014-12-04 13:12:23 +00:00
|
|
|
int err = lll_futex_timed_wait (futex_word, expected, reltime, private);
|
2018-05-10 20:24:56 +00:00
|
|
|
LIBC_CANCEL_RESET (oldtype);
|
2014-12-04 13:12:23 +00:00
|
|
|
switch (err)
|
|
|
|
|
{
|
|
|
|
|
case 0:
|
|
|
|
|
case -EAGAIN:
|
|
|
|
|
case -EINTR:
|
|
|
|
|
case -ETIMEDOUT:
|
|
|
|
|
return -err;
|
|
|
|
|
|
|
|
|
|
case -EFAULT: /* Must have been caused by a glibc or application bug. */
|
|
|
|
|
case -EINVAL: /* Either due to wrong alignment or due to the timeout not
|
|
|
|
|
being normalized. Must have been caused by a glibc or
|
|
|
|
|
application bug. */
|
|
|
|
|
case -ENOSYS: /* Must have been caused by a glibc bug. */
|
|
|
|
|
/* No other errors are documented at this time. */
|
|
|
|
|
default:
|
|
|
|
|
futex_fatal_error ();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-06-21 14:53:40 +00:00
|
|
|
/* See sysdeps/nptl/futex-internal.h for details. */
|
|
|
|
|
static __always_inline int
|
|
|
|
|
futex_abstimed_supported_clockid (clockid_t clockid)
|
|
|
|
|
{
|
|
|
|
|
return lll_futex_supported_clockid (clockid);
|
|
|
|
|
}
|
|
|
|
|
|
2014-12-04 13:12:23 +00:00
|
|
|
/* See sysdeps/nptl/futex-internal.h for details. */
|
|
|
|
|
static __always_inline int
|
|
|
|
|
futex_abstimed_wait (unsigned int *futex_word, unsigned int expected,
|
2019-06-21 14:53:40 +00:00
|
|
|
clockid_t clockid,
|
2014-12-04 13:12:23 +00:00
|
|
|
const struct timespec *abstime, int private)
|
|
|
|
|
{
|
|
|
|
|
/* Work around the fact that the kernel rejects negative timeout values
|
|
|
|
|
despite them being valid. */
|
|
|
|
|
if (__glibc_unlikely ((abstime != NULL) && (abstime->tv_sec < 0)))
|
|
|
|
|
return ETIMEDOUT;
|
2019-06-21 14:53:40 +00:00
|
|
|
int err = lll_futex_clock_wait_bitset (futex_word, expected,
|
|
|
|
|
clockid, abstime,
|
|
|
|
|
private);
|
2014-12-04 13:12:23 +00:00
|
|
|
switch (err)
|
|
|
|
|
{
|
|
|
|
|
case 0:
|
|
|
|
|
case -EAGAIN:
|
|
|
|
|
case -EINTR:
|
|
|
|
|
case -ETIMEDOUT:
|
|
|
|
|
return -err;
|
|
|
|
|
|
|
|
|
|
case -EFAULT: /* Must have been caused by a glibc or application bug. */
|
2019-06-21 14:53:40 +00:00
|
|
|
case -EINVAL: /* Either due to wrong alignment, unsupported
|
|
|
|
|
clockid or due to the timeout not being
|
|
|
|
|
normalized. Must have been caused by a glibc or
|
2014-12-04 13:12:23 +00:00
|
|
|
application bug. */
|
|
|
|
|
case -ENOSYS: /* Must have been caused by a glibc bug. */
|
|
|
|
|
/* No other errors are documented at this time. */
|
|
|
|
|
default:
|
|
|
|
|
futex_fatal_error ();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/* See sysdeps/nptl/futex-internal.h for details. */
|
|
|
|
|
static __always_inline int
|
|
|
|
|
futex_abstimed_wait_cancelable (unsigned int *futex_word,
|
|
|
|
|
unsigned int expected,
|
2019-06-21 14:53:40 +00:00
|
|
|
clockid_t clockid,
|
2014-12-04 13:12:23 +00:00
|
|
|
const struct timespec *abstime, int private)
|
|
|
|
|
{
|
|
|
|
|
/* Work around the fact that the kernel rejects negative timeout values
|
|
|
|
|
despite them being valid. */
|
|
|
|
|
if (__glibc_unlikely ((abstime != NULL) && (abstime->tv_sec < 0)))
|
|
|
|
|
return ETIMEDOUT;
|
|
|
|
|
int oldtype;
|
|
|
|
|
oldtype = __pthread_enable_asynccancel ();
|
2019-06-21 14:53:40 +00:00
|
|
|
int err = lll_futex_clock_wait_bitset (futex_word, expected,
|
|
|
|
|
clockid, abstime,
|
|
|
|
|
private);
|
2014-12-04 13:12:23 +00:00
|
|
|
__pthread_disable_asynccancel (oldtype);
|
|
|
|
|
switch (err)
|
|
|
|
|
{
|
|
|
|
|
case 0:
|
|
|
|
|
case -EAGAIN:
|
|
|
|
|
case -EINTR:
|
|
|
|
|
case -ETIMEDOUT:
|
|
|
|
|
return -err;
|
|
|
|
|
|
|
|
|
|
case -EFAULT: /* Must have been caused by a glibc or application bug. */
|
|
|
|
|
case -EINVAL: /* Either due to wrong alignment or due to the timeout not
|
|
|
|
|
being normalized. Must have been caused by a glibc or
|
|
|
|
|
application bug. */
|
|
|
|
|
case -ENOSYS: /* Must have been caused by a glibc bug. */
|
|
|
|
|
/* No other errors are documented at this time. */
|
|
|
|
|
default:
|
|
|
|
|
futex_fatal_error ();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/* See sysdeps/nptl/futex-internal.h for details. */
|
|
|
|
|
static __always_inline void
|
|
|
|
|
futex_wake (unsigned int *futex_word, int processes_to_wake, int private)
|
|
|
|
|
{
|
|
|
|
|
int res = lll_futex_wake (futex_word, processes_to_wake, private);
|
|
|
|
|
/* No error. Ignore the number of woken processes. */
|
|
|
|
|
if (res >= 0)
|
|
|
|
|
return;
|
|
|
|
|
switch (res)
|
|
|
|
|
{
|
|
|
|
|
case -EFAULT: /* Could have happened due to memory reuse. */
|
|
|
|
|
case -EINVAL: /* Could be either due to incorrect alignment (a bug in
|
|
|
|
|
glibc or in the application) or due to memory being
|
|
|
|
|
reused for a PI futex. We cannot distinguish between the
|
|
|
|
|
two causes, and one of them is correct use, so we do not
|
|
|
|
|
act in this case. */
|
|
|
|
|
return;
|
|
|
|
|
case -ENOSYS: /* Must have been caused by a glibc bug. */
|
|
|
|
|
/* No other errors are documented at this time. */
|
|
|
|
|
default:
|
|
|
|
|
futex_fatal_error ();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#endif /* futex-internal.h */
|
