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