xnu-2422.1.72.tar.gz

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

<h2>host_info</h2>
<hr>
<p>
<strong>Function</strong> - Return information about a host.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   host_info</strong>
                <strong>(host_t</strong>                                    <var>host</var>,
                 <strong>host_flavor_t</strong>                           <var>flavor</var>,
                 <strong>host_info_t</strong>                          <var>host_info</var>,
                 <strong>mach_msg_type_number_t</strong>         <var>host_info_count</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>host</var> 
<dd>
[in host-name send right]
The name (or control) port for the host for 
which information is to be obtained.
<p>
<dt> <var>flavor</var> 
<dd>
[in scalar]
The type of statistics desired:
<dl>
<p>
<dt> <strong>HOST_BASIC_INFO</strong>
<dd>
Basic information (number of processors, amount of
memory).  The returned structure is <strong>host_basic_info</strong>.
<p>
<dt> <strong>HOST_SCHED_INFO</strong>
<dd>
Basic restrictions of the kernel's scheduling, minimum
quantum and time-out value.  The returned structure is 
<strong>host_sched_info</strong>.
<p>
<dt> <strong>HOST_RESOURCE_SIZES</strong>
<dd>
This interface feature is not implemented in OSF/1 R1.3.
Size of significant kernel structures, as a ledger would
consider them when limiting kernel resource consumption.  The
returned structure is <strong>kernel_resource_sizes</strong>.
</dl>
<p>
<dt> <var>host_info</var> 
<dd>
[out structure]
Statistics about the specified host.
<p>
<dt> <var>host_info_count</var> 
<dd>
[in/out scalar]
On input, the maximum size of the buffer; on output, the 
size returned (in natural-sized units).
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>host_info</strong> function returns selected information
about a host, as specified 
by <var>flavor</var>.
<h3>NOTES</h3>
<p>
This interface is machine word length specific because of the memory size
returned by <strong>HOST_BASIC_INFO</strong>.
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="host_get_boot_info.html"><strong>host_get_boot_info</strong></a>,
<a href="host_kernel_version.html"><strong>host_kernel_version</strong></a>,
<a href="host_statistics.html"><strong>host_statistics</strong></a>.
<p>
Data Structures:
<a href="host_basic_info.html"><strong>host_basic_info</strong></a>,
<a href="host_sched_info.html"><strong>host_sched_info</strong></a>,
<a href="kernel_resource_sizes.html"><strong>kernel_resource_sizes</strong></a>.