1*a325d9c4SApple OSS Distributions<h2>thread_policy</h2> 2*a325d9c4SApple OSS Distributions<hr> 3*a325d9c4SApple OSS Distributions<p> 4*a325d9c4SApple OSS Distributions<strong>Function</strong> - Set target thread's scheduling policy state. 5*a325d9c4SApple OSS Distributions<h3>SYNOPSIS</h3> 6*a325d9c4SApple OSS Distributions<pre> 7*a325d9c4SApple OSS Distributions<strong>kern_return_t thread_policy</strong> 8*a325d9c4SApple OSS Distributions <strong>(thread_act_t</strong> <var>thread</var>, 9*a325d9c4SApple OSS Distributions <strong>policy_t</strong> <var>policy</var>, 10*a325d9c4SApple OSS Distributions <strong>policy_base_t</strong> <var>base</var>, 11*a325d9c4SApple OSS Distributions <strong>base</strong> <var>base_count</var>, 12*a325d9c4SApple OSS Distributions <strong>boolean_t</strong> <var>set_limit</var><strong>);</strong> 13*a325d9c4SApple OSS Distributions</pre> 14*a325d9c4SApple OSS Distributions<h3>PARAMETERS</h3> 15*a325d9c4SApple OSS Distributions<dl> 16*a325d9c4SApple OSS Distributions<p> 17*a325d9c4SApple OSS Distributions<dt> <var>thread</var> 18*a325d9c4SApple OSS Distributions<dd> 19*a325d9c4SApple OSS Distributions[in thread send right] 20*a325d9c4SApple OSS DistributionsThe thread scheduling policy is to be set. 21*a325d9c4SApple OSS Distributions<p> 22*a325d9c4SApple OSS Distributions<dt> <var>policy</var> 23*a325d9c4SApple OSS Distributions<dd> 24*a325d9c4SApple OSS Distributions[in scalar] 25*a325d9c4SApple OSS DistributionsPolicy to be set. The values currently defined are <strong>POLICY_TIMESHARE</strong>, 26*a325d9c4SApple OSS Distributions<strong>POLICY_RR</strong> (round robin) and <strong>POLICY_FIFO</strong> (firstin, first-out). 27*a325d9c4SApple OSS Distributions<p> 28*a325d9c4SApple OSS Distributions<dt> <var>base</var> 29*a325d9c4SApple OSS Distributions<dd> 30*a325d9c4SApple OSS Distributions[pointer to in structure] 31*a325d9c4SApple OSS DistributionsBase scheduling policy specific data, 32*a325d9c4SApple OSS Distributions<strong>policy_fifo_base</strong>, <strong>policy_rr_base</strong> or <strong>policy_timeshare_base</strong>. 33*a325d9c4SApple OSS Distributions<p> 34*a325d9c4SApple OSS Distributions<dt> <var>base_count</var> 35*a325d9c4SApple OSS Distributions<dd> 36*a325d9c4SApple OSS Distributions[in scalar] 37*a325d9c4SApple OSS DistributionsThe size of the buffer (in natural-sized units). 38*a325d9c4SApple OSS Distributions<p> 39*a325d9c4SApple OSS Distributions<dt> <var>set_limit</var> 40*a325d9c4SApple OSS Distributions<dd> 41*a325d9c4SApple OSS Distributions[in scalar] 42*a325d9c4SApple OSS DistributionsTrue if the thread's scheduling limits should be restricted to 43*a325d9c4SApple OSS Distributionsallow no more service than specified by <var>base</var>. 44*a325d9c4SApple OSS Distributions</dl> 45*a325d9c4SApple OSS Distributions<h3>DESCRIPTION</h3> 46*a325d9c4SApple OSS Distributions<p> 47*a325d9c4SApple OSS DistributionsThe <strong>thread_policy</strong> function sets the scheduling policy 48*a325d9c4SApple OSS Distributionsto be applied to thread. <var>policy</var> must be a scheduling policy 49*a325d9c4SApple OSS Distributionscurrently "enabled" for the thread's assigned processor set. 50*a325d9c4SApple OSS Distributions<h3>RETURN VALUES</h3> 51*a325d9c4SApple OSS Distributions<dl> 52*a325d9c4SApple OSS Distributions<p> 53*a325d9c4SApple OSS Distributions<dt> <strong>KERN_INVALID_POLICY</strong> 54*a325d9c4SApple OSS Distributions<dd> 55*a325d9c4SApple OSS DistributionsThe processor set to which <var>thread</var> is currently assigned does 56*a325d9c4SApple OSS Distributionsnot currently enable <var>policy</var>. 57*a325d9c4SApple OSS Distributions<p> 58*a325d9c4SApple OSS Distributions<dt> <strong>KERN_POLICY_LIMIT</strong> 59*a325d9c4SApple OSS Distributions<dd> 60*a325d9c4SApple OSS DistributionsThe specified scheduling attributes exceeds the thread's limits. 61*a325d9c4SApple OSS Distributions</dl> 62*a325d9c4SApple OSS Distributions<h3>RELATED INFORMATION</h3> 63*a325d9c4SApple OSS Distributions<p> 64*a325d9c4SApple OSS DistributionsFunctions: 65*a325d9c4SApple OSS Distributions<a href="P_set_policy_control.html"><strong>processor_set_policy_control</strong></a>, 66*a325d9c4SApple OSS Distributions<a href="thread_set_policy.html"><strong>thread_set_policy</strong></a>, 67*a325d9c4SApple OSS Distributions<a href="task_policy.html"><strong>task_policy</strong></a>, 68*a325d9c4SApple OSS Distributions<a href="task_set_policy.html"><strong>task_set_policy</strong></a>. 69*a325d9c4SApple OSS Distributions<p> 70*a325d9c4SApple OSS DistributionsData Structures: 71*a325d9c4SApple OSS Distributions<a href="policy_fifo_info.html"><strong>policy_fifo_info</strong></a>, 72*a325d9c4SApple OSS Distributions<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>, 73*a325d9c4SApple OSS Distributions<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>. 74