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