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