lib/libc_r/man/pthread_rwlock_rdlock.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: src/lib/libc_r/man/pthread_rwlock_rdlock.3,v 1.2.2.2 2001/12/17 10:08:26 ru Exp $
  26 .\" $DragonFly: src/lib/libc_r/man/pthread_rwlock_rdlock.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
  27 .\"
  28 .Dd August 4, 1998
  29 .Dt PTHREAD_RWLOCK_RDLOCK 3
  30 .Os
  31 .Sh NAME
  32 .Nm pthread_rwlock_rdlock ,
  33 .Nm pthread_rwlock_tryrdlock
  34 .Nd acquire a read/write lock for reading
  35 .Sh LIBRARY
  36 .Lb libc_r
  37 .Sh SYNOPSIS
  38 .In pthread.h
  39 .Ft int
  40 .Fn pthread_rwlock_rdlock "pthread_rwlock_t *lock"
  41 .Ft int
  42 .Fn pthread_rwlock_tryrdlock "pthread_rwlock_t *lock"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn pthread_rwlock_rdlock
  46 function acquires a read lock on
  47 .Fa lock
  48 provided that
  49 .Fa lock
  50 is not presently held for writing and no writer threads are
  51 presently blocked on the lock.  If the read lock cannot be
  52 immediately acquired, the calling thread blocks until it can
  53 acquire the lock.
  54 .Pp
  55 The
  56 .Fn pthread_rwlock_tryrdlock
  57 function performs the same action, but does not block if the lock
  58 cannot be immediately obtained (i.e. the lock is held for writing
  59 or there are waiting writers).
  60 .Pp
  61 A thread may hold multiple concurrent read locks.  If so,
  62 .Fn pthread_rwlock_unlock
  63 must be called once for each lock obtained.
  64 .Pp
  65 The results of acquiring a read lock while the calling thread holds
  66 a write lock are undefined.
  67 .Sh IMPLEMENTATION NOTES
  68 To prevent writer starvation, writers are favored over readers.
  69 .Sh RETURN VALUES
  70 If successful, the
  71 .Fn pthread_rwlock_rdlock
  72 and
  73 .Fn pthread_rwlock_tryrdlock
  74 functions will return zero.  Otherwise an error number will be returned
  75 to indicate the error.
  76 .Sh ERRORS
  77 The
  78 .Fn pthread_rwlock_tryrdlock
  79 function will fail if:
  80 .Bl -tag -width Er
  81 .It Bq Er EBUSY
  82 The lock could not be acquired because a writer holds the lock or
  83 was blocked on it.
  84 .El
  85 .Pp
  86 The
  87 .Fn pthread_rwlock_rdlock
  88 and
  89 .Fn pthread_rwlock_tryrdlock
  90 functions may fail if:
  91 .Bl -tag -width Er
  92 .It Bq Er EAGAIN
  93 The lock could not be acquired because the maximum number of read locks
  94 against
  95 .Fa lock
  96 has been exceeded.
  97 .It Bq Er EDEADLK
  98 The current thread already owns
  99 .Fa lock
 100 for writing.
 101 .It Bq Er EINVAL
 102 The value specified by
 103 .Fa lock
 104 is invalid.
 105 .It Bq Er ENOMEM
 106 Insufficient memory exists to initialize the lock (applies to
 107 statically initialized locks only).
 108 .El
 109 .Sh SEE ALSO
 110 .Xr pthread_rwlock_init 3 ,
 111 .Xr pthread_rwlock_trywrlock 3 ,
 112 .Xr pthread_rwlock_unlock 3 ,
 113 .Xr pthread_rwlock_wrlock 3
 114 .Sh STANDARDS
 115 The
 116 .Fn pthread_rwlock_rdlock
 117 and
 118 .Fn pthread_rwlock_tryrdlock
 119 functions are expected to conform to
 120 .St -susv2 .
 121 .Sh HISTORY
 122 The
 123 .Fn pthread_rwlock_rdlock
 124 function first appeared in
 125 .Fx 3.0 .