osfmk/man/host_processors.html

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