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