xref: /minix3/lib/libc/sys/_lwp_detach.2 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\"	$NetBSD: _lwp_detach.2,v 1.4 2008/04/30 13:10:51 martin Exp $
2*2fe8fb19SBen Gras.\"
3*2fe8fb19SBen Gras.\" Copyright (c) 2003, 2007 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, and by Andrew Doran.
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 20, 2007
31*2fe8fb19SBen Gras.Dt _LWP_DETACH 2
32*2fe8fb19SBen Gras.Os
33*2fe8fb19SBen Gras.Sh NAME
34*2fe8fb19SBen Gras.Nm _lwp_detach
35*2fe8fb19SBen Gras.Nd detach a light-weight process
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_detach "lwpid_t lwp"
42*2fe8fb19SBen Gras.Sh DESCRIPTION
43*2fe8fb19SBen Gras.Fn _lwp_detach
44*2fe8fb19SBen Grascauses a light-weight process to become detached, having the same
45*2fe8fb19SBen Graseffect as if the LWP was created with the
46*2fe8fb19SBen Gras.Dv LWP_DETACHED
47*2fe8fb19SBen Grasflag.
48*2fe8fb19SBen Gras.Pp
49*2fe8fb19SBen GrasThe resources associated with a detached LWP will be automatically
50*2fe8fb19SBen Grasreclaimed by the system when the LWP exits.
51*2fe8fb19SBen GrasConversely, an attached LWP's resources will not be reclaimed until
52*2fe8fb19SBen Grasits status is reported to another LWP via
53*2fe8fb19SBen Gras.Xr _lwp_wait 2 .
54*2fe8fb19SBen Gras.Sh RETURN VALUES
55*2fe8fb19SBen GrasA 0 value indicates that the call succeeded.
56*2fe8fb19SBen GrasA \-1 return value indicates an error occurred and
57*2fe8fb19SBen Gras.Va errno
58*2fe8fb19SBen Grasis set to indicate the reason.
59*2fe8fb19SBen Gras.Sh ERRORS
60*2fe8fb19SBen Gras.Bl -tag -width [EINVAL]
61*2fe8fb19SBen Gras.It Bq Er EINVAL
62*2fe8fb19SBen GrasThe LWP is already detached.
63*2fe8fb19SBen Gras.It Bq Er ESRCH
64*2fe8fb19SBen GrasNo LWP can be found in the current process corresponding to that
65*2fe8fb19SBen Grasspecified by
66*2fe8fb19SBen Gras.Fa lwp .
67*2fe8fb19SBen Gras.El
68*2fe8fb19SBen Gras.Sh SEE ALSO
69*2fe8fb19SBen Gras.Xr _lwp_create 2 ,
70*2fe8fb19SBen Gras.Xr _lwp_wait 2
71*2fe8fb19SBen Gras.Sh HISTORY
72*2fe8fb19SBen GrasThe
73*2fe8fb19SBen Gras.Fn _lwp_detach
74*2fe8fb19SBen Grassystem call first appeared in
75*2fe8fb19SBen Gras.Nx 5.0 .
76