man-pages/man3/pthread_mutex_consistent.3.html
2021-03-31 01:06:50 +01:00

174 lines
4.3 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PTHREAD_MUTEX_CONSISTENT</TITLE>
</HEAD><BODY>
<H1>PTHREAD_MUTEX_CONSISTENT</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2019-10-10<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
pthread_mutex_consistent - make a robust mutex consistent
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/pthread.h">pthread.h</A>&gt;</B>
<B>int pthread_mutex_consistent(pthread_mutex_t *</B><I>mutex</I><B>);</B>
</PRE>
<P>
Compile and link with <I>-pthread</I>.
<P>
Feature Test Macro Requirements for glibc (see
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
<P>
<B>pthread_mutex_consistent</B>():
<BR>
<DL COMPACT><DT id="1"><DD>
_POSIX_C_SOURCE &gt;= 200809L
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
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
<B>EOWNERDEAD</B>
from a call to
<B>pthread_mutex_lock</B>().
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success,
<I>pthread_mutex_consistent</I>()
returns 0.
Otherwise,
it returns a positive error number to indicate the cause of the error.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<DL COMPACT>
<DT id="2"><B>EINVAL</B>
<DD>
The mutex is either not robust or is not in an inconsistent state.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>VERSIONS</H2>
<B>pthread_mutex_consistent</B>()
was added to glibc in version 2.12.
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
POSIX.1-2008.
<A NAME="lbAI">&nbsp;</A>
<H2>NOTES</H2>
<B>pthread_mutex_consistent</B>()
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
<B>pthread_mutex_consistent</B>().
<P>
Before the addition of
<B>pthread_mutex_consistent</B>()
to POSIX,
glibc defined the following equivalent nonstandard function if
<B>_GNU_SOURCE</B>
was defined:
<P>
<PRE>
<B>int pthread_mutex_consistent(const pthread_mutex_t *</B><I>mutex</I><B>);</B>
</PRE>
<P>
This GNU-specific API, which first appeared in glibc 2.4,
is nowadays obsolete and should not be used in new programs.
<A NAME="lbAJ">&nbsp;</A>
<H2>EXAMPLE</H2>
See
<B><A HREF="/cgi-bin/man/man2html?3+pthread_mutexattr_setrobust">pthread_mutexattr_setrobust</A></B>(3).
<A NAME="lbAK">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+pthread_mutexattr_init">pthread_mutexattr_init</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+pthread_mutex_lock">pthread_mutex_lock</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+pthread_mutexattr_getrobust">pthread_mutexattr_getrobust</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+pthread_mutexattr_setrobust">pthread_mutexattr_setrobust</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?7+pthreads">pthreads</A></B>(7)
<A NAME="lbAL">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="3"><A HREF="#lbAB">NAME</A><DD>
<DT id="4"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="5"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="6"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="7"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="8"><A HREF="#lbAG">VERSIONS</A><DD>
<DT id="9"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="10"><A HREF="#lbAI">NOTES</A><DD>
<DT id="11"><A HREF="#lbAJ">EXAMPLE</A><DD>
<DT id="12"><A HREF="#lbAK">SEE ALSO</A><DD>
<DT id="13"><A HREF="#lbAL">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:53 GMT, March 31, 2021
</BODY>
</HTML>