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