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