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