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