xref: /xnu-10002.41.9/osfmk/man/thread_get_state.html (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions<h2>thread_get_state</h2>
2*699cd480SApple OSS Distributions<hr>
3*699cd480SApple OSS Distributions<p>
4*699cd480SApple OSS Distributions<strong>Function</strong> - Return the execution state for a thread.
5*699cd480SApple OSS Distributions<h3>SYNOPSIS</h3>
6*699cd480SApple OSS Distributions<pre>
7*699cd480SApple OSS Distributions<strong>kern_return_t   thread_get_state</strong>
8*699cd480SApple OSS Distributions                <strong>(thread_act_t</strong>                     <var>target_thread</var>,
9*699cd480SApple OSS Distributions                 <strong>thread_state_flavor_t</strong>                   <var>flavor</var>,
10*699cd480SApple OSS Distributions                 <strong>thread_state_t</strong>                       <var>old_state</var>,
11*699cd480SApple OSS Distributions                 <strong>mach_msg_type_number_t</strong>         <var>old_state_count</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>target_thread</var>
17*699cd480SApple OSS Distributions<dd>
18*699cd480SApple OSS Distributions[in thread send right]
19*699cd480SApple OSS DistributionsThe thread for which the execution state is to be
20*699cd480SApple OSS Distributionsreturned.  The calling thread cannot specify itself.
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 execution state to be returned.  Valid values
26*699cd480SApple OSS Distributionscorrespond to supported machined architectures.
27*699cd480SApple OSS Distributions<p>
28*699cd480SApple OSS Distributions<dt> <var>old_state</var>
29*699cd480SApple OSS Distributions<dd>
30*699cd480SApple OSS Distributions[out structure]
31*699cd480SApple OSS DistributionsState information for the specified thread.
32*699cd480SApple OSS Distributions<p>
33*699cd480SApple OSS Distributions<dt> <var>old_state_count</var>
34*699cd480SApple OSS Distributions<dd>
35*699cd480SApple OSS Distributions[in/out scalar]
36*699cd480SApple OSS DistributionsOn input, the maximum size of the buffer; on output, the
37*699cd480SApple OSS Distributionssize returned (in natural-sized units).
38*699cd480SApple OSS Distributions</dl>
39*699cd480SApple OSS Distributions<h3>DESCRIPTION</h3>
40*699cd480SApple OSS Distributions<p>
41*699cd480SApple OSS DistributionsThe <strong>thread_get_state</strong> function returns the execution
42*699cd480SApple OSS Distributionsstate (for example, the
43*699cd480SApple OSS Distributionsmachine registers) for <var>target_thread</var>. flavor specifies the type
44*699cd480SApple OSS Distributionsof state information
45*699cd480SApple OSS Distributionsreturned.
46*699cd480SApple OSS Distributions<p>
47*699cd480SApple OSS DistributionsThe format of the data returned is machine specific; it is defined in
48*699cd480SApple OSS Distributions\*L<mach/thread_status.h>\*O.
49*699cd480SApple OSS Distributions<h3>RETURN VALUES</h3>
50*699cd480SApple OSS Distributions<p>
51*699cd480SApple OSS DistributionsOnly generic errors apply.
52*699cd480SApple OSS Distributions<h3>RELATED INFORMATION</h3>
53*699cd480SApple OSS Distributions<p>
54*699cd480SApple OSS DistributionsFunctions:
55*699cd480SApple OSS Distributions<a href="task_info.html"><strong>task_info</strong></a>,
56*699cd480SApple OSS Distributions<a href="thread_info.html"><strong>thread_info</strong></a>,
57*699cd480SApple OSS Distributions<a href="thread_set_state.html"><strong>thread_set_state</strong></a>.
58