xref: /xnu-8019.80.24/osfmk/man/host_statistics.html (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1*a325d9c4SApple OSS Distributions<h2>host_statistics</h2>
2*a325d9c4SApple OSS Distributions<hr>
3*a325d9c4SApple OSS Distributions<p>
4*a325d9c4SApple OSS Distributions<strong>Function</strong> - Return statistics for a host.<h3>SYNOPSIS</h3>
5*a325d9c4SApple OSS Distributions<pre>
6*a325d9c4SApple OSS Distributions<strong>kern_return_t   host_statistics</strong>
7*a325d9c4SApple OSS Distributions                <strong>(host_priv_t</strong>                          <var>host_priv</var>,
8*a325d9c4SApple OSS Distributions                 <strong>host_flavor_t</strong>                           <var>flavor</var>,
9*a325d9c4SApple OSS Distributions                 <strong>host_info_t</strong>                          <var>host_info</var>,
10*a325d9c4SApple OSS Distributions                 <strong>mach_msg_type_number_t</strong>         <var>host_info_count</var><strong>);</strong>
11*a325d9c4SApple OSS Distributions</pre>
12*a325d9c4SApple OSS Distributions<h3>PARAMETERS</h3>
13*a325d9c4SApple OSS Distributions<dl>
14*a325d9c4SApple OSS Distributions<p>
15*a325d9c4SApple OSS Distributions<dt> <var>host_priv</var>
16*a325d9c4SApple OSS Distributions<dd>
17*a325d9c4SApple OSS Distributions[in host-control send right]
18*a325d9c4SApple OSS DistributionsThe control port for the host for which
19*a325d9c4SApple OSS Distributionsinformation is to be obtained.
20*a325d9c4SApple OSS Distributions<p>
21*a325d9c4SApple OSS Distributions<dt> <var>flavor</var>
22*a325d9c4SApple OSS Distributions<dd>
23*a325d9c4SApple OSS Distributions[in scalar]
24*a325d9c4SApple OSS DistributionsThe type of statistics desired.
25*a325d9c4SApple OSS Distributions<dl>
26*a325d9c4SApple OSS Distributions<p>
27*a325d9c4SApple OSS Distributions<dt> <strong>HOST_LOAD_INFO</strong>
28*a325d9c4SApple OSS Distributions<dd>
29*a325d9c4SApple OSS DistributionsSystem loading statistics.  The returned structure is
30*a325d9c4SApple OSS Distributions<strong>host_load_info</strong>.
31*a325d9c4SApple OSS Distributions<p>
32*a325d9c4SApple OSS Distributions<dt> <strong>HOST_VM_INFO</strong>
33*a325d9c4SApple OSS Distributions<dd>
34*a325d9c4SApple OSS DistributionsVirtual memory statistics.  The returned structure is
35*a325d9c4SApple OSS Distributions<strong>vm_statistics</strong>.
36*a325d9c4SApple OSS Distributions</dl>
37*a325d9c4SApple OSS Distributions<p>
38*a325d9c4SApple OSS Distributions<dt> <var>host_info</var>
39*a325d9c4SApple OSS Distributions<dd>
40*a325d9c4SApple OSS Distributions[out structure]
41*a325d9c4SApple OSS DistributionsStatistics about the specified host.
42*a325d9c4SApple OSS Distributions<p>
43*a325d9c4SApple OSS Distributions<dt> <var>host_info_count</var>
44*a325d9c4SApple OSS Distributions<dd>
45*a325d9c4SApple OSS Distributions[in/out scalar]
46*a325d9c4SApple OSS DistributionsOn input, the maximum size of the buffer; on output, the
47*a325d9c4SApple OSS Distributionssize returned (in natural-sized units).
48*a325d9c4SApple OSS Distributions</dl>
49*a325d9c4SApple OSS Distributions<h3>DESCRIPTION</h3>
50*a325d9c4SApple OSS Distributions<p>
51*a325d9c4SApple OSS DistributionsThe <strong>host_statistics</strong> function returns scheduling and
52*a325d9c4SApple OSS Distributionsvirtual memory statistics
53*a325d9c4SApple OSS Distributionsconcerning the host as specified by <var>flavor</var>.
54*a325d9c4SApple OSS Distributions<h3>RETURN VALUES</h3>
55*a325d9c4SApple OSS Distributions<p>
56*a325d9c4SApple OSS DistributionsOnly generic errors apply.
57*a325d9c4SApple OSS Distributions<h3>RELATED INFORMATION</h3>
58*a325d9c4SApple OSS Distributions<p>
59*a325d9c4SApple OSS DistributionsFunctions:
60*a325d9c4SApple OSS Distributions<a href="host_info.html"><strong>host_info</strong></a>,
61*a325d9c4SApple OSS Distributions<a href="processor_set_statistics.html"><strong>processor_set_statistics</strong></a>.
62*a325d9c4SApple OSS Distributions<p>
63*a325d9c4SApple OSS DistributionsData Structures:
64*a325d9c4SApple OSS Distributions<a href="host_load_info.html"><strong>host_load_info</strong></a>,
65*a325d9c4SApple OSS Distributions<a href="vm_statistics.html"><strong>vm_statistics</strong></a>.
66