xref: /xnu-8792.61.2/osfmk/man/thread_assign.html (revision 42e220869062b56f8d7d0726fd4c88954f87902c)
1*42e22086SApple OSS Distributions<h2>thread_assign</h2>
2*42e22086SApple OSS Distributions<hr>
3*42e22086SApple OSS Distributions<p>
4*42e22086SApple OSS Distributions<strong>Function</strong> - Assign a thread to a processor set.
5*42e22086SApple OSS Distributions<h3>SYNOPSIS</h3>
6*42e22086SApple OSS Distributions<pre>
7*42e22086SApple OSS Distributions<strong>kern_return_t   thread_assign</strong>
8*42e22086SApple OSS Distributions                <strong>(thread_act_t</strong>                            <var>thread</var>,
9*42e22086SApple OSS Distributions                 <strong>processor_set_t</strong>                  <var>processor_set</var><strong>);</strong>
10*42e22086SApple OSS Distributions</pre>
11*42e22086SApple OSS Distributions<h3>PARAMETERS</h3>
12*42e22086SApple OSS Distributions<dl>
13*42e22086SApple OSS Distributions<p>
14*42e22086SApple OSS Distributions<dt> <var>thread</var>
15*42e22086SApple OSS Distributions<dd>
16*42e22086SApple OSS Distributions[in thread send right]
17*42e22086SApple OSS DistributionsThe thread to be assigned.
18*42e22086SApple OSS Distributions<p>
19*42e22086SApple OSS Distributions<dt> <var>processor_set</var>
20*42e22086SApple OSS Distributions<dd>
21*42e22086SApple OSS Distributions[in processor-set-control send right]
22*42e22086SApple OSS DistributionsThe control port for the processor
23*42e22086SApple OSS Distributionsset into which the thread is to be assigned.
24*42e22086SApple OSS Distributions</dl>
25*42e22086SApple OSS Distributions<h3>DESCRIPTION</h3>
26*42e22086SApple OSS Distributions<p>
27*42e22086SApple OSS DistributionsThe <strong>thread_assign</strong> function assigns <strong>thread</strong> to the set
28*42e22086SApple OSS Distributions<var>processor_set</var>.  After the
29*42e22086SApple OSS Distributionsassignment is completed, the thread executes only on processors
30*42e22086SApple OSS Distributionsthat are assigned
31*42e22086SApple OSS Distributionsto that processor set.  Any previous assignment of the thread is nullified.
32*42e22086SApple OSS Distributions<h3>RETURN VALUES</h3>
33*42e22086SApple OSS Distributions<p>
34*42e22086SApple OSS DistributionsOnly generic errors apply.
35*42e22086SApple OSS Distributions<h3>RELATED INFORMATION</h3>
36*42e22086SApple OSS Distributions<p>
37*42e22086SApple OSS DistributionsFunctions:
38*42e22086SApple OSS Distributions<a href="thread_assign_default.html"><strong>thread_assign_default</strong></a>,
39*42e22086SApple OSS Distributions<a href="thread_get_assignment.html"><strong>thread_get_assignment</strong></a>,
40*42e22086SApple OSS Distributions<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
41*42e22086SApple OSS Distributions<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
42*42e22086SApple OSS Distributions<a href="task_assign.html"><strong>task_assign</strong></a>.
43