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