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