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