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