xref: /xnu-10002.1.13/osfmk/man/processor_set_statistics.html (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions<h2>processor_set_statistics</h2>
2*1031c584SApple OSS Distributions<hr>
3*1031c584SApple OSS Distributions<p>
4*1031c584SApple OSS Distributions<strong>Function</strong> - Return scheduling statistics for a processor set.
5*1031c584SApple OSS Distributions<h3>SYNOPSIS</h3>
6*1031c584SApple OSS Distributions<pre>
7*1031c584SApple OSS Distributions<strong>kern_return_t	processor_set_statistics</strong>
8*1031c584SApple OSS Distributions		<strong>(processor_set_t</strong>	<var>processor_set_control</var>,
9*1031c584SApple OSS Distributions		<strong>processor_set_flavor_t</strong>	<var>flavor</var>,
10*1031c584SApple OSS Distributions		<strong>processor_set_info_t</strong>	<var>processor_set_info</var>,
11*1031c584SApple OSS Distributions		<strong>mach_msg_type_number_t</strong>	<var>processor_set_info_count</var><strong>);</strong>
12*1031c584SApple OSS Distributions</pre>
13*1031c584SApple OSS Distributions<h3>PARAMETERS</h3>
14*1031c584SApple OSS Distributions<dl>
15*1031c584SApple OSS Distributions<dt> <var>processor_set_control</var>
16*1031c584SApple OSS Distributions<dd>
17*1031c584SApple OSS Distributions[in processor-set-control send right]
18*1031c584SApple OSS DistributionsA processor set control port for
19*1031c584SApple OSS Distributionswhich information is desired.
20*1031c584SApple OSS Distributions<dt> <var>flavor</var>
21*1031c584SApple OSS Distributions<dd>
22*1031c584SApple OSS Distributions[in scalar]
23*1031c584SApple OSS DistributionsThe type of information requested.
24*1031c584SApple OSS Distributions<dl>
25*1031c584SApple OSS Distributions<dt> <strong>PROCESSOR_SET_LOAD_INFO</strong>
26*1031c584SApple OSS Distributions<dd>
27*1031c584SApple OSS DistributionsLoad statistics for the processor set.  The returned structure is
28*1031c584SApple OSS Distributions<strong>processor_set_load_info</strong>.
29*1031c584SApple OSS Distributions</dl>
30*1031c584SApple OSS Distributions<dt> <var>processor_set_info</var>
31*1031c584SApple OSS Distributions<dd>
32*1031c584SApple OSS Distributions[out structure]
33*1031c584SApple OSS DistributionsInformation about the processor set.
34*1031c584SApple OSS Distributions<dt> <var>processor_set_info_count</var>
35*1031c584SApple OSS Distributions<dd>
36*1031c584SApple OSS Distributions[in/out scalar]
37*1031c584SApple OSS DistributionsOn input, the maximum size of the buffer; on output, the
38*1031c584SApple OSS Distributionssize returned (in natural-sized units).
39*1031c584SApple OSS Distributions</dl>
40*1031c584SApple OSS Distributions<h3>DESCRIPTION</h3>
41*1031c584SApple OSS Distributions<p>
42*1031c584SApple OSS DistributionsThe <strong>processor_set_statistics</strong> function returns statistics
43*1031c584SApple OSS Distributionsfor a processor set as specified by <var>flavor</var>.
44*1031c584SApple OSS Distributions<h3>RETURN VALUES</h3>
45*1031c584SApple OSS Distributions<p>
46*1031c584SApple OSS DistributionsOnly generic errors apply.
47*1031c584SApple OSS Distributions<h3>RELATED INFORMATION</h3>
48*1031c584SApple OSS Distributions<p>
49*1031c584SApple OSS DistributionsFunctions:
50*1031c584SApple OSS Distributions<a href="processor_set_info.html">processor_set_info</a>.
51*1031c584SApple OSS Distributions<p>
52*1031c584SApple OSS DistributionsData Structures:
53*1031c584SApple OSS Distributions<a href="processor_set_load_info.html">processor_set_load_info</a>.
54