xref: /xnu-10002.41.9/osfmk/man/processor_set_max_priority.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>processor_set_max_priority</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Sets the maximum scheduling priority for a processor set.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>#include&lt mach/mach_host.h&gt</strong>
8*699cd480SApple OSS Distributions
9*699cd480SApple OSS Distributions<strong>kern_return_t	processor_set_max_priority</strong>
10*699cd480SApple OSS Distributions		<strong>(processor_set_t</strong>	<var>processor_set</var>,
11*699cd480SApple OSS Distributions		<strong>int</strong>	<var>priority</var>,
12*699cd480SApple OSS Distributions		<strong>boolean_t</strong>	<var>change_threads</var><strong>);</strong>
13*699cd480SApple OSS Distributions</pre>
14*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
15*699cd480SApple OSS Distributions<dl>
16*699cd480SApple OSS Distributions<dt> <var>processor_set</var>
17*699cd480SApple OSS Distributions<dd>
18*699cd480SApple OSS Distributions[in processor-set-control port] The control port for the processor set whose maximum scheduling priority is to be set.
19*699cd480SApple OSS Distributions<dt> <var>priority</var>
20*699cd480SApple OSS Distributions<dd>
21*699cd480SApple OSS Distributions[in scalar] The new priority for the processor set.
22*699cd480SApple OSS Distributions<dt> <var>change_threads</var>
23*699cd480SApple OSS Distributions<dd>
24*699cd480SApple OSS Distributions[in scalar] True if the maximum priority of existing threads assigned to this processor set should also be changed.
25*699cd480SApple OSS Distributions</dl>
26*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
27*699cd480SApple OSS Distributions<p>
28*699cd480SApple OSS DistributionsThe <strong>processor_set_max_priority</strong>
29*699cd480SApple OSS Distributionsfunction sets the maximum scheduling <var>priority</var> for
30*699cd480SApple OSS Distributions<var>processor_set</var>. The maximum <var>priority</var> of a
31*699cd480SApple OSS Distributionsprocessor set is used only when creating new threads. A new thread's
32*699cd480SApple OSS Distributionsmaximum <var>priority</var> is set to that of its assigned processor
33*699cd480SApple OSS Distributionsset. When assigned to a processor set, a thread's maximum
34*699cd480SApple OSS Distributions<var>priority</var> is reduced, if necessary, to that of its new
35*699cd480SApple OSS Distributionsprocessor set; its current <var>priority</var> is also reduced, as
36*699cd480SApple OSS Distributionsneeded. Changing the maximum <var>priority</var> of a processor set
37*699cd480SApple OSS Distributionsdoes not affect the <var>priority</var> of the currently assigned
38*699cd480SApple OSS Distributionsthreads unless <var>change_threads</var> is TRUE. If this
39*699cd480SApple OSS Distributions<var>priority</var> change violates the maximum <var>priority</var> of
40*699cd480SApple OSS Distributionssome threads, their maximum priorities will be reduced to match.
41*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
42*699cd480SApple OSS Distributions<p>
43*699cd480SApple OSS DistributionsOnly generic errors apply.
44*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
45*699cd480SApple OSS Distributions<p>
46*699cd480SApple OSS DistributionsFunctions:
47*699cd480SApple OSS Distributions<a href="thread_assign.html">thread_assign</a>.
48