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