xref: /xnu-11417.121.6/osfmk/man/host_basic_info.html (revision a1e26a70f38d1d7daa7b49b258e2f8538ad81650)
1*a1e26a70SApple OSS Distributions<h2>host_basic_info</h2>
2*a1e26a70SApple OSS Distributions<hr>
3*a1e26a70SApple OSS Distributions<p>
4*a1e26a70SApple OSS Distributions<strong>Structure</strong> - Used to present basic information about a host.
5*a1e26a70SApple OSS Distributions<h3>SYNOPSIS</h3>
6*a1e26a70SApple OSS Distributions<pre>
7*a1e26a70SApple OSS Distributions<strong>struct host_basic_info</strong>
8*a1e26a70SApple OSS Distributions<strong>{</strong>
9*a1e26a70SApple OSS Distributions       <strong>integer_t</strong>            <var>max_cpus</var><strong>;</strong>
10*a1e26a70SApple OSS Distributions       <strong>integer_t</strong>            <var>avail_cpus</var><strong>;</strong>
11*a1e26a70SApple OSS Distributions       <strong>vm_size_t</strong>            <var>memory_size</var><strong>;</strong>
12*a1e26a70SApple OSS Distributions       <strong>cpu_type_t</strong>           <var>cpu_type</var><strong>;</strong>
13*a1e26a70SApple OSS Distributions       <strong>cpu_subtype_t</strong>        <var>cpu_subtype</var><strong>;</strong>
14*a1e26a70SApple OSS Distributions       <strong>cpu_threadtype_t</strong>     <var>cpu_threadtype</var><strong>;</strong>
15*a1e26a70SApple OSS Distributions       <strong>integer_t</strong>            <var>physical_cpu</var><strong>;</strong>
16*a1e26a70SApple OSS Distributions       <strong>integer_t</strong>            <var>physical_cpu_max</var><strong>;</strong>
17*a1e26a70SApple OSS Distributions       <strong>integer_t</strong>            <var>logical_cpu</var><strong>;</strong>
18*a1e26a70SApple OSS Distributions       <strong>integer_t</strong>            <var>logical_cpu_max</var><strong>;</strong>
19*a1e26a70SApple OSS Distributions       <strong>uint64_t</strong>             <var>max_mem</var><strong>;</strong>
20*a1e26a70SApple OSS Distributions<strong>};</strong>
21*a1e26a70SApple OSS Distributions
22*a1e26a70SApple OSS Distributions<strong>typedef struct host_basic_info* host_basic_info_t;</strong>
23*a1e26a70SApple OSS Distributions</pre>
24*a1e26a70SApple OSS Distributions<h3>FIELDS</h3>
25*a1e26a70SApple OSS Distributions<dl>
26*a1e26a70SApple OSS Distributions<dt> <var>max_cpus</var>
27*a1e26a70SApple OSS Distributions<dd>
28*a1e26a70SApple OSS DistributionsMaximum number of CPUs possible
29*a1e26a70SApple OSS Distributions<p>
30*a1e26a70SApple OSS Distributions<dt> <var>avail_cpus</var>
31*a1e26a70SApple OSS Distributions<dd>
32*a1e26a70SApple OSS DistributionsNumber of CPUs now available
33*a1e26a70SApple OSS Distributions<p>
34*a1e26a70SApple OSS Distributions<dt> <var>memory_size</var>
35*a1e26a70SApple OSS Distributions<dd>
36*a1e26a70SApple OSS DistributionsSize of memory in bytes, capped at 2 GB
37*a1e26a70SApple OSS Distributions<p>
38*a1e26a70SApple OSS Distributions<dt> <var>cpu_type</var>
39*a1e26a70SApple OSS Distributions<dd>
40*a1e26a70SApple OSS DistributionsCPU type
41*a1e26a70SApple OSS Distributions<p>
42*a1e26a70SApple OSS Distributions<dt> <var>cpu_subtype</var>
43*a1e26a70SApple OSS Distributions<dd>
44*a1e26a70SApple OSS DistributionsCPU sub-type
45*a1e26a70SApple OSS Distributions<p>
46*a1e26a70SApple OSS Distributions<dt> <var>cpu_threadtype</var>
47*a1e26a70SApple OSS Distributions<dd>
48*a1e26a70SApple OSS DistributionsCPU thread-type
49*a1e26a70SApple OSS Distributions<p>
50*a1e26a70SApple OSS Distributions<dt> <var>physical_cpu</var>
51*a1e26a70SApple OSS Distributions<dd>
52*a1e26a70SApple OSS DistributionsNumber of physical CPUs now available
53*a1e26a70SApple OSS Distributions<p>
54*a1e26a70SApple OSS Distributions<dt> <var>physical_cpu_max</var>
55*a1e26a70SApple OSS Distributions<dd>
56*a1e26a70SApple OSS DistributionsMaximum number of physical CPUs possible
57*a1e26a70SApple OSS Distributions<p>
58*a1e26a70SApple OSS Distributions<dt> <var>logical_cpu</var>
59*a1e26a70SApple OSS Distributions<dd>
60*a1e26a70SApple OSS DistributionsNumber of logical CPUs now available
61*a1e26a70SApple OSS Distributions<p>
62*a1e26a70SApple OSS Distributions<dt> <var>logical_cpu_max</var>
63*a1e26a70SApple OSS Distributions<dd>
64*a1e26a70SApple OSS DistributionsMaximum number of logical CPUs possible
65*a1e26a70SApple OSS Distributions<p>
66*a1e26a70SApple OSS Distributions<dt> <var>max_mem</var>
67*a1e26a70SApple OSS Distributions<dd>
68*a1e26a70SApple OSS DistributionsActual size of physical memory in bytes
69*a1e26a70SApple OSS Distributions</dl>
70*a1e26a70SApple OSS Distributions<h3>DESCRIPTION</h3>
71*a1e26a70SApple OSS Distributions<p>
72*a1e26a70SApple OSS DistributionsThe <strong>host_basic_info</strong> structure defines the basic information
73*a1e26a70SApple OSS Distributionsavailable about a
74*a1e26a70SApple OSS Distributionshost.
75*a1e26a70SApple OSS Distributions<h3>NOTES</h3>
76*a1e26a70SApple OSS Distributions<p>
77*a1e26a70SApple OSS DistributionsThis structure is machine word length specific because of the memory size
78*a1e26a70SApple OSS Distributionsreturned.
79*a1e26a70SApple OSS Distributions<h3>RELATED INFORMATION</h3>
80*a1e26a70SApple OSS Distributions<p>
81*a1e26a70SApple OSS DistributionsFunctions:
82*a1e26a70SApple OSS Distributions<a href="host_info.html"><strong>host_info</strong></a>.
83*a1e26a70SApple OSS Distributions<p>
84*a1e26a70SApple OSS DistributionsData Structures:
85*a1e26a70SApple OSS Distributions<a href="host_load_info.html"><strong>host_load_info</strong></a>,
86*a1e26a70SApple OSS Distributions<a href="host_sched_info.html"><strong>host_sched_info</strong></a>.
87