xnu-2422.1.72.tar.gz

[apple/xnu.git] / osfmk / man / host_basic_info.html

<h2>host_basic_info</h2>
<hr>
<p>
<strong>Structure</strong> - Used to present basic information about a host.
<h3>SYNOPSIS</h3>
<pre>
<strong>struct host_basic_info</strong>
<strong>{</strong>
       <strong>integer_t</strong>            <var>max_cpus</var><strong>;</strong>
       <strong>integer_t</strong>            <var>avail_cpus</var><strong>;</strong>
       <strong>vm_size_t</strong>            <var>memory_size</var><strong>;</strong>
       <strong>cpu_type_t</strong>           <var>cpu_type</var><strong>;</strong>
       <strong>cpu_subtype_t</strong>        <var>cpu_subtype</var><strong>;</strong>
       <strong>cpu_threadtype_t</strong>     <var>cpu_threadtype</var><strong>;</strong>
       <strong>integer_t</strong>            <var>physical_cpu</var><strong>;</strong>
       <strong>integer_t</strong>            <var>physical_cpu_max</var><strong>;</strong>
       <strong>integer_t</strong>            <var>logical_cpu</var><strong>;</strong>
       <strong>integer_t</strong>            <var>logical_cpu_max</var><strong>;</strong>
       <strong>uint64_t</strong>             <var>max_mem</var><strong>;</strong>
<strong>};</strong>

<strong>typedef struct host_basic_info* host_basic_info_t;</strong>
</pre>
<h3>FIELDS</h3>
<dl>
<dt> <var>max_cpus</var>
<dd>
Maximum number of CPUs possible
<p>
<dt> <var>avail_cpus</var>
<dd>
Number of CPUs now available
<p>
<dt> <var>memory_size</var>
<dd>
Size of memory in bytes, capped at 2 GB
<p>
<dt> <var>cpu_type</var>
<dd>
CPU type
<p>
<dt> <var>cpu_subtype</var>
<dd>
CPU sub-type
<p>
<dt> <var>cpu_threadtype</var>
<dd>
CPU thread-type
<p>
<dt> <var>physical_cpu</var>
<dd>
Number of physical CPUs now available
<p>
<dt> <var>physical_cpu_max</var>
<dd>
Maximum number of physical CPUs possible
<p>
<dt> <var>logical_cpu</var>
<dd>
Number of logical CPUs now available
<p>
<dt> <var>logical_cpu_max</var>
<dd>
Maximum number of logical CPUs possible
<p>
<dt> <var>max_mem</var>
<dd>
Actual size of physical memory in bytes
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>host_basic_info</strong> structure defines the basic information
available about a 
host.
<h3>NOTES</h3>
<p>
This structure is machine word length specific because of the memory size
returned.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="host_info.html"><strong>host_info</strong></a>.
<p>
Data Structures:
<a href="host_load_info.html"><strong>host_load_info</strong></a>,
<a href="host_sched_info.html"><strong>host_sched_info</strong></a>.