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