xref: /xnu-10002.41.9/osfmk/man/thread_get_assignment.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>thread_get_assignment</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Return the processor set to which a thread is assigned.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>kern_return_t   thread_get_assignment</strong>
8*699cd480SApple OSS Distributions                <strong>(thread_act_t</strong>                            <var>thread</var>,
9*699cd480SApple OSS Distributions                 <strong>processor_set_name_t</strong>             <var>processor_set</var><strong>);</strong>
10*699cd480SApple OSS Distributions</pre>
11*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
12*699cd480SApple OSS Distributions<dl>
13*699cd480SApple OSS Distributions<p>
14*699cd480SApple OSS Distributions<dt> <var>thread</var>
15*699cd480SApple OSS Distributions<dd>
16*699cd480SApple OSS Distributions[in thread send right]
17*699cd480SApple OSS DistributionsThe thread whose assignment is desired.
18*699cd480SApple OSS Distributions<p>
19*699cd480SApple OSS Distributions<dt> <var>processor_set</var>
20*699cd480SApple OSS Distributions<dd>
21*699cd480SApple OSS Distributions[out processor-set-name send right]
22*699cd480SApple OSS DistributionsThe name port for the processor
23*699cd480SApple OSS Distributionsset into which the thread is assigned.
24*699cd480SApple OSS Distributions</dl>
25*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
26*699cd480SApple OSS Distributions<p>
27*699cd480SApple OSS DistributionsThe <strong>thread_get_assignment</strong> function returns the name
28*699cd480SApple OSS Distributionsport to the processor set to which <var>thread</var> is currently assigned.
29*699cd480SApple OSS DistributionsThis port can only be used to obtain information about the processor set.
30*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
31*699cd480SApple OSS Distributions<p>
32*699cd480SApple OSS DistributionsOnly generic errors apply.
33*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
34*699cd480SApple OSS Distributions<p>
35*699cd480SApple OSS DistributionsFunctions:
36*699cd480SApple OSS Distributions<a href="thread_assign.html"><strong>thread_assign</strong></a>,
37*699cd480SApple OSS Distributions<a href="thread_assign_default.html"><strong>thread_assign_default</strong></a>,
38*699cd480SApple OSS Distributions<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
39*699cd480SApple OSS Distributions<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
40*699cd480SApple OSS Distributions<a href="task_assign.html"><strong>task_assign</strong></a>.
41