man3/pthread_yield.3

   1 .\" Copyright (c) 2009 Michael Kerrisk, <mtk.manpages@gmail.com>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH PTHREAD_YIELD 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 pthread_yield \- yield the processor
  28 .SH SYNOPSIS
  29 .nf
  30 .BR "#define _GNU_SOURCE" "             /* See feature_test_macros(7) */"
  31 .B #include <pthread.h>
  32 .PP
  33 .B int pthread_yield(void);
  34 .fi
  35 .PP
  36 Compile and link with \fI\-pthread\fP.
  37 .SH DESCRIPTION
  38 .BR Note :
  39 This function is deprecated; see below.
  40 .PP
  41 .BR pthread_yield ()
  42 causes the calling thread to relinquish the CPU.
  43 The thread is placed at the end of the run queue for its static
  44 priority and another thread is scheduled to run.
  45 For further details, see
  46 .BR sched_yield (2)
  47 .SH RETURN VALUE
  48 On success,
  49 .BR pthread_yield ()
  50 returns 0;
  51 on error, it returns an error number.
  52 .SH ERRORS
  53 On Linux, this call always succeeds
  54 (but portable and future-proof applications should nevertheless
  55 handle a possible error return).
  56 .SH VERSIONS
  57 Since glibc 2.34, this function is marked as deprecated.
  58 .SH ATTRIBUTES
  59 For an explanation of the terms used in this section, see
  60 .BR attributes (7).
  61 .ad l
  62 .nh
  63 .TS
  64 allbox;
  65 lbx lb lb
  66 l l l.
  67 Interface       Attribute       Value
  68 T{
  69 .BR pthread_yield ()
  70 T}      Thread safety   MT-Safe
  71 .TE
  72 .hy
  73 .ad
  74 .sp 1
  75 .SH CONFORMING TO
  76 This call is nonstandard, but present on several other systems.
  77 Use the standardized
  78 .BR sched_yield (2)
  79 instead.
  80 .\" e.g., the BSDs, Tru64, AIX, and Irix.
  81 .SH NOTES
  82 On Linux, this function is implemented as a call to
  83 .BR sched_yield (2).
  84 .PP
  85 .BR pthread_yield ()
  86 is intended for use with real-time scheduling policies (i.e.,
  87 .BR SCHED_FIFO
  88 or
  89 .BR SCHED_RR ).
  90 Use of
  91 .BR pthread_yield ()
  92 with nondeterministic scheduling policies such as
  93 .BR SCHED_OTHER
  94 is unspecified and very likely means your application design is broken.
  95 .SH SEE ALSO
  96 .BR sched_yield (2),
  97 .\" FIXME . .BR pthread_cond_wait (3),
  98 .BR pthreads (7),
  99 .BR sched (7)