osfmk/man/processor_info.html

   1 <h2>processor_info</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return information about a processor.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   processor_info</strong>
   8                 <strong>(processor_t</strong>   <var>processor</var>,
   9                 <strong>processor_flavor_t</strong>     <var>flavor</var>,
  10                 <strong>host_t</strong> <var>host</var>,
  11                 <strong>processor_info_t</strong>       <var>processor_info</var>,
  12                 <strong>mach_msg_type_number_t</strong> <var>processor_info_count</var><strong>);</strong>
  13 </pre>
  14 <h3>PARAMETERS</h3>
  15 <dl>
  16 <dt> <var>processor</var>
  17 <dd>
  18 [in processor send right]
  19 A processor port for which information is
  20 desired.
  21 <dt> <var>flavor</var>
  22 <dd>
  23 [in scalar]
  24 The type of information requested.
  25 <dl>
  26 <dt> <strong>PROCESSOR_BASIC_INFO</strong>
  27 <dd>
  28 Basic information, slot number, running status, etc.  The
  29 returned structure is <strong>processor_basic_info</strong>.
  30 </dl>
  31 <dt> <var>host</var>
  32 <dd>
  33 [out host-name send right]
  34 The host on which the processor resides.
  35 This is the host name port.
  36 <dt> <var>processor_info</var>
  37 <dd>
  38 [out structure]
  39 Information about the processor.
  40 <dt> <var>processor_info_count</var>
  41 <dd>
  42 [in/out scalar]
  43 On input, the maximum size of the buffer; on output, the
  44 size returned (in natural-sized units).
  45 </dl>
  46 <h3>DESCRIPTION</h3>
  47 <p>
  48 The <strong>processor_info</strong> function returns selected information
  49 for a processor, as specified by <var>flavor</var>.
  50 <h3>RETURN VALUES</h3>
  51 <p>
  52 Only generic errors apply.
  53 <h3>RELATED INFORMATION</h3>
  54 <p>
  55 Functions:
  56 <a href="processor_start.html">processor_start</a>,
  57 <a href="processor_exit.html">processor_exit</a>,
  58 <a href="processor_control.html">processor_control</a>,
  59 <a href="host_processors.html">host_processors</a>.
  60 <p>
  61 Data Structures:
  62 <a href="processor_basic_info.html">processor_basic_info</a>.