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