man3/pthread_attr_setinheritsched.3

   1 .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH PTHREAD_ATTR_SETINHERITSCHED 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 pthread_attr_setinheritsched, pthread_attr_getinheritsched \- set/get
  29 inherit-scheduler attribute in thread attributes object
  30 .SH SYNOPSIS
  31 .nf
  32 .B #include <pthread.h>
  33 .PP
  34 .BI "int pthread_attr_setinheritsched(pthread_attr_t *" attr ,
  35 .BI "                                 int " inheritsched );
  36 .BI "int pthread_attr_getinheritsched(const pthread_attr_t *restrict " attr ,
  37 .BI "                                 int *restrict " inheritsched );
  38 .PP
  39 Compile and link with \fI\-pthread\fP.
  40 .fi
  41 .SH DESCRIPTION
  42 The
  43 .BR pthread_attr_setinheritsched ()
  44 function sets the inherit-scheduler attribute of the
  45 thread attributes object referred to by
  46 .IR attr
  47 to the value specified in
  48 .IR inheritsched .
  49 The inherit-scheduler attribute determines whether a thread created using
  50 the thread attributes object
  51 .I attr
  52 will inherit its scheduling attributes from the calling thread
  53 or whether it will take them from
  54 .IR attr .
  55 .PP
  56 The following scheduling attributes are affected by the
  57 inherit-scheduler attribute:
  58 scheduling policy
  59 .RB ( pthread_attr_setschedpolicy (3)),
  60 scheduling priority
  61 .RB ( pthread_attr_setschedparam (3)),
  62 and contention scope
  63 .RB ( pthread_attr_setscope (3)).
  64 .PP
  65 The following values may be specified in
  66 .IR inheritsched :
  67 .TP
  68 .B PTHREAD_INHERIT_SCHED
  69 Threads that are created using
  70 .I attr
  71 inherit scheduling attributes from the creating thread;
  72 the scheduling attributes in
  73 .I attr
  74 are ignored.
  75 .TP
  76 .B PTHREAD_EXPLICIT_SCHED
  77 Threads that are created using
  78 .I attr
  79 take their scheduling attributes from the values specified
  80 by the attributes object.
  81 .\" FIXME Document the defaults for scheduler settings
  82 .PP
  83 The default setting of the inherit-scheduler attribute in
  84 a newly initialized thread attributes object is
  85 .BR PTHREAD_INHERIT_SCHED .
  86 .PP
  87 The
  88 .BR pthread_attr_getinheritsched ()
  89 returns the inherit-scheduler attribute of the thread attributes object
  90 .IR attr
  91 in the buffer pointed to by
  92 .IR inheritsched .
  93 .SH RETURN VALUE
  94 On success, these functions return 0;
  95 on error, they return a nonzero error number.
  96 .SH ERRORS
  97 .BR pthread_attr_setinheritsched ()
  98 can fail with the following error:
  99 .TP
 100 .B EINVAL
 101 Invalid value in
 102 .IR inheritsched .
 103 .PP
 104 POSIX.1 also documents an optional
 105 .B ENOTSUP
 106 error ("attempt was made to set the attribute to an unsupported value") for
 107 .BR pthread_attr_setinheritsched ().
 108 .\" .SH VERSIONS
 109 .\" Available since glibc 2.0.
 110 .SH ATTRIBUTES
 111 For an explanation of the terms used in this section, see
 112 .BR attributes (7).
 113 .ad l
 114 .nh
 115 .TS
 116 allbox;
 117 lbx lb lb
 118 l l l.
 119 Interface       Attribute       Value
 120 T{
 121 .BR pthread_attr_setinheritsched (),
 122 .BR pthread_attr_getinheritsched ()
 123 T}      Thread safety   MT-Safe
 124 .TE
 125 .hy
 126 .ad
 127 .sp 1
 128 .SH CONFORMING TO
 129 POSIX.1-2001, POSIX.1-2008.
 130 .SH BUGS
 131 As at glibc 2.8, if a thread attributes object is initialized using
 132 .BR pthread_attr_init (3),
 133 then the scheduling policy of the attributes object is set to
 134 .BR SCHED_OTHER
 135 and the scheduling priority is set to 0.
 136 However, if the inherit-scheduler attribute is then set to
 137 .BR PTHREAD_EXPLICIT_SCHED ,
 138 then a thread created using the attribute object
 139 wrongly inherits its scheduling attributes from the creating thread.
 140 This bug does not occur if either the scheduling policy or
 141 scheduling priority attribute is explicitly set
 142 in the thread attributes object before calling
 143 .BR pthread_create (3).
 144 .\" FIXME . Track status of the following bug:
 145 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=7007
 146 .SH EXAMPLES
 147 See
 148 .BR pthread_setschedparam (3).
 149 .SH SEE ALSO
 150 .ad l
 151 .nh
 152 .BR pthread_attr_init (3),
 153 .BR pthread_attr_setschedparam (3),
 154 .BR pthread_attr_setschedpolicy (3),
 155 .BR pthread_attr_setscope (3),
 156 .BR pthread_create (3),
 157 .BR pthread_setschedparam (3),
 158 .BR pthread_setschedprio (3),
 159 .BR pthreads (7),
 160 .BR sched (7)