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