xref: /xnu-11215.41.3/osfmk/man/task_assign_default.html (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1*33de042dSApple OSS Distributions<h2>task_assign_default</h2>
2*33de042dSApple OSS Distributions<hr>
3*33de042dSApple OSS Distributions<p>
4*33de042dSApple OSS Distributions<strong>Function</strong> - Assign a task to the default processor set.
5*33de042dSApple OSS Distributions<h3>SYNOPSIS</h3>
6*33de042dSApple OSS Distributions<pre>
7*33de042dSApple OSS Distributions<strong>kern_return_t   task_assign_default</strong>
8*33de042dSApple OSS Distributions                <strong>(task_t</strong>                                    <var>task</var>,
9*33de042dSApple OSS Distributions                 <strong>boolean_t</strong>                       <var>assign_threads</var><strong>);</strong>
10*33de042dSApple OSS Distributions</pre>
11*33de042dSApple OSS Distributions<h3>PARAMETERS</h3>
12*33de042dSApple OSS Distributions<dl>
13*33de042dSApple OSS Distributions<dt> <var>task</var>
14*33de042dSApple OSS Distributions<dd>
15*33de042dSApple OSS Distributions[in task send right]
16*33de042dSApple OSS DistributionsThe port for the task to be assigned.
17*33de042dSApple OSS Distributions<dt> <var>assign_threads</var>
18*33de042dSApple OSS Distributions<dd>
19*33de042dSApple OSS Distributions[in scalar]
20*33de042dSApple OSS DistributionsTrue if this assignment should apply as well to the threads
21*33de042dSApple OSS Distributionswithin the task.
22*33de042dSApple OSS Distributions</dl>
23*33de042dSApple OSS Distributions<h3>DESCRIPTION</h3>
24*33de042dSApple OSS Distributions<p>
25*33de042dSApple OSS DistributionsThe <strong>task_assign_default</strong> function assigns <var>task</var> to the
26*33de042dSApple OSS Distributionsdefault processor set.
27*33de042dSApple OSS DistributionsAfter the assignment is completed, newly created threads within
28*33de042dSApple OSS Distributionsthis task will be
29*33de042dSApple OSS Distributionsassigned to this processor set.  Any previous assignment of the
30*33de042dSApple OSS Distributionstask is nullified.
31*33de042dSApple OSS Distributions<p>
32*33de042dSApple OSS DistributionsIf <var>assign_threads</var> is <strong>TRUE</strong>, existing threads within the
33*33de042dSApple OSS Distributionstask will also be assigned to the processor set.
34*33de042dSApple OSS Distributions<h3>NOTES</h3>
35*33de042dSApple OSS Distributions<p>
36*33de042dSApple OSS DistributionsThis variant of <strong>task_assign</strong> exists because the control
37*33de042dSApple OSS Distributionsport for the default
38*33de042dSApple OSS Distributionsprocessor set is privileged, and therefore not available to most tasks.
39*33de042dSApple OSS Distributions<h3>RETURN VALUES</h3>
40*33de042dSApple OSS Distributions<p>
41*33de042dSApple OSS DistributionsOnly generic errors apply.
42*33de042dSApple OSS Distributions<h3>RELATED INFORMATION</h3>
43*33de042dSApple OSS Distributions<p>
44*33de042dSApple OSS DistributionsFunctions:
45*33de042dSApple OSS Distributions<a href="task_assign.html"><strong>task_assign</strong></a>,
46*33de042dSApple OSS Distributions<a href="task_get_assignment.html"><strong>task_get_assignment</strong></a>,
47*33de042dSApple OSS Distributions<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
48*33de042dSApple OSS Distributions<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
49*33de042dSApple OSS Distributions<a href="thread_assign.html"><strong>thread_assign</strong></a>.
50