sched_yield(2) — Linux manual page

sched_yield(2)             System Calls Manual            sched_yield(2)

NAME

       sched_yield - yield the processor

LIBRARY

       Standard C library (libc, -lc)

SYNOPSIS

       #include <sched.h>

       int sched_yield(void);

DESCRIPTION

       sched_yield() causes the calling thread to relinquish the CPU.
       The thread is moved to the end of the queue for its static
       priority and a new thread gets to run.

RETURN VALUE

       On success, sched_yield() returns 0.  On error, -1 is returned,
       and errno is set to indicate the error.

ERRORS

       In the Linux implementation, sched_yield() always succeeds.

STANDARDS

       POSIX.1-2008.

HISTORY

       POSIX.1-2001 (but optional).  POSIX.1-2008.

       Before POSIX.1-2008, systems on which sched_yield() is available
       defined _POSIX_PRIORITY_SCHEDULING in <unistd.h>.

CAVEATS

       sched_yield() is intended for use with real-time scheduling
       policies (i.e., SCHED_FIFO or SCHED_RR).  Use of sched_yield()
       with nondeterministic scheduling policies such as SCHED_OTHER is
       unspecified and very likely means your application design is
       broken.

       If the calling thread is the only thread in the highest priority
       list at that time, it will continue to run after a call to
       sched_yield().

       Avoid calling sched_yield() unnecessarily or inappropriately
       (e.g., when resources needed by other schedulable threads are
       still held by the caller), since doing so will result in
       unnecessary context switches, which will degrade system
       performance.

SEE ALSO

       sched(7)

COLOPHON

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-02                 sched_yield(2)

Pages that refer to this page: getrlimit(2), sched_setattr(2), sched_setscheduler(2), syscalls(2), pthread_yield(3), sched(7)

---