share/man/man3c/pthread_rwlock_wrlock.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_WRLOCK 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_rwlock_wrlock, pthread_rwlock_trywrlock \- lock or attempt to lock
  15 read-write lock object for writing
  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_wrlock\fR(\fBpthread_rwlock_t\fR \fI*rwlock\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBpthread_rwlock_trywrlock\fR(\fBpthread_rwlock_t\fR \fI*rwlock\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBpthread_rwlock_wrlock()\fR function applies a write lock to the
  34 read-write lock referenced by \fIrwlock\fR. The calling thread acquires the
  35 write lock if no other thread (reader or writer) holds the read-write lock
  36 \fIrwlock\fR. Otherwise, the thread blocks until it can acquire the lock.
  37 .sp
  38 .LP
  39 The \fBpthread_rwlock_trywrlock()\fR function applies a write lock like the
  40 \fBpthread_rwlock_wrlock()\fR function, with the exception that the function
  41 fails if any thread currently holds \fIrwlock\fR (for reading or writing).
  42 .sp
  43 .LP
  44 Writers are favored over readers of the same priority to avoid writer
  45 starvation. See \fBpthread_rwlock_rdlock\fR(3C).
  46 .sp
  47 .LP
  48 Results are undefined if any of these functions are called with an
  49 uninitialized read-write lock.
  50 .sp
  51 .LP
  52 If a signal is delivered to a thread waiting for a read-write lock for writing,
  53 upon return from the signal handler the thread resumes waiting for the
  54 read-write lock for writing as if it was not interrupted.
  55 .SH RETURN VALUES
  56 .sp
  57 .LP
  58 If successful, the \fBpthread_rwlock_wrlock()\fR function returns \fB0\fR.
  59 Otherwise, an error number is returned to indicate the error.
  60 .sp
  61 .LP
  62 The \fBpthread_rwlock_trywrlock()\fR function returns \fB0\fR if the lock for
  63 writing on the read-write lock object referenced by \fIrwlock\fR is acquired.
  64 Otherwise an error number is returned to indicate the error.
  65 .SH ERRORS
  66 .sp
  67 .LP
  68 The \fBpthread_rwlock_wrlock()\fR function will fail if:
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBEDEADLK\fR\fR
  73 .ad
  74 .RS 11n
  75 The current thread already owns the read-write lock for writing or reading.
  76 .RE
  77
  78 .sp
  79 .LP
  80 The \fBpthread_rwlock_trywrlock()\fR function will fail if:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEBUSY\fR\fR
  85 .ad
  86 .RS 9n
  87 The read-write lock could not be acquired for writing because it was already
  88 locked for reading or writing.
  89 .RE
  90
  91 .SH ATTRIBUTES
  92 .sp
  93 .LP
  94 See  \fBattributes\fR(5) for descriptions of the following attributes:
  95 .sp
  96
  97 .sp
  98 .TS
  99 box;
 100 c | c
 101 l | l .
 102 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 103 _
 104 Interface Stability     Standard
 105 _
 106 MT-Level        MT-Safe
 107 .TE
 108
 109 .SH SEE ALSO
 110 .sp
 111 .LP
 112 \fBpthread_rwlock_init\fR(3C), \fBpthread_rwlock_unlock\fR(3C),
 113 \fBpthread_rwlockattr_init\fR(3C), \fBpthread_rwlock_rdlock\fR(3C),
 114 \fBattributes\fR(5), \fBstandards\fR(5)