xref: /xnu-10002.41.9/osfmk/man/thread_assign_default.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>thread_assign_default</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Assign a thread to the default processor set.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>kern_return_t   thread_assign_default</strong>
8*699cd480SApple OSS Distributions                <strong>(thread_act_t</strong>                            <var>thread</var><strong>);</strong>
9*699cd480SApple OSS Distributions</pre>
10*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
11*699cd480SApple OSS Distributions<dl>
12*699cd480SApple OSS Distributions<p>
13*699cd480SApple OSS Distributions<dt> <var>thread</var>
14*699cd480SApple OSS Distributions<dd>
15*699cd480SApple OSS Distributions[in thread send right]
16*699cd480SApple OSS DistributionsThe thread to be assigned.
17*699cd480SApple OSS Distributions</dl>
18*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
19*699cd480SApple OSS Distributions<p>
20*699cd480SApple OSS DistributionsThe <strong>thread_assign_default</strong> function assigns <var>thread</var> to
21*699cd480SApple OSS Distributionsthe default processor set.
22*699cd480SApple OSS DistributionsAfter the assignment is completed, the thread executes only on processors that
23*699cd480SApple OSS Distributionsare assigned to that processor set.  Any previous assignment of the thread is
24*699cd480SApple OSS Distributionsnullified.
25*699cd480SApple OSS Distributions<h3>NOTES</h3>
26*699cd480SApple OSS Distributions<p>
27*699cd480SApple OSS DistributionsThis variant of <strong>thread_assign</strong> exists because the control
28*699cd480SApple OSS Distributionsport for the default
29*699cd480SApple OSS Distributionsprocessor set is privileged, and therefore not available to most tasks.
30*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
31*699cd480SApple OSS Distributions<p>
32*699cd480SApple OSS DistributionsOnly generic errors apply.
33*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
34*699cd480SApple OSS Distributions<p>
35*699cd480SApple OSS DistributionsFunctions:
36*699cd480SApple OSS Distributions<a href="thread_assign.html"><strong>thread_assign</strong></a>,
37*699cd480SApple OSS Distributions<a href="thread_get_assignment.html"><strong>thread_get_assignment</strong></a>,
38*699cd480SApple OSS Distributions<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
39*699cd480SApple OSS Distributions<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
40*699cd480SApple OSS Distributions<a href="task_assign.html"><strong>task_assign</strong></a>.
41