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