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

<h2>processor_set_max_priority</h2>\r<hr>\r<p>\r<strong>Function</strong> - Sets the maximum scheduling priority 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_max_priority</strong>\r		<strong>(processor_set_t</strong>	<var>processor_set</var>,\r		<strong>int</strong>	<var>priority</var>,\r		<strong>boolean_t</strong>	<var>change_threads</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 whose maximum scheduling priority is to be set.\r<dt> <var>priority</var>\r<dd>\r[in scalar] The new priority for the processor set.\r<dt> <var>change_threads</var>\r<dd>\r[in scalar] True if the maximum priority of existing threads assigned to this processor set should also be changed.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>processor_set_max_priority</strong>\rfunction sets the maximum scheduling <var>priority</var> for\r<var>processor_set</var>. The maximum <var>priority</var> of a\rprocessor set is used only when creating new threads. A new thread's\rmaximum <var>priority</var> is set to that of its assigned processor\rset. When assigned to a processor set, a thread's maximum\r<var>priority</var> is reduced, if necessary, to that of its new\rprocessor set; its current <var>priority</var> is also reduced, as\rneeded. Changing the maximum <var>priority</var> of a processor set\rdoes not affect the <var>priority</var> of the currently assigned\rthreads unless <var>change_threads</var> is TRUE. If this\r<var>priority</var> change violates the maximum <var>priority</var> of\rsome threads, their maximum priorities will be reduced to match.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="thread_assign.html">thread_assign</a>.\r