osfmk/man/host_statistics.html

   1 <h2>host_statistics</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return statistics for a host.<h3>SYNOPSIS</h3>
   5 <pre>
   6 <strong>kern_return_t   host_statistics</strong>
   7                 <strong>(host_priv_t</strong>                          <var>host_priv</var>,
   8                  <strong>host_flavor_t</strong>                           <var>flavor</var>,
   9                  <strong>host_info_t</strong>                          <var>host_info</var>,
  10                  <strong>mach_msg_type_number_t</strong>         <var>host_info_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 host for which
  19 information is to be obtained.
  20 <p>
  21 <dt> <var>flavor</var>
  22 <dd>
  23 [in scalar]
  24 The type of statistics desired.
  25 <dl>
  26 <p>
  27 <dt> <strong>HOST_LOAD_INFO</strong>
  28 <dd>
  29 System loading statistics.  The returned structure is
  30 <strong>host_load_info</strong>.
  31 <p>
  32 <dt> <strong>HOST_VM_INFO</strong>
  33 <dd>
  34 Virtual memory statistics.  The returned structure is
  35 <strong>vm_statistics</strong>.
  36 </dl>
  37 <p>
  38 <dt> <var>host_info</var>
  39 <dd>
  40 [out structure]
  41 Statistics about the specified host.
  42 <p>
  43 <dt> <var>host_info_count</var>
  44 <dd>
  45 [in/out scalar]
  46 On input, the maximum size of the buffer; on output, the
  47 size returned (in natural-sized units).
  48 </dl>
  49 <h3>DESCRIPTION</h3>
  50 <p>
  51 The <strong>host_statistics</strong> function returns scheduling and
  52 virtual memory statistics
  53 concerning the host as specified by <var>flavor</var>.
  54 <h3>RETURN VALUES</h3>
  55 <p>
  56 Only generic errors apply.
  57 <h3>RELATED INFORMATION</h3>
  58 <p>
  59 Functions:
  60 <a href="host_info.html"><strong>host_info</strong></a>,
  61 <a href="processor_set_statistics.html"><strong>processor_set_statistics</strong></a>.
  62 <p>
  63 Data Structures:
  64 <a href="host_load_info.html"><strong>host_load_info</strong></a>,
  65 <a href="vm_statistics.html"><strong>vm_statistics</strong></a>.