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