xref: /xnu-11215.41.3/osfmk/man/thread_set_policy.html (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1*33de042dSApple OSS Distributions<h2>thread_set_policy</h2>
2*33de042dSApple OSS Distributions<hr>
3*33de042dSApple OSS Distributions<p>
4*33de042dSApple OSS Distributions<strong>Function</strong> - Set target thread's scheduling policy state. (Protected Interface.)
5*33de042dSApple OSS Distributions<h3>SYNOPSIS</h3>
6*33de042dSApple OSS Distributions<pre>
7*33de042dSApple OSS Distributions<strong>kern_return_t   thread_set_policy</strong>
8*33de042dSApple OSS Distributions                <strong>(thread_act_t</strong>                            <var>thread</var>,
9*33de042dSApple OSS Distributions                 <strong>processor_set_t</strong>                  <var>processor_set</var>,
10*33de042dSApple OSS Distributions                 <strong>policy_t</strong>                                <var>policy</var>,
11*33de042dSApple OSS Distributions                 <strong>policy_base_t</strong>                             <var>base</var>,
12*33de042dSApple OSS Distributions                 <strong>mach_msg_type_number_t</strong>              <var>base_count</var>,
13*33de042dSApple OSS Distributions                 <strong>policy_limit_t</strong>                           <var>limit</var>,
14*33de042dSApple OSS Distributions                 <strong>mach_msg_type_number_</strong>              <var>limit_count</var><strong>);</strong>
15*33de042dSApple OSS Distributions</pre>
16*33de042dSApple OSS Distributions<h3>PARAMETERS</h3>
17*33de042dSApple OSS Distributions<dl>
18*33de042dSApple OSS Distributions<p>
19*33de042dSApple OSS Distributions<dt> <var>thread</var>
20*33de042dSApple OSS Distributions<dd>
21*33de042dSApple OSS Distributions[in thread send right]
22*33de042dSApple OSS DistributionsThe thread scheduling policy is to be set.
23*33de042dSApple OSS Distributions<p>
24*33de042dSApple OSS Distributions<dt> <var>processor_set</var>
25*33de042dSApple OSS Distributions<dd>
26*33de042dSApple OSS Distributions[in processor-set-control send right]
27*33de042dSApple OSS DistributionsThe control port for the processor
28*33de042dSApple OSS Distributionsset to which the thread is currently assigned.
29*33de042dSApple OSS Distributions<p>
30*33de042dSApple OSS Distributions<dt> <var>policy</var>
31*33de042dSApple OSS Distributions<dd>
32*33de042dSApple OSS Distributions[in scalar]
33*33de042dSApple OSS DistributionsPolicy to be set.  The values currently defined are <strong>POLICY_TIMESHARE</strong>,
34*33de042dSApple OSS Distributions<strong>POLICY_RR</strong> (round robin) and <strong>POLICY_FIFO</strong> (firstin, first-out).
35*33de042dSApple OSS Distributions<p>
36*33de042dSApple OSS Distributions<dt> <var>base</var>
37*33de042dSApple OSS Distributions<dd>
38*33de042dSApple OSS Distributions[pointer to in structure]
39*33de042dSApple OSS DistributionsBase policy specific data, <strong>policy_fifo_base</strong>,
40*33de042dSApple OSS Distributions<strong>policy_rr_base</strong> or <strong>policy_timeshare_base</strong>.
41*33de042dSApple OSS Distributions<p>
42*33de042dSApple OSS Distributions<dt> <var>base_count</var>
43*33de042dSApple OSS Distributions<dd>
44*33de042dSApple OSS Distributions[in scalar]
45*33de042dSApple OSS DistributionsThe size of the buffer (in natural-sized units).
46*33de042dSApple OSS Distributions<p>
47*33de042dSApple OSS Distributions<dt> <var>limit</var>
48*33de042dSApple OSS Distributions<dd>
49*33de042dSApple OSS Distributions[pointer to in structure]
50*33de042dSApple OSS DistributionsPolicy specific limits, <strong>policy_fifo_limit</strong>,
51*33de042dSApple OSS Distributions<strong>policy_rr_limit</strong> or <strong>policy_timeshare_limit</strong>.
52*33de042dSApple OSS Distributions<p>
53*33de042dSApple OSS Distributions<dt> <var>limit_count</var>
54*33de042dSApple OSS Distributions<dd>
55*33de042dSApple OSS Distributions[in scalar]
56*33de042dSApple OSS DistributionsThe size of the buffer (in natural-sized units).
57*33de042dSApple OSS Distributions</dl>
58*33de042dSApple OSS Distributions<h3>DESCRIPTION</h3>
59*33de042dSApple OSS Distributions<p>
60*33de042dSApple OSS DistributionsThe <strong>thread_set_policy</strong> function sets the scheduling
61*33de042dSApple OSS Distributionsattributes, both base and limit, for <var>thread</var>.
62*33de042dSApple OSS Distributions<var>policy</var> may be any policy implemented by the processor set
63*33de042dSApple OSS Distributionswhether or not it is enabled.
64*33de042dSApple OSS Distributions<h3>RETURN VALUES</h3>
65*33de042dSApple OSS Distributions<dl>
66*33de042dSApple OSS Distributions<p>
67*33de042dSApple OSS Distributions<dt> <strong>KERN_INVALID_PROCESSOR_SET</strong>
68*33de042dSApple OSS Distributions<dd>
69*33de042dSApple OSS Distributions<var>processor_set</var> is not the thread's processor set control port.
70*33de042dSApple OSS Distributions</dl>
71*33de042dSApple OSS Distributions<h3>RELATED INFORMATION</h3>
72*33de042dSApple OSS Distributions<p>
73*33de042dSApple OSS DistributionsFunctions:
74*33de042dSApple OSS Distributions<a href="P_set_policy_control.html"><strong>processor_set_policy_control</strong></a>,
75*33de042dSApple OSS Distributions<a href="thread_policy.html"><strong>thread_policy</strong></a>,
76*33de042dSApple OSS Distributions<a href="task_policy.html"><strong>task_policy</strong></a>,
77*33de042dSApple OSS Distributions<a href="task_set_policy.html"><strong>task_set_policy</strong></a>.
78*33de042dSApple OSS Distributions<p>
79*33de042dSApple OSS DistributionsData Structures:
80*33de042dSApple OSS Distributions<a href="policy_fifo_info.html"><strong>policy_fifo_info</strong></a>,
81*33de042dSApple OSS Distributions<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>,
82*33de042dSApple OSS Distributions<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>.
83