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