xref: /xnu-10002.1.13/osfmk/man/thread_policy.html (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions<h2>thread_policy</h2>
2*1031c584SApple OSS Distributions<hr>
3*1031c584SApple OSS Distributions<p>
4*1031c584SApple OSS Distributions<strong>Function</strong> - Set target thread's scheduling policy state.
5*1031c584SApple OSS Distributions<h3>SYNOPSIS</h3>
6*1031c584SApple OSS Distributions<pre>
7*1031c584SApple OSS Distributions<strong>kern_return_t   thread_policy</strong>
8*1031c584SApple OSS Distributions                <strong>(thread_act_t</strong>                            <var>thread</var>,
9*1031c584SApple OSS Distributions                 <strong>policy_t</strong>                                <var>policy</var>,
10*1031c584SApple OSS Distributions                 <strong>policy_base_t</strong>                             <var>base</var>,
11*1031c584SApple OSS Distributions                 <strong>base</strong>                                <var>base_count</var>,
12*1031c584SApple OSS Distributions                 <strong>boolean_t</strong>                            <var>set_limit</var><strong>);</strong>
13*1031c584SApple OSS Distributions</pre>
14*1031c584SApple OSS Distributions<h3>PARAMETERS</h3>
15*1031c584SApple OSS Distributions<dl>
16*1031c584SApple OSS Distributions<p>
17*1031c584SApple OSS Distributions<dt> <var>thread</var>
18*1031c584SApple OSS Distributions<dd>
19*1031c584SApple OSS Distributions[in thread send right]
20*1031c584SApple OSS DistributionsThe thread scheduling policy is to be set.
21*1031c584SApple OSS Distributions<p>
22*1031c584SApple OSS Distributions<dt> <var>policy</var>
23*1031c584SApple OSS Distributions<dd>
24*1031c584SApple OSS Distributions[in scalar]
25*1031c584SApple OSS DistributionsPolicy to be set.  The values currently defined are <strong>POLICY_TIMESHARE</strong>,
26*1031c584SApple OSS Distributions<strong>POLICY_RR</strong> (round robin) and <strong>POLICY_FIFO</strong> (firstin, first-out).
27*1031c584SApple OSS Distributions<p>
28*1031c584SApple OSS Distributions<dt> <var>base</var>
29*1031c584SApple OSS Distributions<dd>
30*1031c584SApple OSS Distributions[pointer to in structure]
31*1031c584SApple OSS DistributionsBase scheduling policy specific data,
32*1031c584SApple OSS Distributions<strong>policy_fifo_base</strong>, <strong>policy_rr_base</strong> or <strong>policy_timeshare_base</strong>.
33*1031c584SApple OSS Distributions<p>
34*1031c584SApple OSS Distributions<dt> <var>base_count</var>
35*1031c584SApple OSS Distributions<dd>
36*1031c584SApple OSS Distributions[in scalar]
37*1031c584SApple OSS DistributionsThe size of the buffer (in natural-sized units).
38*1031c584SApple OSS Distributions<p>
39*1031c584SApple OSS Distributions<dt> <var>set_limit</var>
40*1031c584SApple OSS Distributions<dd>
41*1031c584SApple OSS Distributions[in scalar]
42*1031c584SApple OSS DistributionsTrue if the thread's scheduling limits should be restricted to
43*1031c584SApple OSS Distributionsallow no more service than specified by <var>base</var>.
44*1031c584SApple OSS Distributions</dl>
45*1031c584SApple OSS Distributions<h3>DESCRIPTION</h3>
46*1031c584SApple OSS Distributions<p>
47*1031c584SApple OSS DistributionsThe <strong>thread_policy</strong> function sets the scheduling policy
48*1031c584SApple OSS Distributionsto be applied to thread.  <var>policy</var> must be a scheduling policy
49*1031c584SApple OSS Distributionscurrently "enabled" for the thread's assigned processor set.
50*1031c584SApple OSS Distributions<h3>RETURN VALUES</h3>
51*1031c584SApple OSS Distributions<dl>
52*1031c584SApple OSS Distributions<p>
53*1031c584SApple OSS Distributions<dt> <strong>KERN_INVALID_POLICY</strong>
54*1031c584SApple OSS Distributions<dd>
55*1031c584SApple OSS DistributionsThe processor set to which <var>thread</var> is currently assigned does
56*1031c584SApple OSS Distributionsnot currently enable <var>policy</var>.
57*1031c584SApple OSS Distributions<p>
58*1031c584SApple OSS Distributions<dt> <strong>KERN_POLICY_LIMIT</strong>
59*1031c584SApple OSS Distributions<dd>
60*1031c584SApple OSS DistributionsThe specified scheduling attributes exceeds the thread's limits.
61*1031c584SApple OSS Distributions</dl>
62*1031c584SApple OSS Distributions<h3>RELATED INFORMATION</h3>
63*1031c584SApple OSS Distributions<p>
64*1031c584SApple OSS DistributionsFunctions:
65*1031c584SApple OSS Distributions<a href="P_set_policy_control.html"><strong>processor_set_policy_control</strong></a>,
66*1031c584SApple OSS Distributions<a href="thread_set_policy.html"><strong>thread_set_policy</strong></a>,
67*1031c584SApple OSS Distributions<a href="task_policy.html"><strong>task_policy</strong></a>,
68*1031c584SApple OSS Distributions<a href="task_set_policy.html"><strong>task_set_policy</strong></a>.
69*1031c584SApple OSS Distributions<p>
70*1031c584SApple OSS DistributionsData Structures:
71*1031c584SApple OSS Distributions<a href="policy_fifo_info.html"><strong>policy_fifo_info</strong></a>,
72*1031c584SApple OSS Distributions<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>,
73*1031c584SApple OSS Distributions<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>.
74