xref: /netbsd-src/lib/libc/sys/_lwp_wait.2 (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1.\"	$NetBSD: _lwp_wait.2,v 1.3 2003/04/16 13:34:50 wiz Exp $
2.\"
3.\" Copyright (c) 2003 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.
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 January 13, 2003
38.Dt _LWP_WAIT 2
39.Os
40.Sh NAME
41.Nm _lwp_wait
42.Nd wait for light-weight process termination
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.In lwp.h
47.Ft int
48.Fn _lwp_wait "lwpid_t wlwp" "lwpid_t *rlwp"
49.Sh DESCRIPTION
50.Fn _lwp_wait
51suspends execution of the calling LWP until the LWP specified by
52.Fa wlwp
53terminates.
54The specified LWP must not be detached.
55If
56.Fa wlwp
57is 0, then
58.Fn _lwp_wait
59waits for any undetached LWP in the current process.
60.Pp
61If
62.Fa rlwp
63is not
64.Dv NULL ,
65then it points to the location where the LWP ID of
66the exited LWP is stored.
67.Sh RETURN VALUES
68Upon successful completion,
69.Fn _lwp_wait
70returns a value of 0.
71Otherwise, an error code is returned to indicate the error.
72.Sh ERRORS
73.Fn _lwp_wait
74will fail if:
75.Bl -tag -width [EDEADLK]
76.It Bq Er ESRCH
77No undetached LWP can be found in the current process corresponding to that
78specified by
79.Fa wlwp .
80.It Bq Er EDEADLK
81The calling LWP is the only LWP in the process.
82.It Bq Er EDEADLK
83The LWP ID specified by
84.Fa wlwp
85is the LWP ID of the calling LWP.
86.It Bq Er EINTR
87.Fn _lwp_wait
88was interrupted by a caught signal, or the signal did not
89have the
90.Dv SA_RESTART
91flag set.
92.El
93.Sh SEE ALSO
94.Xr _lwp_create 2 ,
95.Xr _lwp_exit 2
96.Sh HISTORY
97The
98.Fn _lwp_wait
99system call first appeared in
100.Nx 2.0 .
101