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