usr/src/man/man3c/pthread_rwlock_rdlock.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   4 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH PTHREAD_RWLOCK_RDLOCK 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_rwlock_rdlock, pthread_rwlock_tryrdlock \- lock or attempt to lock
  15 read-write lock object for reading
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  20 #include <pthread.h>
  21
  22 \fBint\fR \fBpthread_rwlock_rdlock\fR(\fBpthread_rwlock_t\fR \fI*rwlock\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBpthread_rwlock_tryrdlock\fR(\fBpthread_rwlock_t\fR \fI*rwlock\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBpthread_rwlock_rdlock()\fR function applies a read lock to the
  34 read-write lock referenced by \fIrwlock\fR.  The calling thread acquires the
  35 read lock if a writer does not hold the lock and there are no writers blocked
  36 on the lock.
  37 .sp
  38 .LP
  39 The calling thread does not acquire the lock if a writer holds the lock or if
  40 writers of higher or equal priority are blocked on the lock; otherwise, the
  41 calling thread acquires the lock. If the read lock is not acquired, the calling
  42 thread blocks until it can acquire the lock.
  43 .sp
  44 .LP
  45 A thread can hold multiple concurrent read locks on \fIrwlock\fR (that is,
  46 successfully call the \fBpthread_rwlock_rdlock()\fR function \fIn\fR times). If
  47 so, the thread must perform matching unlocks (that is, it must call the
  48 \fBpthread_rwlock_unlock()\fR function \fIn\fR times).
  49 .sp
  50 .LP
  51 The maximum number of concurrent read locks that a thread can hold on one
  52 read-write lock is currently set at 100,000, though this number could change in
  53 a future release. There is no imposed limit on the number of different threads
  54 that can apply a read lock to one read-write lock.
  55 .sp
  56 .LP
  57 The \fBpthread_rwlock_tryrdlock()\fR function applies a read lock like the
  58 \fBpthread_rwlock_rdlock()\fR function, with the exception that the function
  59 fails if the equivalent \fBpthread_rwlock_rdlock()\fR call would have blocked
  60 the calling thread.  In no case will the \fBpthread_rwlock_tryrdlock()\fR
  61 function ever bloc. It always either acquires the lock or fails and returns
  62 immediately.
  63 .sp
  64 .LP
  65 Results are undefined if any of these functions are called with an
  66 uninitialized read-write lock.
  67 .sp
  68 .LP
  69 If a signal is delivered to a thread waiting for a read-write lock for reading,
  70 upon return from the signal handler the thread resumes waiting for the
  71 read-write lock for reading as if it was not interrupted.
  72 .SH RETURN VALUES
  73 .sp
  74 .LP
  75 If successful, the \fBpthread_rwlock_rdlock()\fR function returns \fB0\fR.
  76 Otherwise, an error number is returned to indicate the error.
  77 .sp
  78 .LP
  79 The \fBpthread_rwlock_tryrdlock()\fR function returns \fB0\fR if the lock for
  80 reading on the read-write lock object referenced by \fIrwlock\fR is acquired.
  81 Otherwise an error number  is returned to indicate the error.
  82 .SH ERRORS
  83 .sp
  84 .LP
  85 The \fBpthread_rwlock_rdlock()\fR and \fBpthread_rwlock_tryrdlock()\fR
  86 functions will fail if:
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBEAGAIN\fR\fR
  91 .ad
  92 .RS 10n
  93 The read lock could not be acquired because the maximum number of read locks by
  94 the current thread for \fIrwlock\fR has been exceeded.
  95 .RE
  96
  97 .sp
  98 .LP
  99 The \fBpthread_rwlock_rdlock()\fR function will fail if:
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBEDEADLK\fR\fR
 104 .ad
 105 .RS 11n
 106 The current thread already owns the read-write lock for writing.
 107 .RE
 108
 109 .sp
 110 .LP
 111 The \fBpthread_rwlock_tryrdlock()\fR function will fail if:
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBEBUSY\fR\fR
 116 .ad
 117 .RS 9n
 118 The read-write lock could not be acquired for reading because a writer holds
 119 the lock or a writer with the appropriate priority was blocked on it.
 120 .RE
 121
 122 .SH ATTRIBUTES
 123 .sp
 124 .LP
 125 See  \fBattributes\fR(5) for descriptions of the following attributes:
 126 .sp
 127
 128 .sp
 129 .TS
 130 box;
 131 c | c
 132 l | l .
 133 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 134 _
 135 Interface Stability     Standard
 136 _
 137 MT-Level        MT-Safe
 138 .TE
 139
 140 .SH SEE ALSO
 141 .sp
 142 .LP
 143 \fBpthread_rwlock_init\fR(3C), \fBpthread_rwlock_wrlock\fR(3C),
 144 \fBpthread_rwlockattr_init\fR(3C), \fBpthread_rwlock_unlock\fR(3C),
 145 \fBattributes\fR(5), \fBstandards\fR(5)