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