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.\" 257f3dea24SPeter Wemm.\" $FreeBSD$ 26c0e36632SAlexander Langer.\" 27c0e36632SAlexander Langer.Dd August 4, 1998 28c0e36632SAlexander Langer.Dt PTHREAD_RWLOCK_INIT 3 29c0e36632SAlexander Langer.Os 30c0e36632SAlexander Langer.Sh NAME 31c0e36632SAlexander Langer.Nm pthread_rwlock_init 32c0e36632SAlexander Langer.Nd initialize a read/write lock 33d8a78688SAlexey Zelkin.Sh LIBRARY 34d8a78688SAlexey Zelkin.Lb libc_r 35ec7452f1SRuslan Ermilov.Lb libpthread 36f9f9d2e8SRuslan Ermilov.Lb libthr 37c0e36632SAlexander Langer.Sh SYNOPSIS 3832eef9aeSRuslan Ermilov.In pthread.h 39c0e36632SAlexander Langer.Ft int 40c0e36632SAlexander Langer.Fn pthread_rwlock_init "pthread_rwlock_t *lock" "const pthread_rwlockattr_t *attr" 41c0e36632SAlexander Langer.Sh DESCRIPTION 42c0e36632SAlexander LangerThe 43c0e36632SAlexander Langer.Fn pthread_rwlock_init 44c0e36632SAlexander Langerfunction is used to initialize a read/write lock, with attributes 45c0e36632SAlexander Langerspecified by 46c0e36632SAlexander Langer.Fa attr . 47c0e36632SAlexander LangerIf 48c0e36632SAlexander Langer.Fa attr 49c0e36632SAlexander Langeris NULL, the default read/write lock attributes are used. 50c0e36632SAlexander Langer.Pp 51c0e36632SAlexander LangerThe results of calling 52c0e36632SAlexander Langer.Fn pthread_rwlock_init 53c0e36632SAlexander Langerwith an already initialized lock are undefined. 54c0e36632SAlexander Langer.Sh RETURN VALUES 55c0e36632SAlexander LangerIf successful, the 56c0e36632SAlexander Langer.Fn pthread_rwlock_init 575203edcdSRuslan Ermilovfunction will return zero. 585203edcdSRuslan ErmilovOtherwise an error number will be returned 59c0e36632SAlexander Langerto indicate the error. 60c0e36632SAlexander Langer.Sh SEE ALSO 61c0e36632SAlexander Langer.Xr pthread_rwlockattr_init 3 , 625521ff5aSRuslan Ermilov.Xr pthread_rwlockattr_setpshared 3 , 635521ff5aSRuslan Ermilov.Xr pthread_rwlock_destroy 3 64c0e36632SAlexander Langer.Sh STANDARDS 65c0e36632SAlexander LangerThe 66c0e36632SAlexander Langer.Fn pthread_rwlock_init 67c0e36632SAlexander Langerfunction is expected to conform to 68c0e36632SAlexander Langer.St -susv2 . 69c0e36632SAlexander Langer.Sh ERRORS 70c0e36632SAlexander LangerThe 71c0e36632SAlexander Langer.Fn pthread_rwlock_init 72c0e36632SAlexander Langerfunction will fail if: 73c0e36632SAlexander Langer.Bl -tag -width Er 74c0e36632SAlexander Langer.It Bq Er EAGAIN 75c0e36632SAlexander LangerThe system lacked the necessary resources (other than memory) to 76c0e36632SAlexander Langerinitialize the lock. 77c0e36632SAlexander Langer.It Bq Er ENOMEM 78c0e36632SAlexander LangerInsufficient memory exists to initialize the lock. 79c0e36632SAlexander Langer.It Bq Er EPERM 80c0e36632SAlexander LangerThe caller does not have sufficient privilege to perform the 81c0e36632SAlexander Langeroperation. 82c0e36632SAlexander Langer.El 83c0e36632SAlexander Langer.Pp 84c0e36632SAlexander LangerThe 85c0e36632SAlexander Langer.Fn pthread_rwlock_init 86c0e36632SAlexander Langerfunction may fail if: 87c0e36632SAlexander Langer.Bl -tag -width Er 88c0e36632SAlexander Langer.It Bq Er EBUSY 89c0e36632SAlexander LangerThe system has detected an attempt to re-initialize the object 90c0e36632SAlexander Langerreferenced by 91c0e36632SAlexander Langer.Fa lock , 92c0e36632SAlexander Langera previously initialized but not yet destroyed read/write lock. 93c0e36632SAlexander Langer.It Bq Er EINVAL 94c0e36632SAlexander LangerThe value specified by 95c0e36632SAlexander Langer.Fa attr 96c0e36632SAlexander Langeris invalid. 97c0e36632SAlexander Langer.El 98c0e36632SAlexander Langer.Sh HISTORY 99c0e36632SAlexander LangerThe 100c0e36632SAlexander Langer.Fn pthread_rwlock_init 101c0e36632SAlexander Langerfunction first appeared in 102c0e36632SAlexander Langer.Fx 3.0 . 103c0e36632SAlexander Langer.Sh BUGS 104c0e36632SAlexander LangerThe PTHREAD_PROCESS_SHARED attribute is not supported. 105