xref: /freebsd/lib/libc/gen/sem_wait.3 (revision 26b6c45a92c8eae91cad4a7ce8935e08d2e5d368)
1c5e7e03aSRuslan Ermilov.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
2b0a1b4f8SJason Evans.\" All rights reserved.
3b0a1b4f8SJason Evans.\"
4b0a1b4f8SJason Evans.\" Redistribution and use in source and binary forms, with or without
5b0a1b4f8SJason Evans.\" modification, are permitted provided that the following conditions
6b0a1b4f8SJason Evans.\" are met:
7b0a1b4f8SJason Evans.\" 1. Redistributions of source code must retain the above copyright
8b0a1b4f8SJason Evans.\"    notice(s), this list of conditions and the following disclaimer as
9b0a1b4f8SJason Evans.\"    the first lines of this file unmodified other than the possible
10b0a1b4f8SJason Evans.\"    addition of one or more copyright notices.
11b0a1b4f8SJason Evans.\" 2. Redistributions in binary form must reproduce the above copyright
12b0a1b4f8SJason Evans.\"    notice(s), this list of conditions and the following disclaimer in
13b0a1b4f8SJason Evans.\"    the documentation and/or other materials provided with the
14b0a1b4f8SJason Evans.\"    distribution.
15b0a1b4f8SJason Evans.\"
16b0a1b4f8SJason Evans.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17b0a1b4f8SJason Evans.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18b0a1b4f8SJason Evans.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19b0a1b4f8SJason Evans.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
20b0a1b4f8SJason Evans.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21b0a1b4f8SJason Evans.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22b0a1b4f8SJason Evans.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23b0a1b4f8SJason Evans.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24b0a1b4f8SJason Evans.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25b0a1b4f8SJason Evans.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26b0a1b4f8SJason Evans.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27b0a1b4f8SJason Evans.\"
28b0a1b4f8SJason Evans.\" $FreeBSD$
2926b6c45aSRuslan Ermilov.\"
30b0a1b4f8SJason Evans.Dd February 15, 2000
31b0a1b4f8SJason Evans.Dt SEM_WAIT 3
32b0a1b4f8SJason Evans.Os
33b0a1b4f8SJason Evans.Sh NAME
34b0a1b4f8SJason Evans.Nm sem_wait ,
35b0a1b4f8SJason Evans.Nm sem_trywait
36b0a1b4f8SJason Evans.Nd decrement (lock) a semaphore
37d8a78688SAlexey Zelkin.Sh LIBRARY
38fccedf06SRuslan Ermilov.Lb libc
39b0a1b4f8SJason Evans.Sh SYNOPSIS
4032eef9aeSRuslan Ermilov.In semaphore.h
41b0a1b4f8SJason Evans.Ft int
42b0a1b4f8SJason Evans.Fn sem_wait "sem_t *sem"
43b0a1b4f8SJason Evans.Ft int
44b0a1b4f8SJason Evans.Fn sem_trywait "sem_t *sem"
45b0a1b4f8SJason Evans.Sh DESCRIPTION
46b0a1b4f8SJason EvansThe
47b0a1b4f8SJason Evans.Fn sem_wait
48b0a1b4f8SJason Evansfunction decrements (locks) the semaphore pointed to by
49b0a1b4f8SJason Evans.Fa sem ,
50b0a1b4f8SJason Evansbut blocks if the value of
51b0a1b4f8SJason Evans.Fa sem
52b0a1b4f8SJason Evansis zero, until the value is non-zero and the value can be decremented.
53b0a1b4f8SJason Evans.Pp
54b0a1b4f8SJason EvansThe
55b0a1b4f8SJason Evans.Fn sem_trywait
56b0a1b4f8SJason Evansfunction decrements (locks) the semaphore pointed to by
57b0a1b4f8SJason Evans.Fa sem
5826b6c45aSRuslan Ermilovonly if the value is non-zero.
5926b6c45aSRuslan ErmilovOtherwise, the semaphore is not decremented and
60b0a1b4f8SJason Evansan error is returned.
61b0a1b4f8SJason Evans.Sh RETURN VALUES
62d6002fefSRuslan Ermilov.Rv -std
63b0a1b4f8SJason Evans.Sh ERRORS
649d09157aSPhilippe CharnierThe
65b0a1b4f8SJason Evans.Fn sem_wait
66b0a1b4f8SJason Evansand
67b0a1b4f8SJason Evans.Fn sem_trywait
689d09157aSPhilippe Charnierfunctions will fail if:
69b0a1b4f8SJason Evans.Bl -tag -width Er
70b0a1b4f8SJason Evans.It Bq Er EINVAL
7126b6c45aSRuslan ErmilovThe
72b0a1b4f8SJason Evans.Fa sem
7326b6c45aSRuslan Ermilovargument
74b0a1b4f8SJason Evanspoints to an invalid semaphore.
75b0a1b4f8SJason Evans.El
76b0a1b4f8SJason Evans.Pp
77b0a1b4f8SJason EvansAdditionally,
78b0a1b4f8SJason Evans.Fn sem_trywait
79b0a1b4f8SJason Evanswill fail if:
80b0a1b4f8SJason Evans.Bl -tag -width Er
81b0a1b4f8SJason Evans.It Bq Er EAGAIN
82b0a1b4f8SJason EvansThe semaphore value was zero, and thus could not be decremented.
83b0a1b4f8SJason Evans.El
84b0a1b4f8SJason Evans.Sh SEE ALSO
8551f2ddd7STim J. Robbins.Xr sem_post 3 ,
8651f2ddd7STim J. Robbins.Xr sem 4
87b0a1b4f8SJason Evans.Sh STANDARDS
889d09157aSPhilippe CharnierThe
89b0a1b4f8SJason Evans.Fn sem_wait
90b0a1b4f8SJason Evansand
91b0a1b4f8SJason Evans.Fn sem_trywait
929d09157aSPhilippe Charnierfunctions conform to
93096841ecSRuslan Ermilov.St -p1003.1-96 .
94