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