xref: /openbsd/lib/libpthread/man/sem_getvalue.3 (revision e5dd7070)
1.\" $OpenBSD: sem_getvalue.3,v 1.6 2013/06/05 03:44:50 tedu 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.\" $FreeBSD: src/lib/libc_r/man/sem_getvalue.3,v 1.9 2001/10/01 16:09:09 ru Exp $
31.Dd $Mdocdate: June 5 2013 $
32.Dt SEM_GETVALUE 3
33.Os
34.Sh NAME
35.Nm sem_getvalue
36.Nd get the value of a semaphore
37.Sh SYNOPSIS
38.In semaphore.h
39.Ft int
40.Fn sem_getvalue "sem_t *sem" "int *sval"
41.Sh DESCRIPTION
42The
43.Fn sem_getvalue
44function sets the variable pointed to by
45.Fa sval
46to the current value of the semaphore pointed to by
47.Fa sem ,
48as of the time that the call to
49.Fn sem_getvalue
50is actually run.
51.Sh RETURN VALUES
52.Rv -std sem_getvalue
53.Sh ERRORS
54.Fn sem_getvalue
55will fail if:
56.Bl -tag -width Er
57.It Bq Er EINVAL
58.Fa sem
59points to an invalid semaphore.
60.El
61.Sh SEE ALSO
62.Xr sem_destroy 3 ,
63.Xr sem_init 3 ,
64.Xr sem_open 3 ,
65.Xr sem_post 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