xref: /freebsd/lib/libc/gen/sem_post.3 (revision fccedf067d9e77523b684f179b4aed07995f7b05)
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_POST 3
31.Os
32.Sh NAME
33.Nm sem_post
34.Nd increment (unlock) a semaphore
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In semaphore.h
39.Ft int
40.Fn sem_post "sem_t *sem"
41.Sh DESCRIPTION
42The
43.Fn sem_post
44function increments (unlocks) the semaphore pointed to by
45.Fa sem .
46If there are threads blocked on the semaphore when
47.Fn sem_post
48is called, then the highest priority thread that has been blocked the longest on
49the semaphore will be allowed to return from
50.Fn sem_wait .
51.Pp
52The
53.Fn sem_post
54function is signal-reentrant and may be called within signal handlers.
55.Sh RETURN VALUES
56.Rv -std sem_post
57.Sh ERRORS
58The
59.Fn sem_post
60function will 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_trywait 3 ,
68.Xr sem_wait 3 ,
69.Xr sem 4
70.Sh STANDARDS
71The
72.Fn sem_post
73function conforms to
74.St -p1003.1-96 .
75