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