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