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