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

<h2>host_statistics</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return statistics for a host.<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   host_statistics</strong>\r                <strong>(host_priv_t</strong>                          <var>host_priv</var>,\r                 <strong>host_flavor_t</strong>                           <var>flavor</var>,\r                 <strong>host_info_t</strong>                          <var>host_info</var>,\r                 <strong>mach_msg_type_number_t</strong>         <var>host_info_count</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>host_priv</var> \r<dd>\r[in host-control send right]\rThe control port for the host for which\rinformation is to be obtained.\r<p>\r<dt> <var>flavor</var> \r<dd>\r[in scalar]\rThe type of statistics desired.\r<dl>\r<p>\r<dt> <strong>HOST_LOAD_INFO</strong>\r<dd>\rSystem loading statistics.  The returned structure is\r<strong>host_load_info</strong>.\r<p>\r<dt> <strong>HOST_VM_INFO</strong>\r<dd>\rVirtual memory statistics.  The returned structure is\r<strong>vm_statistics</strong>.\r</dl>\r<p>\r<dt> <var>host_info</var> \r<dd>\r[out structure]\rStatistics about the specified host.\r<p>\r<dt> <var>host_info_count</var> \r<dd>\r[in/out scalar]\rOn input, the maximum size of the buffer; on output, the \rsize returned (in natural-sized units).\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>host_statistics</strong> function returns scheduling and\rvirtual memory statistics \rconcerning the host as specified by <var>flavor</var>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="host_info.html"><strong>host_info</strong></a>,\r<a href="processor_set_statistics.html"><strong>processor_set_statistics</strong></a>.\r<p>\rData Structures:\r<a href="host_load_info.html"><strong>host_load_info</strong></a>,\r<a href="vm_statistics.html"><strong>vm_statistics</strong></a>.\r