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