usr/src/man/man3c/pthread_mutexattr_gettype.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_MUTEXATTR_GETTYPE 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_mutexattr_gettype, pthread_mutexattr_settype \- get or set mutex type
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  19 #include <pthread.h>
  20
  21 \fBint\fR \fBpthread_mutexattr_gettype\fR(\fBpthread_mutexattr_t *restrict\fR \fIattr\fR,
  22      \fBint *restrict\fR \fItype\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBpthread_mutexattr_settype\fR(\fBpthread_mutexattr_t *\fR\fIattr\fR, \fBint\fR \fItype\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBpthread_mutexattr_gettype()\fR and \fBpthread_mutexattr_settype()\fR
  34 functions respectively get and set the mutex \fItype\fR attribute. This
  35 attribute is set in the \fItype\fR parameter to these functions. The default
  36 value of the \fItype\fR attribute is \fBPTHREAD_MUTEX_DEFAULT\fR.
  37 .sp
  38 .LP
  39 The type of mutex is contained in the \fItype\fR attribute of the mutex
  40 attributes. Valid mutex types include:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBPTHREAD_MUTEX_NORMAL\fR\fR
  45 .ad
  46 .RS 28n
  47 This type of mutex does not detect deadlock. A thread attempting to relock this
  48 mutex without first unlocking it will deadlock. Attempting to unlock a mutex
  49 locked by a different thread results in undefined behavior. Attempting to
  50 unlock an unlocked mutex results in undefined behavior.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBPTHREAD_MUTEX_ERRORCHECK\fR\fR
  57 .ad
  58 .RS 28n
  59 This type of mutex provides error checking. A thread attempting to relock this
  60 mutex without first unlocking it will return with an error. A thread attempting
  61 to unlock a mutex that another thread has locked will return with an error. A
  62 thread attempting to unlock an unlocked mutex will return with an error.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBPTHREAD_MUTEX_RECURSIVE\fR\fR
  69 .ad
  70 .RS 28n
  71 A thread attempting to relock this mutex without first unlocking it will
  72 succeed in locking the mutex. The relocking deadlock that can occur with
  73 mutexes of type \fBPTHREAD_MUTEX_NORMAL\fR cannot occur with this type of
  74 mutex. Multiple locks of this mutex require the same number of unlocks to
  75 release the mutex before another thread can acquire the mutex. A thread
  76 attempting to unlock a mutex that another thread has locked will return with an
  77 error. A thread attempting to unlock an unlocked mutex will return with an
  78 error. This type of mutex is only supported for mutexes whose process shared
  79 attribute is \fBPTHREAD_PROCESS_PRIVATE\fR.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBPTHREAD_MUTEX_DEFAULT\fR\fR
  86 .ad
  87 .RS 28n
  88 Attempting to recursively lock a mutex of this type results in undefined
  89 behavior. Attempting to unlock a mutex of this type that was not locked by the
  90 calling thread results in undefined behavior. Attempting to unlock a mutex of
  91 this type that is not locked results in undefined behavior. An implementation
  92 is allowed to map this mutex to one of the other mutex types.
  93 .RE
  94
  95 .SH RETURN VALUES
  96 .sp
  97 .LP
  98 Upon successful completion, the \fBpthread_mutexattr_settype()\fR function
  99 returns \fB0\fR. Otherwise, an error number is returned to indicate the error.
 100 .sp
 101 .LP
 102 Upon successful completion, the \fBpthread_mutexattr_gettype()\fR function
 103 returns \fB0\fR and stores the value of the \fItype\fR attribute of \fIattr\fR
 104 in the object referenced by the \fItype\fR parameter. Otherwise an error number
 105 is returned to indicate the error.
 106 .SH ERRORS
 107 .sp
 108 .LP
 109 The \fBpthread_mutexattr_gettype()\fR and \fBpthread_mutexattr_settype()\fR
 110 functions will fail if:
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBEINVAL\fR\fR
 115 .ad
 116 .RS 10n
 117 The value \fBtype\fR is invalid.
 118 .RE
 119
 120 .sp
 121 .LP
 122 The \fBpthread_mutexattr_gettype()\fR and \fBpthread_mutexattr_settype()\fR
 123 functions may fail if:
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBEINVAL\fR\fR
 128 .ad
 129 .RS 10n
 130 The value specified by \fIattr\fR is invalid.
 131 .RE
 132
 133 .SH ATTRIBUTES
 134 .sp
 135 .LP
 136 See \fBattributes\fR(5) for descriptions of the following attributes:
 137 .sp
 138
 139 .sp
 140 .TS
 141 box;
 142 c | c
 143 l | l .
 144 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 145 _
 146 Interface Stability     Standard
 147 _
 148 MT-Level        MT-Safe
 149 .TE
 150
 151 .SH SEE ALSO
 152 .sp
 153 .LP
 154 \fBpthread_cond_timedwait\fR(3C), \fBpthread_cond_wait\fR(3C),
 155 \fBattributes\fR(5), \fBstandards\fR(5)
 156 .SH NOTES
 157 .sp
 158 .LP
 159 Application should not use a \fBPTHREAD_MUTEX_RECURSIVE\fR mutex with condition
 160 variables because the implicit unlock performed for \fBpthread_cond_wait()\fR
 161 or \fBpthread_cond_timedwait()\fR will not actually release the mutex (if it
 162 had been locked multiple times). If this occurs, no other thread can satisfy
 163 the condition of the predicate.