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