osfmk/man/processor_set_statistics.html

   1 <h2>processor_set_statistics</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return scheduling statistics for a processor set.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   processor_set_statistics</strong>
   8                 <strong>(processor_set_t</strong>       <var>processor_set_control</var>,
   9                 <strong>processor_set_flavor_t</strong> <var>flavor</var>,
  10                 <strong>processor_set_info_t</strong>   <var>processor_set_info</var>,
  11                 <strong>mach_msg_type_number_t</strong> <var>processor_set_info_count</var><strong>);</strong>
  12 </pre>
  13 <h3>PARAMETERS</h3>
  14 <dl>
  15 <dt> <var>processor_set_control</var>
  16 <dd>
  17 [in processor-set-control send right]
  18 A processor set control port for
  19 which information is desired.
  20 <dt> <var>flavor</var>
  21 <dd>
  22 [in scalar]
  23 The type of information requested.
  24 <dl>
  25 <dt> <strong>PROCESSOR_SET_LOAD_INFO</strong>
  26 <dd>
  27 Load statistics for the processor set.  The returned structure is
  28 <strong>processor_set_load_info</strong>.
  29 </dl>
  30 <dt> <var>processor_set_info</var>
  31 <dd>
  32 [out structure]
  33 Information about the processor set.
  34 <dt> <var>processor_set_info_count</var>
  35 <dd>
  36 [in/out scalar]
  37 On input, the maximum size of the buffer; on output, the
  38 size returned (in natural-sized units).
  39 </dl>
  40 <h3>DESCRIPTION</h3>
  41 <p>
  42 The <strong>processor_set_statistics</strong> function returns statistics
  43 for a processor set as specified by <var>flavor</var>.
  44 <h3>RETURN VALUES</h3>
  45 <p>
  46 Only generic errors apply.
  47 <h3>RELATED INFORMATION</h3>
  48 <p>
  49 Functions:
  50 <a href="processor_set_info.html">processor_set_info</a>.
  51 <p>
  52 Data Structures:
  53 <a href="processor_set_load_info.html">processor_set_load_info</a>.