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