Loading...
osfmk/man/processor_set_info.html xnu-12377.101.15 /dev/null
--- xnu/xnu-12377.101.15/osfmk/man/processor_set_info.html
+++ /dev/null
@@ -1,101 +0,0 @@
-<h2>processor_set_info</h2>
-<hr>
-<p>
-<strong>Function</strong> - Return processor set state according to caller-specified flavor.
-<h3>SYNOPSIS</h3>
-<pre>
-<strong>kern_return_t	processor_set_info</strong>
-		<strong>(processor_set_name_t</strong>	<var>processor_set_name</var>,
-		<strong>int</strong>	<var>flavor</var>,
-		<strong>host_t</strong>	<var>host</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_name</var> 
-<dd>
-[in processor-set-name send right]
-A processor set name (or control) 
-port for which information is desired.
-<dt> <var>flavor</var> 
-<dd>
-[in scalar]
-The type of information requested.
-<dl>
-<dt> <strong>PROCESSOR_SET_BASIC_INFO</strong>
-<dd>
-Basic information concerning the processor set (number of
-assigned processors and default policy).  The returned structure 
-is defined by <strong>processor_set_basic_info</strong>.
-<dt> <strong>PROCESSOR_SET_TIMESHARE_DEFAULT</strong>
-<dd>
-The base attributes for the timeshare scheduling policy.  The 
-returned structure is <strong>policy_timeshare_base</strong>.
-<dt> <strong>PROCESSOR_SET_FIFO_DEFAULT</strong>
-<dd>
-The base attributes for the FIFO scheduling policy.  The
-returned structure is <strong>policy_fifo_base</strong>.
-<dt> <strong>PROCESSOR_SET_RR_DEFAULT</strong>
-<dd>
-The base attributes for the round-robin scheduling policy.  The 
-returned structure is <strong>policy_rr_base</strong>.
-<dt> <strong>PROCESSOR_SET_TIMESHARE_LIMITS</strong>
-<dd>
-Limits on the allowed timeshare policy attributes.  The
-returned structure is defined by <strong>policy_timeshare_limit</strong>.
-<dt> <strong>PROCESSOR_SET_RR_LIMITS</strong>
-<dd>
-Limits on the allowed round robin policy attributes.  The
-returned structure is defined by <strong>policy_rr_limit</strong>.
-<dt> <strong>PROCESSOR_SET_FIFO_LIMITS</strong>
-<dd>
-Limits on the allowed first-in, first-out policy attributes.  The 
-returned structure is defined by <strong>policy_fifo_limit</strong>.
-<dt> <strong>PROCESSOR_SET_ENABLED_POLICIES</strong>
-<dd>
-The set of enabled policies.  The returned data is a bit-vector.
-</dl>
-<dt> <var>host</var> 
-<dd>
-[out host-name send right]
-The name port for the host on which the 
-processor set resides.
-<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_info</strong> function returns selected information
-for a processor set, as specified by <var>flavor</var>.
-<h3>NOTES</h3>
-<p>
-A processor set has a single default scheduling policy in effect for it (as
-returned by <strong>PROCESSOR_SET_BASIC_INFO</strong>), so only one of the default
-scheduling structures has valid information.  On the other hand,
-a processor set 
-maintains limits for all defined scheduling policies, so all
-of the scheduling limit 
-structures return valid values.
-<h3>RETURN VALUES</h3>
-<p>
-Only generic errors apply.
-<h3>RELATED INFORMATION</h3>
-<p>
-Functions:
-<a href="processor_set_statistics.html">processor_set_statistics</a>,
-<a href="processor_set_default.html">processor_set_default</a>,
-<a href="processor_assign.html">processor_assign</a>,
-<p>
-Data Structures:
-<a href="processor_set_basic_info.html">processor_set_basic_info</a>,
-<a href="policy_timeshare_info.html">policy_timeshare_info</a>,
-<a href="policy_rr_info.html">policy_rr_info</a>,
-<a href="policy_fifo_info.html">policy_fifo_info</a>.