xref: /netbsd-src/lib/libc/sys/_lwp_detach.2 (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1.\"	$NetBSD: _lwp_detach.2,v 1.3 2007/02/10 10:34:03 ad 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 January 20, 2007
38.Dt _LWP_DETACH 2
39.Os
40.Sh NAME
41.Nm _lwp_detach
42.Nd detach a light-weight process
43.Sh LIBRARY
44.Lb libc
45.Sh SYNOPSIS
46.In lwp.h
47.Ft int
48.Fn _lwp_detach "lwpid_t lwp"
49.Sh DESCRIPTION
50.Fn _lwp_detach
51causes a light-weight process to become detached, having the same
52effect as if the LWP was created with the
53.Dv LWP_DETACHED
54flag.
55.Pp
56The resources associated with a detached LWP will be automatically
57reclaimed by the system when the LWP exits.
58Conversely, an attached LWP's resources will not be reclaimed until
59its status is reported to another LWP via
60.Xr _lwp_wait 2 .
61.Sh RETURN VALUES
62A 0 value indicates that the call succeeded.
63A \-1 return value indicates an error occurred and
64.Va errno
65is set to indicate the reason.
66.Sh ERRORS
67.Bl -tag -width [EINVAL]
68.It Bq Er EINVAL
69The LWP is already detached.
70.It Bq Er ESRCH
71No LWP can be found in the current process corresponding to that
72specified by
73.Fa lwp .
74.El
75.Sh SEE ALSO
76.Xr _lwp_create 2 ,
77.Xr _lwp_wait 2
78.Sh HISTORY
79The
80.Fn _lwp_detach
81system call first appeared in
82.Nx 5.0 .
83