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