original/man2/sched_yield.2

   1 .\" Copyright (C) Tom Bjorkholm & Markus Kuhn, 1996
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\"
   9 .\" The GNU General Public License's references to "object code"
  10 .\" and "executables" are to be interpreted as the output of any
  11 .\" document formatting or typesetting system, including
  12 .\" intermediate and printed output.
  13 .\"
  14 .\" This manual is distributed in the hope that it will be useful,
  15 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 .\" GNU General Public License for more details.
  18 .\"
  19 .\" You should have received a copy of the GNU General Public
  20 .\" License along with this manual; if not, see
  21 .\" <http://www.gnu.org/licenses/>.
  22 .\" %%%LICENSE_END
  23 .\"
  24 .\" 1996-04-01 Tom Bjorkholm <tomb@mydata.se>
  25 .\"            First version written
  26 .\" 1996-04-10 Markus Kuhn <mskuhn@cip.informatik.uni-erlangen.de>
  27 .\"            revision
  28 .\"
  29 .TH SCHED_YIELD 2 2014-04-28 "Linux" "Linux Programmer's Manual"
  30 .SH NAME
  31 sched_yield \- yield the processor
  32 .SH SYNOPSIS
  33 .B #include <sched.h>
  34 .sp
  35 .B int sched_yield(void);
  36 .SH DESCRIPTION
  37 .BR sched_yield ()
  38 causes the calling thread to relinquish the CPU.
  39 The thread is moved to the end of the queue for its static
  40 priority and a new thread gets to run.
  41 .SH RETURN VALUE
  42 On success,
  43 .BR sched_yield ()
  44 returns 0.
  45 On error, \-1 is returned, and
  46 .I errno
  47 is set appropriately.
  48 .SH ERRORS
  49 In the Linux implementation,
  50 .BR sched_yield ()
  51 always succeeds.
  52 .SH CONFORMING TO
  53 POSIX.1-2001.
  54 .SH NOTES
  55 If the calling thread is the only thread in the highest
  56 priority list at that time,
  57 it will continue to run after a call to
  58 .BR sched_yield ().
  59
  60 POSIX systems on which
  61 .BR sched_yield ()
  62 is available define
  63 .B _POSIX_PRIORITY_SCHEDULING
  64 in
  65 .IR <unistd.h> .
  66
  67 Strategic calls to
  68 .BR sched_yield ()
  69 can improve performance by giving other threads or processes
  70 a chance to run when (heavily) contended resources (e.g., mutexes)
  71 have been released by the caller.
  72 Avoid calling
  73 .BR sched_yield ()
  74 unnecessarily or inappropriately
  75 (e.g., when resources needed by other
  76 schedulable threads are still held by the caller),
  77 since doing so will result in unnecessary context switches,
  78 which will degrade system performance.
  79 .SH SEE ALSO
  80 .BR sched (7)
  81 .SH COLOPHON
  82 This page is part of release 3.79 of the Linux
  83 .I man-pages
  84 project.
  85 A description of the project,
  86 information about reporting bugs,
  87 and the latest version of this page,
  88 can be found at
  89 \%http://www.kernel.org/doc/man\-pages/.