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