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