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