lib/libc/sys/_lwp_detach.2

   1 .\"     $NetBSD: _lwp_detach.2,v 1.4 2008/04/30 13:10:51 martin 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 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd January 20, 2007
  31 .Dt _LWP_DETACH 2
  32 .Os
  33 .Sh NAME
  34 .Nm _lwp_detach
  35 .Nd detach a light-weight process
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In lwp.h
  40 .Ft int
  41 .Fn _lwp_detach "lwpid_t lwp"
  42 .Sh DESCRIPTION
  43 .Fn _lwp_detach
  44 causes a light-weight process to become detached, having the same
  45 effect as if the LWP was created with the
  46 .Dv LWP_DETACHED
  47 flag.
  48 .Pp
  49 The resources associated with a detached LWP will be automatically
  50 reclaimed by the system when the LWP exits.
  51 Conversely, an attached LWP's resources will not be reclaimed until
  52 its status is reported to another LWP via
  53 .Xr _lwp_wait 2 .
  54 .Sh RETURN VALUES
  55 A 0 value indicates that the call succeeded.
  56 A \-1 return value indicates an error occurred and
  57 .Va errno
  58 is set to indicate the reason.
  59 .Sh ERRORS
  60 .Bl -tag -width [EINVAL]
  61 .It Bq Er EINVAL
  62 The LWP is already detached.
  63 .It Bq Er ESRCH
  64 No LWP can be found in the current process corresponding to that
  65 specified by
  66 .Fa lwp .
  67 .El
  68 .Sh SEE ALSO
  69 .Xr _lwp_create 2 ,
  70 .Xr _lwp_wait 2
  71 .Sh HISTORY
  72 The
  73 .Fn _lwp_detach
  74 system call first appeared in
  75 .Nx 5.0 .