mount_setattr.2: Minor tweaks to Christian's patch
[man-pages.git] / man3 / pthread_mutex_consistent.3
bloba653f3d0679c1214c0d76d0dd8af7d4976dcec62
1 .\" Copyright (c) 2017, Yubin Ruan <ablacktshirt@gmail.com>
2 .\" and Copyright (c) 2017, Michael Kerrisk <mtk.manpages@gmail.com>
3 .\"
4 .\" %%%LICENSE_START(VERBATIM)
5 .\" Permission is granted to make and distribute verbatim copies of this
6 .\" manual provided the copyright notice and this permission notice are
7 .\" preserved on all copies.
8 .\"
9 .\" Permission is granted to copy and distribute modified versions of this
10 .\" manual under the conditions for verbatim copying, provided that the
11 .\" entire resulting derived work is distributed under the terms of a
12 .\" permission notice identical to this one.
13 .\"
14 .\" Since the Linux kernel and libraries are constantly changing, this
15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
16 .\" responsibility for errors or omissions, or for damages resulting from
17 .\" the use of the information contained herein.  The author(s) may not
18 .\" have taken the same level of care in the production of this manual,
19 .\" which is licensed free of charge, as they might when working
20 .\" professionally.
21 .\"
22 .\" Formatted or processed versions of this manual, if unaccompanied by
23 .\" the source, must acknowledge the copyright and authors of this work.
24 .\" %%%LICENSE_END
25 .\"
26 .TH PTHREAD_MUTEX_CONSISTENT 3 2021-03-22 "Linux" "Linux Programmer's Manual"
27 .SH NAME
28 pthread_mutex_consistent \- make a robust mutex consistent
29 .SH SYNOPSIS
30 .nf
31 .B #include <pthread.h>
32 .PP
33 .BI "int pthread_mutex_consistent(pthread_mutex_t *" mutex ");"
34 .fi
35 .PP
36 Compile and link with \fI\-pthread\fP.
37 .PP
38 .RS -4
39 Feature Test Macro Requirements for glibc (see
40 .BR feature_test_macros (7)):
41 .RE
42 .PP
43 .BR pthread_mutex_consistent ():
44 .nf
45     _POSIX_C_SOURCE >= 200809L
46 .fi
47 .SH DESCRIPTION
48 This function makes a robust mutex consistent if it is in an inconsistent
49 state.
50 A mutex can be left in an inconsistent state if its owner terminates
51 while holding the mutex, in which case the next owner who acquires the
52 mutex will succeed and be notified by a return value of
53 .BR EOWNERDEAD
54 from a call to
55 .BR pthread_mutex_lock ().
56 .SH RETURN VALUE
57 On success,
58 .IR pthread_mutex_consistent ()
59 returns 0.
60 Otherwise,
61 it returns a positive error number to indicate the error.
62 .SH ERRORS
63 .TP
64 .B EINVAL
65 The mutex is either not robust or is not in an inconsistent state.
66 .SH VERSIONS
67 .BR pthread_mutex_consistent ()
68 was added to glibc in version 2.12.
69 .SH CONFORMING TO
70 POSIX.1-2008.
71 .SH NOTES
72 .BR pthread_mutex_consistent ()
73 simply informs the implementation that the state (shared data)
74 guarded by the mutex has been restored to a consistent state and that
75 normal operations can now be performed with the mutex.
76 It is the application's responsibility to ensure that the
77 shared data has been restored to a consistent state before calling
78 .BR pthread_mutex_consistent ().
79 .PP
80 Before the addition of
81 .BR pthread_mutex_consistent ()
82 to POSIX,
83 glibc defined the following equivalent nonstandard function if
84 .BR _GNU_SOURCE
85 was defined:
86 .PP
87 .nf
88 .BI "int pthread_mutex_consistent_np(const pthread_mutex_t *" mutex );
89 .fi
90 .PP
91 This GNU-specific API, which first appeared in glibc 2.4,
92 is nowadays obsolete and should not be used in new programs;
93 since glibc 2.34 it has been marked as deprecated.
94 .SH EXAMPLES
95 See
96 .BR pthread_mutexattr_setrobust (3).
97 .SH SEE ALSO
98 .ad l
99 .nh
100 .BR pthread_mutex_lock (3),
101 .BR pthread_mutexattr_init (3),
102 .BR pthread_mutexattr_getrobust (3),
103 .BR pthread_mutexattr_setrobust (3),
104 .BR pthreads (7)