xref: /freebsd/share/man/man3/pthread_rwlockattr_setpshared.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1c0e36632SAlexander Langer.\" Copyright (c) 1998 Alex Nash
2c0e36632SAlexander Langer.\" All rights reserved.
3c0e36632SAlexander Langer.\"
4c0e36632SAlexander Langer.\" Redistribution and use in source and binary forms, with or without
5c0e36632SAlexander Langer.\" modification, are permitted provided that the following conditions
6c0e36632SAlexander Langer.\" are met:
7c0e36632SAlexander Langer.\" 1. Redistributions of source code must retain the above copyright
8c0e36632SAlexander Langer.\"    notice, this list of conditions and the following disclaimer.
9c0e36632SAlexander Langer.\" 2. Redistributions in binary form must reproduce the above copyright
10c0e36632SAlexander Langer.\"    notice, this list of conditions and the following disclaimer in the
11c0e36632SAlexander Langer.\"    documentation and/or other materials provided with the distribution.
12c0e36632SAlexander Langer.\"
13c0e36632SAlexander Langer.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14c0e36632SAlexander Langer.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15c0e36632SAlexander Langer.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16c0e36632SAlexander Langer.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17c0e36632SAlexander Langer.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18c0e36632SAlexander Langer.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19c0e36632SAlexander Langer.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20c0e36632SAlexander Langer.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21c0e36632SAlexander Langer.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22c0e36632SAlexander Langer.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23c0e36632SAlexander Langer.\" SUCH DAMAGE.
24c0e36632SAlexander Langer.\"
25*631e4e3aSJilles Tjoelker.Dd May 31, 2016
26c0e36632SAlexander Langer.Dt PTHREAD_RWLOCKATTR_SETPSHARED 3
27c0e36632SAlexander Langer.Os
28c0e36632SAlexander Langer.Sh NAME
29c0e36632SAlexander Langer.Nm pthread_rwlockattr_setpshared
30c0e36632SAlexander Langer.Nd set the process shared attribute
31d8a78688SAlexey Zelkin.Sh LIBRARY
32ec7452f1SRuslan Ermilov.Lb libpthread
33c0e36632SAlexander Langer.Sh SYNOPSIS
3432eef9aeSRuslan Ermilov.In pthread.h
35c0e36632SAlexander Langer.Ft int
36e7589db8SBruce Evans.Fn pthread_rwlockattr_setpshared "pthread_rwlockattr_t *attr" "int pshared"
37c0e36632SAlexander Langer.Sh DESCRIPTION
38c0e36632SAlexander LangerThe
39c0e36632SAlexander Langer.Fn pthread_rwlockattr_setpshared
40c0e36632SAlexander Langerfunction sets the process shared attribute of
41c0e36632SAlexander Langer.Fa attr
42c0e36632SAlexander Langerto the value referenced by
43c0e36632SAlexander Langer.Fa pshared .
449d09157aSPhilippe CharnierThe
45c0e36632SAlexander Langer.Fa pshared
469d09157aSPhilippe Charnierargument may be one of two values:
470d42ab24SRuslan Ermilov.Bl -tag -width PTHREAD_PROCESS_PRIVATE
480d42ab24SRuslan Ermilov.It Dv PTHREAD_PROCESS_SHARED
49c0e36632SAlexander LangerAny thread of any process that has access to the memory where the
50c0e36632SAlexander Langerread/write lock resides can manipulate the lock.
510d42ab24SRuslan Ermilov.It Dv PTHREAD_PROCESS_PRIVATE
52c0e36632SAlexander LangerOnly threads created within the same process as the thread that
535203edcdSRuslan Ermilovinitialized the read/write lock can manipulate the lock.
545203edcdSRuslan ErmilovThis is
55c0e36632SAlexander Langerthe default value.
56c0e36632SAlexander Langer.El
57c0e36632SAlexander Langer.Sh RETURN VALUES
58c0e36632SAlexander LangerIf successful, the
59c0e36632SAlexander Langer.Fn pthread_rwlockattr_setpshared
605203edcdSRuslan Ermilovfunction will return zero.
615203edcdSRuslan ErmilovOtherwise an error number will be returned
62c0e36632SAlexander Langerto indicate the error.
63c0e36632SAlexander Langer.Sh ERRORS
649d09157aSPhilippe CharnierThe
65c0e36632SAlexander Langer.Fn pthread_rwlockattr_setpshared
669d09157aSPhilippe Charnierfunction will fail if:
67c0e36632SAlexander Langer.Bl -tag -width Er
68c0e36632SAlexander Langer.It Bq Er EINVAL
69c0e36632SAlexander LangerThe value specified by
70c0e36632SAlexander Langer.Fa attr
71c0e36632SAlexander Langeror
72c0e36632SAlexander Langer.Fa pshared
73c0e36632SAlexander Langeris invalid.
74c0e36632SAlexander Langer.El
759cbda590SRuslan Ermilov.Sh SEE ALSO
76e52a1af2SBaptiste Daroussin.Xr pthread_rwlock_init 3 ,
779cbda590SRuslan Ermilov.Xr pthread_rwlockattr_getpshared 3 ,
78e52a1af2SBaptiste Daroussin.Xr pthread_rwlockattr_init 3
799cbda590SRuslan Ermilov.Sh STANDARDS
809cbda590SRuslan ErmilovThe
819cbda590SRuslan Ermilov.Fn pthread_rwlockattr_setpshared
829cbda590SRuslan Ermilovfunction is expected to conform to
839cbda590SRuslan Ermilov.St -susv2 .
84c0e36632SAlexander Langer.Sh HISTORY
85c0e36632SAlexander LangerThe
86c0e36632SAlexander Langer.Fn pthread_rwlockattr_setpshared
87c0e36632SAlexander Langerfunction first appeared in
88c0e36632SAlexander Langer.Fx 3.0 .
89*631e4e3aSJilles TjoelkerSupport for process-shared read/write locks appeared in
90*631e4e3aSJilles Tjoelker.Fx 11.0 .
91