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

<h2>host_info</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return information about a host.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   host_info</strong>\r                <strong>(host_t</strong>                                    <var>host</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</var> \r<dd>\r[in host-name send right]\rThe name (or control) port for the host for \rwhich information 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_BASIC_INFO</strong>\r<dd>\rBasic information (number of processors, amount of\rmemory).  The returned structure is <strong>host_basic_info</strong>.\r<p>\r<dt> <strong>HOST_SCHED_INFO</strong>\r<dd>\rBasic restrictions of the kernel's scheduling, minimum\rquantum and time-out value.  The returned structure is \r<strong>host_sched_info</strong>.\r<p>\r<dt> <strong>HOST_RESOURCE_SIZES</strong>\r<dd>\rThis interface feature is not implemented in OSF/1 R1.3.\rSize of significant kernel structures, as a ledger would\rconsider them when limiting kernel resource consumption.  The\rreturned structure is <strong>kernel_resource_sizes</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_info</strong> function returns selected information\rabout a host, as specified \rby <var>flavor</var>.\r<h3>NOTES</h3>\r<p>\rThis interface is machine word length specific because of the memory size\rreturned by <strong>HOST_BASIC_INFO</strong>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="host_get_boot_info.html"><strong>host_get_boot_info</strong></a>,\r<a href="host_kernel_version.html"><strong>host_kernel_version</strong></a>,\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<a href="kernel_resource_sizes.html"><strong>kernel_resource_sizes</strong></a>.\r