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