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