6/share/man/man3/pthread_rwlock_init.3

   1 .\" Copyright (c) 1998 Alex Nash
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd August 4, 1998
  28 .Dt PTHREAD_RWLOCK_INIT 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_rwlock_init
  32 .Nd initialize a read/write lock
  33 .Sh LIBRARY
  34 .Lb libc_r
  35 .Lb libpthread
  36 .Lb libthr
  37 .Sh SYNOPSIS
  38 .In pthread.h
  39 .Ft int
  40 .Fn pthread_rwlock_init "pthread_rwlock_t *lock" "const pthread_rwlockattr_t *attr"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn pthread_rwlock_init
  44 function is used to initialize a read/write lock, with attributes
  45 specified by
  46 .Fa attr .
  47 If
  48 .Fa attr
  49 is NULL, the default read/write lock attributes are used.
  50 .Pp
  51 The results of calling
  52 .Fn pthread_rwlock_init
  53 with an already initialized lock are undefined.
  54 .Sh RETURN VALUES
  55 If successful, the
  56 .Fn pthread_rwlock_init
  57 function will return zero.
  58 Otherwise an error number will be returned
  59 to indicate the error.
  60 .Sh ERRORS
  61 The
  62 .Fn pthread_rwlock_init
  63 function will fail if:
  64 .Bl -tag -width Er
  65 .It Bq Er EAGAIN
  66 The system lacked the necessary resources (other than memory) to
  67 initialize the lock.
  68 .It Bq Er ENOMEM
  69 Insufficient memory exists to initialize the lock.
  70 .It Bq Er EPERM
  71 The caller does not have sufficient privilege to perform the
  72 operation.
  73 .El
  74 .Pp
  75 The
  76 .Fn pthread_rwlock_init
  77 function may fail if:
  78 .Bl -tag -width Er
  79 .It Bq Er EBUSY
  80 The system has detected an attempt to re-initialize the object
  81 referenced by
  82 .Fa lock ,
  83 a previously initialized but not yet destroyed read/write lock.
  84 .It Bq Er EINVAL
  85 The value specified by
  86 .Fa attr
  87 is invalid.
  88 .El
  89 .Sh SEE ALSO
  90 .Xr pthread_rwlockattr_init 3 ,
  91 .Xr pthread_rwlockattr_setpshared 3 ,
  92 .Xr pthread_rwlock_destroy 3
  93 .Sh STANDARDS
  94 The
  95 .Fn pthread_rwlock_init
  96 function is expected to conform to
  97 .St -susv2 .
  98 .Sh HISTORY
  99 The
 100 .Fn pthread_rwlock_init
 101 function first appeared in
 102 .Fx 3.0 .
 103 .Sh BUGS
 104 The PTHREAD_PROCESS_SHARED attribute is not supported.