xref: /netbsd-src/lib/libc/sys/_lwp_unpark_all.2 (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1.\"	$NetBSD: _lwp_unpark_all.2,v 1.4 2007/02/17 08:38:06 wiz 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.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd February 10, 2007
38.Dt _LWP_UNPARK_ALL 2
39.Os
40.Sh NAME
41.Nm _lwp_unpark_all
42.Nd resume execution of a waiting LWP
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.In lwp.h
47.Ft ssize_t
48.Fn _lwp_unpark_all "lwpid_t *targets" "size_t ntargets" "const void *hint"
49.Sh DESCRIPTION
50.Fn _lwp_unpark_all
51resumes execution of one or more light-weight processes listed in
52the array pointed to by
53.Fa targets .
54.Pp
55The target LWPs are assumed to be waiting in the kernel as a result of
56calls to
57.Fn _lwp_park .
58If any of the target LWPs are not currently waiting, those LWPs will return
59immediatley upon the next call to
60.Fn _lwp_park .
61.Pp
62The value pointed to by
63.Fa ntargets
64specifies the size of the array pointed to by
65.Fa targets .
66If the
67.Fa targets
68argument is given as
69.Dv NULL ,
70the maximum size of the array (expressed
71as the number of entries) is returned.
72.Pp
73See
74.Xr _lwp_park 2
75for a description of the
76.Fa hint
77argument.
78.Sh RETURN VALUES
79If the maximum size of the
80.Fa targets
81array is not being queried, a return of 0 indicates that the call succeeded.
82A \-1 return value indicates an error occurred and
83.Va errno
84is set to indicate the reason.
85.Sh ERRORS
86.Bl -tag -width [EINVAL]
87.It Bq Er EFAULT
88The value specified for
89.Fa targets
90is invalid.
91.It Bq Er EINVAL
92The value specified for
93.Fa ntargets
94is out of range.
95.It Bq Er ENOMEM
96Insufficient resources are available to complete the operation.
97.El
98.Sh SEE ALSO
99.Xr _lwp_park 2 ,
100.Xr _lwp_unpark 2 ,
101.Xr _lwp_wakeup 2
102.Sh HISTORY
103The
104.Fn _lwp_unpark_all
105system call first appeared in
106.Nx 5.0 .
107