X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/9bccf70c0258c7cac2dcb80011b2a964d884c552..HEAD:/osfmk/man/host_info.html?ds=inline diff --git a/osfmk/man/host_info.html b/osfmk/man/host_info.html old mode 100755 new mode 100644 index 8bafeb2a4..23a38fdc1 --- a/osfmk/man/host_info.html +++ b/osfmk/man/host_info.html @@ -1 +1,80 @@ -

host_info


Function - Return information about a host.

SYNOPSIS

kern_return_t   host_info
                (host_t                                    host,
                 host_flavor_t                           flavor,
                 host_info_t                          host_info,
                 mach_msg_type_number_t         host_info_count);

PARAMETERS

host
[in host-name send right] The name (or control) port for the host for which information is to be obtained.

flavor
[in scalar] The type of statistics desired:

HOST_BASIC_INFO
Basic information (number of processors, amount of memory). The returned structure is host_basic_info.

HOST_SCHED_INFO
Basic restrictions of the kernel's scheduling, minimum quantum and time-out value. The returned structure is host_sched_info.

HOST_RESOURCE_SIZES
This interface feature is not implemented in OSF/1 R1.3. Size of significant kernel structures, as a ledger would consider them when limiting kernel resource consumption. The returned structure is kernel_resource_sizes.

host_info
[out structure] Statistics about the specified host.

host_info_count
[in/out scalar] On input, the maximum size of the buffer; on output, the size returned (in natural-sized units).

DESCRIPTION

The host_info function returns selected information about a host, as specified by flavor.

NOTES

This interface is machine word length specific because of the memory size returned by HOST_BASIC_INFO.

RETURN VALUES

Only generic errors apply.

RELATED INFORMATION

Functions: host_get_boot_info, host_kernel_version, host_statistics.

Data Structures: host_basic_info, host_sched_info, kernel_resource_sizes. \ No newline at end of file +

host_info

+
+

+Function - Return information about a host. +

SYNOPSIS

+
+kern_return_t   host_info
+                (host_t                                    host,
+                 host_flavor_t                           flavor,
+                 host_info_t                          host_info,
+                 mach_msg_type_number_t         host_info_count);
+
+

PARAMETERS

+
+

+

host +
+[in host-name send right] +The name (or control) port for the host for +which information is to be obtained. +

+

flavor +
+[in scalar] +The type of statistics desired: +
+

+

HOST_BASIC_INFO +
+Basic information (number of processors, amount of +memory). The returned structure is host_basic_info. +

+

HOST_SCHED_INFO +
+Basic restrictions of the kernel's scheduling, minimum +quantum and time-out value. The returned structure is +host_sched_info. +

+

HOST_RESOURCE_SIZES +
+This interface feature is not implemented in OSF/1 R1.3. +Size of significant kernel structures, as a ledger would +consider them when limiting kernel resource consumption. The +returned structure is kernel_resource_sizes. +
+

+

host_info +
+[out structure] +Statistics about the specified host. +

+

host_info_count +
+[in/out scalar] +On input, the maximum size of the buffer; on output, the +size returned (in natural-sized units). +
+

DESCRIPTION

+

+The host_info function returns selected information +about a host, as specified +by flavor. +

NOTES

+

+This interface is machine word length specific because of the memory size +returned by HOST_BASIC_INFO. +

RETURN VALUES

+

+Only generic errors apply. +

RELATED INFORMATION

+

+Functions: +host_get_boot_info, +host_kernel_version, +host_statistics. +

+Data Structures: +host_basic_info, +host_sched_info, +kernel_resource_sizes.