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