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