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