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