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