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