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