[apple/xnu.git] / osfmk / man / host_load_info.html

<h2>host_load_info</h2>\r<hr>\r<p>\r<strong>Structure</strong> - Used to present a host's processor load information.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>#define CPU_STATE_USER     0</strong>\r\r<strong>#define CPU_STATE_SYSTEM   1</strong>\r\r<strong>#define CPU_STATE_IDLE     2</strong>\r\r<strong>struct host_load_info</strong>\r<strong>{</strong>\r       <strong>integer_t</strong>        <var>avenrun</var><strong>[3];</strong>\r       <strong>integer_t</strong>    <var>mach_factor</var><strong>[3];</strong>\r<strong>};</strong>\r\r<strong>typedef struct host_load_info* host_load_info_t;</strong>\r</pre>\r<h3>FIELDS</h3>\r<dl>\r<dt> <var>avenrun</var>\r<dd>\rload average--average number of runnable processes divided by\rnumber of CPUs\r<p>\r<dt> <var>mach_factor</var>\r<dd>\rThe processing resources available to a new thread--the number of \rCPUs divided by (1 + the number of threads)\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>host_load_info</strong> structure defines the loading information\ravailable about a \rhost.  The information returned is exponential averages over three periods of \rtime: 5, 30 and 60 seconds.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="host_statistics.html"><strong>host_statistics</strong></a>.\r<p>\rData Structures:\r<a href="host_basic_info.html"><strong>host_basic_info</strong></a>,\r<a href="host_sched_info.html"><strong>host_sched_info</strong></a>.\r\r