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