lib/libc/sys/_lwp_unpark.2

   1 .\"     $NetBSD: _lwp_unpark.2,v 1.4 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 January 20, 2007
  31 .Dt _LWP_UNPARK 2
  32 .Os
  33 .Sh NAME
  34 .Nm _lwp_unpark
  35 .Nd resume execution of a waiting LWP
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In lwp.h
  40 .Ft int
  41 .Fn _lwp_unpark "lwpid_t lwp" "const void *hint"
  42 .Sh DESCRIPTION
  43 .Fn _lwp_unpark
  44 resumes execution of the light-weight process
  45 .Fa lwp .
  46 .Pp
  47 The target LWP is assumed to be waiting in the kernel as a result of a
  48 call to
  49 .Fn _lwp_park .
  50 If the target LWP is not currently waiting, it will return immediately
  51 upon the next call to
  52 .Fn _lwp_park .
  53 .Pp
  54 See
  55 .Xr _lwp_park 2
  56 for a description of the
  57 .Fa hint
  58 argument.
  59 .Sh RETURN VALUES
  60 A 0 value indicates that the call succeeded.
  61 A \-1 return value indicates an error occurred and
  62 .Va errno
  63 is set to indicate the reason.
  64 .Sh ERRORS
  65 .Bl -tag -width [EINVAL]
  66 .It Bq Er ESRCH
  67 No LWP can be found in the current process corresponding to that
  68 specified by
  69 .Fa lwp .
  70 .El
  71 .Sh SEE ALSO
  72 .Xr _lwp_park 2 ,
  73 .Xr _lwp_unpark_all 2 ,
  74 .Xr _lwp_wakeup 2
  75 .Sh HISTORY
  76 The
  77 .Fn _lwp_unpark
  78 system call first appeared in
  79 .Nx 5.0 .