xref: /xnu-10002.1.13/osfmk/man/thread_basic_info.html (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions<h2>thread_basic_info</h2>
2*1031c584SApple OSS Distributions<hr>
3*1031c584SApple OSS Distributions<p>
4*1031c584SApple OSS Distributions<strong>Structure</strong> - Defines basic information for a thread.
5*1031c584SApple OSS Distributions<h3>SYNOPSIS</h3>
6*1031c584SApple OSS Distributions<pre>
7*1031c584SApple OSS Distributions<strong>struct thread_basic_info</strong>
8*1031c584SApple OSS Distributions<strong>{</strong>
9*1031c584SApple OSS Distributions       <strong>time_value_t</strong>     <var>user_time</var><strong>;</strong>
10*1031c584SApple OSS Distributions       <strong>time_value_t</strong>   <var>system_time</var><strong>;</strong>
11*1031c584SApple OSS Distributions       <strong>integer_t</strong>        <var>cpu_usage</var><strong>;</strong>
12*1031c584SApple OSS Distributions       <strong>policy_t</strong>            <var>policy</var><strong>;</strong>
13*1031c584SApple OSS Distributions       <strong>integer_t</strong>        <var>run_state</var><strong>;</strong>
14*1031c584SApple OSS Distributions       <strong>integer_t</strong>            <var>flags</var><strong>;</strong>
15*1031c584SApple OSS Distributions       <strong>integer_t</strong>    <var>suspend_count</var><strong>;</strong>
16*1031c584SApple OSS Distributions       <strong>integer_t</strong>       <var>sleep_time</var><strong>;</strong>
17*1031c584SApple OSS Distributions<strong>};</strong>
18*1031c584SApple OSS Distributions
19*1031c584SApple OSS Distributions<strong>typedef struct thread_basic_info* thread_basic_info_t;</strong>
20*1031c584SApple OSS Distributions</pre>
21*1031c584SApple OSS Distributions<h3>FIELDS</h3>
22*1031c584SApple OSS Distributions<dl>
23*1031c584SApple OSS Distributions<dt> <var>user_time</var>
24*1031c584SApple OSS Distributions<dd>
25*1031c584SApple OSS DistributionsThe total user run time for the thread.
26*1031c584SApple OSS Distributions     <p>
27*1031c584SApple OSS Distributions<dt> <var>system_time</var>
28*1031c584SApple OSS Distributions<dd>
29*1031c584SApple OSS DistributionsThe total system run time for the thread.
30*1031c584SApple OSS Distributions          <p>
31*1031c584SApple OSS Distributions<dt> <var>cpu_usage</var>
32*1031c584SApple OSS Distributions<dd>
33*1031c584SApple OSS DistributionsScaled <strong>CPU</strong> usage percentage for the thread.
34*1031c584SApple OSS Distributions          <p>
35*1031c584SApple OSS Distributions<dt> <var>policy</var>
36*1031c584SApple OSS Distributions<dd>
37*1031c584SApple OSS DistributionsScheduling policy in effect
38*1031c584SApple OSS Distributions          <p>
39*1031c584SApple OSS Distributions<dt> <var>run_state</var>
40*1031c584SApple OSS Distributions<dd>
41*1031c584SApple OSS DistributionsThe thread's run state.  Possible values are:
42*1031c584SApple OSS Distributions<dl>
43*1031c584SApple OSS Distributions       <p>
44*1031c584SApple OSS Distributions<dt> <strong>TH_STATE_RUNNING</strong>
45*1031c584SApple OSS Distributions<dd>
46*1031c584SApple OSS DistributionsThe thread is running normally.
47*1031c584SApple OSS Distributions          <p>
48*1031c584SApple OSS Distributions<dt> <strong>TH_STATE_STOPPED</strong>
49*1031c584SApple OSS Distributions<dd>
50*1031c584SApple OSS DistributionsThe thread is stopped.
51*1031c584SApple OSS Distributions          <p>
52*1031c584SApple OSS Distributions<dt> <strong>TH_STATE_WAITING</strong>
53*1031c584SApple OSS Distributions<dd>
54*1031c584SApple OSS DistributionsThe thread is waiting normally.
55*1031c584SApple OSS Distributions          <p>
56*1031c584SApple OSS Distributions<dt> <strong>TH_STATE_UNINTERRUPTIBLE</strong>
57*1031c584SApple OSS Distributions<dd>
58*1031c584SApple OSS DistributionsThe thread is in an un-interruptible wait state.
59*1031c584SApple OSS Distributions          <p>
60*1031c584SApple OSS Distributions<dt> <strong>TH_STATE_HALTED</strong>
61*1031c584SApple OSS Distributions<dd>
62*1031c584SApple OSS DistributionsThe thread is halted at a clean point.
63*1031c584SApple OSS Distributions</dl>
64*1031c584SApple OSS Distributions     <p>
65*1031c584SApple OSS Distributions<dt> <var>flags</var>
66*1031c584SApple OSS Distributions<dd>
67*1031c584SApple OSS DistributionsSwap/idle flags for the thread.  Possible values are:
68*1031c584SApple OSS Distributions<dl>
69*1031c584SApple OSS Distributions       <p>
70*1031c584SApple OSS Distributions<dt> <strong>TH_FLAGS_SWAPPED</strong>
71*1031c584SApple OSS Distributions<dd>
72*1031c584SApple OSS DistributionsThe thread is swapped out.
73*1031c584SApple OSS Distributions          <p>
74*1031c584SApple OSS Distributions<dt> <strong>TH_FLAGS_IDLE</strong>
75*1031c584SApple OSS Distributions<dd>
76*1031c584SApple OSS DistributionsThe thread is an idle thread.
77*1031c584SApple OSS Distributions</dl>
78*1031c584SApple OSS Distributions     <p>
79*1031c584SApple OSS Distributions<dt> <var>suspend_count</var>
80*1031c584SApple OSS Distributions<dd>
81*1031c584SApple OSS DistributionsThe current suspend count for the thread.
82*1031c584SApple OSS Distributions          <p>
83*1031c584SApple OSS Distributions<dt> <var>sleep_time</var>
84*1031c584SApple OSS Distributions<dd>
85*1031c584SApple OSS DistributionsThe number of seconds that the thread has been sleeping.
86*1031c584SApple OSS Distributions</dl>
87*1031c584SApple OSS Distributions<h3>DESCRIPTION</h3>
88*1031c584SApple OSS Distributions<p>
89*1031c584SApple OSS DistributionsThe <strong>thread_basic_info</strong> structure defines the basic information
90*1031c584SApple OSS Distributionsarray for threads.
91*1031c584SApple OSS DistributionsThe <strong>thread_info</strong> function returns this array for a specified thread.
92*1031c584SApple OSS Distributions<h3>RELATED INFORMATION</h3>
93*1031c584SApple OSS Distributions<p>
94*1031c584SApple OSS DistributionsFunctions:
95*1031c584SApple OSS Distributions<a href="thread_info.html"><strong>thread_info</strong></a>.
96*1031c584SApple OSS Distributions<p>
97*1031c584SApple OSS DistributionsData Structures:
98*1031c584SApple OSS Distributions<a href="policy_fifo_info.html"><strong>policy_fifo_info</strong></a>,
99*1031c584SApple OSS Distributions<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>,
100*1031c584SApple OSS Distributions<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>.
101