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