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