xnu-4903.221.2.tar.gz

[apple/xnu.git] / osfmk / man / thread_assign.html

<h2>thread_assign</h2>
<hr>
<p>
<strong>Function</strong> - Assign a thread to a processor set.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   thread_assign</strong>
                <strong>(thread_act_t</strong>                            <var>thread</var>,
                 <strong>processor_set_t</strong>                  <var>processor_set</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>thread</var> 
<dd>
[in thread send right]
The thread to be assigned.
<p>
<dt> <var>processor_set</var> 
<dd>
[in processor-set-control send right]
The control port for the processor 
set into which the thread is to be assigned.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>thread_assign</strong> function assigns <strong>thread</strong> to the set
<var>processor_set</var>.  After the
assignment is completed, the thread executes only on processors
that are assigned 
to that processor set.  Any previous assignment of the thread is nullified. 
<h3>RETURN VALUES</h3>
<p>
Only generic errors apply.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="thread_assign_default.html"><strong>thread_assign_default</strong></a>,
<a href="thread_get_assignment.html"><strong>thread_get_assignment</strong></a>,
<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
<a href="task_assign.html"><strong>task_assign</strong></a>.