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