xref: /xnu-10002.41.9/osfmk/man/processor_set_threads.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>processor_set_threads</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Return a list of pointers to all threads currently assigned to the target processor set.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>kern_return_t	processor_set_threads</strong>
8*699cd480SApple OSS Distributions		<strong>(processor_set_t</strong>	<var>processor_set</var>,
9*699cd480SApple OSS Distributions		<strong>thread_port_array_t</strong>	<var>thread_list</var>,
10*699cd480SApple OSS Distributions		<strong>mach_msg_type_number_t*</strong>	<var>thread_count</var><strong>);</strong>
11*699cd480SApple OSS Distributions</pre>
12*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
13*699cd480SApple OSS Distributions<dl>
14*699cd480SApple OSS Distributions<dt> <var>processor_set</var>
15*699cd480SApple OSS Distributions<dd>
16*699cd480SApple OSS Distributions[in processor-set-control send right]
17*699cd480SApple OSS DistributionsA processor set control port for
18*699cd480SApple OSS Distributionswhich information is desired.
19*699cd480SApple OSS Distributions<dt> <var>thread_list</var>
20*699cd480SApple OSS Distributions<dd>
21*699cd480SApple OSS Distributions[out pointer to dynamic array of thread send rights]
22*699cd480SApple OSS DistributionsThe returned set of
23*699cd480SApple OSS Distributionsports naming the threads currently assigned to <var>processor_set</var>.
24*699cd480SApple OSS Distributions<dt> <var>thread_count</var>
25*699cd480SApple OSS Distributions<dd>
26*699cd480SApple OSS Distributions[out scalar]
27*699cd480SApple OSS DistributionsThe number of threads returned in <var>thread_list</var>.
28*699cd480SApple OSS Distributions</dl>
29*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
30*699cd480SApple OSS Distributions<p>
31*699cd480SApple OSS DistributionsThe <strong>processor_set_threads</strong> function returns send rights
32*699cd480SApple OSS Distributionsto the kernel ports for each thread currently assigned to <var>processor_set</var>.
33*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
34*699cd480SApple OSS Distributions<p>
35*699cd480SApple OSS DistributionsOnly generic errors apply.
36*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
37*699cd480SApple OSS Distributions<p>
38*699cd480SApple OSS DistributionsFunctions:
39*699cd480SApple OSS Distributions<a href="processor_set_tasks.html">processor_set_tasks</a>,
40*699cd480SApple OSS Distributions<a href="task_assign.html">task_assign</a>,
41*699cd480SApple OSS Distributions<a href="thread_assign.html">thread_assign</a>.
42