osfmk/man/host_info.html

   1 <h2>host_info</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Return information about a host.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   host_info</strong>
   8                 <strong>(host_t</strong>                                    <var>host</var>,
   9                  <strong>host_flavor_t</strong>                           <var>flavor</var>,
  10                  <strong>host_info_t</strong>                          <var>host_info</var>,
  11                  <strong>mach_msg_type_number_t</strong>         <var>host_info_count</var><strong>);</strong>
  12 </pre>
  13 <h3>PARAMETERS</h3>
  14 <dl>
  15 <p>
  16 <dt> <var>host</var>
  17 <dd>
  18 [in host-name send right]
  19 The name (or control) port for the host for
  20 which information is to be obtained.
  21 <p>
  22 <dt> <var>flavor</var>
  23 <dd>
  24 [in scalar]
  25 The type of statistics desired:
  26 <dl>
  27 <p>
  28 <dt> <strong>HOST_BASIC_INFO</strong>
  29 <dd>
  30 Basic information (number of processors, amount of
  31 memory).  The returned structure is <strong>host_basic_info</strong>.
  32 <p>
  33 <dt> <strong>HOST_SCHED_INFO</strong>
  34 <dd>
  35 Basic restrictions of the kernel's scheduling, minimum
  36 quantum and time-out value.  The returned structure is
  37 <strong>host_sched_info</strong>.
  38 <p>
  39 <dt> <strong>HOST_RESOURCE_SIZES</strong>
  40 <dd>
  41 This interface feature is not implemented in OSF/1 R1.3.
  42 Size of significant kernel structures, as a ledger would
  43 consider them when limiting kernel resource consumption.  The
  44 returned structure is <strong>kernel_resource_sizes</strong>.
  45 </dl>
  46 <p>
  47 <dt> <var>host_info</var>
  48 <dd>
  49 [out structure]
  50 Statistics about the specified host.
  51 <p>
  52 <dt> <var>host_info_count</var>
  53 <dd>
  54 [in/out scalar]
  55 On input, the maximum size of the buffer; on output, the
  56 size returned (in natural-sized units).
  57 </dl>
  58 <h3>DESCRIPTION</h3>
  59 <p>
  60 The <strong>host_info</strong> function returns selected information
  61 about a host, as specified
  62 by <var>flavor</var>.
  63 <h3>NOTES</h3>
  64 <p>
  65 This interface is machine word length specific because of the memory size
  66 returned by <strong>HOST_BASIC_INFO</strong>.
  67 <h3>RETURN VALUES</h3>
  68 <p>
  69 Only generic errors apply.
  70 <h3>RELATED INFORMATION</h3>
  71 <p>
  72 Functions:
  73 <a href="host_get_boot_info.html"><strong>host_get_boot_info</strong></a>,
  74 <a href="host_kernel_version.html"><strong>host_kernel_version</strong></a>,
  75 <a href="host_statistics.html"><strong>host_statistics</strong></a>.
  76 <p>
  77 Data Structures:
  78 <a href="host_basic_info.html"><strong>host_basic_info</strong></a>,
  79 <a href="host_sched_info.html"><strong>host_sched_info</strong></a>,
  80 <a href="kernel_resource_sizes.html"><strong>kernel_resource_sizes</strong></a>.