xref: /xnu-10002.41.9/osfmk/man/P_set_policy_enable.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>processor_set_policy_enable</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Enables a scheduling policy for a processor set.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>#include&lt mach/mach_host.h&gt</strong>
8*699cd480SApple OSS Distributions
9*699cd480SApple OSS Distributions<strong>kern_return_t	processor_set_policy_enable</strong>
10*699cd480SApple OSS Distributions		<strong>(processor_set_t</strong>	<var>processor_set</var>,
11*699cd480SApple OSS Distributions		<strong>int</strong>	<var>policy</var><strong>);</strong>
12*699cd480SApple OSS Distributions</pre>
13*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
14*699cd480SApple OSS Distributions<dl>
15*699cd480SApple OSS Distributions<dt> <var>processor_set</var>
16*699cd480SApple OSS Distributions<dd>
17*699cd480SApple OSS Distributions[in processor-set-control port] The control port for the processor set for which a scheduling policy is to be enabled.
18*699cd480SApple OSS Distributions<dt> <var>policy</var>
19*699cd480SApple OSS Distributions<dd>
20*699cd480SApple OSS Distributions[in scalar] Policy to be enabled. The values currently defined are POLICY_TIMESHARE and POLICY_FIXEDPRI.
21*699cd480SApple OSS Distributions</dl>
22*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
23*699cd480SApple OSS Distributions<p>
24*699cd480SApple OSS DistributionsThe <strong>processor_set_policy_enable</strong>
25*699cd480SApple OSS Distributionsfunction extends the set of scheduling policies allowed for
26*699cd480SApple OSS Distributions<var>processor_set</var>. The set of scheduling policies allowed for a
27*699cd480SApple OSS Distributionsprocessor set is the set of policies allowed to be set for threads
28*699cd480SApple OSS Distributionsassigned to that processor set. The current set of permitted policies
29*699cd480SApple OSS Distributionscan be obtained from <strong>processor_set_info</strong>.
30*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
31*699cd480SApple OSS Distributions<p>
32*699cd480SApple OSS DistributionsOnly generic errors apply.
33*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
34*699cd480SApple OSS Distributions<p>
35*699cd480SApple OSS DistributionsFunctions:
36*699cd480SApple OSS Distributions<a href="processor_set_info.html">processor_set_info</a>,
37*699cd480SApple OSS Distributions<a href="P_set_policy_disable.html">processor_set_policy_disable</a>,
38*699cd480SApple OSS Distributions<a href="thread_policy.html">thread_policy</a>.
39