osfmk/man/host_load_info.html

   1 <h2>host_load_info</h2>
   2 <hr>
   3 <p>
   4 <strong>Structure</strong> - Used to present a host's processor load information.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>#define CPU_STATE_USER     0</strong>
   8
   9 <strong>#define CPU_STATE_SYSTEM   1</strong>
  10
  11 <strong>#define CPU_STATE_IDLE     2</strong>
  12
  13 <strong>struct host_load_info</strong>
  14 <strong>{</strong>
  15        <strong>integer_t</strong>        <var>avenrun</var><strong>[3];</strong>
  16        <strong>integer_t</strong>    <var>mach_factor</var><strong>[3];</strong>
  17 <strong>};</strong>
  18
  19 <strong>typedef struct host_load_info* host_load_info_t;</strong>
  20 </pre>
  21 <h3>FIELDS</h3>
  22 <dl>
  23 <dt> <var>avenrun</var>
  24 <dd>
  25 load average--average number of runnable processes divided by
  26 number of CPUs
  27 <p>
  28 <dt> <var>mach_factor</var>
  29 <dd>
  30 The processing resources available to a new thread--the number of
  31 CPUs divided by (1 + the number of threads)
  32 </dl>
  33 <h3>DESCRIPTION</h3>
  34 <p>
  35 The <strong>host_load_info</strong> structure defines the loading information
  36 available about a
  37 host.  The information returned is exponential averages over three periods of
  38 time: 5, 30 and 60 seconds.
  39 <h3>RELATED INFORMATION</h3>
  40 <p>
  41 Functions:
  42 <a href="host_statistics.html"><strong>host_statistics</strong></a>.
  43 <p>
  44 Data Structures:
  45 <a href="host_basic_info.html"><strong>host_basic_info</strong></a>,
  46 <a href="host_sched_info.html"><strong>host_sched_info</strong></a>.
  47