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