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