1.\" $NetBSD: sem_getvalue.3,v 1.4 2012/03/08 22:12:37 wiz Exp $ 2.\" 3.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice(s), this list of conditions and the following disclaimer as 11.\" the first lines of this file unmodified other than the possible 12.\" addition of one or more copyright notices. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice(s), this list of conditions and the following disclaimer in 15.\" the documentation and/or other materials provided with the 16.\" distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 19.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE 22.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 25.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 26.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 27.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 28.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd February 29, 2012 31.Dt SEM_GETVALUE 3 32.Os 33.Sh NAME 34.Nm sem_getvalue 35.Nd get the value of a semaphore 36.Sh LIBRARY 37.Lb librt 38.Sh SYNOPSIS 39.In semaphore.h 40.Ft int 41.Fn sem_getvalue "sem_t * restrict sem" "int * restrict sval" 42.Sh DESCRIPTION 43The 44.Fn sem_getvalue 45function sets the variable pointed to by 46.Fa sval 47to the current value of the semaphore pointed to by 48.Fa sem , 49as of the time that the call to 50.Fn sem_getvalue 51is actually run. 52.Sh RETURN VALUES 53.Rv -std sem_getvalue 54.Sh ERRORS 55.Fn sem_getvalue 56will fail if: 57.Bl -tag -width Er 58.It Bq Er EINVAL 59.Fa sem 60points to an invalid semaphore. 61.El 62.Sh SEE ALSO 63.Xr sem_post 3 , 64.Xr sem_timedwait 3 , 65.Xr sem_trywait 3 , 66.Xr sem_wait 3 67.Sh STANDARDS 68.Fn sem_getvalue 69conforms to 70.St -p1003.1-96 . 71.Pp 72The value of the semaphore is never negative, even if there are threads blocked 73on the semaphore. 74POSIX is somewhat ambiguous in its wording with regard to 75what the value of the semaphore should be if there are blocked waiting threads, 76but this behavior is conformant, given the wording of the specification. 77