xnu-4903.221.2.tar.gz

[apple/xnu.git] / osfmk / man / P_set_policy_enable.html

<h2>processor_set_policy_enable</h2>
<hr>
<p>
<strong>Function</strong> - Enables a scheduling policy for a processor set.
<h3>SYNOPSIS</h3>
<pre>
<strong>#include&lt mach/mach_host.h&gt</strong>

<strong>kern_return_t	processor_set_policy_enable</strong>
		<strong>(processor_set_t</strong>	<var>processor_set</var>,
		<strong>int</strong>	<var>policy</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<dt> <var>processor_set</var>
<dd>
[in processor-set-control port] The control port for the processor set for which a scheduling policy is to be enabled.
<dt> <var>policy</var>
<dd>
[in scalar] Policy to be enabled. The values currently defined are POLICY_TIMESHARE and POLICY_FIXEDPRI.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>processor_set_policy_enable</strong>
function extends the set of scheduling policies allowed for
<var>processor_set</var>. The set of scheduling policies allowed for a
processor set is the set of policies allowed to be set for threads
assigned to that processor set. The current set of permitted policies
can be obtained from <strong>processor_set_info</strong>.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="processor_set_info.html">processor_set_info</a>,
<a href="P_set_policy_disable.html">processor_set_policy_disable</a>,
<a href="thread_policy.html">thread_policy</a>.