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