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