xref: /xnu-10002.61.3/osfmk/man/P_set_policy_control.html (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1*0f4c859eSApple OSS Distributions<h2>processor_set_policy_control</h2>
2*0f4c859eSApple OSS Distributions<hr>
3*0f4c859eSApple OSS Distributions<p>
4*0f4c859eSApple OSS Distributions<strong>Function</strong> - Set target processor set's scheduling policy state.
5*0f4c859eSApple OSS Distributions<h3>SYNOPSIS</h3>
6*0f4c859eSApple OSS Distributions<pre>
7*0f4c859eSApple OSS Distributions<strong>kern_return_t	processor_set_policy_control</strong>
8*0f4c859eSApple OSS Distributions		<strong>(processor_set_t</strong>	<var>processor_set_control</var>,
9*0f4c859eSApple OSS Distributions		<strong>processor_set_flavor_t</strong>	<var>flavor</var>,
10*0f4c859eSApple OSS Distributions		<strong>processor_set_info_t</strong>	<var>policy_info</var>,
11*0f4c859eSApple OSS Distributions		<strong>mach_msg_type_number_t*</strong>	<var>policy_info_count</var>,
12*0f4c859eSApple OSS Distributions		<strong>boolean_t</strong>	<var>change_tasks_threads</var><strong>);</strong>
13*0f4c859eSApple OSS Distributions</pre>
14*0f4c859eSApple OSS Distributions<h3>PARAMETERS</h3>
15*0f4c859eSApple OSS Distributions<dl>
16*0f4c859eSApple OSS Distributions<dt> <var>processor_set_control</var>
17*0f4c859eSApple OSS Distributions<dd>
18*0f4c859eSApple OSS Distributions[in processor-set-control send right]
19*0f4c859eSApple OSS DistributionsA processor set control port.
20*0f4c859eSApple OSS Distributions<dt> <var>flavor</var>
21*0f4c859eSApple OSS Distributions<dd>
22*0f4c859eSApple OSS Distributions[in scalar]
23*0f4c859eSApple OSS DistributionsThe type of policy change to make.
24*0f4c859eSApple OSS Distributions<dl>
25*0f4c859eSApple OSS Distributions<dt> <strong>PROCESSOR_SET_TIMESHARE_DEFAULT</strong>
26*0f4c859eSApple OSS Distributions<dd>
27*0f4c859eSApple OSS DistributionsChange the base attributes for the timeshare scheduling
28*0f4c859eSApple OSS Distributionspolicy, making timeshare the default policy.  The structure is
29*0f4c859eSApple OSS Distributions<strong>policy_timeshare_base</strong>.
30*0f4c859eSApple OSS Distributions<dt> <strong>PROCESSOR_SET_FIFO_DEFAULT</strong>
31*0f4c859eSApple OSS Distributions<dd>
32*0f4c859eSApple OSS DistributionsChange the base attributes for the FIFO (first-in, first-out)
33*0f4c859eSApple OSS Distributionsscheduling policy, making FIFO the default policy.  The
34*0f4c859eSApple OSS Distributionsstructure is <strong>policy_fifo_base</strong>.
35*0f4c859eSApple OSS Distributions<dt> <strong>PROCESSOR_SET_RR_DEFAULT</strong>
36*0f4c859eSApple OSS Distributions<dd>
37*0f4c859eSApple OSS DistributionsChanged the base attributes for the round-robin scheduling
38*0f4c859eSApple OSS Distributionspolicy, making round robin the default policy.  The structure is
39*0f4c859eSApple OSS Distributions<strong>policy_rr_base</strong>.
40*0f4c859eSApple OSS Distributions<dt> <strong>PROCESSOR_SET_TIMESHARE_LIMITS</strong>
41*0f4c859eSApple OSS Distributions<dd>
42*0f4c859eSApple OSS DistributionsChange the limits on the allowed timeshare policy attributes.
43*0f4c859eSApple OSS DistributionsThe structure is defined by <strong>policy_timeshare_limit</strong>.
44*0f4c859eSApple OSS Distributions<dt> <strong>PROCESSOR_SET_RR_LIMITS</strong>
45*0f4c859eSApple OSS Distributions<dd>
46*0f4c859eSApple OSS DistributionsChange the limits on the allowed round robin policy
47*0f4c859eSApple OSS Distributionsattributes.  The structure is defined by <strong>policy_rr_limit</strong>.
48*0f4c859eSApple OSS Distributions<dt> <strong>PROCESSOR_SET_FIFO_LIMITS</strong>
49*0f4c859eSApple OSS Distributions<dd>
50*0f4c859eSApple OSS DistributionsChange the limits on the allowed first-in, first-out policy
51*0f4c859eSApple OSS Distributionsattributes.  The structure is defined by <strong>policy_fifo_limit</strong>.
52*0f4c859eSApple OSS Distributions<dt> <strong>PROCESSOR_SET_ENABLED_POLICIES</strong>
53*0f4c859eSApple OSS Distributions<dd>
54*0f4c859eSApple OSS DistributionsChange the set of enabled policies.  The data is a bit-vector.
55*0f4c859eSApple OSS Distributions</dl>
56*0f4c859eSApple OSS Distributions<dt> <var>policy_info</var>
57*0f4c859eSApple OSS Distributions<dd>
58*0f4c859eSApple OSS Distributions[in structure]
59*0f4c859eSApple OSS DistributionsThe relevant policy information.
60*0f4c859eSApple OSS Distributions<dt> <var>policy_info_count</var>
61*0f4c859eSApple OSS Distributions<dd>
62*0f4c859eSApple OSS Distributions[in scalar]
63*0f4c859eSApple OSS DistributionsThe size of the buffer (in natural-sized units).
64*0f4c859eSApple OSS Distributions<dt> <var>change_tasks_threads</var>
65*0f4c859eSApple OSS Distributions<dd>
66*0f4c859eSApple OSS Distributions[in scalar]
67*0f4c859eSApple OSS DistributionsIf true, any assigned task or thread whose policy is no
68*0f4c859eSApple OSS Distributionslonger enabled or whose scheduling attributes exceed the current limits will
69*0f4c859eSApple OSS Distributionshave their limits adjusted or their policy set to the default as
70*0f4c859eSApple OSS Distributionsappropriate.
71*0f4c859eSApple OSS Distributions</dl>
72*0f4c859eSApple OSS Distributions<h3>DESCRIPTION</h3>
73*0f4c859eSApple OSS Distributions<p>
74*0f4c859eSApple OSS DistributionsThe <strong>processor_set_policy_control</strong> function controls
75*0f4c859eSApple OSS Distributionsscheduling attributes governing the processor set.
76*0f4c859eSApple OSS Distributions<h3>RETURN VALUES</h3>
77*0f4c859eSApple OSS Distributions<p>
78*0f4c859eSApple OSS DistributionsOnly generic errors apply.
79*0f4c859eSApple OSS Distributions<h3>RELATED INFORMATION</h3>
80*0f4c859eSApple OSS Distributions<p>
81*0f4c859eSApple OSS DistributionsFunctions:
82*0f4c859eSApple OSS Distributions<a href="processor_set_statistics.html">processor_set_statistics</a>,
83*0f4c859eSApple OSS Distributions<a href="processor_set_create.html">processor_set_create</a>,
84*0f4c859eSApple OSS Distributions<a href="processor_set_default.html">processor_set_default</a>,
85*0f4c859eSApple OSS Distributions<a href="processor_assign.html">processor_assign</a>,
86*0f4c859eSApple OSS Distributions<a href="processor_set_info.html">processor_set_info</a>.
87*0f4c859eSApple OSS Distributions<p>
88*0f4c859eSApple OSS DistributionsData Structures:
89*0f4c859eSApple OSS Distributions<a href="policy_timeshare_info.html">policy_timeshare_info</a>,
90*0f4c859eSApple OSS Distributions<a href="policy_rr_info.html">policy_rr_info</a>,
91*0f4c859eSApple OSS Distributions<a href="policy_fifo_info.html">policy_fifo_info</a>.
92