osfmk/man/thread_assign_default.html

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