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