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