xref: /minix3/lib/libc/sys/_lwp_wait.2 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\"	$NetBSD: _lwp_wait.2,v 1.4 2008/04/30 13:10:51 martin Exp $
2*2fe8fb19SBen Gras.\"
3*2fe8fb19SBen Gras.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
4*2fe8fb19SBen Gras.\" All rights reserved.
5*2fe8fb19SBen Gras.\"
6*2fe8fb19SBen Gras.\" This code is derived from software contributed to The NetBSD Foundation
7*2fe8fb19SBen Gras.\" by Jason R. Thorpe of Wasabi Systems, Inc.
8*2fe8fb19SBen Gras.\"
9*2fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
10*2fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
11*2fe8fb19SBen Gras.\" are met:
12*2fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
13*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
14*2fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
15*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
16*2fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
17*2fe8fb19SBen Gras.\"
18*2fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19*2fe8fb19SBen Gras.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20*2fe8fb19SBen Gras.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21*2fe8fb19SBen Gras.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22*2fe8fb19SBen Gras.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23*2fe8fb19SBen Gras.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24*2fe8fb19SBen Gras.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25*2fe8fb19SBen Gras.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26*2fe8fb19SBen Gras.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27*2fe8fb19SBen Gras.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28*2fe8fb19SBen Gras.\" POSSIBILITY OF SUCH DAMAGE.
29*2fe8fb19SBen Gras.\"
30*2fe8fb19SBen Gras.Dd January 13, 2003
31*2fe8fb19SBen Gras.Dt _LWP_WAIT 2
32*2fe8fb19SBen Gras.Os
33*2fe8fb19SBen Gras.Sh NAME
34*2fe8fb19SBen Gras.Nm _lwp_wait
35*2fe8fb19SBen Gras.Nd wait for light-weight process termination
36*2fe8fb19SBen Gras.Sh LIBRARY
37*2fe8fb19SBen Gras.Lb libc
38*2fe8fb19SBen Gras.Sh SYNOPSIS
39*2fe8fb19SBen Gras.In lwp.h
40*2fe8fb19SBen Gras.Ft int
41*2fe8fb19SBen Gras.Fn _lwp_wait "lwpid_t wlwp" "lwpid_t *rlwp"
42*2fe8fb19SBen Gras.Sh DESCRIPTION
43*2fe8fb19SBen Gras.Fn _lwp_wait
44*2fe8fb19SBen Grassuspends execution of the calling LWP until the LWP specified by
45*2fe8fb19SBen Gras.Fa wlwp
46*2fe8fb19SBen Grasterminates.
47*2fe8fb19SBen GrasThe specified LWP must not be detached.
48*2fe8fb19SBen GrasIf
49*2fe8fb19SBen Gras.Fa wlwp
50*2fe8fb19SBen Grasis 0, then
51*2fe8fb19SBen Gras.Fn _lwp_wait
52*2fe8fb19SBen Graswaits for any undetached LWP in the current process.
53*2fe8fb19SBen Gras.Pp
54*2fe8fb19SBen GrasIf
55*2fe8fb19SBen Gras.Fa rlwp
56*2fe8fb19SBen Grasis not
57*2fe8fb19SBen Gras.Dv NULL ,
58*2fe8fb19SBen Grasthen it points to the location where the LWP ID of
59*2fe8fb19SBen Grasthe exited LWP is stored.
60*2fe8fb19SBen Gras.Sh RETURN VALUES
61*2fe8fb19SBen GrasUpon successful completion,
62*2fe8fb19SBen Gras.Fn _lwp_wait
63*2fe8fb19SBen Grasreturns a value of 0.
64*2fe8fb19SBen GrasOtherwise, an error code is returned to indicate the error.
65*2fe8fb19SBen Gras.Sh ERRORS
66*2fe8fb19SBen Gras.Fn _lwp_wait
67*2fe8fb19SBen Graswill fail if:
68*2fe8fb19SBen Gras.Bl -tag -width [EDEADLK]
69*2fe8fb19SBen Gras.It Bq Er ESRCH
70*2fe8fb19SBen GrasNo undetached LWP can be found in the current process corresponding to that
71*2fe8fb19SBen Grasspecified by
72*2fe8fb19SBen Gras.Fa wlwp .
73*2fe8fb19SBen Gras.It Bq Er EDEADLK
74*2fe8fb19SBen GrasThe calling LWP is the only LWP in the process.
75*2fe8fb19SBen Gras.It Bq Er EDEADLK
76*2fe8fb19SBen GrasThe LWP ID specified by
77*2fe8fb19SBen Gras.Fa wlwp
78*2fe8fb19SBen Grasis the LWP ID of the calling LWP.
79*2fe8fb19SBen Gras.It Bq Er EINTR
80*2fe8fb19SBen Gras.Fn _lwp_wait
81*2fe8fb19SBen Graswas interrupted by a caught signal, or the signal did not
82*2fe8fb19SBen Grashave the
83*2fe8fb19SBen Gras.Dv SA_RESTART
84*2fe8fb19SBen Grasflag set.
85*2fe8fb19SBen Gras.El
86*2fe8fb19SBen Gras.Sh SEE ALSO
87*2fe8fb19SBen Gras.Xr _lwp_create 2 ,
88*2fe8fb19SBen Gras.Xr _lwp_exit 2
89*2fe8fb19SBen Gras.Sh HISTORY
90*2fe8fb19SBen GrasThe
91*2fe8fb19SBen Gras.Fn _lwp_wait
92*2fe8fb19SBen Grassystem call first appeared in
93*2fe8fb19SBen Gras.Nx 2.0 .
94