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

<h2>task_set_policy</h2>\r<hr>\r<p>\r<strong>Function</strong> - Set target task's default scheduling policy state. (Protected Interface.)\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   task_set_policy</strong>\r                <strong>(task_t</strong>                                    <var>task</var>,\r                 <strong>processor_set_t</strong>                  <var>processor_set</var>,\r                 <strong>policy_t</strong>                                <var>policy</var>,\r                 <strong>policy_base_t</strong>                             <var>base</var>,\r                 <strong>mach_msg_type_number_t</strong>              <var>base_count</var>,\r                 <strong>policy_limit_t</strong>                           <var>limit</var>,\r                 <strong>mach_msg_type_number_t</strong>             <var>limit_count</var>,\r                 <strong>boolean_t</strong>                       <var>change_threads</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>task</var> \r<dd>\r[in task send right]\rThe task whose scheduling policy is to be set.\r<dt> <var>processor_set</var> \r<dd>\r[in processor-set-control send right]\rThe control port for the processor \rset to which the task is currently assigned.\r<dt> <var>policy</var> \r<dd>\r[in scalar]\rPolicy to be set.  The values currently defined are <strong>POLICY_TIMESHARE</strong>, \r<strong>POLICY_RR</strong> (round robin) and <strong>POLICY_FIFO</strong> (firstin, first-out).\r<dt> <var>base</var> \r<dd>\r[pointer to in structure]\rBase policy specific data, <strong>policy_fifo_base</strong>, \r<strong>policy_rr_base</strong> or <strong>policy_timeshare_base</strong>.\r<dt> <var>base_count</var> \r<dd>\r[in scalar]\rThe size of the buffer (in natural-sized units).\r<dt> <var>limit</var> \r<dd>\r[pointer to in structure]\rPolicy specific limits, <strong>policy_fifo_limit</strong>,\r<strong>policy_rr_limit</strong> or <strong>policy_timeshare_limit</strong>.\r<dt> <var>limit_count</var> \r<dd>\r[in scalar]\rThe size of the buffer (in natural-sized units).\r<dt> <var>change_threads</var> \r<dd>\r[in scalar]\rTrue if the scheduling attributes for all contained threads \rshould be changed as well.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>task_set_policy</strong> function sets the scheduling attributes,\rboth base and limit, for <var>task</var>. \r<var>policy</var> may be any policy implemented by the processor set whether or \rnot it is enabled.\r<h3>RETURN VALUES</h3>\r<dl>\r<dt> <strong>KERN_INVALID_PROCESSOR_SET</strong>\r<dd>\r<var>processor_set</var> is not the task's processor set control port.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="P_set_policy_control.html"><strong>processor_set_policy_control</strong></a>,\r<a href="thread_policy.html"><strong>thread_policy</strong></a>,\r<a href="thread_set_policy.html"><strong>thread_set_policy</strong></a>,\r<a href="task_policy.html"><strong>task_policy</strong></a>.\r<p>\rData Structures:\r<a href="policy_fifo_info.html"><strong>policy_fifo_info</strong></a>,\r<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>,\r<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>.\r