xref: /xnu-10002.41.9/osfmk/man/thread_create_running.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>thread_create_running</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Optimized creation of a running thread.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>kern_return_t   thread_create_running</strong>
8*699cd480SApple OSS Distributions                <strong>(task_t</strong>                             <var>parent_task</var>,
9*699cd480SApple OSS Distributions                 <strong>thread_state_flavor_t</strong>                   <var>flavor</var>,
10*699cd480SApple OSS Distributions                 <strong>thread_state_t</strong>                           <var>state</var>,
11*699cd480SApple OSS Distributions                 <strong>thread_act_t</strong>                      <var>child_thread</var><strong>);</strong>
12*699cd480SApple OSS Distributions</pre>
13*699cd480SApple OSS Distributions<h3>PARAMETERS</h3>
14*699cd480SApple OSS Distributions<dl>
15*699cd480SApple OSS Distributions<p>
16*699cd480SApple OSS Distributions<dt> <var>parent_task</var>
17*699cd480SApple OSS Distributions<dd>
18*699cd480SApple OSS Distributions[in task send right]
19*699cd480SApple OSS DistributionsThe port for the task that is to contain the new
20*699cd480SApple OSS Distributionsthread.
21*699cd480SApple OSS Distributions<p>
22*699cd480SApple OSS Distributions<dt> <var>flavor</var>
23*699cd480SApple OSS Distributions<dd>
24*699cd480SApple OSS Distributions[in scalar]
25*699cd480SApple OSS DistributionsThe type of state to establish.  Valid values correspond to
26*699cd480SApple OSS Distributionssupported machine architecture features.
27*699cd480SApple OSS Distributions<p>
28*699cd480SApple OSS Distributions<dt> <var>state</var>
29*699cd480SApple OSS Distributions<dd>
30*699cd480SApple OSS Distributions[pointer to in structure]
31*699cd480SApple OSS DistributionsState information for the specified thread.
32*699cd480SApple OSS Distributions<p>
33*699cd480SApple OSS Distributions<dt> <var>child_thread</var>
34*699cd480SApple OSS Distributions<dd>
35*699cd480SApple OSS Distributions[out thread send right]
36*699cd480SApple OSS DistributionsThe kernel-assigned name for the new thread.
37*699cd480SApple OSS Distributions</dl>
38*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
39*699cd480SApple OSS Distributions<p>
40*699cd480SApple OSS DistributionsThe <strong>thread_create_running</strong> function creates a new thread
41*699cd480SApple OSS Distributionswithin <var>parent_task</var>.
42*699cd480SApple OSS DistributionsThe new thread has is not suspended.  Its initial state is given
43*699cd480SApple OSS Distributionsby <var>state</var>.  <var>flavor</var> specifies the type of state to set.
44*699cd480SApple OSS Distributions<p>
45*699cd480SApple OSS DistributionsThe format of the state to set is machine specific; it is defined in
46*699cd480SApple OSS Distributions\*L<mach/thread_status.h>\*O.
47*699cd480SApple OSS Distributions<p>
48*699cd480SApple OSS DistributionsThe new thread holds a send right for its thread kernel port.
49*699cd480SApple OSS DistributionsA send right for the
50*699cd480SApple OSS Distributionsthread's kernel port is also returned to the calling task or
51*699cd480SApple OSS Distributionsthread in <var>child_thread</var>.
52*699cd480SApple OSS DistributionsThe new thread's exception ports are set to <strong>MACH_PORT_NULL</strong>.
53*699cd480SApple OSS Distributions<h3>NOTES</h3>
54*699cd480SApple OSS Distributions<p>
55*699cd480SApple OSS DistributionsThis is an optimized form of the sequence: <strong>thread_create</strong>,
56*699cd480SApple OSS Distributions<strong>thread_set_state</strong>
57*699cd480SApple OSS Distributionsand <strong>thread_resume</strong>.
58*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
59*699cd480SApple OSS Distributions<p>
60*699cd480SApple OSS DistributionsOnly generic errors apply.
61*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
62*699cd480SApple OSS Distributions<p>
63*699cd480SApple OSS DistributionsFunctions:
64*699cd480SApple OSS Distributions<a href="task_create.html"><strong>task_create</strong></a>,
65*699cd480SApple OSS Distributions<a href="task_threads.html"><strong>task_threads</strong></a>,
66*699cd480SApple OSS Distributions<a href="thread_get_special_port.html"><strong>thread_get_special_port</strong></a>,
67*699cd480SApple OSS Distributions<a href="thread_get_state.html"><strong>thread_get_state</strong></a>,
68*699cd480SApple OSS Distributions<a href="thread_resume.html"><strong>thread_resume</strong></a>,
69*699cd480SApple OSS Distributions<a href="thread_set_special_port.html"><strong>thread_set_special_port</strong></a>,
70*699cd480SApple OSS Distributions<a href="thread_set_state.html"><strong>thread_set_state</strong></a>,
71*699cd480SApple OSS Distributions<a href="thread_suspend.html"><strong>thread_suspend</strong></a>,
72*699cd480SApple OSS Distributions<a href="thread_terminate.html"><strong>thread_terminate</strong></a>,
73*699cd480SApple OSS Distributions<a href="thread_create.html"><strong>thread_create</strong></a>.
74