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