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