pthread_mutex_consistent(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | VERSIONS | CONFORMING TO | NOTES | EXAMPLES | SEE ALSO | COLOPHON

PTHREAD_MUTEX_CONSISTENT(3)ux Programmer's ManualEAD_MUTEX_CONSISTENT(3)

NAME         top

       pthread_mutex_consistent - make a robust mutex consistent

SYNOPSIS         top

       #include <pthread.h>

       int pthread_mutex_consistent(pthread_mutex_t *mutex);

       Compile and link with -pthread.

   Feature Test Macro Requirements for glibc (see
   feature_test_macros(7)):

       pthread_mutex_consistent():
           _POSIX_C_SOURCE >= 200809L

DESCRIPTION         top

       This function makes a robust mutex consistent if it is in an
       inconsistent state.  A mutex can be left in an inconsistent state
       if its owner terminates while holding the mutex, in which case
       the next owner who acquires the mutex will succeed and be
       notified by a return value of EOWNERDEAD from a call to
       pthread_mutex_lock().

RETURN VALUE         top

       On success, pthread_mutex_consistent() returns 0.  Otherwise, it
       returns a positive error number to indicate the error.

ERRORS         top

       EINVAL The mutex is either not robust or is not in an
              inconsistent state.

VERSIONS         top

       pthread_mutex_consistent() was added to glibc in version 2.12.

CONFORMING TO         top

       POSIX.1-2008.

NOTES         top

       pthread_mutex_consistent() simply informs the implementation that
       the state (shared data) guarded by the mutex has been restored to
       a consistent state and that normal operations can now be
       performed with the mutex.  It is the application's responsibility
       to ensure that the shared data has been restored to a consistent
       state before calling pthread_mutex_consistent().

       Before the addition of pthread_mutex_consistent() to POSIX, glibc
       defined the following equivalent nonstandard function if
       _GNU_SOURCE was defined:

       int pthread_mutex_consistent(const pthread_mutex_t *mutex);

       This GNU-specific API, which first appeared in glibc 2.4, is
       nowadays obsolete and should not be used in new programs.

EXAMPLES         top

       See pthread_mutexattr_setrobust(3).

SEE ALSO         top

       pthread_mutex_lock(3), pthread_mutexattr_init(3),
       pthread_mutexattr_getrobust(3), pthread_mutexattr_setrobust(3),
       pthreads(7)

COLOPHON         top

       This page is part of release 5.11 of the Linux man-pages project.
       A description of the project, information about reporting bugs,
       and the latest version of this page, can be found at
       https://www.kernel.org/doc/man-pages/.

Linux                          2021-03-22    PTHREAD_MUTEX_CONSISTENT(3)

Pages that refer to this page: pthread_mutexattr_setrobust(3)