xref: /xnu-10002.41.9/osfmk/man/processor_get_assignment.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>processor_get_assignment</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Get current assignment for a processor.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>kern_return_t	processor_get_assignment</strong>
8*699cd480SApple OSS Distributions		<strong>(processor_t</strong>	<var>processor</var>,
9*699cd480SApple OSS Distributions		<strong>processor_set_name_t</strong>	<var>assigned_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<dt> <var>processor</var>
14*699cd480SApple OSS Distributions<dd>
15*699cd480SApple OSS Distributions[in processor send right]
16*699cd480SApple OSS DistributionsThe processor whose assignment is desired.
17*699cd480SApple OSS Distributions<dt> <var>new_set</var>
18*699cd480SApple OSS Distributions<dd>
19*699cd480SApple OSS Distributions[out processor-set-name send right]
20*699cd480SApple OSS DistributionsThe name port for the processor
21*699cd480SApple OSS Distributionsset to which <var>processor</var> is currently assigned.
22*699cd480SApple OSS Distributions</dl>
23*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
24*699cd480SApple OSS Distributions<p>
25*699cd480SApple OSS DistributionsThe <strong>processor_get_assignment</strong> function returns the name port for the
26*699cd480SApple OSS Distributionsprocessor set to which a desired processor is currently assigned.
27*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
28*699cd480SApple OSS Distributions<dl>
29*699cd480SApple OSS Distributions<dt> <strong>KERN_FAILURE</strong>
30*699cd480SApple OSS Distributions<dd>
31*699cd480SApple OSS DistributionsProcessor is either shut down of off-line.
32*699cd480SApple OSS Distributions</dl>
33*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
34*699cd480SApple OSS Distributions<p>
35*699cd480SApple OSS DistributionsFunctions:
36*699cd480SApple OSS Distributions<a href="processor_assign.html">processor_assign</a>,
37*699cd480SApple OSS Distributions<a href="processor_set_create.html">processor_set_create</a>,
38*699cd480SApple OSS Distributions<a href="processor_info.html">processor_info</a>,
39*699cd480SApple OSS Distributions<a href="task_assign.html">task_assign</a>,
40*699cd480SApple OSS Distributions<a href="thread_assign.html">thread_assign</a>.
41