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