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

<h2>thread_assign_default</h2>\r<hr>\r<p>\r<strong>Function</strong> - Assign a thread to the default processor set.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   thread_assign_default</strong>\r                <strong>(thread_act_t</strong>                            <var>thread</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</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>thread_assign_default</strong> function assigns <var>thread</var> to\rthe default processor set. \rAfter the assignment is completed, the thread executes only on processors that \rare assigned to that processor set.  Any previous assignment of the thread is\rnullified.\r<h3>NOTES</h3>\r<p>\rThis variant of <strong>thread_assign</strong> exists because the control\rport for the default\rprocessor set is privileged, and therefore not available to most tasks.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="thread_assign.html"><strong>thread_assign</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