usr/src/man/man3c/pthread_mutex_init.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_MUTEX_INIT 3C "Nov 11, 2008"
  13 .SH NAME
  14 pthread_mutex_init, pthread_mutex_destroy \- initialize or destroy a mutex
  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_mutex_init\fR(\fBpthread_mutex_t *restrict\fR \fImutex\fR,
  22      \fBconst pthread_mutexattr_t *restrict\fR \fIattr\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBpthread_mutex_destroy\fR(\fBpthread_mutex_t *\fR\fImutex\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBpthread_mutex_t\fR \fImutex\fR= \fBPTHREAD_MUTEX_INITIALIZER\fR;
  33 .fi
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 The \fBpthread_mutex_init()\fR function initializes the mutex referenced by
  39 \fImutex\fR with attributes specified by \fIattr\fR. If \fIattr\fR is
  40 \fINULL\fR, the default mutex attributes are used; the effect is the same as
  41 passing the address of a default mutex attributes object. Upon successful
  42 initialization, the state of the mutex becomes initialized and unlocked.
  43 .sp
  44 .LP
  45 Except for robust mutexes, attempting to initialize an already initialized
  46 mutex results in undefined behavior.
  47 .sp
  48 .LP
  49 The \fBpthread_mutex_destroy()\fR function destroys the mutex object referenced
  50 by \fImutex\fR; the mutex object becomes, in effect, uninitialized. A destroyed
  51 mutex object can be re-initialized using \fBpthread_mutex_init()\fR; the
  52 results of otherwise referencing the object after it has been destroyed are
  53 undefined.
  54 .sp
  55 .LP
  56 It is safe to destroy an initialized mutex that is unlocked. Attempting to
  57 destroy a locked mutex results in undefined behavior.
  58 .sp
  59 .LP
  60 In cases where default mutex attributes are appropriate, the macro
  61 \fBPTHREAD_MUTEX_INITIALIZER\fR can be used to initialize mutexes that are
  62 statically allocated. The effect is equivalent to dynamic initialization by a
  63 call to \fBpthread_mutex_init()\fR with parameter \fIattr\fR specified as
  64 \fINULL\fR, except that no error checks are performed.
  65 .SH RETURN VALUES
  66 .sp
  67 .LP
  68 If successful, the \fBpthread_mutex_init()\fR and \fBpthread_mutex_destroy()\fR
  69 functions return  \fB0\fR. Otherwise, an error number is returned to indicate
  70 the error.
  71 .SH ERRORS
  72 .sp
  73 .LP
  74 The \fBpthread_mutex_init()\fR function will fail if:
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBEAGAIN\fR\fR
  79 .ad
  80 .RS 10n
  81 The system lacked the necessary resources (other than memory) to initialize
  82 another mutex.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBEBUSY\fR\fR
  89 .ad
  90 .RS 10n
  91 An attempt was detected to  re-initialize a robust mutex previously initialized
  92 but not yet destroyed. See \fBpthread_mutexattr_setrobust\fR(3C).
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBEINVAL\fR\fR
  99 .ad
 100 .RS 10n
 101 An attempt was detected to re-initialize a robust mutex previously initialized
 102 with a different set of attributes. See \fBpthread_mutexattr_setrobust\fR(3C).
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBENOMEM\fR\fR
 109 .ad
 110 .RS 10n
 111 Insufficient memory exists to initialize the mutex.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBEPERM\fR\fR
 118 .ad
 119 .RS 10n
 120 The caller does not have the privilege to perform the operation.
 121 .RE
 122
 123 .sp
 124 .LP
 125 The \fBpthread_mutex_init()\fR function may fail if:
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fBEBUSY\fR\fR
 130 .ad
 131 .RS 10n
 132 An attempt was detected to re-initialize the object referenced by \fImutex\fR,
 133 a mutex previously initialized but not yet destroyed.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBEINVAL\fR\fR
 140 .ad
 141 .RS 10n
 142 The value specified by \fIattr\fR or \fImutex\fR is invalid.
 143 .RE
 144
 145 .sp
 146 .LP
 147 The \fBpthread_mutex_destroy()\fR function may fail if:
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fBEBUSY\fR\fR
 152 .ad
 153 .RS 10n
 154 An attempt was detected to destroy the object referenced by \fImutex\fR while
 155 it is locked or referenced (for example, while being used in a
 156 \fBpthread_cond_wait\fR(3C) or \fBpthread_cond_timedwait\fR(3C)) by another
 157 thread.
 158 .RE
 159
 160 .sp
 161 .ne 2
 162 .na
 163 \fB\fBEINVAL\fR\fR
 164 .ad
 165 .RS 10n
 166 The value specified by \fImutex\fR is invalid.
 167 .RE
 168
 169 .SH ATTRIBUTES
 170 .sp
 171 .LP
 172 See \fBattributes\fR(5) for descriptions of the following attributes:
 173 .sp
 174
 175 .sp
 176 .TS
 177 box;
 178 c | c
 179 l | l .
 180 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 181 _
 182 Interface Stability     Standard
 183 _
 184 MT-Level        MT-Safe
 185 .TE
 186
 187 .SH SEE ALSO
 188 .sp
 189 .LP
 190 \fBpthread_cond_wait\fR(3C), \fBpthread_mutex_lock\fR(3C),
 191 \fBpthread_mutexattr_setprioceiling\fR(3C),
 192 \fBpthread_mutexattr_setprotocol\fR(3C),
 193 \fBpthread_mutexattr_setpshared\fR(3C), \fBpthread_mutexattr_setrobust\fR(3C),
 194 \fBpthread_mutexattr_settype\fR(3C), \fBattributes\fR(5), \fBmutex\fR(5),
 195 \fBstandards\fR(5)