lib/libc/sys/_lwp_unpark_all.2

   1 .\"     $NetBSD: _lwp_unpark_all.2,v 1.6 2010/11/02 20:49:47 skrll 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 February 10, 2007
  31 .Dt _LWP_UNPARK_ALL 2
  32 .Os
  33 .Sh NAME
  34 .Nm _lwp_unpark_all
  35 .Nd resume execution of a waiting LWP
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In lwp.h
  40 .Ft ssize_t
  41 .Fn _lwp_unpark_all "lwpid_t *targets" "size_t ntargets" "const void *hint"
  42 .Sh DESCRIPTION
  43 .Fn _lwp_unpark_all
  44 resumes execution of one or more light-weight processes listed in
  45 the array pointed to by
  46 .Fa targets .
  47 .Pp
  48 The target LWPs are assumed to be waiting in the kernel as a result of
  49 calls to
  50 .Fn _lwp_park .
  51 If any of the target LWPs are not currently waiting, those LWPs will return
  52 immediately upon the next call to
  53 .Fn _lwp_park .
  54 .Pp
  55 The value pointed to by
  56 .Fa ntargets
  57 specifies the size of the array pointed to by
  58 .Fa targets .
  59 If the
  60 .Fa targets
  61 argument is given as
  62 .Dv NULL ,
  63 the maximum size of the array (expressed
  64 as the number of entries) is returned.
  65 .Pp
  66 See
  67 .Xr _lwp_park 2
  68 for a description of the
  69 .Fa hint
  70 argument.
  71 .Sh RETURN VALUES
  72 If the maximum size of the
  73 .Fa targets
  74 array is not being queried, a return of 0 indicates that the call succeeded.
  75 A \-1 return value indicates an error occurred and
  76 .Va errno
  77 is set to indicate the reason.
  78 .Sh ERRORS
  79 .Bl -tag -width [EINVAL]
  80 .It Bq Er EFAULT
  81 The value specified for
  82 .Fa targets
  83 is invalid.
  84 .It Bq Er EINVAL
  85 The value specified for
  86 .Fa ntargets
  87 is out of range.
  88 .It Bq Er ENOMEM
  89 Insufficient resources are available to complete the operation.
  90 .El
  91 .Sh SEE ALSO
  92 .Xr _lwp_park 2 ,
  93 .Xr _lwp_unpark 2 ,
  94 .Xr _lwp_wakeup 2
  95 .Sh HISTORY
  96 The
  97 .Fn _lwp_unpark_all
  98 system call first appeared in
  99 .Nx 5.0 .