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