xref: /freebsd/lib/libc/gen/sem_getvalue.3 (revision 8e234adf862f8cda5ed370b933224162cc19527a)
1.\" Copyright (C) 2000 Jason Evans <jasone@freebsd.org>.
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(s), this list of conditions and the following disclaimer as
9.\"    the first lines of this file unmodified other than the possible
10.\"    addition of one or more copyright notices.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice(s), this list of conditions and the following disclaimer in
13.\"    the documentation and/or other materials provided with the
14.\"    distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
20.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27.\"
28.\" $FreeBSD$
29.Dd February 15, 2000
30.Dt SEM_GETVALUE 3
31.Os
32.Sh NAME
33.Nm sem_getvalue
34.Nd get the value of a semaphore
35.Sh LIBRARY
36.Lb libc_r
37.Sh SYNOPSIS
38.Fd #include <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
52If successful,
53.Fn sem_getvalue
54returns 0.  Otherwise, -1 is returned and
55.Va errno
56is set to indicate the type of
57error.
58.Sh ERRORS
59.Fn sem_getvalue
60will fail if:
61.Bl -tag -width Er
62.It Bq Er EINVAL
63.Fa sem
64points to an invalid semaphore.
65.El
66.Sh SEE ALSO
67.Xr sem_post 3 ,
68.Xr sem_trywait 3 ,
69.Xr sem_wait 3
70.Sh STANDARDS
71.Fn sem_getvalue
72conforms to ISO/IEC 9945-1 ANSI/IEEE
73.Pq Dq Tn POSIX
74Std 1003.1 1996 Edition.
75.Pp
76The value of the semaphore is never negative, even if there are threads blocked
77on the semaphore.  POSIX is somewhat ambiguous in its wording with regard to
78what the value of the semaphore should be if there are blocked waiting threads,
79but this behavior is conformant, given the wording of the specification.
80