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