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