xref: /xnu-10002.41.9/osfmk/man/processor_set_default.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>processor_set_default</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Return the default processor set.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>kern_return_t	processor_set_default</strong>
8*699cd480SApple OSS Distributions		<strong>(host_t</strong>	<var>host</var>,
9*699cd480SApple OSS Distributions		<strong>processor_set_name_t</strong>	<var>default_set_name</var><strong>);</strong>
10*699cd480SApple OSS Distributions</pre>
11*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
12*699cd480SApple OSS Distributions<dl>
13*699cd480SApple OSS Distributions<dt> <var>host</var>
14*699cd480SApple OSS Distributions<dd>
15*699cd480SApple OSS Distributions[in host-name send right]
16*699cd480SApple OSS DistributionsThe name (or control) port for the host for
17*699cd480SApple OSS Distributionswhich the default processor set is desired.
18*699cd480SApple OSS Distributions<dt> <var>default_set_name</var>
19*699cd480SApple OSS Distributions<dd>
20*699cd480SApple OSS Distributions[out processor-set-name send right]
21*699cd480SApple OSS DistributionsThe returned name port for the
22*699cd480SApple OSS Distributionsdefault processor set.
23*699cd480SApple OSS Distributions</dl>
24*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
25*699cd480SApple OSS Distributions<p>
26*699cd480SApple OSS DistributionsThe <strong>processor_set_default</strong> function returns the name
27*699cd480SApple OSS Distributionsport for the default
28*699cd480SApple OSS Distributionsprocessor set for the specified host.  The default processor
29*699cd480SApple OSS Distributionsset is used by all threads,
30*699cd480SApple OSS Distributionstasks and processors that are not explicitly assigned to other sets.
31*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
32*699cd480SApple OSS Distributions<p>
33*699cd480SApple OSS DistributionsOnly generic errors apply.
34*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
35*699cd480SApple OSS Distributions<p>
36*699cd480SApple OSS DistributionsFunctions:
37*699cd480SApple OSS Distributions<a href="processor_set_info.html">processor_set_info</a>,
38*699cd480SApple OSS Distributions<a href="thread_assign.html">thread_assign</a>,
39*699cd480SApple OSS Distributions<a href="task_assign.html">task_assign</a>.
40