lib/libc/sys/_lwp_wait.2

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