xref: /xnu-8796.141.3/osfmk/man/host_processor_sets.html (revision 1b191cb58250d0705d8a51287127505aa4bc0789)
1*1b191cb5SApple OSS Distributions<h2>host_processor_sets</h2>
2*1b191cb5SApple OSS Distributions<hr>
3*1b191cb5SApple OSS Distributions<p>
4*1b191cb5SApple OSS Distributions<strong>Function</strong> - Return a list of send rights representing all processor set name ports.
5*1b191cb5SApple OSS Distributions
6*1b191cb5SApple OSS Distributions<h3>SYNOPSIS</h3>
7*1b191cb5SApple OSS Distributions<pre>
8*1b191cb5SApple OSS Distributions<strong>kern_return_t   host_processor_sets</strong>
9*1b191cb5SApple OSS Distributions                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
10*1b191cb5SApple OSS Distributions                 <strong>processor_set_name_port_array_t</strong><var>processor_set_name_list</var>,
11*1b191cb5SApple OSS Distributions                 <strong>host_priv</strong>             <var>processor_set_name_count</var><strong>);</strong>
12*1b191cb5SApple OSS Distributions</pre>
13*1b191cb5SApple OSS Distributions<h3>PARAMETERS</h3>
14*1b191cb5SApple OSS Distributions<dl>
15*1b191cb5SApple OSS Distributions<p>
16*1b191cb5SApple OSS Distributions<dt> <var>host_priv</var>
17*1b191cb5SApple OSS Distributions<dd>
18*1b191cb5SApple OSS Distributions[in host-control send right]
19*1b191cb5SApple OSS DistributionsThe control port for the host for which the
20*1b191cb5SApple OSS Distributionsprocessor sets are desired.
21*1b191cb5SApple OSS Distributions<p>
22*1b191cb5SApple OSS Distributions<dt> <var>processor_set_name_list</var>
23*1b191cb5SApple OSS Distributions<dd>
24*1b191cb5SApple OSS Distributions[out pointer to dynamic array of processor-set-name send rights]
25*1b191cb5SApple OSS DistributionsThe
26*1b191cb5SApple OSS Distributionsset of processor set name ports for those currently existing on
27*1b191cb5SApple OSS Distributions<var>host_priv</var>; no particular order is guaranteed.
28*1b191cb5SApple OSS Distributions<p>
29*1b191cb5SApple OSS Distributions<dt> <var>processor_set_name_count</var>
30*1b191cb5SApple OSS Distributions<dd>
31*1b191cb5SApple OSS Distributions[out scalar]
32*1b191cb5SApple OSS DistributionsThe number of processor set names returned.
33*1b191cb5SApple OSS Distributions</dl>
34*1b191cb5SApple OSS Distributions<h3>DESCRIPTION</h3>
35*1b191cb5SApple OSS Distributions<p>
36*1b191cb5SApple OSS DistributionsThe <strong>host_processor_sets</strong> function returns send rights
37*1b191cb5SApple OSS Distributionsfor the name ports for
38*1b191cb5SApple OSS Distributionseach processor set currently existing on host.
39*1b191cb5SApple OSS Distributions<h3>NOTES</h3>
40*1b191cb5SApple OSS Distributions<p>
41*1b191cb5SApple OSS DistributionsIf control ports to the processor sets are needed, use
42*1b191cb5SApple OSS Distributions<strong>host_processor_set_priv</strong>.
43*1b191cb5SApple OSS Distributions<h3>RETURN VALUES</h3>
44*1b191cb5SApple OSS Distributions<p>
45*1b191cb5SApple OSS DistributionsOnly generic errors apply.
46*1b191cb5SApple OSS Distributions<h3>RELATED INFORMATION</h3>
47*1b191cb5SApple OSS Distributions<p>
48*1b191cb5SApple OSS DistributionsFunctions:
49*1b191cb5SApple OSS Distributions<a href="host_processor_set_priv.html"><strong>host_processor_set_priv</strong></a>,
50*1b191cb5SApple OSS Distributions<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
51*1b191cb5SApple OSS Distributions<a href="processor_set_tasks.html"><strong>processor_set_tasks</strong></a>,
52*1b191cb5SApple OSS Distributions<a href="processor_set_threads.html"><strong>processor_set_threads</strong></a>.
53