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