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

<h2>processor_set_policy_enable</h2>\r<hr>\r<p>\r<strong>Function</strong> - Enables a scheduling policy for a processor set.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>#include&lt mach/mach_host.h&gt</strong>\r\r<strong>kern_return_t	processor_set_policy_enable</strong>\r		<strong>(processor_set_t</strong>	<var>processor_set</var>,\r		<strong>int</strong>	<var>policy</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>processor_set</var>\r<dd>\r[in processor-set-control port] The control port for the processor set for which a scheduling policy is to be enabled.\r<dt> <var>policy</var>\r<dd>\r[in scalar] Policy to be enabled. The values currently defined are POLICY_TIMESHARE and POLICY_FIXEDPRI.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>processor_set_policy_enable</strong>\rfunction extends the set of scheduling policies allowed for\r<var>processor_set</var>. The set of scheduling policies allowed for a\rprocessor set is the set of policies allowed to be set for threads\rassigned to that processor set. The current set of permitted policies\rcan be obtained from <strong>processor_set_info</strong>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="processor_set_info.html">processor_set_info</a>,\r<a href="P_set_policy_disable.html">processor_set_policy_disable</a>,\r<a href="thread_policy.html">thread_policy</a>.\r