]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/man/processor_set_statistics.html
xnu-7195.101.1.tar.gz
[apple/xnu.git] / osfmk / man / processor_set_statistics.html
old mode 100755 (executable)
new mode 100644 (file)
index 5bd6536..315304b
@@ -1 +1,53 @@
-<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
\ No newline at end of file
+<h2>processor_set_statistics</h2>
+<hr>
+<p>
+<strong>Function</strong> - Return scheduling statistics for a processor set.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t  processor_set_statistics</strong>
+               <strong>(processor_set_t</strong>       <var>processor_set_control</var>,
+               <strong>processor_set_flavor_t</strong> <var>flavor</var>,
+               <strong>processor_set_info_t</strong>   <var>processor_set_info</var>,
+               <strong>mach_msg_type_number_t</strong> <var>processor_set_info_count</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<dt> <var>processor_set_control</var> 
+<dd>
+[in processor-set-control send right]
+A processor set control port for 
+which information is desired.
+<dt> <var>flavor</var> 
+<dd>
+[in scalar]
+The type of information requested.
+<dl>
+<dt> <strong>PROCESSOR_SET_LOAD_INFO</strong>
+<dd>
+Load statistics for the processor set.  The returned structure is 
+<strong>processor_set_load_info</strong>.
+</dl>
+<dt> <var>processor_set_info</var> 
+<dd>
+[out structure]
+Information about the processor set.
+<dt> <var>processor_set_info_count</var> 
+<dd>
+[in/out scalar]
+On input, the maximum size of the buffer; on output, the 
+size returned (in natural-sized units).
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>processor_set_statistics</strong> function returns statistics
+for a processor set as specified by <var>flavor</var>.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="processor_set_info.html">processor_set_info</a>.
+<p>
+Data Structures:
+<a href="processor_set_load_info.html">processor_set_load_info</a>.