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