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