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