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