xnu-2422.1.72.tar.gz

[apple/xnu.git] / osfmk / man / thread_basic_info.html

<h2>thread_basic_info</h2>
<hr>
<p>
<strong>Structure</strong> - Defines basic information for a thread.
<h3>SYNOPSIS</h3>
<pre>
<strong>struct thread_basic_info</strong>
<strong>{</strong>
       <strong>time_value_t</strong>     <var>user_time</var><strong>;</strong>
       <strong>time_value_t</strong>   <var>system_time</var><strong>;</strong>
       <strong>integer_t</strong>        <var>cpu_usage</var><strong>;</strong>
       <strong>policy_t</strong>            <var>policy</var><strong>;</strong>
       <strong>integer_t</strong>        <var>run_state</var><strong>;</strong>
       <strong>integer_t</strong>            <var>flags</var><strong>;</strong>
       <strong>integer_t</strong>    <var>suspend_count</var><strong>;</strong>
       <strong>integer_t</strong>       <var>sleep_time</var><strong>;</strong>
<strong>};</strong>

<strong>typedef struct thread_basic_info* thread_basic_info_t;</strong>
</pre>
<h3>FIELDS</h3>
<dl>
<dt> <var>user_time</var>
<dd>
The total user run time for the thread.
     <p>
<dt> <var>system_time</var>
<dd>
The total system run time for the thread.
          <p>
<dt> <var>cpu_usage</var>
<dd>
Scaled <strong>CPU</strong> usage percentage for the thread.
          <p>
<dt> <var>policy</var>
<dd>
Scheduling policy in effect
          <p>
<dt> <var>run_state</var>
<dd>
The thread's run state.  Possible values are:
<dl>
       <p>
<dt> <strong>TH_STATE_RUNNING</strong>
<dd>
The thread is running normally.
          <p>
<dt> <strong>TH_STATE_STOPPED</strong>
<dd>
The thread is stopped.
          <p>
<dt> <strong>TH_STATE_WAITING</strong>
<dd>
The thread is waiting normally.
          <p>
<dt> <strong>TH_STATE_UNINTERRUPTIBLE</strong>
<dd>
The thread is in an un-interruptible wait state.
          <p>
<dt> <strong>TH_STATE_HALTED</strong>
<dd>
The thread is halted at a clean point.
</dl>
     <p>
<dt> <var>flags</var>
<dd>
Swap/idle flags for the thread.  Possible values are:
<dl>
       <p>
<dt> <strong>TH_FLAGS_SWAPPED</strong>
<dd>
The thread is swapped out.
          <p>
<dt> <strong>TH_FLAGS_IDLE</strong>
<dd>
The thread is an idle thread.
</dl>
     <p>
<dt> <var>suspend_count</var>
<dd>
The current suspend count for the thread.
          <p>
<dt> <var>sleep_time</var>
<dd>
The number of seconds that the thread has been sleeping.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>thread_basic_info</strong> structure defines the basic information
array for threads. 
The <strong>thread_info</strong> function returns this array for a specified thread.
<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="thread_info.html"><strong>thread_info</strong></a>.
<p>
Data Structures:
<a href="policy_fifo_info.html"><strong>policy_fifo_info</strong></a>,
<a href="policy_rr_info.html"><strong>policy_rr_info</strong></a>,
<a href="policy_timeshare_info.html"><strong>policy_timeshare_info</strong></a>.