|
Packit |
7cfc04 |
.\" Copyright (c) 2009 Michael Kerrisk, <mtk.manpages@gmail.com>
|
|
Packit |
7cfc04 |
.\"
|
|
Packit |
7cfc04 |
.\" %%%LICENSE_START(VERBATIM)
|
|
Packit |
7cfc04 |
.\" Permission is granted to make and distribute verbatim copies of this
|
|
Packit |
7cfc04 |
.\" manual provided the copyright notice and this permission notice are
|
|
Packit |
7cfc04 |
.\" preserved on all copies.
|
|
Packit |
7cfc04 |
.\"
|
|
Packit |
7cfc04 |
.\" Permission is granted to copy and distribute modified versions of this
|
|
Packit |
7cfc04 |
.\" manual under the conditions for verbatim copying, provided that the
|
|
Packit |
7cfc04 |
.\" entire resulting derived work is distributed under the terms of a
|
|
Packit |
7cfc04 |
.\" permission notice identical to this one.
|
|
Packit |
7cfc04 |
.\"
|
|
Packit |
7cfc04 |
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
Packit |
7cfc04 |
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
Packit |
7cfc04 |
.\" responsibility for errors or omissions, or for damages resulting from
|
|
Packit |
7cfc04 |
.\" the use of the information contained herein. The author(s) may not
|
|
Packit |
7cfc04 |
.\" have taken the same level of care in the production of this manual,
|
|
Packit |
7cfc04 |
.\" which is licensed free of charge, as they might when working
|
|
Packit |
7cfc04 |
.\" professionally.
|
|
Packit |
7cfc04 |
.\"
|
|
Packit |
7cfc04 |
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
Packit |
7cfc04 |
.\" the source, must acknowledge the copyright and authors of this work.
|
|
Packit |
7cfc04 |
.\" %%%LICENSE_END
|
|
Packit |
7cfc04 |
.\"
|
|
Packit |
7cfc04 |
.TH PTHREAD_YIELD 3 2017-11-26 "Linux" "Linux Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
pthread_yield \- yield the processor
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
.BR "#define _GNU_SOURCE" " /* See feature_test_macros(7) */"
|
|
Packit |
7cfc04 |
.B #include <pthread.h>
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
.B int pthread_yield(void);
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
Compile and link with \fI\-pthread\fP.
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
.BR pthread_yield ()
|
|
Packit |
7cfc04 |
causes the calling thread to relinquish the CPU.
|
|
Packit |
7cfc04 |
The thread is placed at the end of the run queue for its static
|
|
Packit |
7cfc04 |
priority and another thread is scheduled to run.
|
|
Packit |
7cfc04 |
For further details, see
|
|
Packit |
7cfc04 |
.BR sched_yield (2)
|
|
Packit |
7cfc04 |
.SH RETURN VALUE
|
|
Packit |
7cfc04 |
On success,
|
|
Packit |
7cfc04 |
.BR pthread_yield ()
|
|
Packit |
7cfc04 |
returns 0;
|
|
Packit |
7cfc04 |
on error, it returns an error number.
|
|
Packit |
7cfc04 |
.SH ERRORS
|
|
Packit |
7cfc04 |
On Linux, this call always succeeds
|
|
Packit |
7cfc04 |
(but portable and future-proof applications should nevertheless
|
|
Packit |
7cfc04 |
handle a possible error return).
|
|
Packit |
7cfc04 |
.SH ATTRIBUTES
|
|
Packit |
7cfc04 |
For an explanation of the terms used in this section, see
|
|
Packit |
7cfc04 |
.BR attributes (7).
|
|
Packit |
7cfc04 |
.TS
|
|
Packit |
7cfc04 |
allbox;
|
|
Packit |
7cfc04 |
lb lb lb
|
|
Packit |
7cfc04 |
l l l.
|
|
Packit |
7cfc04 |
Interface Attribute Value
|
|
Packit |
7cfc04 |
T{
|
|
Packit |
7cfc04 |
.BR pthread_yield ()
|
|
Packit |
7cfc04 |
T} Thread safety MT-Safe
|
|
Packit |
7cfc04 |
.TE
|
|
Packit |
7cfc04 |
.SH CONFORMING TO
|
|
Packit |
7cfc04 |
This call is nonstandard, but present on several other systems.
|
|
Packit |
7cfc04 |
Use the standardized
|
|
Packit |
7cfc04 |
.BR sched_yield (2)
|
|
Packit |
7cfc04 |
instead.
|
|
Packit |
7cfc04 |
.\" e.g., the BSDs, Tru64, AIX, and Irix.
|
|
Packit |
7cfc04 |
.SH NOTES
|
|
Packit |
7cfc04 |
On Linux, this function is implemented as a call to
|
|
Packit |
7cfc04 |
.BR sched_yield (2).
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
.BR pthread_yield ()
|
|
Packit |
7cfc04 |
is intended for use with real-time scheduling policies (i.e.,
|
|
Packit |
7cfc04 |
.BR SCHED_FIFO
|
|
Packit |
7cfc04 |
or
|
|
Packit |
7cfc04 |
.BR SCHED_RR ).
|
|
Packit |
7cfc04 |
Use of
|
|
Packit |
7cfc04 |
.BR pthread_yield ()
|
|
Packit |
7cfc04 |
with nondeterministic scheduling policies such as
|
|
Packit |
7cfc04 |
.BR SCHED_OTHER
|
|
Packit |
7cfc04 |
is unspecified and very likely means your application design is broken.
|
|
Packit |
7cfc04 |
.SH SEE ALSO
|
|
Packit |
7cfc04 |
.BR sched_yield (2),
|
|
Packit |
7cfc04 |
.\" FIXME . .BR pthread_cond_wait (3),
|
|
Packit |
7cfc04 |
.BR pthreads (7),
|
|
Packit |
7cfc04 |
.BR sched (7)
|
|
Packit |
7cfc04 |
.SH COLOPHON
|
|
Packit |
7cfc04 |
This page is part of release 4.15 of the Linux
|
|
Packit |
7cfc04 |
.I man-pages
|
|
Packit |
7cfc04 |
project.
|
|
Packit |
7cfc04 |
A description of the project,
|
|
Packit |
7cfc04 |
information about reporting bugs,
|
|
Packit |
7cfc04 |
and the latest version of this page,
|
|
Packit |
7cfc04 |
can be found at
|
|
Packit |
7cfc04 |
\%https://www.kernel.org/doc/man\-pages/.
|