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