xref: /xnu-10002.61.3/osfmk/man/host_load_info.html (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1*0f4c859eSApple OSS Distributions<h2>host_load_info</h2>
2*0f4c859eSApple OSS Distributions<hr>
3*0f4c859eSApple OSS Distributions<p>
4*0f4c859eSApple OSS Distributions<strong>Structure</strong> - Used to present a host's processor load information.
5*0f4c859eSApple OSS Distributions<h3>SYNOPSIS</h3>
6*0f4c859eSApple OSS Distributions<pre>
7*0f4c859eSApple OSS Distributions<strong>#define CPU_STATE_USER     0</strong>
8*0f4c859eSApple OSS Distributions
9*0f4c859eSApple OSS Distributions<strong>#define CPU_STATE_SYSTEM   1</strong>
10*0f4c859eSApple OSS Distributions
11*0f4c859eSApple OSS Distributions<strong>#define CPU_STATE_IDLE     2</strong>
12*0f4c859eSApple OSS Distributions
13*0f4c859eSApple OSS Distributions<strong>struct host_load_info</strong>
14*0f4c859eSApple OSS Distributions<strong>{</strong>
15*0f4c859eSApple OSS Distributions       <strong>integer_t</strong>        <var>avenrun</var><strong>[3];</strong>
16*0f4c859eSApple OSS Distributions       <strong>integer_t</strong>    <var>mach_factor</var><strong>[3];</strong>
17*0f4c859eSApple OSS Distributions<strong>};</strong>
18*0f4c859eSApple OSS Distributions
19*0f4c859eSApple OSS Distributions<strong>typedef struct host_load_info* host_load_info_t;</strong>
20*0f4c859eSApple OSS Distributions</pre>
21*0f4c859eSApple OSS Distributions<h3>FIELDS</h3>
22*0f4c859eSApple OSS Distributions<dl>
23*0f4c859eSApple OSS Distributions<dt> <var>avenrun</var>
24*0f4c859eSApple OSS Distributions<dd>
25*0f4c859eSApple OSS Distributionsload average--average number of runnable processes divided by
26*0f4c859eSApple OSS Distributionsnumber of CPUs
27*0f4c859eSApple OSS Distributions<p>
28*0f4c859eSApple OSS Distributions<dt> <var>mach_factor</var>
29*0f4c859eSApple OSS Distributions<dd>
30*0f4c859eSApple OSS DistributionsThe processing resources available to a new thread--the number of
31*0f4c859eSApple OSS DistributionsCPUs divided by (1 + the number of threads)
32*0f4c859eSApple OSS Distributions</dl>
33*0f4c859eSApple OSS Distributions<h3>DESCRIPTION</h3>
34*0f4c859eSApple OSS Distributions<p>
35*0f4c859eSApple OSS DistributionsThe <strong>host_load_info</strong> structure defines the loading information
36*0f4c859eSApple OSS Distributionsavailable about a
37*0f4c859eSApple OSS Distributionshost.  The information returned is exponential averages over three periods of
38*0f4c859eSApple OSS Distributionstime: 5, 30 and 60 seconds.
39*0f4c859eSApple OSS Distributions<h3>RELATED INFORMATION</h3>
40*0f4c859eSApple OSS Distributions<p>
41*0f4c859eSApple OSS DistributionsFunctions:
42*0f4c859eSApple OSS Distributions<a href="host_statistics.html"><strong>host_statistics</strong></a>.
43*0f4c859eSApple OSS Distributions<p>
44*0f4c859eSApple OSS DistributionsData Structures:
45*0f4c859eSApple OSS Distributions<a href="host_basic_info.html"><strong>host_basic_info</strong></a>,
46*0f4c859eSApple OSS Distributions<a href="host_sched_info.html"><strong>host_sched_info</strong></a>.
47*0f4c859eSApple OSS Distributions
48