osfmk/man/host_processor_slots.html

   1 <h2>host_processor_slots</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return a list of numbers that map processor slots to active processors.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   host_processor_slots</strong>
   8                 <strong>(host_t</strong>                                    <var>host</var>,
   9                  <strong>processor_slot_t</strong>                         <var>slots</var>,
  10                  <strong>host</strong>                                     <var>count</var><strong>);</strong>
  11 </pre>
  12 <h3>PARAMETERS</h3>
  13 <dl>
  14 <p>
  15 <dt> <var>host</var>
  16 <dd>
  17 [in host-name send right]
  18 The name (or control) port for the host for
  19 which information is to be obtained.
  20 <p>
  21 <dt> <var>slots</var>
  22 <dd>
  23 [out array of <var>processor_slot_t</var>]
  24 An array of the processor slot numbers
  25 for active processors.
  26 <p>
  27 <dt> <var>count</var>
  28 <dd>
  29 [pointer to in/out scalar]
  30 On input, the maximum size of the slots
  31 buffer; on output, the number of returned slot numbers.
  32 </dl>
  33 <h3>DESCRIPTION</h3>
  34 <p>
  35 The <strong>host_processor_slots</strong> function returns an array
  36 of the processor slots
  37 defined for the host.
  38 <h3>RETURN VALUES</h3>
  39 <p>
  40 Only generic errors apply.
  41 <h3>RELATED INFORMATION</h3>
  42 <p>
  43 Functions:
  44 <a href="host_info.html"><strong>host_info</strong></a>,
  45 <a href="host_processors.html"><strong>host_processors</strong></a>,
  46 <a href="processor_info.html"><strong>processor_info</strong></a>.