osfmk/man/thread_assign.html

   1 <h2>thread_assign</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Assign a thread to a processor set.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   thread_assign</strong>
   8                 <strong>(thread_act_t</strong>                            <var>thread</var>,
   9                  <strong>processor_set_t</strong>                  <var>processor_set</var><strong>);</strong>
  10 </pre>
  11 <h3>PARAMETERS</h3>
  12 <dl>
  13 <p>
  14 <dt> <var>thread</var>
  15 <dd>
  16 [in thread send right]
  17 The thread to be assigned.
  18 <p>
  19 <dt> <var>processor_set</var>
  20 <dd>
  21 [in processor-set-control send right]
  22 The control port for the processor
  23 set into which the thread is to be assigned.
  24 </dl>
  25 <h3>DESCRIPTION</h3>
  26 <p>
  27 The <strong>thread_assign</strong> function assigns <strong>thread</strong> to the set
  28 <var>processor_set</var>.  After the
  29 assignment is completed, the thread executes only on processors
  30 that are assigned
  31 to that processor set.  Any previous assignment of the thread is nullified.
  32 <h3>RETURN VALUES</h3>
  33 <p>
  34 Only generic errors apply.
  35 <h3>RELATED INFORMATION</h3>
  36 <p>
  37 Functions:
  38 <a href="thread_assign_default.html"><strong>thread_assign_default</strong></a>,
  39 <a href="thread_get_assignment.html"><strong>thread_get_assignment</strong></a>,
  40 <a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
  41 <a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
  42 <a href="task_assign.html"><strong>task_assign</strong></a>.