osfmk/man/task_assign.html

   1 <h2>task_assign</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Assign a task to a processor set.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   task_assign</strong>
   8                 <strong>(task_t</strong>                                    <var>task</var>,
   9                  <strong>processor_set_t</strong>                  <var>processor_set</var>,
  10                  <strong>boolean_t</strong>                       <var>assign_threads</var><strong>);</strong>
  11 </pre>
  12 <h3>PARAMETERS</h3>
  13 <dl>
  14 <dt> <var>task</var>
  15 <dd>
  16 [in task send right]
  17 The port for the task to be assigned.
  18 <dt> <var>processor_set</var>
  19 <dd>
  20 [in processor-set-control send right]
  21 The control port for the processor
  22 set into which the task is to be assigned.
  23 <dt> <var>assign_threads</var>
  24 <dd>
  25 [in scalar]
  26 True if this assignment should apply as well to the threads
  27 within the task.
  28 </dl>
  29 <h3>DESCRIPTION</h3>
  30 <p>
  31 The <strong>task_assign</strong> function assigns <var>task</var> to the set
  32 <var>processor_set</var>.
  33 After the assignment is completed, newly created threads within this task
  34 will be assigned to
  35 this processor set.  Any previous assignment of the task is nullified.
  36 <p>
  37 If <var>assign_threads</var> is <strong>TRUE</strong>, existing threads within the task
  38 will also be assigned to the processor set.
  39 <h3>RETURN VALUES</h3>
  40 <p>
  41 Only generic errors apply.
  42 <h3>RELATED INFORMATION</h3>
  43 <p>
  44 Functions:
  45 <a href="task_assign_default.html"><strong>task_assign_default</strong></a>,
  46 <a href="task_get_assignment.html"><strong>task_get_assignment</strong></a>,
  47 <a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
  48 <a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
  49 <a href="thread_assign.html"><strong>thread_assign</strong></a>.