xref: /xnu-10002.1.13/osfmk/man/P_set_policy_disable.html (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions<h2>processor_set_policy_disable</h2>
2*1031c584SApple OSS Distributions<hr>
3*1031c584SApple OSS Distributions<p>
4*1031c584SApple OSS Distributions<strong>Function</strong> - Disables a scheduling policy for a processor set.
5*1031c584SApple OSS Distributions<h3>SYNOPSIS</h3>
6*1031c584SApple OSS Distributions<pre>
7*1031c584SApple OSS Distributions<strong>#include&lt mach/mach_host.h&gt</strong>
8*1031c584SApple OSS Distributions
9*1031c584SApple OSS Distributions<strong>kern_return_t	processor_set_policy_disable</strong>
10*1031c584SApple OSS Distributions		<strong>(processor_set_t</strong>	<var>processor_set</var>,
11*1031c584SApple OSS Distributions		<strong>int</strong>	<var>policy</var>,
12*1031c584SApple OSS Distributions		<strong>boolean_t</strong>	<var>change_threads</var><strong>);</strong>
13*1031c584SApple OSS Distributions</pre>
14*1031c584SApple OSS Distributions<h3>PARAMETERS</h3>
15*1031c584SApple OSS Distributions<dl>
16*1031c584SApple OSS Distributions<dt> <var>processor_set</var>
17*1031c584SApple OSS Distributions<dd>
18*1031c584SApple OSS Distributions[in processor-set-control port] The control port for the processor set for which a scheduling policy is to be disabled.
19*1031c584SApple OSS Distributions<dt> <var>policy</var>
20*1031c584SApple OSS Distributions<dd>
21*1031c584SApple OSS Distributions[in scalar] Policy to be disabled. The values currently defined are POLICY_TIMESHARE and POLICY_FIXEDPRI.
22*1031c584SApple OSS Distributions<dt> <var>change_threads</var>
23*1031c584SApple OSS Distributions<dd>
24*1031c584SApple OSS Distributions[in scalar] If true, causes the scheduling policy for all threads currently running with policy to POLICY_TIMESHARE.
25*1031c584SApple OSS Distributions</dl>
26*1031c584SApple OSS Distributions<h3>DESCRIPTION</h3>
27*1031c584SApple OSS Distributions<p>
28*1031c584SApple OSS DistributionsThe <strong>processor_set_policy_disable</strong>
29*1031c584SApple OSS Distributionsfunction restricts the set of scheduling policies allowed for
30*1031c584SApple OSS Distributions<var>processor_set</var>. The set of scheduling policies allowed for a
31*1031c584SApple OSS Distributionsprocessor set is the set of policies allowed to be set for threads
32*1031c584SApple OSS Distributionsassigned to that processor set. The current set of permitted policies
33*1031c584SApple OSS Distributionscan be obtained from <strong>processor_set_info</strong>. Timesharing may
34*1031c584SApple OSS Distributionsnot be forbidden for any processor set. This is a compromise to reduce
35*1031c584SApple OSS Distributionsthe complexity of the assign operation; any thread whose
36*1031c584SApple OSS Distributions<var>policy</var> is forbidden by its target processor set has its
37*1031c584SApple OSS Distributions<var>policy</var> reset to timesharing. Disabling a scheduling
38*1031c584SApple OSS Distributions<var>policy</var> for a processor set has no effect on threads
39*1031c584SApple OSS Distributionscurrently assigned to that processor set unless
40*1031c584SApple OSS Distributions<var>change_threads</var> is TRUE, in which case their policies will
41*1031c584SApple OSS Distributionsbe reset to timesharing.
42*1031c584SApple OSS Distributions<h3>RETURN VALUES</h3>
43*1031c584SApple OSS Distributions<p>
44*1031c584SApple OSS DistributionsOnly generic errors apply.
45*1031c584SApple OSS Distributions<h3>RELATED INFORMATION</h3>
46*1031c584SApple OSS Distributions<p>
47*1031c584SApple OSS DistributionsFunctions:
48*1031c584SApple OSS Distributions<a href="P_set_policy_enable.html">processor_set_policy_enable</a>,
49*1031c584SApple OSS Distributions<a href="processor_set_info.html">processor_set_info</a>,
50*1031c584SApple OSS Distributions<a href="thread_policy.html">thread_policy</a>.
51