xref: /xnu-10002.1.13/osfmk/man/host_processors.html (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions<h2>host_processors</h2>
2*1031c584SApple OSS Distributions<hr>
3*1031c584SApple OSS Distributions<p>
4*1031c584SApple OSS Distributions<strong>Function</strong> - Return a list of send rights representing all processor ports.
5*1031c584SApple OSS Distributions<h3>SYNOPSIS</h3>
6*1031c584SApple OSS Distributions<pre>
7*1031c584SApple OSS Distributions<strong>kern_return_t   host_processors</strong>
8*1031c584SApple OSS Distributions                <strong>(host_t</strong>                               <var>host_priv</var>,
9*1031c584SApple OSS Distributions                 <strong>processor_port_array_t</strong>          <var>processor_list</var>,
10*1031c584SApple OSS Distributions                 <strong>host_priv</strong>                      <var>processor_count</var><strong>);</strong>
11*1031c584SApple OSS Distributions</pre>
12*1031c584SApple OSS Distributions<h3>PARAMETERS</h3>
13*1031c584SApple OSS Distributions<dl>
14*1031c584SApple OSS Distributions<p>
15*1031c584SApple OSS Distributions<dt> <var>host_priv</var>
16*1031c584SApple OSS Distributions<dd>
17*1031c584SApple OSS Distributions[in host-control send right]
18*1031c584SApple OSS DistributionsThe control port for the desired host.
19*1031c584SApple OSS Distributions<p>
20*1031c584SApple OSS Distributions<dt> <var>processor_list</var>
21*1031c584SApple OSS Distributions<dd>
22*1031c584SApple OSS Distributions[out pointer to dynamic array of processor send rights]
23*1031c584SApple OSS DistributionsThe set of
24*1031c584SApple OSS Distributionsprocessors existing on <var>host_priv</var>; no particular order is guaranteed.
25*1031c584SApple OSS Distributions<p>
26*1031c584SApple OSS Distributions<dt> <var>processor_count</var>
27*1031c584SApple OSS Distributions<dd>
28*1031c584SApple OSS Distributions[out scalar]
29*1031c584SApple OSS DistributionsThe number of ports returned in <var>processor_list</var>.
30*1031c584SApple OSS Distributions</dl>
31*1031c584SApple OSS Distributions<h3>DESCRIPTION</h3>
32*1031c584SApple OSS Distributions<p>
33*1031c584SApple OSS DistributionsThe <strong>host_processors</strong> function returns an array of send
34*1031c584SApple OSS Distributionsright ports for each
35*1031c584SApple OSS Distributionsprocessor existing on <var>host_priv</var>.
36*1031c584SApple OSS Distributions<h3>RETURN VALUES</h3>
37*1031c584SApple OSS Distributions<p>
38*1031c584SApple OSS DistributionsOnly generic errors apply.
39*1031c584SApple OSS Distributions<h3>RELATED INFORMATION</h3>
40*1031c584SApple OSS Distributions<p>
41*1031c584SApple OSS DistributionsFunctions:
42*1031c584SApple OSS Distributions<a href="processor_start.html"><strong>processor_start</strong></a>,
43*1031c584SApple OSS Distributions<a href="processor_exit.html"><strong>processor_exit</strong></a>,
44*1031c584SApple OSS Distributions<a href="processor_info.html"><strong>processor_info</strong></a>,
45*1031c584SApple OSS Distributions<a href="processor_control.html"><strong>processor_control</strong></a>,
46*1031c584SApple OSS Distributions<a href="host_processor_slots.html"><strong>host_processor_slots</strong></a>.
47