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