osfmk/man/host_basic_info.html

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