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