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

<h2>processor_set_policy_control</h2>\r<hr>\r<p>\r<strong>Function</strong> - Set target processor set's scheduling policy state.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t	processor_set_policy_control</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>policy_info</var>,\r		<strong>mach_msg_type_number_t*</strong>	<var>policy_info_count</var>,\r		<strong>boolean_t</strong>	<var>change_tasks_threads</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.\r<dt> <var>flavor</var> \r<dd>\r[in scalar]\rThe type of policy change to make.\r<dl>\r<dt> <strong>PROCESSOR_SET_TIMESHARE_DEFAULT</strong>\r<dd>\rChange the base attributes for the timeshare scheduling\rpolicy, making timeshare the default policy.  The structure is\r<strong>policy_timeshare_base</strong>.\r<dt> <strong>PROCESSOR_SET_FIFO_DEFAULT</strong>\r<dd>\rChange the base attributes for the FIFO (first-in, first-out) \rscheduling policy, making FIFO the default policy.  The\rstructure is <strong>policy_fifo_base</strong>.\r<dt> <strong>PROCESSOR_SET_RR_DEFAULT</strong>\r<dd>\rChanged the base attributes for the round-robin scheduling \rpolicy, making round robin the default policy.  The structure is \r<strong>policy_rr_base</strong>.\r<dt> <strong>PROCESSOR_SET_TIMESHARE_LIMITS</strong>\r<dd>\rChange the limits on the allowed timeshare policy attributes. \rThe structure is defined by <strong>policy_timeshare_limit</strong>.\r<dt> <strong>PROCESSOR_SET_RR_LIMITS</strong>\r<dd>\rChange the limits on the allowed round robin policy\rattributes.  The structure is defined by <strong>policy_rr_limit</strong>.\r<dt> <strong>PROCESSOR_SET_FIFO_LIMITS</strong>\r<dd>\rChange the limits on the allowed first-in, first-out policy\rattributes.  The structure is defined by <strong>policy_fifo_limit</strong>.\r<dt> <strong>PROCESSOR_SET_ENABLED_POLICIES</strong>\r<dd>\rChange the set of enabled policies.  The data is a bit-vector.\r</dl>\r<dt> <var>policy_info</var> \r<dd>\r[in structure]\rThe relevant policy information.\r<dt> <var>policy_info_count</var> \r<dd>\r[in scalar]\rThe size of the buffer (in natural-sized units).\r<dt> <var>change_tasks_threads</var> \r<dd>\r[in scalar]\rIf true, any assigned task or thread whose policy is no\rlonger enabled or whose scheduling attributes exceed the current limits will \rhave their limits adjusted or their policy set to the default as\rappropriate.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>processor_set_policy_control</strong> function controls\rscheduling attributes governing the processor set.\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="processor_set_info.html">processor_set_info</a>.\r<p>\rData Structures:\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