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