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