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