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