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