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