lib/libc/sys/sa_yield.2

   1 .\"     $NetBSD: sa_yield.2,v 1.4 2004/05/09 11:28:58 yamt Exp $
   2 .\"
   3 .\" Copyright (c)2004 YAMAMOTO Takashi,
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" ------------------------------------------------------------
  28 .Dd May 9, 2004
  29 .Dt SA_YIELD 2
  30 .Os
  31 .Sh NAME
  32 .Nm sa_yield
  33 .Nd idle a virtual processor
  34 .\" ------------------------------------------------------------
  35 .Sh LIBRARY
  36 .Lb libc
  37 .\" ------------------------------------------------------------
  38 .Sh SYNOPSIS
  39 .In sa.h
  40 .Ft int
  41 .Fn sa_yield
  42 .\" ------------------------------------------------------------
  43 .Sh DESCRIPTION
  44 .Fn sa_yield
  45 is used to idle a virtual processor on which the calling thread is running.
  46 It's typically used when the process's userland scheduler has no userland
  47 thread to run.
  48 .Pp
  49 Scheduler activation should be enabled by
  50 .Fn sa_enable
  51 beforehand.
  52 .\" ------------------------------------------------------------
  53 .Sh RETURN VALUES
  54 On success,
  55 .Fn sa_yield
  56 will not return to userland in the normal way.
  57 It returns into an upcall hander with an upcall.
  58 Otherwise, a value of \-1 is returned and
  59 .Va errno
  60 is set to indicate the error.
  61 .\" ------------------------------------------------------------
  62 .Sh SEE ALSO
  63 .Xr sa_enable 2 ,
  64 .Xr pthread 3