sched_yield man page

sched_yield — yield the processor

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 appropriately.

Errors

In the Linux implementation, sched_yield() always succeeds.

Conforming to

POSIX.1-2001, POSIX.1-2008.

Notes

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().

POSIX systems on which sched_yield() is available define _POSIX_PRIORITY_SCHEDULING in <unistd.h>.

Strategic calls to sched_yield() can improve performance by giving other threads or processes a chance to run when (heavily) contended resources (e.g., mutexes) have been released by the caller. 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 release 4.08 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.

Referenced By

getrlimit(2), pthread_yield(3), sched(7), sched_setattr(2), sched_setscheduler(2), stress-ng(1), syscalls(2).

2015-08-08 Linux Linux Programmer's Manual