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