1.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com> 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.\" 3. Neither the name of the author nor the names of any co-contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" $FreeBSD$ 29.\" 30.Dd April 29, 2016 31.Dt PTHREAD_MUTEX_UNLOCK 3 32.Os 33.Sh NAME 34.Nm pthread_mutex_unlock 35.Nd unlock a mutex 36.Sh LIBRARY 37.Lb libpthread 38.Sh SYNOPSIS 39.In pthread.h 40.Ft int 41.Fn pthread_mutex_unlock "pthread_mutex_t *mutex" 42.Sh DESCRIPTION 43If the current thread holds the lock on 44.Fa mutex , 45then the 46.Fn pthread_mutex_unlock 47function unlocks 48.Fa mutex . 49.Pp 50If the argument pointed by the 51.Fa mutex 52is a robust mutex in the inconsistent state, and the call to 53.Fn pthread_mutex_consistent 54function was not done prior to unlocking, further locking attempts on 55the mutex 56.Fa mutex 57are denied and locking functions return 58.Er ENOTRECOVERABLE 59error. 60.Sh RETURN VALUES 61If successful, 62.Fn pthread_mutex_unlock 63will return zero, otherwise an error number will be returned to 64indicate the error. 65.Sh ERRORS 66The 67.Fn pthread_mutex_unlock 68function will fail if: 69.Bl -tag -width Er 70.It Bq Er EINVAL 71The value specified by 72.Fa mutex 73is invalid. 74.It Bq Er EPERM 75The current thread does not hold a lock on 76.Fa mutex . 77.El 78.Sh SEE ALSO 79.Xr pthread_mutex_destroy 3 , 80.Xr pthread_mutex_init 3 , 81.Xr pthread_mutex_lock 3 , 82.Xr pthread_mutex_trylock 3 83.Sh STANDARDS 84The 85.Fn pthread_mutex_unlock 86function conforms to 87.St -p1003.1-96 . 88