xnu-792.6.70.tar.gz

[apple/xnu.git] / osfmk / man / processor_set_statistics.html

<h2>processor_set_statistics</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return scheduling statistics for a processor set.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t	processor_set_statistics</strong>\r		<strong>(processor_set_t</strong>	<var>processor_set_control</var>,\r		<strong>processor_set_flavor_t</strong>	<var>flavor</var>,\r		<strong>processor_set_info_t</strong>	<var>processor_set_info</var>,\r		<strong>mach_msg_type_number_t</strong>	<var>processor_set_info_count</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>processor_set_control</var> \r<dd>\r[in processor-set-control send right]\rA processor set control port for \rwhich information is desired.\r<dt> <var>flavor</var> \r<dd>\r[in scalar]\rThe type of information requested.\r<dl>\r<dt> <strong>PROCESSOR_SET_LOAD_INFO</strong>\r<dd>\rLoad statistics for the processor set.  The returned structure is \r<strong>processor_set_load_info</strong>.\r</dl>\r<dt> <var>processor_set_info</var> \r<dd>\r[out structure]\rInformation about the processor set.\r<dt> <var>processor_set_info_count</var> \r<dd>\r[in/out scalar]\rOn input, the maximum size of the buffer; on output, the \rsize returned (in natural-sized units).\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>processor_set_statistics</strong> function returns statistics\rfor a processor set as specified by <var>flavor</var>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="processor_set_info.html">processor_set_info</a>.\r<p>\rData Structures:\r<a href="processor_set_load_info.html">processor_set_load_info</a>.\r