static/freebsd/man3/pthread_schedparam.3 3.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

<table class="head">
  <tr>
    <td class="head-ltitle">PTHREAD_SCHEDPARAM(3)</td>
    <td class="head-vol">Library Functions Manual</td>
    <td class="head-rtitle">PTHREAD_SCHEDPARAM(3)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">pthread_setschedparam</code>,
    <code class="Nm">pthread_getschedparam</code> &#x2014;
    <span class="Nd">thread scheduling parameter manipulation</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
<p class="Pp"><span class="Lb">POSIX Threads Library (libpthread,
    -lpthread)</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
    &lt;<a class="In">pthread.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">pthread_setschedparam</code>(<var class="Fa" style="white-space: nowrap;">pthread_t
    thread</var>, <var class="Fa" style="white-space: nowrap;">int policy</var>,
    <var class="Fa" style="white-space: nowrap;">const struct sched_param
    *param</var>);</p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">pthread_getschedparam</code>(<var class="Fa" style="white-space: nowrap;">pthread_t
    thread</var>, <var class="Fa" style="white-space: nowrap;">int *restrict
    policy</var>, <var class="Fa" style="white-space: nowrap;">struct
    sched_param *restrict param</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The
    <a class="permalink" href="#pthread_setschedparam"><code class="Fn" id="pthread_setschedparam">pthread_setschedparam</code></a>()
    and
    <a class="permalink" href="#pthread_getschedparam"><code class="Fn" id="pthread_getschedparam">pthread_getschedparam</code></a>()
    functions set and get the scheduling parameters of individual threads. The
    scheduling policy for a thread can either be
    <code class="Dv">SCHED_FIFO</code> (first in, first out),
    <code class="Dv">SCHED_RR</code> (round-robin), or
    <code class="Dv">SCHED_OTHER</code> (timesharing). Valid thread priorities
    (accessed via <var class="Va">param-&gt;sched_priority</var>) must be within
    the range returned by the <a class="Xr">sched_get_priority_min(2)</a> and
    <a class="Xr">sched_get_priority_max(2)</a> system calls.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
  VALUES</a></h1>
<p class="Pp">If successful, these functions return 0. Otherwise, an error
    number is returned to indicate the error.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
<p class="Pp">The <code class="Fn">pthread_setschedparam</code>() function will
    fail if:</p>
<dl class="Bl-tag">
  <dt id="EINVAL">[<a class="permalink" href="#EINVAL"><code class="Er">EINVAL</code></a>]</dt>
  <dd>Invalid value for <var class="Fa">policy</var>.</dd>
  <dt id="ENOTSUP">[<a class="permalink" href="#ENOTSUP"><code class="Er">ENOTSUP</code></a>]</dt>
  <dd>Invalid value for scheduling parameters.</dd>
  <dt id="EPERM">[<a class="permalink" href="#EPERM"><code class="Er">EPERM</code></a>]</dt>
  <dd>The calling thread does not have sufficient privilege to perform the
      operation.</dd>
  <dt id="ESRCH">[<a class="permalink" href="#ESRCH"><code class="Er">ESRCH</code></a>]</dt>
  <dd>Non-existent thread <var class="Fa">thread</var>.</dd>
</dl>
<p class="Pp">The <code class="Fn">pthread_getschedparam</code>() function will
    fail if:</p>
<dl class="Bl-tag">
  <dt id="ESRCH~2">[<a class="permalink" href="#ESRCH~2"><code class="Er">ESRCH</code></a>]</dt>
  <dd>Non-existent thread <var class="Fa">thread</var>.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">sched_get_priority_max(2)</a>,
    <a class="Xr">sched_get_priority_min(2)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1>
<p class="Pp">The <code class="Fn">pthread_setschedparam</code>() and
    <code class="Fn">pthread_getschedparam</code>() functions conform to
    <span class="St">Version&#x00A0;2 of the Single UNIX Specification
    (&#x201C;SUSv2&#x201D;)</span>.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">October 17, 2022</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>