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