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