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