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

<h2>processor_set_info</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return processor set state according to caller-specified flavor.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t	processor_set_info</strong>\r		<strong>(processor_set_name_t</strong>	<var>processor_set_name</var>,\r		<strong>int</strong>	<var>flavor</var>,\r		<strong>host_t</strong>	<var>host</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_name</var> \r<dd>\r[in processor-set-name send right]\rA processor set name (or control) \rport for which 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_BASIC_INFO</strong>\r<dd>\rBasic information concerning the processor set (number of\rassigned processors and default policy).  The returned structure \ris defined by <strong>processor_set_basic_info</strong>.\r<dt> <strong>PROCESSOR_SET_TIMESHARE_DEFAULT</strong>\r<dd>\rThe base attributes for the timeshare scheduling policy.  The \rreturned structure is <strong>policy_timeshare_base</strong>.\r<dt> <strong>PROCESSOR_SET_FIFO_DEFAULT</strong>\r<dd>\rThe base attributes for the FIFO scheduling policy.  The\rreturned structure is <strong>policy_fifo_base</strong>.\r<dt> <strong>PROCESSOR_SET_RR_DEFAULT</strong>\r<dd>\rThe base attributes for the round-robin scheduling policy.  The \rreturned structure is <strong>policy_rr_base</strong>.\r<dt> <strong>PROCESSOR_SET_TIMESHARE_LIMITS</strong>\r<dd>\rLimits on the allowed timeshare policy attributes.  The\rreturned structure is defined by <strong>policy_timeshare_limit</strong>.\r<dt> <strong>PROCESSOR_SET_RR_LIMITS</strong>\r<dd>\rLimits on the allowed round robin policy attributes.  The\rreturned structure is defined by <strong>policy_rr_limit</strong>.\r<dt> <strong>PROCESSOR_SET_FIFO_LIMITS</strong>\r<dd>\rLimits on the allowed first-in, first-out policy attributes.  The \rreturned structure is defined by <strong>policy_fifo_limit</strong>.\r<dt> <strong>PROCESSOR_SET_ENABLED_POLICIES</strong>\r<dd>\rThe set of enabled policies.  The returned data is a bit-vector.\r</dl>\r<dt> <var>host</var> \r<dd>\r[out host-name send right]\rThe name port for the host on which the \rprocessor set resides.\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_info</strong> function returns selected information\rfor a processor set, as specified by <var>flavor</var>.\r<h3>NOTES</h3>\r<p>\rA processor set has a single default scheduling policy in effect for it (as\rreturned by <strong>PROCESSOR_SET_BASIC_INFO</strong>), so only one of the default\rscheduling structures has valid information.  On the other hand,\ra processor set \rmaintains limits for all defined scheduling policies, so all\rof the scheduling limit \rstructures return valid values.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="processor_set_statistics.html">processor_set_statistics</a>,\r<a href="processor_set_create.html">processor_set_create</a>,\r<a href="processor_set_default.html">processor_set_default</a>,\r<a href="processor_assign.html">processor_assign</a>,\r<a href="P_set_policy_control.html">processor_set_policy_control</a>.\r<p>\rData Structures:\r<a href="processor_set_basic_info.html">processor_set_basic_info</a>,\r<a href="policy_timeshare_info.html">policy_timeshare_info</a>,\r<a href="policy_rr_info.html">policy_rr_info</a>,\r<a href="policy_fifo_info.html">policy_fifo_info</a>.\r