osfmk/man/processor_set_threads.html

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