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