1*0f4c859eSApple OSS Distributions<h2>task_set_policy</h2> 2*0f4c859eSApple OSS Distributions<hr> 3*0f4c859eSApple OSS Distributions<p> 4*0f4c859eSApple OSS Distributions<strong>Function</strong> - Set target task's default scheduling policy state. (Protected Interface.) 5*0f4c859eSApple OSS Distributions<h3>SYNOPSIS</h3> 6*0f4c859eSApple OSS Distributions<pre> 7*0f4c859eSApple OSS Distributions<strong>kern_return_t task_set_policy</strong> 8*0f4c859eSApple OSS Distributions <strong>(task_t</strong> <var>task</var>, 9*0f4c859eSApple OSS Distributions <strong>processor_set_t</strong> <var>processor_set</var>, 10*0f4c859eSApple OSS Distributions <strong>policy_t</strong> <var>policy</var>, 11*0f4c859eSApple OSS Distributions <strong>policy_base_t</strong> <var>base</var>, 12*0f4c859eSApple OSS Distributions <strong>mach_msg_type_number_t</strong> <var>base_count</var>, 13*0f4c859eSApple OSS Distributions <strong>policy_limit_t</strong> <var>limit</var>, 14*0f4c859eSApple OSS Distributions <strong>mach_msg_type_number_t</strong> <var>limit_count</var>, 15*0f4c859eSApple OSS Distributions <strong>boolean_t</strong> <var>change_threads</var><strong>);</strong> 16*0f4c859eSApple OSS Distributions</pre> 17*0f4c859eSApple OSS Distributions<h3>PARAMETERS</h3> 18*0f4c859eSApple OSS Distributions<dl> 19*0f4c859eSApple OSS Distributions<dt> <var>task</var> 20*0f4c859eSApple OSS Distributions<dd> 21*0f4c859eSApple OSS Distributions[in task send right] 22*0f4c859eSApple OSS DistributionsThe task whose scheduling policy is to be set. 23*0f4c859eSApple OSS Distributions<dt> <var>processor_set</var> 24*0f4c859eSApple OSS Distributions<dd> 25*0f4c859eSApple OSS Distributions[in processor-set-control send right] 26*0f4c859eSApple OSS DistributionsThe control port for the processor 27*0f4c859eSApple OSS Distributionsset to which the task is currently assigned. 28*0f4c859eSApple OSS Distributions<dt> <var>policy</var> 29*0f4c859eSApple OSS Distributions<dd> 30*0f4c859eSApple OSS Distributions[in scalar] 31*0f4c859eSApple OSS DistributionsPolicy to be set. The values currently defined are <strong>POLICY_TIMESHARE</strong>, 32*0f4c859eSApple OSS Distributions<strong>POLICY_RR</strong> (round robin) and <strong>POLICY_FIFO</strong> (firstin, first-out). 33*0f4c859eSApple OSS Distributions<dt> <var>base</var> 34*0f4c859eSApple OSS Distributions<dd> 35*0f4c859eSApple OSS Distributions[pointer to in structure] 36*0f4c859eSApple OSS DistributionsBase policy specific data, <strong>policy_fifo_base</strong>, 37*0f4c859eSApple OSS Distributions<strong>policy_rr_base</strong> or <strong>policy_timeshare_base</strong>. 38*0f4c859eSApple OSS Distributions<dt> <var>base_count</var> 39*0f4c859eSApple OSS Distributions<dd> 40*0f4c859eSApple OSS Distributions[in scalar] 41*0f4c859eSApple OSS DistributionsThe size of the buffer (in natural-sized units). 42*0f4c859eSApple OSS Distributions<dt> <var>limit</var> 43*0f4c859eSApple OSS Distributions<dd> 44*0f4c859eSApple OSS Distributions[pointer to in structure] 45*0f4c859eSApple OSS DistributionsPolicy specific limits, <strong>policy_fifo_limit</strong>, 46*0f4c859eSApple OSS Distributions<strong>policy_rr_limit</strong> or <strong>policy_timeshare_limit</strong>. 47*0f4c859eSApple OSS Distributions<dt> <var>limit_count</var> 48*0f4c859eSApple OSS Distributions<dd> 49*0f4c859eSApple OSS Distributions[in scalar] 50*0f4c859eSApple OSS DistributionsThe size of the buffer (in natural-sized units). 51*0f4c859eSApple OSS Distributions<dt> <var>change_threads</var> 52*0f4c859eSApple OSS Distributions<dd> 53*0f4c859eSApple OSS Distributions[in scalar] 54*0f4c859eSApple OSS DistributionsTrue if the scheduling attributes for all contained threads 55*0f4c859eSApple OSS Distributionsshould be changed as well. 56*0f4c859eSApple OSS Distributions</dl> 57*0f4c859eSApple OSS Distributions<h3>DESCRIPTION</h3> 58*0f4c859eSApple OSS Distributions<p> 59*0f4c859eSApple OSS DistributionsThe <strong>task_set_policy</strong> function sets the scheduling attributes, 60*0f4c859eSApple OSS Distributionsboth base and limit, for <var>task</var>. 61*0f4c859eSApple OSS Distributions<var>policy</var> may be any policy implemented by the processor set whether or 62*0f4c859eSApple OSS Distributionsnot it is enabled. 63*0f4c859eSApple OSS Distributions<h3>RETURN VALUES</h3> 64*0f4c859eSApple OSS Distributions<dl> 65*0f4c859eSApple OSS Distributions<dt> <strong>KERN_INVALID_PROCESSOR_SET</strong> 66*0f4c859eSApple OSS Distributions<dd> 67*0f4c859eSApple OSS Distributions<var>processor_set</var> is not the task's processor set control port. 68*0f4c859eSApple OSS Distributions</dl> 69*0f4c859eSApple OSS Distributions<h3>RELATED INFORMATION</h3> 70*0f4c859eSApple OSS Distributions<p> 71*0f4c859eSApple OSS DistributionsFunctions: 72*0f4c859eSApple OSS Distributions<a href="P_set_policy_control.html"><strong>processor_set_policy_control</strong></a>, 73*0f4c859eSApple OSS Distributions<a href="thread_policy.html"><strong>thread_policy</strong></a>, 74*0f4c859eSApple OSS Distributions<a href="thread_set_policy.html"><strong>thread_set_policy</strong></a>, 75*0f4c859eSApple OSS Distributions<a href="task_policy.html"><strong>task_policy</strong></a>. 76*0f4c859eSApple OSS Distributions<p> 77*0f4c859eSApple OSS DistributionsData Structures: 78*0f4c859eSApple OSS Distributions<a href="policy_fifo_info.html"><strong>policy_fifo_info</strong></a>, 79*0f4c859eSApple OSS Distributions<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>, 80*0f4c859eSApple OSS Distributions<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>. 81