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

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