xref: /netbsd-src/lib/libc/sys/_lwp_unpark_all.2 (revision 15c5c5f47235d06ffb52fc67ae524c4a93e97a39)
1.\"	$NetBSD: _lwp_unpark_all.2,v 1.8 2022/12/04 16:17:50 uwe Exp $
2.\"
3.\" Copyright (c) 2003, 2007 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jason R. Thorpe of Wasabi Systems, Inc, and by Andrew Doran.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE 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 BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd February 10, 2007
31.Dt _LWP_UNPARK_ALL 2
32.Os
33.Sh NAME
34.Nm _lwp_unpark_all
35.Nd resume execution of a waiting LWP
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In lwp.h
40.Ft ssize_t
41.Fn _lwp_unpark_all "const lwpid_t *targets" "size_t ntargets" "const void *hint"
42.Sh DESCRIPTION
43.Fn _lwp_unpark_all
44resumes execution of one or more light-weight processes listed in
45the array pointed to by
46.Fa targets .
47.Pp
48The target LWPs are assumed to be waiting in the kernel as a result of
49calls to
50.Fn _lwp_park .
51If any of the target LWPs are not currently waiting, those LWPs will return
52immediately upon the next call to
53.Fn _lwp_park .
54.Pp
55The
56.Fa ntargets
57argument specifies the size of the array pointed to by
58.Fa targets .
59.Pp
60If the
61.Fa targets
62argument is given as
63.Dv NULL ,
64the maximum size of the array
65.Pq expressed as the number of entries
66is returned.
67.Pp
68See
69.Xr _lwp_park 2
70for a description of the
71.Fa hint
72argument.
73.Sh RETURN VALUES
74.\" XXX: almsost, but we need the initial "if" clause...
75.\" .Rv -std _lwp_unpark_all
76If the maximum size of the
77.Fa targets
78array is not being queried, the
79.Fn _lwp_unpark_all
80function returns the value 0 if successful;
81otherwise the value \-1 is returned and the global variable
82.Va errno
83is set to indicate the error.
84.Sh ERRORS
85.Bl -tag -width Er
86.It Bq Er EFAULT
87The value specified for
88.Fa targets
89is invalid.
90.It Bq Er EINVAL
91The value specified for
92.Fa ntargets
93is out of range.
94.It Bq Er ENOMEM
95Insufficient resources are available to complete the operation.
96.El
97.Sh SEE ALSO
98.Xr _lwp_park 2 ,
99.Xr _lwp_unpark 2 ,
100.Xr _lwp_wakeup 2
101.Sh HISTORY
102The
103.Fn _lwp_unpark_all
104system call first appeared in
105.Nx 5.0 .
106