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