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