xref: /xnu-11417.121.6/osfmk/man/thread_create.html (revision a1e26a70f38d1d7daa7b49b258e2f8538ad81650)
1*a1e26a70SApple OSS Distributions<h2>thread_create</h2>
2*a1e26a70SApple OSS Distributions<hr>
3*a1e26a70SApple OSS Distributions<p>
4*a1e26a70SApple OSS Distributions<strong>Function</strong> - Create a thread within a task.
5*a1e26a70SApple OSS Distributions<h3>SYNOPSIS</h3>
6*a1e26a70SApple OSS Distributions<pre>
7*a1e26a70SApple OSS Distributions<strong>kern_return_t   thread_create</strong>
8*a1e26a70SApple OSS Distributions                <strong>(task_t</strong>                             <var>parent_task</var>,
9*a1e26a70SApple OSS Distributions                 <strong>thread_act_t</strong>                      <var>child_thread</var><strong>);</strong>
10*a1e26a70SApple OSS Distributions</pre>
11*a1e26a70SApple OSS Distributions<h3>PARAMETERS</h3>
12*a1e26a70SApple OSS Distributions<dl>
13*a1e26a70SApple OSS Distributions<p>
14*a1e26a70SApple OSS Distributions<dt> <var>parent_task</var>
15*a1e26a70SApple OSS Distributions<dd>
16*a1e26a70SApple OSS Distributions[in task send right]
17*a1e26a70SApple OSS DistributionsThe port for the task that is to contain the new
18*a1e26a70SApple OSS Distributionsthread.
19*a1e26a70SApple OSS Distributions<p>
20*a1e26a70SApple OSS Distributions<dt> <var>child_thread</var>
21*a1e26a70SApple OSS Distributions<dd>
22*a1e26a70SApple OSS Distributions[out thread send right]
23*a1e26a70SApple OSS DistributionsThe kernel-assigned name for the new thread.
24*a1e26a70SApple OSS Distributions</dl>
25*a1e26a70SApple OSS Distributions<h3>DESCRIPTION</h3>
26*a1e26a70SApple OSS Distributions<p>
27*a1e26a70SApple OSS DistributionsThe <strong>thread_create</strong> function creates a new thread within
28*a1e26a70SApple OSS Distributions<var>parent_task</var>.  The new thread has a suspend count of one and
29*a1e26a70SApple OSS Distributionsno processor state.
30*a1e26a70SApple OSS Distributions<p>
31*a1e26a70SApple OSS DistributionsThe new thread holds a send right for its thread kernel port.
32*a1e26a70SApple OSS DistributionsA send right for the
33*a1e26a70SApple OSS Distributionsthread's kernel port is also returned to the calling task or
34*a1e26a70SApple OSS Distributionsthread in <var>child_thread</var>.
35*a1e26a70SApple OSS DistributionsThe new thread's exception ports are set to <strong>MACH_PORT_NULL</strong>.
36*a1e26a70SApple OSS Distributions<h3>NOTES</h3>
37*a1e26a70SApple OSS Distributions<p>
38*a1e26a70SApple OSS DistributionsTo get a new thread running, first use <strong>thread_set_state</strong>
39*a1e26a70SApple OSS Distributionsto set a processor state
40*a1e26a70SApple OSS Distributionsfor the thread.  Then, use <strong>thread_resume</strong> to schedule
41*a1e26a70SApple OSS Distributionsthe thread for execution.
42*a1e26a70SApple OSS DistributionsAlternately, use <strong>thread_create_running</strong>.
43*a1e26a70SApple OSS Distributions<h3>RETURN VALUES</h3>
44*a1e26a70SApple OSS Distributions<p>
45*a1e26a70SApple OSS DistributionsOnly generic errors apply.
46*a1e26a70SApple OSS Distributions<h3>RELATED INFORMATION</h3>
47*a1e26a70SApple OSS Distributions<p>
48*a1e26a70SApple OSS DistributionsFunctions:
49*a1e26a70SApple OSS Distributions<a href="task_create.html"><strong>task_create</strong></a>,
50*a1e26a70SApple OSS Distributions<a href="task_threads.html"><strong>task_threads</strong></a>,
51*a1e26a70SApple OSS Distributions<a href="thread_get_special_port.html"><strong>thread_get_special_port</strong></a>,
52*a1e26a70SApple OSS Distributions<a href="thread_get_state.html"><strong>thread_get_state</strong></a>,
53*a1e26a70SApple OSS Distributions<a href="thread_resume.html"><strong>thread_resume</strong></a>,
54*a1e26a70SApple OSS Distributions<a href="thread_set_special_port.html"><strong>thread_set_special_port</strong></a>,
55*a1e26a70SApple OSS Distributions<a href="thread_set_state.html"><strong>thread_set_state</strong></a>,
56*a1e26a70SApple OSS Distributions<a href="thread_suspend.html"><strong>thread_suspend</strong></a>,
57*a1e26a70SApple OSS Distributions<a href="thread_terminate.html"><strong>thread_terminate</strong></a>,
58*a1e26a70SApple OSS Distributions<a href="thread_create_running.html"><strong>thread_create_running</strong></a>.
59