xref: /freebsd/lib/libsys/sched_yield.2 (revision 8269e7673cf033aba67dab8264fe719920c70f87)
1*8269e767SBrooks Davis.\" Copyright (c) 1998 HD Associates, Inc.
2*8269e767SBrooks Davis.\" All rights reserved.
3*8269e767SBrooks Davis.\"
4*8269e767SBrooks Davis.\" Redistribution and use in source and binary forms, with or without
5*8269e767SBrooks Davis.\" modification, are permitted provided that the following conditions
6*8269e767SBrooks Davis.\" are met:
7*8269e767SBrooks Davis.\" 1. Redistributions of source code must retain the above copyright
8*8269e767SBrooks Davis.\"    notice, this list of conditions and the following disclaimer.
9*8269e767SBrooks Davis.\" 2. Redistributions in binary form must reproduce the above copyright
10*8269e767SBrooks Davis.\"    notice, this list of conditions and the following disclaimer in the
11*8269e767SBrooks Davis.\"    documentation and/or other materials provided with the distribution.
12*8269e767SBrooks Davis.\"
13*8269e767SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*8269e767SBrooks Davis.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*8269e767SBrooks Davis.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*8269e767SBrooks Davis.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*8269e767SBrooks Davis.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*8269e767SBrooks Davis.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*8269e767SBrooks Davis.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*8269e767SBrooks Davis.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*8269e767SBrooks Davis.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*8269e767SBrooks Davis.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*8269e767SBrooks Davis.\" SUCH DAMAGE.
24*8269e767SBrooks Davis.\"
25*8269e767SBrooks Davis.Dd March 12, 1998
26*8269e767SBrooks Davis.Dt SCHED_YIELD 2
27*8269e767SBrooks Davis.Os
28*8269e767SBrooks Davis.Sh NAME
29*8269e767SBrooks Davis.Nm sched_yield
30*8269e767SBrooks Davis.Nd yield processor
31*8269e767SBrooks Davis.Sh LIBRARY
32*8269e767SBrooks Davis.Lb libc
33*8269e767SBrooks Davis.Sh SYNOPSIS
34*8269e767SBrooks Davis.In sched.h
35*8269e767SBrooks Davis.Ft int
36*8269e767SBrooks Davis.Fn sched_yield void
37*8269e767SBrooks Davis.Sh DESCRIPTION
38*8269e767SBrooks DavisThe
39*8269e767SBrooks Davis.Fn sched_yield
40*8269e767SBrooks Davissystem call forces the running process to relinquish the processor until it
41*8269e767SBrooks Davisagain becomes the head of its process list.
42*8269e767SBrooks DavisIt takes no arguments.
43*8269e767SBrooks Davis.Sh RETURN VALUES
44*8269e767SBrooks Davis.Rv -std sched_yield
45*8269e767SBrooks Davis.Sh ERRORS
46*8269e767SBrooks DavisOn failure
47*8269e767SBrooks Davis.Va errno
48*8269e767SBrooks Daviswill be set to the corresponding value:
49*8269e767SBrooks Davis.Bl -tag -width Er
50*8269e767SBrooks Davis.It Bq Er ENOSYS
51*8269e767SBrooks DavisThe system is not configured to support this functionality.
52*8269e767SBrooks Davis.El
53*8269e767SBrooks Davis.Sh STANDARDS
54*8269e767SBrooks DavisThe
55*8269e767SBrooks Davis.Fn sched_yield
56*8269e767SBrooks Davissystem call conforms to
57*8269e767SBrooks Davis.St -p1003.1b-93 .
58